Metadata Remapping Tool

Last updated
Save as PDF

The Metadata Remapping Tool remaps fields during an upgrade or schema change. You can use this tool in a number of scenarios:

Upgrading a TeamConnect Business Intelligence Integration to 6.1.3
Upgrading to a release that features a schema change.
Clients using an older version of TeamConnect Business Intelligence that requires a schema change.

This tool must be run as the dashboard owner user, which requires the Sisense standalone credentials for that user. If your integration has multiple designers, see Using the Tool with Multiple Designer Users.

Using the Metadata Remapping Tool

To use the Metadata Remapping Tool:

Download the tcbi-mrt.jar file into a folder on a local machine.
Open a command prompt and navigate to the folder where you placed the .jar file.
Use the following command to execute:
java -jar tcbi-mrt.jar -h <host> -u <Sisense_user> -n <eCube / eCubeSet name> -f <.json translation file>
where:
- <.json translation file> = the name of the .json file that got generated by TCBI 6.1.3 during the schema sync/data sync/data reload.
- <eCube / eCubeSet name> = the name of the eCube/eCubeSet that the dashboards use
- <Sisense_user> = Sisense username
- <host> = sisense url
  For example,
  java -jar tcbi-mrt.jar -h http://servername.samplecompanyname.corp:8081 -u sisenseadmin@samplecompanyname.com -n "METADATA_TRANSLATION" -f METADATA_TRANSLATION.json
  
  When prompted for a password, enter the Sisense standalone password.

The tool then performs the following tasks:

Downloads all dashboards that are attached to the Elasticube.
Creates backup .dash files in the local folder.
Uses the .json file to translate the field names.
Replaces the original dashboard on the server with the updated version.

Using the Tool with Multiple Designer Users

If the integration has a few Designers with many dashboards, you have the option change the password for the Designer users, run the tool on each of the Designers, then sync users and groups.

Note:

If the Designer user does not have a valid email, you cannot change the password until a valid email exists.
This method does not break SSO, as Designer users still have report integration availability.

To use the tool with multiple Designer users:

Login to Sisense standalone as an administrator.
Find the Designer user in the User Management page (Admin tab > User Management section > Users page) and change the password.
Run the Metadata Remapping Tool with the Designer's credentials.
Repeat for each Designer user.
Open the Report Integration Tool (Tools > Report Integration).
Click the Sync users and groups icon in the Action column for the integration.