Skip to main content
Mitratech Success Center
Client Support Center

Need help? Click a product group below to select your application and get access to knowledge articles, webinars, training content, and release notes or to contact our support team.

Authorized users - log in to create a ticket, view tickets status and check your success plan details.

 

TeamConnect Business Intelligence (Linux) Migration Process Guide

This guide explains how to move from an existing Sisense Windows server (the source server) to a new Sisense Linux server (the target server) running Rocky Linux.

Prerequisites for Migration

To begin the migration process, ensure you have the following:

  • Source Environment: A fully operational Sisense Windows server (the source server) hosting a functioning TeamConnect (TC) instance.
  • Target Environment: A new Sisense Linux server (the target server), pre-configured with:
    • All necessary plugins installed.
    • Required configurations applied.
  • Access Credentials: Credentials for:
    • The database used for TeamConnect and report integration.
    • A Sisense administrator account.
    • TeamConnect administrative access.

Prerequisites overview

Create and Build the ElastiCube (eCube) on Linux

This step creates the data model (ecube) on the new server. Without it, dashboards will not load correctly. Follow below steps to create and build ElasticCube (eCube) on Linux.

  1. Ensure Java is installed on the server.
  2. Open a terminal and run the following command to verify Java installation:
java -version

Java version verification output

  1. Confirm the command returns the installed Java version.
  2. If Java 21 is not installed, install it by running the following command.
sudo dnf install java-21-openjdk
  1. Run the following command again to confirm Java 21 is installed:
java -version

Java 21 installation output

  1. Verify all required files for the TCBI package installation are available and placed in the correct directory.

TCBI package installation files verification

  1. Open the autoCube.properties file in a text editor. Specify values for the following properties, ensuring that all entries are case sensitive. After completing the updates, save the file and close it.
Property Description
database.hostname Fully qualified domain name (FQDN) of the server hosting the database
database.portnumber Database port number
database.dbname Database SID or service name
database.dbtype Database type (e.g., Oracle)
database.driverClassName Database driver class name (e.g., oracle.jdbc.driver.OracleDriver)
database.connectionString Connection string for Sisense (needed when using load balancing or clustering)
Database.jdbcDriverProperties JDBC driver properties in key=value;key=value format (e.g., encrypt=false)
database.username Database username
database.userpassword Encrypted database password (encrypted using encrypt.jar)
sisense.cubename Name of the ElastiCube (without .ecube extension)
sisense.serverName Fully qualified domain name of the Sisense server
sisense.username Sisense admin username
sisense.password Encrypted admin password (encrypted using encrypt.jar, same as for teamconnect.properties)
sisense.pluginLocation Plugin directory path (e.g., Linux: /opt/sisense/storage/plugins/). AutoCube copies JSON to translations/ automatically. If left blank, JSON won't be copied.
enable.fail.email.notification YES to enable email notifications for failed builds; NO otherwise
enable.success.email.notification YES to enable email notifications for successful builds; NO otherwise
email.recipient Recipient email(s). For multiple recipients, separate with commas
email.sender Valid sender email address
email.server Email server IP address
email.report.subject Subject line for email notifications
email.report.body Body text for email notifications
  1. After configuring the autocube.properties file, proceed to run the schema sync.
sh TCBI_SchemaSync.sh
  1. If email notifications are configured, check your inbox for a success/failure notification. Review logs in the autoCube_logs folder to confirm execution details and troubleshoot failures.
  2. If you receive an error indicating the .json file was not copied automatically, manually move the generated .json file to the translations folder.

Eg. /opt/Sisense/storage/plugins/metadata/translations/

Configure report integration

This document assumes that users already have a previous integration configured and that both Sisense servers use the same password.

Create the Admin group in New Sisense (Linux)
  1. Log in to the Sisense server using an admin account. Navigate to the Admin page, click on Groups in the left pane, and then click on + Add Group button.

Sisense Admin Groups page

Add Group button in Sisense Admin

  1. Enter a group name that matches the existing group name. Add the admin user to the group.

Enter group name and add admin user

  1. After the eCube build is complete and the group is created, share the eCube with the group.
  2. Go to the Data tab. Locate the eCube, click the three dots (⋯) next to it, and select Share.
  3. In the Share pop-up, select the group. Grant access permissions for the selected group (allow the group to use/access the eCube).

Share eCube with group permissions

Install/Update the Report Integration package (Linux)
  1. Identify the available updates for Report Integration. Use the available updates to update the report integration files.
  2. For Linux, install TCBI Report Integration Version 7.0.2.

TCBI Report Integration Version 7.0.2 installation

Updating Report Integration settings

  1. Log in to the TeamConnect instance. Navigate to Tools and click on Report Integration Settings.

TeamConnect Report Integration Settings

  1. Enter the required values for the report integration configuration.
  2. Provide the Shared Secret value, Password, and Update the Group ID value in the database.

Report Integration configuration fields

How to get a Shared Secret?
  1. Log in to the Sisense server and navigate to the SSO Settings page.
  2. Locate the Shared Secret field and copy its value.
  3. Use this value when configuring the Report Integration Settings in TeamConnect.

Shared secret.png

How to Get the Admin Group Id?

Log in to the Sisense server.

  1. Navigate to the Admin tab.
  2. In the left navigation pane, select REST API, then choose API version 0.9.
  3. Locate the GET /groups/{group} endpoint and click Try it out.

Sisense REST API GET groups endpoint

  1. Enter the group name and click Execute. In the response body, identify the GroupId value.

GroupId value in REST API response body

Update the AdminGroupId in the Database

To update the AdminGroupId value in the database, perform the following steps:

  1. Log in to the database using an account with appropriate privileges.
  2. Execute the following query to retrieve the existing properties:
SELECT *
FROM U_REPORT_INTEGRATION_PROPERTY;
  1. In the result set, locate the record where:
    • FIELD_NAME = 'AdminGroupId'
      or
    • Identify the corresponding PRIMARY_KEY value for the AdminGroupId property.
  2. Update the AdminGroupId using the PRIMARY_KEY and FIELD_NAME by executing the following statements and examples:
update U_REPORT_INTEGRATION_PROPERTY set FIELD_VALUE = <GroupID>
WHERE PRIMARY_KEY = <PRIMARY_KEY>;

Eg. update U_REPORT_INTEGRATION_PROPERTY set FIELD_VALUE = '3321315131' WHERE PRIMARY_KEY = 15005;
OR
update using the field_name:
update U_REPORT_INTEGRATION_PROPERTY set FIELD_VALUE = <GroupID>
WHERE FIELD_NAME = 'AdminGroupId';

Eg. update U_REPORT_INTEGRATION_PROPERTY set FIELD_VALUE = '3321315131'
WHERE FIELD_NAME = 'AdminGroupId';

Important Notes:

  • Ensure that <GroupID> matches the ID of the group created manually in Sisense.
  • If you are using an Oracle Database, execute a COMMIT; statement after the update to persist the changes:
COMMIT;
Update the Sisense URL in teamconnect.properties

To redirect TeamConnect to the Linux-based Sisense server, complete the following steps:

  1. Stop the TeamConnect application or service.
  2. Open the teamconnect.properties file and locate the Sisense base URL configuration entry.
  3. Update the value to the new Linux-based Sisense server URL. Save the file.
  4. Restart the TeamConnect application or service to apply the changes.
  5. If the deployment is managed through Jenkins:
    • Update the SISENSE_SERVER parameter with the new Sisense URL.
    • Execute the Jenkins job using the build type WAR_ONLY.

teamconnect.properties Sisense URL update

Jenkins WAR_ONLY build type execution

Once the deployment is up and running, update the Shared Secret as follows:

  1. Navigate to the integration settings in TeamConnect.
  2. Enter the Shared Secret value (from Sisense) and the corresponding password.
  3. Click Update Integration to save the changes.

Update Integration with Shared Secret

Sync users to the new Sisense server

User synchronization sends TeamConnect user data to Sisense, enabling users to access Sisense dashboards.

  1. Log in to TeamConnect.
  2. Navigate to Report Integration. Select the User Sync icon/button.
  3. Wait for the synchronization process to complete.
  4. Once synchronization finishes, TeamConnect users will be available in Sisense and will be able to access the configured dashboards.

User Sync in TeamConnect Report Integration

Migrate dashboards (Rapid BI Migration Tool)

This document assumes that you have already setup the Rapid BI tool Migration and is already running. Refer to documentation: TCBI Linux Migration Tool Guide

Moving Dashboards Between Sisense Environments

Follow the steps below to replicate dashboards from a source Sisense environment to a destination Sisense environment, generate folder mappings, apply the database remap, and then re-sync dashboards.

  1. Note: If Dashboard Co-Authoring was left enabled during migration, Pivot Table widgets on the migrated dashboard will lose their Edit Script, breaking any hyperlinks configured on them. To resolve: delete the affected dashboard on the destination instance, disable Co-Authoring on the source dashboard, and re-run this replication step with conflict_resolution_strategy set to "overwrite". Verify the Edit Script and hyperlinks are intact on the Pivot Table before proceeding

image-20260730-001005.png

  1. Navigate to the endpoint: /api/v1/replicate-folder-dashboards
  2. Select Try it out.
  3. Enter the request body with the source and destination environment details:
{
  "source_domain": "<source_base_url>",
  "source_username": "<source_admin_user>",
  "source_password": "<source_password>",
  "destination_domain": "<destination_base_url>",
  "destination_username": "<destination_admin_user>",
  "destination_password": "<destination_password>",
  "verify_cert": false,
  "folder_name_filter": [],
  "dashboard_title_filter": [],
  "conflict_resolution_strategy": "skip"
}
  1. Select Execute to begin the dashboard replication process.
  2. After the process completes, copy or download the response output, as it will be required for the next step.

replicate-folder-dashboards endpoint execution

Note: If Dashboard Co-Authoring was left enabled during migration, Pivot Table widgets on the migrated dashboard will lose their Edit Script, breaking any hyperlinks configured on them. To resolve: delete the affected dashboard on the destination instance, disable Co-Authoring on the source dashboard, and re-run this replication step with conflict_resolution_strategy set to "overwrite". Verify the Edit Script and hyperlinks are intact on the Pivot Table before proceeding.

  1. Navigate to the endpoint: /api/extract-folder-mapping
  2. Select Try it out.
  3. Paste the response output from the previous step into the request body. Select Execute button.

extract-folder-mapping endpoint with pasted response

  1. Once the request completes, download the generated CSV from the link in the response. This CSV provides the mapping between the old folder IDs (source) and the new folder IDs (destination).

download file link.png

CSV folder mapping file downloaded

  1. Open the downloaded CSV file and copy the data rows only (exclude the header row).

CSV file with data rows to copy

  1. Open the spreadsheet file GenerateUpdateStatement.xlsx and navigate to the CSV Entries tab. Paste the copied CSV data into the sheet.
  2. Use the clipboard paste options and select Split Text to Columns to populate each value into the correct column.

CSV data pasted into GenerateUpdateStatement.xlsx CSV Entries tab

  1. Go to the Process Update Statement tab and copy the generated update statements, which will be used to update folder mappings so dashboards reference the correct folders in the destination environment.
Note: Folder IDs often change between environments. The generated CSV and update statements ensure dashboards remain correctly linked to their corresponding folders after migration.

Process Update Statement tab with generated SQL statements

  1. Update the folder remapping script with the generated update statements (or paste the statements into the script as required by your process).
  2. Execute the updated remapping script against the target database.

Executing folder remapping script against target database

  1. Restart the deployment/application services. After restart, re-run the dashboard synchronization (as applicable to your workflow) and confirm dashboards appear under the correct folders in the destination environment.