Upgrading Smart Reporting
Supported versions and databases
The following table lists the supported product versions and databases from which you can upgrade Smart Reporting to a containerized environment:
Smart Reporting source version | Smart Reporting target version | Source database | Target database |
---|---|---|---|
18.08 to 20.02 | 21.05.03 Hotfix 11 | Microsoft SQL | Microsoft SQL |
Oracle | Oracle |
Upgrade process
The following image shows the process to upgrade Smart Reporting:
Before you begin
Make sure that you migrated BMC Helix Service Management.
See Migrating-Remedy-on-premises-to-BMC-Helix-Service-Management-on-premises.
To export Oracle database dumps
- Log in to the source database server.
Run the following command to export database dumps to the target database:
expdp $<ADMIN USER>/$<ADMIN_PASS> DIRECTORY=$<DUMP_DIRECTORY_PATH> DUMPFILE=$<DUMP_FILE_NAME>
schemas=$<DATABASE_SCHEMA> LOGFILE=$<LOG_FILE_NAME>Parameter name
Description
ADMIN USER
Database administrator user.
ADMIN_PASS
Database administrator password.
DUMP_DIRECTORY_PATH
Database dump location.
DUMP_FILE_NAME
Database dump file name.
DATABASE_SCHEMA
Database schema name.
LOG_FILE_NAME
Database log file name.
To export Microsoft SQL database dumps
You can export database dumps to the target database by using the user interface or the command line interface.
Export by user interface
- Log in to the Microsoft SQL Server Management Studio as an administrator user.
- Expand Databases.
- Right click on your Smart Reporting database.
- Select Tasks > Back up.
- On the Back Up Database window, verify your database details.
- Click OK.
Export by command line interface
- Log in to the source database server.
Run the following command:
sqlcmd.exe -S $<DATABASE_SERVER> -U $<ADMIN USER> -P $<ADMIN_PASS>
-Q "BACKUP DATABASE SmartReporting TO DISK = N\'$<BACKUP_FILENAME_WITH_PATH> \'"Parameter name
Description
DATABASE_SERVER
Database server name.
ADMIN USER
Database administrator user.
ADMIN_PASS
Database administrator password.
BACKUP_FILENAME_WITH_PATH
Database back up file location with file name.
To restore Oracle database dumps
- Download the following files:
- Innovation_Suite_schema_tablespace_creation.sql—This file creates users, database schemas, and table spaces required for setting up the database configurations.
- Data_Population_Script_for_Innovation_Suite—This file imports the database dumps.
In this file, update the parameters with appropriate values.
- Log in to your target database server by using the Oracle user credentials.
- In the target database, copy the Data_Population_Script_for_Innovation_Suite and Innovation_Suite_schema_tablespace_creation.sql files to a required location.
- Navigate to the required path such as /data1/DB_DUMP/ or C:\data1\DB_DUMP.
- Change your directory to the directory path where you copied the Data_Population_Script_for_Innovation_Suite and Innovation_Suite_schema_tablespace_creation.sql files.
Run the Innovation_Suite_schema_tablespace_creation.sql file by using the following command:
sqlplus system/<Password> @Innovation_Suite_schema_tablespace_creation.sqlRun the Data_Population_Script_for_Innovation_Suite file.
- On Windows, perform the following steps:
- In the database server, rename the Data_Population_Script_for_Innovation_Suite file to Data_Population_Script_for_Innovation_Suite.bat
Start command prompt, navigate to the directory that contains the Data_Population_Script_for_Innovation_Suite.bat file, and run the file by using the following command:
cmd Data_Population_Script_for_Innovation_Suite.bat
On Linux, in the database server, run the file as an Oracle user by using the following command:
sh Data_Population_Script_for_Innovation_Suite
- On Windows, perform the following steps:
To import Microsoft SQL database dumps
- Download the following files:
- Drop_Innovation_Suite_database_and_users.sql—This file cleans an existing Smart Reporting target database and the ReportAdmin user.
Innovation_Suite_schema_creation.sql—This file imports the database dumps.
In this file, update the RESTORE DATABASE [SmartReporting] commands with the paths where you have the database dump files.
For example, if you have database dump file located at C:\BACKUP\ location, update the RESTORE DATABASE [ARSystem] command as follows:RESTORE DATABASE [SmartReporting] FROM DISK = N'<Path of Smart Reporting database dump file>.Bak' WITH FILE = 1,
MOVE N'SmartReporting' TO N'<MS SQL Data folder path>\SmartReporting.mdf',
MOVE N'SmartReporting_log' TO N'<MS SQL Log folder path>\SmartReporting_log.ldf', NOUNLOAD, STATS = 5
- In the target database server, copy the Drop_Innovation_Suite_database_and_users.sql, and Innovation_Suite_schema_creation.sql files to the required location. Example: C:\BACKUP\.
(Optional) To clean up an existing Smart Reporting target database and the ReportAdmin user, run the Drop_Innovation_Suite_database_and_users.sql file by using the following command:
sqlcmd -i Drop_Innovation_Suite_database_and_users.sqlRun the Innovation_Suite_schema_creation.sql file by using the following command:
sqlcmd -i Innovation_Suite_schema_creation.sql
To upgrade Smart Reporting
- Log in to your Jenkins server by using the following URL:
http://<Jenkins server host name>:8080 - Select the HELIX_ONPREM_DEPLOYMENT pipeline, select the latest build, and click Rebuild.
- In the CODE section, specify the following in the GIT_USER_HOME_DIR parameter, specify the Git user home directory.
In the CUSTOMER-INFO section, specify the following parameters:
Parameter name
Description
SOURCE_VERSION
Specify 2021306.1.07.00 for the source version of the Helm repositories.
SMARTREPORTING_SOURCE_VERSION
Specify 210503.1.05.00 for the Smart Reporting application version of the Helm repositories.
Specify the value as UPDATE.
In the PRODUCT-DEPLOY section,
Parameter name
Description
HELIX_GENERATE_CONFIG
Select this check box.
HELIX_SMARTREPORTING_DEPLOY
Select this check box to upgrade BMC Helix ITSM: Smart Reporting.
- Click Rebuild.
The HELIX_ONPREM_DEPLOYMENT pipeline updates the Smart Reporting application.
To perform post-upgrade configurations
- Update the AR System server host and port values.
- Log in to your target database.
Run the following commands:
Update SmartReportingConfig set value='<Target AR Server Host>' where key_name = 'onboarding.arserver';
Update SmartReportingConfig set value= '<Target AR Server Port>' where key_name = 'onboarding.arserverport'After you run these commands, the AR System server host and port values are displayed on the Smart Reporting Admin Console UI.
- Add the Smart Reporting Centralized Configuration Server (CCS) parameters in the AR System Configuration Generic UI form.
- Log in to the Remedy AR System Administration Console.
- Select System > General > Centralized Configuration.
- In the AR System Configuration Generic UI form, from the Component Name list, select the arsystem.bmc.arsys.midtier component.
- Add the arsystem.radminuser, arsystem.radminpass, arsystem.reportingURL, arsystem.rtenantid parameters and their values.
The following image shows an example: - Click Apply.
- Click Close.
- Add the arsystem.radminuser, arsystem.radminpass, arsystem.reportingURL, arsystem.rtenantid parameters and their values.
- Update the entries in the SmartReportingServer_Info form.
- Log in to the AR System server as the AR System administrator.
- Open the SmartReportingServer_Info form.
- In the SmartReportingServer_Info form, add the values for the Reporting Server Host, Reporting Server Port, Reporting Server Admin Name, Reporting Server Admin Password, Reporting Server OrgName parameters.
The following image shows an example:
- Update the Reporting Settings in the Mid Tier Configuration Tool.
- Log in to Mid Tier Configuration Tool.
- Navigate to Reporting Settings.
- Add the values for the Reporting URL, Admin User, Admin Password, and Customer Name parameters.
- Select the Validate Smart Reporting information check box.
- Click Save Changes.
The following image shows a completed example:
- Verify that the Smart Reporting parameters are displayed on the AR System Configuration Generic UI form.
- Log in to the Remedy AR System Administration Console.
- Select System > General > Centralized Configuration.
- In the AR System Configuration Generic UI form, from the Component Name list, select the com.bmc.arsys.server.shared component.
- Verify that the Smart Reporting parameters are displayed.
The following image shows an example:
- Test the data source connection.
- Log in to Mid Tier.
- From the Applications menu, select Smart Reporting > Smart Reporting Console.
- In the Smart Reporting console, in the left panel, select Administration > Admin Console.
- Open the Data Sources panel.
- Click the connection.
- Expand Connection Settings and click Test Connection.
The following image shows an example:
To access Smart Reporting
- Verify the Smart Reporting pod is running.
- Log in to the Jenkins server.
Run the following command:
kubectl get pod -n <namespace>The following image shows an example:
Verify that the you can access the Smart Reporting application by using the following URL:
https://<smartreporting ingress name>
Use the siadmin user credentials to login.