OpenLM Reporting Hub Upgrade

Notes:

• While upgrading the ETL version make sure to rename or remove the old folder.
• The installation should be done in an empty folder. When overwriting an existing folder it could keep some files that were deleted in the later releases and this may lead to broken functionalities.
• It is recommended to keep an existing kettle.properties file before upgrading the ETL.
• For newer releases, we may add new parameters to the kettle.properties file.
• If you replace a new empty configuration with an existing one it also may break the functionality if a new file has a different set of parameters.

How to Upgrade the Reporting Hub

1. Go to the current installation path of the Reporting Hub and copy a backup of the license file found in “C:…ETLJobsLicense”.

2. Copy a backup of the kettle file found in “C:…ETLJobsLicense”, it holds database connection details and ETL preferences.

3. Download the latest version of RH from https://www.openlm.com/download/ReportingHub/Latest

4. Unzip and replace the current ETL folder with the downloaded one.

5. Paste the license file you saved back to the folder “C:…ETLJobsLicense”.

6. From the original kettle.properties file, copy the following:

a. Source Database (Note: FireBird entry has been removed as it is no longer supported).

b. Cross-check the Reporting database entries.

c. Destination database if using it (MSSQL or MySQL)

d. Fill in the SMTP server details from the original Kettle.properties file.

e. Fill in the entries of License params.

f. Fill in the correct ETL flagging**:

7. Applicable only if using MySQL or MS SQL Server as the destination database: Delete all the tables in the destination Reporting Hub MySQL / MSSQL database, the schema will be recreated

8. Set the variable “ETL_RUN_ON_INCREMENTS” to be “false” and save the kettle file.

9. Run the ETL using the “Run_ETL.bat” file, which will delete the old DB schema and recreate it.

10. Once the run is finished, set the variable “ETL_RUN_ON_INCREMENTS” to be “true” and save the kettle file.

**

Kettle file ETL flagging map:

• 1. ETL_DATA_AGGREGATION_BY_HOUR (true/false)
     • Choose if the data will get aggregated to a daily or an hourly resolution.
  2. ETL_RUN_ON_INCREMENTS (true/false)
     • The ETL can do an incremental run or recreate the whole database each time.
  3. ETL_COMPILE_RESERVED_LICENSES (true/false)
     • Show reserved licenses like they are used licenses, even if no one is using the reserved license.
  4. ETL_SHOW_ONLY_TRUE_DENIALS (true/false)
     • Filter out any false denials or choose to show them
  5. ETL_EXPORT_DENIALS_INTERVAL (Whole Number)
     • Aggregate close denials into a single denial event. The number represents the period you wish to aggregate denials by (0 means no aggregation of denials).
  6. ETL_ANONYMIZE (true/false)
     • Allows for personal information like usernames and group names to be anonymized in case high-security measures are required.
  7. ETL_FILTER_BY_VENDOR (text list separated by “,”)
     • Filter only the vendors you are interested in (empty means selecting all vendors.)
  8. ETL_EXPORT_RAW_START_DATE=’2010-01-01 00:00:00′
     • Selects data starting from a chosen date.