Installing and upgrading Reporting Metadata Studio

Before you begin

• Make sure that you have OpenJDK 17.0.5 with secure access to your tenant URL and BMC Helix ITSM via cacerts.
• Make sure that you are installing Reporting Metadata Studio on a Windows 10 or 11 system. 
• Configure the JAVA_HOME environment variable that includes the path to the OpenJDK 17.0.5 directory.

• Configure BMC Helix Client Gateway to securely connect to the AR host and port.
  For details, see BMC Helix Client Gateway connectivity.

• Make sure that you have the Admin or Editor role.
  For details, see Roles-and-permissions.

• Create a secret key and user access key in BMC Helix Portal. These keys are required for authentication.
  For details, see Setting up access keys for programmatic access. Make sure that you have the following permissions for generating these keys:

  

   

System requirements

To download the Reporting Metadata Studio installer 

1. Open BMC Helix Dashboards.
2. From the navigation menu , select Administration > General > Reporting Metadata Studio.
3. Click Download.
   The Reporting_Metadata_Studio.zip file is downloaded to your computer.
4. Click Copy to Clipboard to copy the specified environment details. 
   These details are required to connect to the AR system host.

To install Reporting Metadata Studio

1. Navigate to the path where you downloaded the installer file.
2. Extract the downloaded file to the directory of your choice.
   Note: Make sure that you have the appropriate read, write, and execute permissions for the entire directory.
3. Navigate to the following path in the extracted files:
   Reporting_Metadata_Studio\metadata-editor\bmcauthconfiguration
4. Open the env.properties file, and paste the following environment details that you copied from the UI.
   1. Env Alias - The type of environment, such as QA, staging, or production.
   2. Tenant ID - The ID of your tenant.
   3. Tenant URL - The URL of your tenant.
   4. AR Host - The host name or IP address of the computer where the AR host is running.
   5. AR RPC Port - The TCP/RPC port number that is used to connect to the AR host.
   6. REST endpoint - The JDBC REST endpoint that is used for communication with the AR host.
5. (Optional) If you want to route connection requests from Reporting Metadata Studio to your tenant through a web proxy, perform these steps:
   1. Navigate to the following path:
      Reporting_Metadata_Studio\metadata-editor\bmcauthconfiguration
   2. In a text editor, open the webproxy.properties file and provide values for these parameters:
      1. WEB_PROXY_HOST - The IP address of the web proxy.
      2. WEB_PROXY_PORT - The port number of the web proxy.
      3. If the web proxy requires authentication, specify the user name and password for the web proxy.
      4. Save the changes.
6. If only a single user with the Admin or Editor role plans to use Reporting Metadata Studio, perform the following steps; otherwise, go to step 8.
   1. In a text editor, open the profile.properties file.
   2. Add your secret and access keys.
   3. Save the changes.
7. Navigate to the metadata-editor directory, and double-click reporting-metadata-studio.bat.
8. At the command prompt, enter your secret and access keys if they were not already added to the profile.properties file.
   Reporting Metadata Studio opens.

To upgrade Reporting Metadata Studio

1. Navigate to the following path:
   Reporting_Metadata_Studio\metadata-editor\bmcauthconfiguration
2. Back up the bmcauthconfiguration folder.
3. Download the latest installer of Reporting Metadata Studio.
   For download instructions, see To download the Reporting Metadata Studio installer.
4. Extract the downloaded files to the directory of your choice.
5. Navigate to the following path in the extracted files:
   Reporting_Metadata_Studio\metadata-editor\bmcauthconfiguration
6. Replace the bmcauthconfiguration folder with the folder that you backed up in step 2.
7. Navigate to the metadata-editor directory, and double-click reporting-metadata-studio.bat.
8. At the command prompt, enter your secret and access keys if they were not already added to the profile.properties file.
   Reporting Metadata Studio opens.