This documentation supports an earlier version of BMC Helix IT Service Management on-premises deployment. To view the documentation for the latest version, select 23.3.04 from the Product version picker.


Upgrading Smart Reporting


Upgrade BMC Helix ITSM: Smart Reporting from a noncontainerized environment to a containerized environment.

Important

When you upgrade Smart Reporting from a noncontainerized environment to a containerized environment, Smart Reporting is upgraded to 21.05.03 Hotfix 11 version.

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

Important

Use the staged upgrade process to upgrade Smart Reporting in the following scenarios:

  • The source database is Microsoft SQL, and the target database is Oracle.
  • The target database is a PostgreSQL database.

Upgrade process

The following image shows the process to upgrade Smart Reporting:

SR upgrade.png

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

  1. Log in to the source database server.
  2. 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

  1. Log in to the Microsoft SQL Server Management Studio as an administrator user.
  2. Expand Databases.
  3. Right click on your Smart Reporting database.
  4. Select Tasks > Back up.
  5. On the Back Up Database window, verify your database details.
  6. Click OK.

Export by command line interface

  1. Log in to the source database server.
  2. 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

  1. Download the following files:
  2. Log in to your target database server by using the Oracle user credentials.
  3. In the target database, copy the Data_Population_Script_for_Innovation_Suite and Innovation_Suite_schema_tablespace_creation.sql files to a required location. 
  4. Navigate to the required path such as /data1/DB_DUMP/ or C:\data1\DB_DUMP.
  5. 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.
  6. Run the Innovation_Suite_schema_tablespace_creation.sql file by using the following command:

    sqlplus system/<Password> @Innovation_Suite_schema_tablespace_creation.sql
  7. Run the Data_Population_Script_for_Innovation_Suite file.

    • On Windows, perform the following steps:
      1. In the database server, rename the Data_Population_Script_for_Innovation_Suite file to Data_Population_Script_for_Innovation_Suite.bat
      2. 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

To import Microsoft SQL database dumps

  1. 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
  2. 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\.
  3. (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.sql
  4. Run the Innovation_Suite_schema_creation.sql file by using the following command:

    sqlcmd -i Innovation_Suite_schema_creation.sql

To upgrade Smart Reporting

  1. Log in to your Jenkins server by using the following URL:
    http://<Jenkins server host name>:8080
  2. Select the HELIX_ONPREM_DEPLOYMENT pipeline, select the latest build, and click Rebuild.
  3. In the CODE section, in the GIT_USER_HOME_DIR parameter, specify the Git user home directory.
  4. 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.

    DEPLOYMENT_MODE

    Specify the value as UPDATE.

  5. In the PRODUCT-DEPLOY section, specify the following parameters:

    Parameter name

    Description

    HELIX_GENERATE_CONFIG

    Select this check box.

    HELIX_SMARTREPORTING_DEPLOY

    Select this check box to upgrade BMC Helix ITSM: Smart Reporting.

    Important

    Make sure that you do not select the HELIX_CONFIGURE_ITSM, HELIX_POST_DEPLOY_CONFIG, HELIX_DR, and SCALE_DOWN check boxes.

  6. Click Rebuild.
    The HELIX_ONPREM_DEPLOYMENT pipeline updates the Smart Reporting application.

To perform post-upgrade configurations

  1. Update the AR System server host and port values.
    1. Log in to your target database.
    2. 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.

  2. Add the Smart Reporting Centralized Configuration Server (CCS) parameters in the AR System Configuration Generic UI form.
    1. Log in to the Remedy AR System Administration Console.
    2. Select System > General > Centralized Configuration.
    3. In the AR System Configuration Generic UI form, from the Component Name list, select the arsystem.bmc.arsys.midtier component.
    1. Add the arsystem.radminuser, arsystem.radminpass, arsystem.reportingURL, arsystem.rtenantid parameters and their values.
      The following image shows an example:

      Mid tier reporting parameters.png
    2. Click Apply.
    3. Click Close.

  1. Update the entries in the SmartReportingServer_Info form.
    1. Log in to the AR System server as the AR System administrator.
    2. Open the SmartReportingServer_Info form.
    3. 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:
      SmartReporting server info form.png
  2. Update the Reporting Settings in the Mid Tier Configuration Tool.
    1. Log in to Mid Tier Configuration Tool.
    2. Navigate to Reporting Settings.
    3. Add the values for the Reporting URL, Admin User, Admin Password, and Customer Name parameters.
    4. Select the Validate Smart Reporting information check box.
    5. Click Save Changes.
      The following image shows a completed example:
      Mid tier configuration.png
  3. Verify that the Smart Reporting parameters are displayed on the AR System Configuration Generic UI form.
    1. Log in to the Remedy AR System Administration Console.
    2. Select System > General > Centralized Configuration.
    3. In the AR System Configuration Generic UI form, from the Component Name list, select the com.bmc.arsys.server.shared component.
    4. Verify that the Smart Reporting parameters are displayed.
      The following image shows an example:
      Shared SR parameters.png
  4. Test the data source connection.
    1. Log in to Mid Tier.
    2. From the Applications menu, select Smart Reporting > Smart Reporting Console.
    3. In the Smart Reporting console, in the left panel, select Administration > Admin Console.
    4. Open the Data Sources panel.
    5. Click the connection.
    6. Expand Connection Settings and click Test Connection.
      The following image shows an example:
      Data source test.png


To access Smart Reporting

  1. Verify the Smart Reporting pod is running.
    1. Log in to the Jenkins server.
    2. Run the following command:

      kubectl get pod -n <namespace>

      The following image shows an example:

      Verify pods status.png

  2. 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.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*