Installation Guide for BI4

Version 1.63

Documentation revision: 2015-12-09

Page 1 of 32

CONTENTS

I. REQUIREMENTS.................................................................................................................3

II. FIRST STEP: INITIALIZING THE DATABASE...........................................................................4

III. SECOND STEP: DEPLOYING THE TOOL................................................................................5

A. INSTALLATION WIZARD..................................................................................................................................... 5B. IMPORTING THE 360EYES JOBS, UNIVERSES AND DOCUMENTS.......................................................................................8C. BUSINESS OBJECTS AUDITOR CONFIGURATION........................................................................................................11D. CONFIGURING YOUR BOE ENVIRONNEMENT...........................................................................................................12E. NON-STANDARD 360EYES INSTALLATION PATH: CUSTOM JOBS CONFIGURATION....................................................................13F. SETTING THE 360EYES CONNECTION UP...............................................................................................................14

IV. THIRD STEP: RUNNING THE PROGRAM.............................................................................16

V. OPTIONAL: RUNNING THE TOOL FROM COMMAND LINE......................................................17

VI. OPTIONAL: RUNNING THE TOOL FROM THE GRAPHICAL INTERFACE (GUI)..........................19

A. PREPARING THE TOOL.................................................................................................................................... 19B. RUNNING THE TOOL...................................................................................................................................... 19

VII. INSTALL TIPS................................................................................................................21

A. OUTOFMEMORY ERROR ON JAVA MODULES...........................................................................................................21B. DISABLE TRACE ON BOE SERVICES...................................................................................................................21C. ISSUES WITH DCOM PARAMETERS....................................................................................................................22

VIII. DEPLOY WITHIN A CLUSTERED ENVIRONMENT...............................................................22

IX. UPDATING 360EYES........................................................................................................23

X. UPDATING SAP BUSINESS OBJECTS..................................................................................23

XI. UNINSTALLING 360EYES.................................................................................................23

XII. ANNEX.........................................................................................................................24

A. ADVANCED: INSTALLING 360EYES WITHOUT THE WIZARD, OR CUSTOM SETUP...............................................................24A.1. Populating the parameter/Configuration file.................................................................................24A.2. Optional arguments for debugging / Customizing........................................................................31

B. COMMAND LINE ONLY: HIDING THE PASSWORD (OPTIONAL)..........................................................................................32

Page 2 of 32

I. REQUIREMENTS

360Eyes is a powerful solution allowing Business Objects deployments auditing and analysis.

The application offers solutions for analyzing your Business Objects deployments by mapping all theelements in your repositories (Users, Documents, Universes, etc.).

360Eyes also allows documenting your BO deployments by analyzing document impact (Webi, Deski andCrystal documents), data providers (universes, excel sheets, XML files, etc) and objects (results andconditions) in your repositories.

Finally 360eyes is designed to analyze user activity on Webi and Deski documents.

To install this solution the following requirements must be fulfilled:

• A Business Objects BI4 platform

• A supported database (SQL Server, MySQL, Oracle, DB2, PostgreSQL, Sybase SQLAnywhere)

• A 360Eyes product key

• Oracle/SUN Java 1.6 or higher (on the machine running the install wizard)

Please send us your feedback or comments about this document at support@gbandsmith.com

See 360Eyes in action on http://youtu.be/SXJUnnf1XDk

Important note:

The WACS / RESTful SDK component must be deployed and running for 360Eyes to run properly.

Page 3 of 32

II. FIRST STEP: INITIALIZING THE DATABASE

Before first-time setup, the empty database schema must be created on a supported RDBMS (Oracle10g or 11g, Microsoft SQL Server 2005 or 2008, MySQL 5, DB2, PostgreSQL 9.x, Sybase SQLAnywhere).

→ On MySQL, the empty database should be created with the latin1 default character set (so as toprevent UTF8 character set encoding errors) as follows:

CREATE DATABASE 360eyes CHARACTER SET latin1

→ On SQLAnywhere, you must use a DBA account.

→ On DB2, the empty database should be created with at least a 32K page size as follows:

CREATE DATABASE EYES PAGESIZE 32 K

Once the database ready, a user with table creation rights must be defined (the user creationcommand varies depending on which back-end RDBMS is used). 360eyes will then create and populate thedatabase schema at run time.

When upgrading 360Eyes to a newer version, there is no need to modify the database. Only the CMS job(containing the DB upgrade scripts) must be run first following the upgrade.

Note: A clean-up script is provided if the database needs to be dropped, as well as a delete script if youneed to empty your database.

Page 4 of 32

III. SECOND STEP: DEPLOYING THE TOOL

A. INSTALLATION WIZARD

360Eyes can be installed using the provided wizard. Advanced/custom setups are also possible. Pleaserefer to the advanced install guide (annex in this documentation) for further details if needed.

IMPORTANT : If you are using a database other than Oracle / SQL Server / MySQL, the appropriateDB JDBC driver MUST be copied to the libs/ folder after having extracted the content of the 360EyesZIP file. If the driver is unavailable, the wizard will fail to test connectivity to the specified database:

• For Sybase SQLAnyWhere, please use the Jconnect driver (jconn4.jar file).

• For DB2, use the db2jcc.jar driver file ONLY (not the db2jcc4.jar file)

Specific note for Oracle Database:

If the Oracle database configuration fails, settings may be overriden manually by entering the JDBC stringdirectly, using the TNS entry as follows:

jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=<host>)(PORT=<port>))

(CONNECT_DATA=(SERVICE_NAME=<service>)))

Extract the content of the provided 360Eyes ZIP archive, then launch the Install Wizard:

• setup.exe (Windows systems only)

OR

• 360eyes_wizard.jar (any system running Java. e.g: Linux, BSD/*nix, Windows, etc.). Launch thewizard from the command line by entering java –jar 360eyes_wizard.jar

The wizard opens. Please note that that tooltips provide extra information about each parameter availablein the install wizard. Should you need more details about those settings, comprehensive descriptions areincluded in the Advanced Install documentation in the annex (Custom setup).

Follow the on-screen instructions to proceed to the 360Eyes setup.

Page 5 of 32

Step 1Specify the 360Eyes install folder.

Recommended setting:Use the default install directoryif possible in order to avoid anextra configuration steps whenusing InfoView / CMC jobs.

If using a different installationlocation, you MUST follow theinstructions detailed in (followingthe rest of the setup andconfiguration procedures):

F. Non-standard 360EyesInstallation path: Jobsconfiguration

Step 2Browse to the folder containing the360EYES.key file.

This file is usually sent via E-mailwith the GB&SMITH licensingdetails.

Click the “Choose” button toselect it on your local system. Thefile will be copied to the installationfolder.

If you have not received yourlicense file, please request it via E-mail: support@gbandsmith.com

or on our support website: https://support.gbandsmith.com

Step 3Select the 360Eyes database type.

You can use the “JDBC URL Auto”tab or use the “Custom” tab toenter the JDBC URL manually.

The wizard performs the databaseconnectivity and table creationchecks.

Page 6 of 32

Step 4Activate & Select the BOE AuditDatabase.

Select the database type andspecify the required information.

Similarly to step 3, you can providea custom JDBC URL in theDatabase Type section

Step 5Specify additional parameters:

• Replace Mode• Delta/Full loading Mode• Snapshot Limit• Folder to extract• Connection/Session

extraction

Hover the mouse over theavailable fields to display therelated information in the helppanel.

Step 6Specify CMS Security parameters(security information to extract)and Impact Analysis parameters.

Page 7 of 32

Step 7Launch the installation by clickingon “Install Now”.

IMPORTANT:Following this step, thedatabase, its schema and the360Eyes base configuration areready. Make sure to import theBIAR file to your system beforeusing the application.

See: B. Importing the 360EyesJobs, Universes and Documents

B. IMPORTING THE 360EYES JOBS, UNIVERSES AND DOCUMENTS

The 360eyes_bi4.biar file provided in the 360Eyes ZIP. This archive contains:

• All the required Jobs (in the 360eyes jobs folder)

• A set of Webi reports (and universes) you can use to audit and analyze your system (stored in the360eyes report folder)

To import the BIAR file content into your BI4 deployment, you can use:

• Via the command line, using upgrademanagementtool.jar if your server installation is running ona Linux/*nix, BSD, etc. machine (please refer to the BI4 Platform Upgrade Guide for more info onhow to use this tool).

Example:

# cd /home/bi4/bi4sp2/sap_bobj/enterprise_xi40/java/apps/upgradeManagementTool/jars/

# /home/bi4/bi4sp2/sap_bobj/enterprise_xi40/linux_x64/sapjvm/bin/java -Xmx2g -jar upgrademanagementtool.jar -mode biartolive -biarfile "/home/bi4/360eyes/360eyes_bi4.biar" -destination lin04 -destinationusername "Administrator" -destinationpassword ""

• The Upgrade Management Tool GUI if your server installation is running on a Microsoft Windowsmachine. See next pages for details.

Page 8 of 32

1. In the BusinessObjects UpgradeManagement tool, select IncrementalUpdate then click on Next.

2. Select BIAR to Live as upgradescenario.

3. Select 360eyes_bi4.biar as theimport source. Then, specify the theappropriate destination CMS name,User name and password. Click onNext.

4. Select Folders and Objects,Universes and Universes(information design tool), includingall children elements and sub-elements.

Click on Next to continue.

Page 9 of 32

5. Make sure ALL objects are selected(including sub-items) in the list.

Click on Start to proceed.

Note: If updating 360Eyes, you canuncheck the 360eyes connection, sothat your existing settings will not beoverwritten.

The tool performs the operation. The next step is the BusinessObjects Auditor configuration.

Page 10 of 32

C. BUSINESS OBJECTS AUDITOR CONFIGURATION

WARNING : You may need to redefine some synonyms in your Oracle dabase if user selected to writeaudit data is different from the user selected to read audits in 360Eyes.

1. Go to Auditing in the CMC.

2. Select the desired level: “Default” or “Complete”. If “Custom”, is selected, tick the checkboxescorresponding to the following events:

• View

• Refresh

• Create

• Modify

• Logon

• Logout

Page 11 of 32

D. CONFIGURING YOUR BOE ENVIRONNEMENT

When running the tool on a BI4.x platform, you must adjust the following settings in the CMC:

1. In Applications, right-click on CentralManagement Console (CMC), and selectProgram Object Rights in the context menu.

2. Ensure the following parameters are set asfollows:

→ Allow users to:

Run scripts/binaries: Checked

Run Java programs: Checked

Use impersonation: Unchecked

Page 12 of 32

E. NON-STANDARD 360EYES INSTALLATION PATH: CUSTOM JOBS CONFIGURATION

IMPORTANT NOTE: This section applies ONLY if BusinessObjects and (/or) 360Eyes are installedin a custom location. If using default settings, you can skip to the next section.

The BIAR file contains all the 360Eyes jobs. If you have specified an installation path on your server otherthan C:\360eyes (Windows) you must change the argument in the settings of each imported job:

1. Right-click on the listed programs andselect Default Settings in the contextmenu.

2. Click on “Program Parameters” andedit the Arguments field (by default :C:\360eyes) to match the custom path youhave previously set in the Install Wizard.

The classpath value is not defined by default. It must be defined explicitly. For instance, on a Windowsplatform, you need to edit the settings for each job to add the following classpath in Default Settings →Program Parameters:

Class to run: com.gbs.eyes.Cms

Classpath: C:\Program Files (x86)\SAP BusinessObjects\

SAP BusinessObjects Enterprise XI 4.0\java\lib\*

Please note that the trailing wildcard (*) in the path allows the use of any file present in the specifieddirectory.

3. Repeat these steps for EACH item in the list.

Page 13 of 32

F. SETTING THE 360EYES CONNECTION UP

Once the 360Eyes universes imported, the connection must be configured.

1. Launch the Universe Design tool,

2. Click on the Tools menu and selectConnections.

3. Edit the 360eyes connection.

A warning will be displayed if the connectionhas been created on XIr2. It can be safelyignored.

4. Click Back in this Window

Page 14 of 32

5. When editing the connection, select the database driver matching the type of the 360eyesdatabase (as selected in the Install Wizard, step 3), then click Next.

Then provide the 360eyes database credentials (credentials used during in the Install Wizard, step 3).

Follow the on-screen instructions, then click on “Finish” to save the changes.

Page 15 of 32

IV. THIRD STEP: RUNNING THE PROGRAM

Once the installation and configuration complete, the 360Eyes jobs can be launched.

• Directly, via History / Run Now• Or via the BO Scheduler (“Schedule” tab)

IMPORTANT: When 360Eyes is first run, OR following an update, the CMS job containing the database self-upgrade script should be launched. If this script is not run, you will experience problems with jobs or inconsistent operation (on COMPLIANCE-only systems, the COMPLIANCEjob will perform this task).

Each running job is represented by an instance:

When an instance fails, you can click on “Failed” to display the detailed error message and its code:

Here is the error code table:

ErrorCode

Description

-1 JDBC Connection error. Please check the JAR driver file, the URL format and the login.

-2 SQL query error. Please check that the schema has been initialized with the corresponding scriptprovided in the 360Eyes ZIP.

-3 CMS version error: the version is not supported by the current product.

-4 License file error (360eyes.key): please check the file in the previously specified folder/directory

-5 License expired: your key has expired, please contact the GBS Support to renew it.

-6 Program argument error: please check the arguments.

-7 Program argument: please check the mandatory arguments.

-8 Error in properties file (360EYES.param): check it (refer to Advanced Install. See annex).

-9 Unknown error.

Page 16 of 32

V. OPTIONAL: RUNNING THE TOOL FROM COMMAND LINE

360Eyes was designed to be run directly from your BOE system. But it can be run from the command-linerun. This can be useful for testing purposes on a Production environment, without installing anything onthe system.

Requirements:

• All the Java SDK libraries available in the following directories (by platform):

o C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI

4.0\java\lib (BI4.x, Windows platform)

• Java JRE 1.6 or higher (java.exe must to be in the PATH system environment variable)

• A 360eyes folder (for example C:\360eyes, containing the 360eyes.param and 360EYES.key files)

• The 360Eyes executable (named 360eyes.jar). The file is in the the zip file: tools/ folder

To run 360Eyes from command line, launch the 360eyes.jar executable from its location as follows:

java -Xmx1024m -cp”SDK_LIB_FOLDER/*;360eyes.jar” com.gbs.eyes.Launcher ARG1 ARG2 ARG3 ARG4 ARG5 ARG6

Arguments detail and syntax:

• ARG1: The job run. Can be CMS, COMPLIANCE, COMPLIANCEREPO, CRYSTAL, DESKI, DESKIINFOVIEW,DESKIFOLDER, REMOVESNAPSHOT, UNIVERSE or WEBI

• ARG2: The CMS to extract data from. Can be written following the SERVER:PORT format

• ARG3: The BO User Logon to use (must be an Enterprise account)

• ARG4: The BO Password of the user (See Annex B for password encoding).

• ARG5: The authentication type. Can be secEnterprise, secLDAP, secWinAD or secSAPR3. If notspecified secEnterprise will be the default value

• ARG6: The 360Eyes folder on the local computer (C:\360eyes for instance)

• Optional arguments: following the 5 mandatory arguments, you can provide one or more optionalparameters:

o –add : adds a snapshot instead of replacing a previous one

o -replace : replaces the latest snapshot with the new one

o –debug: debug mode

o –usage: computes in-report object usage

o –delta: enables delta loading mode

o –inherited: extracts explicit and inherited rights

o –effective: extract effective rights (with the SECURITY version of the product only)

o -effectiveplus: extracts effective rights and fine rights as defined in the param file (withthe SECURITY version of the product only)

Page 17 of 32

o -no_impact_analysis: no impact analysis documents (DESKIINFOVIEW, WEBI, CRYSTAL)

o -replace: forces replace mode

o -full: forces full mode

o -no_db_update: does not run the DB update script

o -repourl: JDBC URL of the BO V6 repository (for Compliance V6)

o -repouser: JDBC user of the BO V6 repository (for Compliance V6)

o -repopass: JDBC password of the BO V6 repository (for Compliance V6)

o -forceCluster: forces the name of cluster store in the 360Eyes DB

o -folderType: forces the folder type to extract, this is a list of comma-separated items:PUBLIC, FAVORITE, INBOX, TEMP, for instance.

o -anonymize : anonymizes the extracted audit data

o -noanonymize : does not anonymize extracted audit data

o -DBAUDurl : URL to another audit database

o -DBAUDuser : uses another user (specify user name) on audit database

o -DBAUDpass : use another password on audit database

o -keep : keeps the current snapshot

Example 1: CMS job run on a XI3.1 platform, from a Windows computer, with –add argument:

java -Xmx1024m -cp "C:\Program Files\Business Objects\common\4.0\java\lib\*;360eyes.jar"com.gbs.eyes.Launcher CMS WIN01 Administrator "" secEnterprise C:\360eyes -add

Logging into the WIN01 CMS system, as Administrator and without a password (note the mandatory “”).

Example 2: A COMPLIANCEREPO job (COMPLIANCE on BO v5/BO v6) from a Windows computer :

java -Xmx1024m -cp "C:\Program Files\Business Objects\common\4.0\java\lib\*;360eyes.jar"com.gbs.eyes.Launcher COMPLIANCEREPO "" "" "" secEnterprise C:\360eyes -repourl=jdbc:oracle:thin:@//win03:1521/XE -repouser=BO6_REPO_USER -repopass=BO6_REPO_PASS

Example 3: Running a REMOVE SNAPSHOT job :

java -Xmx1024m -cp "C:\Program Files\Business Objects\common\4.0\java\lib\*;360eyes.jar"com.gbs.eyes.Launcher REMOVESNAPSHOT WIN01 Administrator "" secEnterprise C:\360eyes 234,235,236

Page 18 of 32

VI. OPTIONAL: RUNNING THE TOOL FROM THE GRAPHICAL INTERFACE (GUI)

360Eyes (version 1.14 and higher) can be used in graphical interface to run jobs outside BO environment.Like the CLI (command line interface), this allow running jobs remotely (no need to install 360Eyes on theCMS you want to extract data from).

This tool also allows running specifics jobs:

• COMPLIANCE V5/V6: run license compliance audits on BOv5 and BOv6 repositories, and mixresults with your license compliance outputs on XI systems. This job can only be run if you have aCOMPLIANCE version of the product (such as the COMPLIANCE job).

• REMOVE SNAPSHOT: a graphical version of the REMOVE_SNAPSHOT job. It allow you todynamically select the snapshot to remove.

A. PREPARING THE TOOL

You need to specify the Java SDK libraries you want to use. To do so, edit the 360eyes_GUI.bat file presentin the tools/ folder of the installation package :

java -cp "C:\Program Files\Business Objects\common\4.0\java\lib\*;360eyes.jar" com.gbs.eyes.LauncherGui

The highlighted part should to be adapted to match the path on your system.

Without custom path, only 2 jobs will be available: COMPLIANCE V5/V6 and REMOVE SNAPSHOT (sincethey do not require access to the Java SDK libraries).

B. RUNNING THE TOOL

Launch the 360eyes_GUI.bat file. Java JRE (1.6 or higher) must be installed on your system, and the PATHenvironment variable should contain the path to the Java (javaw.exe for instance). The launch file isWindow specific, but you can adapt it to run it on Unix platform with graphical environment.

Without XI Libraries (access to COMPLIANCE V5/V6and REMOVE SNAPSHOT jobs only)

With XI librariess (access to all jobs)

Specific options available for each job type. The most common one is the mandatory 360Eyes folder path,containing the param file and the key file.

The “Add snapshot” option, CMS login box on XI jobs, a DB selector for COMPLIANCE V5/V6 panel, and asnapshot list for the REMOVE SNAPSHOT jobs are also available.

Page 19 of 32

To run a job, provide the required information, and click on the “Launch Job” button:

The log console is displayed in the bottom part of the window. It provides information and displays errorsas well as a log of the currently running job.

Page 20 of 32

VII. INSTALL TIPS

A. OUTOFMEMORY ERROR ON JAVA MODULES

In some circumstances, OutOfMemory errors occur when the Java VM memory is full:

You can extend the memory allocated when launching the module by editing the argument line and addinga this parameter at the beginning of the line: {-jvmArgs -Xms64m -Xmx1024m}

This parameter instructs Java to allocate 1024MB to the module.

B. DISABLE TRACE ON BOE SERVICES

Enabling tracing on BOE services (such as Webi Processing Server, or Deski Processing Server) can generate large log files in the BOE logs directory. If tracing is enabled while running 360Eyes (WEBI, CRYSTAL or DESKI_INFOVIEW job), gigabytes of logs WILL be generated, because each document on the platform will be opened by the job. The solution is to disable BOE trace before launching 360Eyes.

Page 21 of 32

C. ISSUES WITH DCOM PARAMETERS

If there are issues setting up the DCOM parameters, the 360eyes_DESKI_INFOVIEW and360eyes_UNIVERSE jobs will not run.

To ensure proper setup of your DCOM server (your Windows machine), please check the following:

• Check the DCOM Security:o Click Start, click Programs, click Administrative Tools, click Component Services.o Expand Component Services, expand Computers, and right-click My Computer. Select

Properties.o Click Default COM Security.o Under Default Access Permissions click Edit Default. Make sure the user/group whose

authentication credentials will be used to access the COM application all have Local andRemote Access permissions.

o Under Default Access Permissions click Edit Limits. Make sure that the user/groupwhose authentication credentials will be used to access the COM application has Local andRemote Access permissions.

o Under Default Launch Permissions click Edit Default. Make sure that the user/groupwhose authentication credentials will be used to access the COM application all has Localand Remote Launch permissions, as well as Local and Remote Activation permissions.

o Under Default Launch Permissions click Edit Limits. Make sure that the user/groupwhose authentication credentials will be used to access the COM application has Local andRemote Launch permissions, as well as Local and Remote Activation permissions.

• Check the Windows Firewall:o If possible, disable your Windows firewall (DCOM is not using specific port).o If disabling the firewall is not possible, add the following on the exception panel:

Allow port 135 to be opened Allow designer.exe and busobj.exe from the BOBJ deployment for the exception

• Check the “Remote Registry service”:o Open the Windows services panel (run services.msc for instance)o Select the Remote Registry serviceo Start it, if not started; and check that it starts with the system.

If "access denied" or "permission denied" errors still occur following the DCOM settings configuration,reboot the system apply the new settings.

VIII. DEPLOY WITHIN A CLUSTERED ENVIRONMENT

There is no specific installation. Please note that in a clustered environnement, each member of thecluster can run a service named 'Adaptive Job Server' (BI4.x) for running 360Eyes jobs.

In such a case, you MUST have a running “Adaptive Job Server” on all the members of the clusterrunning from folder set up at initial install time (on one of the cluster members). Copy-paste this folder andits content (by default: C:\360eyes) on all the other cluster members.

Page 22 of 32

IX. UPDATING 360EYES

To update the 360Eyes software package, simply install the new version over the previous one:

• Run the install wizard, it will recover the configuration and data from the previous installation willadd potential additionnal new parameters,

• Import the BIAR file, it will replace previous objects (jobs & reports): you can de-select the360eyes connection in the Upgrade Management tool to later skip the universe connectionupdate step.

• Finally, launch the 360Eyes CMS job to update the DB schema if needed before starting any otherjob (COMPLIANCE job if you have a COMPLIANCE license only).

If you are using the CLI/GUI interface, you may need to update the 360eyes.jar file to the new version, aswell as the 360eyes.param file (if new parameters and options are set).

WARNING: since version 1.29, the JDBC libraries are not included in the 360eyes.jar file anymore, butmust be stored in libs/ sub-sirectory of the 360Eyes install location (by default C:\360eyes\libs)

X. UPDATING SAP BUSINESS OBJECTS

Following a SAP BusinessObjects upgrade, you must check the 360Eyes software :

• In the case of a BO Migration (XI3.1 to BI4.0), you must check that you have the correct 360Eyespackage. 360Eyes is available for XIr2/Xi3.x and a specific package is available for BI4.Running an incorrect version of 360Eyes may corrupt your 360Eyes database.

• If not, 360Eyes can be run as normal without requiring updating the application after havingapplied a SP or FP update. We always recommend running the latest version of 360Eyes if possible.

XI. UNINSTALLING 360EYES

To uninstall 360Eyes, you should:

a. Delete the C:\360eyes directory on the server (or custom directory if applicable)

b. Delete the “360eyes jobs” and “360eyes reports” folders in the CMC

c. Drop the 360eyes schema from the database

d. Remove the macro from all local deski computer (if installed)

Page 23 of 32

XII. ANNEX

A. ADVANCED: INSTALLING 360EYES WITHOUT THE WIZARD, OR CUSTOM SETUP

You can choose to install 360Eyes without the wizard, and/or to specify additional parameters that wouldnot be available in the wizard.

Log on to the server hosting Business Objects and create a folder for 360Eyes. Usually C:\360eyes.

WARNING: if using a different location to store the 360Eyes, you will have to edit the argument for eachjob (see: Non-standard installation: Custom jobs configuration).

In this folder/directory, the following files and directories must be copied :

• The libs folder included in the ZIP file. This folder contains the DB drivers for common databases(Oracle, SQL Server, MySQL). The GB&SMITH Support may ask you to add a library to this folder tosupport an additional database.

• The tools folder included in the ZIP file. This folder contain the CLI/GUI interfaces.

• The 360EYES.key file (provided by mail)

• The parameter/config file (360eyes.param, an example is provided in the installation package).

A.1. POPULATING THE PARAMETER/CONFIGURATION FILE

A.1.A)DATABASES JDBC URL FORMAT

DB Type JDBC URL format

MySQL jdbc:mysql://IP_OR_HOSTNAME:PORT_NUMBER/DB_NAME

Oracle jdbc:oracle:thin:@//IP_OR_HOSTNAME:PORT_NUMBER/SID

SQL Server jdbc:jtds:sqlserver://IP_OR_HOSTNAME:PORT_NUMBER/DB_NAME;instance=INSTANCE_NAME

DB2 jdbc:db2://IP_OR_HOSTNAME:PORT_NUMBER/DB_NAME

PostgresSQL Jdbc:postgres://IP_OR_HOSTNAME:PORT_NUMBER/DB_NAME

SQL AnyWhere jdbc:sybase:Tds:IP_OR_HOSTNAME:PORT_NUMBER?ServiceName=SERVICE_NAME

The 360eyes.param file will need to be customized to fit your specific needs.

Please refer to the next pages for details about available configuration parameters.

Page 24 of 32

A.1.B)GENERAL PARAMETERS

# 360eyes database connection (MANDATORY)DBurl = jdbc:oracle:thin:@//IP_OR_HOSTNAME:PORT_NUMBER/SIDDBuser = myuserDBpass = mypass

The 360eyes database connection is mandatory. The DB stores the information extracted from jobs. TheJDBC URL, user and password are mandatory. The password will be obfuscated if using the wizard.

# Snapshot behavior# ADD will add a new snapshot# REPLACE will replace the previous snapshot# It can be overloaded on the command line (put -add as a additional argument after the folder path)replaceMode = REPLACE

This parameter defaults to REPLACE mode:

• REPLACE: replace the previous snapshot done on the same cluster name, and same module.• ADD: always add a new snapshot

# Limit the # of snapshot per type and CMS (OFF by default/ON)# And set the max value if limitation is activatedsnapshot.limit = OFFsnapshot.count.max = 3

Snapshot deletion system, control. Enable it and specify how many snapshots you wish to keep. The oldestsnapshots on same system and snapshots having the same name will be deleted.

# Distinct the snapshot user (OFF by default/ON)# ON : distinct 2 snapshots by type, CMS and user (can't replace a snapshot run by a different user)# OFF : distinct 2 snapshots by type and CMS (replace a snapshot run by a different user)snapshot.distinct.user = OFF

“Distinct snapshot user” feature control. When disabed (OFF), all snapshots of a same kind (CMS forexample) will be seen as the same content. So, they can be REPLACED if launched with the correctreplaceMode. This is the default behavior.

When enabled (ON), a run launched by user1 and a run launched by user2 are displayed as 2 differentextractions. They cannot be REPLACED even if launched with the correct replaceMode. This is useful whenextracting parts of the system for different projects / entities.

# DELTA/FULL loading mode# DELTA will only reload modified objects since last extraction# FULL will always reload everything# The DELTA mode is available only for CRYSTAL, DESKI_INFOVIEW, UNIVERSE and WEBI jobsloadingMode = FULL

This parameter controls the DELTA/FULL loading mode (FULL by default):

• FULL: always reload everything.• DELTA: reload modified content since last extraction only (on CRYSTAL, DESKI_INFOVIEW,

UNIVERSE and WEBI jobs)

# Folder Type to extract# This parameter control which folders and documents you want to extract.# You can choose multiple value between PUBLIC, FAVORITE, INBOX and TEMP.# It will impact all jobs dealing with documents, by default only PUBLIC folders/documents are extracted.# CAUTION: on XIR2 system, you must set PUBLIC, FAVORITE, INBOX, TEMPfolderType = PUBLIC

Specifies which type of folders will be extracted: PUBLIC folders/documents only by default, or PUBLIC andFAVORITE, etc.

WARNING: This option does not apply to XIR2. in this case, you MUST pick all folder types (PUBLIC,FAVORITE, INBOX, TEMP). This parameter is not effective when the 'parent_ids' setting is defined.

Page 25 of 32

# Extract object usage inside documents (OFF by default/ON)extractObjectUsage = OFF

Set this parameter to ON in to compute the object (universe object results, variables) occurrences inDESKI_INFOVIEW and WEBI jobs.

# Extract document content (blocks, cells...) (OFF by default/ON)extractDocumentContent = OFF

Set this parameter to ON to extract content (reports, blocks, cells, etc.) from Webi documents.

# Extract (or not) number of page for each webi report (OFF by default/ON)webi.page = OFF

Set this parameter to ON to extract the number of pages for each Webi documents.

# Extract the information about partial result (OFF bu default/ON)webi.checkPartialResult = OFF

Set this parameter to ON to extract for each Dataprovider (whether this is a partial result or not).

# 360 webapp links: provide extraction from 360 webapp; customfields extraction, cast schedules.# The root URL of 360 need to be provided, and then each parameter can be OFF (default) or ONcms.extract.360url = http://server:8080/360/cms.extract.360.customfields = OFFcms.extract.360.cast = OFF

Controls extraction of the data specified in the 360 web application. First; you MUST specify the URL to the360 webapp, and then enable 2 extractions :

• Custom fields (set to users, documents and universes). Data is then accessible in CMS universe.

• 360Cast schedules. Data is then accessible in CMS universe.

# Optional extract of the fullname of the folders (hierachical view) (OFF by default/ON)cms.extract.folder.fullname = OFF

Controls the extraction of the group fullname (with hierarchy) in CMS_GROUP.FULLNAME.

# Path for the log files (if not given, use the install folder)# And number of log files to be keep by each job type (10 by default)log.folder =log.keep = 10

Define the path to the 360Eyes log files. If left undefined, log files will be written in the logs subdirectoryof the 360Eyes folder (C:\360eyes by default).

You can also define how many log files to keep for each job type. A log file is generated for each job,formatted as: jobname, date & time and cluster name (example: CMS_20130208_151858_WIN01.log).

# Locale value used to customize language used in report engines (en by default)locale = en

Default locale value (en, fr, etc.) to be used by the Report Engine. It is used to select the right languagewhen extracting variable expressions, for instance.

# Check or not file repository store in CMS job (OFF by default/ON)cms.check.frsIntegrity = OFF

This parameter allows checking file integrity of your Repository against FRS. This fills the field namedFILE_CHECK in CMS_DOCUMENT and CMS_UNIVERSE; the value will be 0 if at least one file in the object isunavailable. Disabled by default as CMS jobs are about 30% slower with this option.

# Extract prompt information from all instances (OFF by default/ON)cms.extract.prompts = OFF

This setting allows populating the CMS_DOCUMENT_PROMPT table (all prompt information extracted frominstances), you can choose to enable it by switching to ON (it will increase the CMS job run time by 20%).

Page 26 of 32

# Alternative Folder Extraction (ON by default/OFF)alternativeFolderExtraction = ON

Set this parameter to OFF if encountering issues when extracting folders from the CMS job: it will extractfolders recursively; may be faster but will not use the provided ID in the parent_ids param.

# Optional argument to find the last instance for each document (OFF by default/ON)cms.extract.last.instance = OFF

Set this parameter to ON to find the last instance of each document.

# Optional argument to extract instances during WEBI, DESKI and CRYSTAL jobs (OFF by default/ON)extractDocumentInstances = OFF

Set this parameter to ON to extract instances of WEBI, DESKI or CRYSTAL documents.

# Optional argument to extract the last instance of each document during WEBI, DESKI and CRYSTAL jobs (OFF by default/ON)extractDocumentLastInstance = OFF

Set this parameter to ON to extract the last instance of each WEBI, DESKI or CRYSTAL document.

# Optional extraction of error message in the EYE_ERROR table (OFF by default/ON)extract.error = OFF

Set this parameter to ON to extract SEVERE and WARNING messages from the EYE_ERROR table in the360Eyes database.

# OpenDocument Regular Expression Detectionopendoc.regexp = .*openDocument.jsp.*iDocID=(\\w+)&.*

This is the regular expression used to detect Open Document links in Webi reports, and retrieve the relatedCUID; it is possible to customize this setting to detect different information.

# Upper SQL Keywords (OFF by default/ON)syntax.upperSQLKeywords = OFF

Switch to ON to force uppercase formating on extracted SQL data.

A.1.C)CMS SECURITY

# Security behavior on 360eyes_CMS# OFF will not extract the security info at all# EXPLICIT will extract explicit security# INHERITED will extract inherited security# EFFECTIVE will extract effective security (only with SECURITY product version)# FINE will extract effective + fine rights (only with SECURITY product version)# There is memory leak issues on security/XIR2 before SP5. You could get an OutOfMemoryError # if securityMode is not OFF in this configuration.securityMode = OFF

This parameter controls security information extraction in the CMS module:

• OFF: security is not extracted.• EXPLICIT: will extract EXPLICIT roles only.• INHERITED: will extract EXPLICIT + INHERITED roles.• EFFECTIVE: will extract EFFECTIVE roles (with SECURITY product version only).• FINE: will extract EFFECTIVE roles + fine rights specified below (with SECURITY product version

only)

# Limit info extraction in CMS job (OFF by default/ON)limitMode = OFF

This parameter controls limits information extraction in the CMS module:

• OFF: limits information is not extracted • ON: will extract limits, matching the same “level” (EXPLICIT, INHERITED, EFFECTIVE, etc.)

Limits information is never extracted if securityMode is set to OFF.

Page 27 of 32

# Object types where 360eyes will extract security# You can choose to not extract security from all object typessecurityObjects = GROUP,USER,UNIVERSE,OVERLOAD,CONNECTION,FOLDER,DOCUMENT,APPLI

Choose which object types to extract security of in the CMS job. Everything is extracted by default. Valuesare comma-separated.

# Principal type you want to extract (only for EFFECTIVE and FINE mode)securityPrincipals = GROUP,USER

When running an EFFECTIVE or FINE extraction, extract Users rights only, Group rights only, or both(available with SECURITY version of the product only).

# Fine Right you want to export when FINE security is activated (View objects by default)# You can choose several rights separated by a comma# FINE is only available with SECURITY product versionsecurityFineRights = View objects

Specify the fine rights (in ENGLISH only) to extract from the CMS job. This will work when securityMode isset to FINE only and with a SECURITY version of the product.

A.1.D) AUDIT DATA

# Activate Auditor extraction (OFF by default/ON)useAuditor = OFF

The useAuditor flag controls the extraction state:

• ON: 360Eyes will extract data from Auditor• OFF: 360Eyes will not extract data from Auditor

# Activate Auditor extended extraction (DETAIL table). Useful to extract more data from Auditor, but# can take longer to extract (user IP address, remove fake Refresh event, rowCount)# (OFF by default/ON)audit.extended = OFF

The audit.extended flag allows extracting rowCount for each Refresh action, for instance.

# Extract CMS action during CMS job (OFF: don't extract anything, CONNECTION: extract connection # informations, SESSION: extract session informations, BOTH: extract both)cms.extract.action = OFF

This parameter controls CMS-related action extraction on the server: you can choose to extract loginevents (login, logoff with associated IP), sessions (duration, etc.) or both. It aims at replacing slower BOaudit reports.

# The sampling duration in minutes during which the session information are extractedcms.session.sampling = 60

This parameter controls the sampling duration used to extract session information.

# To extract audit data on instance (OFF: don't extract, ON: extract)audit.instance = OFF

Set this parameter to ON to extract audit information from your instances. The collected data will be linkedto the parent document, using a specific action name : Instance Refresh, Instance View, etc.

# To extract actions linked to documents that no longer exist (OFF: don't extract, ON: extract)audit.orphan.actions = OFF

Set this parameter to ON to extract actions triggered by no longer existing documents.

# Anonymize Audit data (OFF by default/ON)anonymize_audit = OFF

Set this parameter to ON in order to anonymize your audit data extracted from Auditor, when runningWEBI, DESKI_INFOVIEW or CRYSTAL jobs (to comply with enterprise criteria).

Page 28 of 32

# Stop auditing service during eyes job to avoid fake events generated by 360eyes (OFF/ON by default)auditor.disable_audit_during_run = ON

The auditor.disable_audit_during_run flag controls the Server audit state (enabled/disabled) duringEyes job. If server audit is disabled, the generation of fake events in the Auditor database will beprevented; but this will also prevent generation of actual events during Eyes jobs.

# Audit level to be set at the end of a job who has "auditor.disable_audit_during_run = ON" param# XiR2 & Xi3 values = {OFF, ON, RESTORE}# BI4.x values = {OFF, MINIMAL, DEFAULT, CUSTOM, COMPLETE, RESTORE}# RESTORE is the default value (caution: not safe if previous job have failed)audit.restore.level = RESTORE

The audit.restore.level flag defines the audit level to set when jobs having theauditor.disable_audit_during_run parameter set to ON end running.

# Which users to exclude from Audit data, help to not retrieve fake events generated by 360eyes if # previous parameter is set to OFF.auditor.users_to_exclude_from_audit = Administrator

The parameter auditor.users_to_exclude_from_audit is useful when server auditing is enabled: fakeevents have been generated by 360Eyes jobs. In order NOT include them in the audit extraction performedby 360Eyes, you can choose to exclude specific user actions. So, if 360Eyes jobs are run by a user named360Eyes, you can exclude data related to this specific user not to retrieve false actions in the 360Eyesaudit data. Multiple users can be specified and separated by commas.

# allow you to extract audit only from X last months# null by default, use an integer to activate this optional argumentaudit.since =

Optional: allows extracting audit data for a given time period (in months). The value must be an integer.

# BOE Audit database connectionDBAUDurl = jdbc:oracle:thin:@//IP_OR_HOSTNAME:PORT_NUMBER/SIDDBAUDuser = myuserDBAUDpass = mypass

The JDBC URL, username and password must be provided if useAuditor is true. 360Eyes will NOT writeanything into the Auditor database but reads data from it.

A.1.E)CONTENT FLAGGING

# Flag content: activate the flag content of old documents in WEBI, CRYSTAL, DESKI_INFOVIEW jobs (OFF by default/ON)content.flag = OFF

Content flagging will add a specific expression in the description of all the documents analyzed in WEBI,DESKI_INFOVIEW, CRYSTAL jobs and meeting specific criteria. Switch to ON to enable this mode.

# Flag content keyword: the keyword added in the document descriptioncontent.flag.keyword = #TOARCHIVE

The specific expression to add to document description.

# Flag content month: documents will be flagged after N months with no actioncontent.flag.month = 6

Documents will be flagged if they have not been used (based on auditor data) for the specified number ofmonths.

# Folder type to flag, can be a PUBLIC, FAVORITE, INBOX, TEMP (separated by a comma)content.flag.folder.type = PUBLIC

You can choose to flag PUBLIC documents, or FAVORITE, INBOX, etc.

# Object type to be flagged (all if empty, Webi, FullClient separated by comma’s)content.flag.object.type =

You can choose to flag a specifc content type only. If none is specified, all content types are tagged.

Page 29 of 32

# Folder to exclude, for example /Root Folder/Archive (separated by a comma)content.flag.exclude = /Root Folder/Archive

You can choose to exclude specific directories. Documents in these directories will never be flagged.

# Exclude content flagging for the list of Owner(s) separated by comma’scontent.flag.owner.exclude =

You can choose to exclude owner lists from flagging. Documents owned listed users will never be flagged.

# Flag content created month: exclude objects with a creation date more recent than N monthscontent.flag.created.month = 6

You can choose to exclude contents being more recent than N months from flagging.

# Flag content modified month: exclude objects with a modification date more recent than N monthscontent.flag.modified.month = 6

You can choose to exclude content having modification date more recent than N months from flagging.

# Exclude content with a recurring schedulecontent.flag.schedule.exclude = OFF

You can choose to exclude from flagging content a recurring schedule.

# Exclude content with a recurring schedule owned by the list of owner below (separated by commas)content.flag.schedule.owner.exclude =

You can choose to exclude from flagging content with a recurring schedule, but only content matching aspecific owner list.

A.1.F) DEBUG PARAMETERS

# You can debug the product with the following filters, to extract only specifics ids, or objects from# specifics parent ids, or limit the extraction to a specific number of items# id = 234,235# parent_ids = 345,345# ids_to_exclude = 34667,457# limits = 100

These parameters are useful for limiting extraction to specific ids, parent_ids, to exclude some ids or tolimit the amount of objects to extract.

A.1.G) DCOM PARAMETERS

# Extraction way for Universe and Deski: choose extraction type: DCOM (using DCOM# server and Designer/Deski libs) or DIRECT (no DCOM need, default values)UniverseExtraction = DIRECTDeskiExtraction = DIRECT

# DCOM Server (Windows Box) used to get Designer and Deski libs (mandatory if set to DCOM)DCOMhost = myhostDCOMdomain = mydomainDCOMuser = myuserDCOMpass = mypass

These parameters are used for launching the 360eyes_UNIVERSE and 360_DESKI_INFOVIEW jobs.

There are two options for the 2 jobs:

• DIRECT: extract content directly from the unv/rep file

• DCOM: use the DCOM values specified below to use COM libraries for Deski and Designer. In thiscase, specifying DCOMhost, DCOMdomain, DCOMuser and DCOMpass is mandatory.

• UniverseExtraction: DIRECT or DCOM, mode used for UNIVERSE job• DeskiExtraction: DIRECT or DCOM, mode used for DESKI_INFOVIEW job• DCOMhost: DCOM Windows maching hosting BOE client tools (at least Designer and Deski)• DCOMdomain: Domain Name of the Windows user (if no domain, set the same as the host)• DCOMuser: Windows user, without the domain• DCOMpass: password of the Windows user.

Page 30 of 32

Note: BusinessObjects Auditor must be enabled/running and configured TO BE ABLE TO SEEUSER ACTIVITY IN WEBI & DESKI DOCUMENTS (Please refer to III.D. BusinessObjects Auditorconfiguration).

A.2. OPTIONAL ARGUMENTS FOR DEBUGGING / CUSTOMIZING

Specific arguments can be added to the param file to debug your system:

Argument Usage Description

limits limits=100 Limits extraction to a specific amount ofobjects.

ids Ids=23,45,78 Limits extraction to a specific set ofInfoObject IDs.

ids_to_exclude ids_to_exclude=354,34,12 Excludes IDs from the items to extract(useful when an error is returned for aspecific document).

parent_ids parent_ids=132,43,456,23 Limits extraction to the specified ids and alltheir subitems.

folder folder=C:\deski_folder Sets a specific Deski Folder (to be used withDeski Folder job)

360 can extract user information from an additonal data source. For instance, if using a SAP BW connector, there isno user information (fullname, comments) in BO. This functionality allows specifying another DB (like a SAP BW DB),username/password and a specific SQL query to extract the fullname and comments fields.

external.user.extraction.url external.user.extraction.url =jdbc:mysql://gbs-server5:3306/360eyes

JDBC URL of information datasource

external.user.extraction.user external.user.extraction.user = root

JDBC user of information datasource

external.user.extraction.pass external.user.extraction.pass = root

JDBC password of information datasource

external.user.extraction.query external.user.extraction.query =SELECT NAME, CONCAT(FULLNAME,'BLA'), COMMENTS FROM CMS_USER WHERE SNAPSHOT_ID=0

SQL query. Must include 3 fields:• Username (link with BO username)• Full name• Comments field

360Eyes can use a specific SQL query for the COMPLIANCE job (2 columns: old and new value) to match theusername (replace a username by another). This is useful for cross-platform users having different usernames (whilebeing the same actual user. Eg.: jbras and julien.bras).

compliance.user.replacement.url compliance.user.replacement.url = jdbc:mysql://gbs-server5:3306/360eyes

JDBC URL of user info datasource

compliance.user.replacement.user compliance.user.replacement.user = root

JDBC user of user info datasource

compliance.user.replacement.pass compliance.user.replacement.pass = root

JDBC password of user info datasource

compliance.user.replacement.query compliance.user.replacement.query = SELECT OLDNAME, NEWNAME FROM USERS

SQL query. Must include 2 fields:• Old username to replace• New username

Page 31 of 32

B. COMMAND LINE ONLY: HIDING THE PASSWORD (OPTIONAL)

The command-line tool requires a password, but this one is not hidden by default.

You can encode your password with another class, and specify it in the command line.

To encode your password from the CLI, run the following command from the directory containing the360eyes.jar executable file:

java -Xmx1024m -Djava.ext.dirs=”SDK_LIB_FOLDER” -cp 360eyes.jar com.gbs.eyes.PasswordCrypt ARG1

Here is the arguments detail:

● ARG1 is the only one argument needed. It's the BO Password of the user.

● SDK_LIB_FOLDER is described in the section V of this install guide.

After having entered this command, the script will return an encoded password, beginning with “ENC(“.

Use this new password in all your command lines, as “ARG4”.

Example: a CMS job run on a XI3.1 platform, from a Windows computer, with an encoded password:

java -cp "C:\Program Files\Business Objects\common\4.0\java\lib\*;360eyes.jar" com.gbs.eyes.Launcher CMS WIN01 Administrator ENC(XdeR38aR) secEnterprise C:\360eyes

Logging in to the WIN01 CMS system, as Administrator with an encoded password.

Documentation revision: 2015-12-09

Page 32 of 32