You are viewing content for 4.4 | 4.3 | Previous Releases


Tenant Management Tool (TMT)

A tenant is an instance of a dashboard that can be shared by many users. Even though each tenant is using the same dashboard, they can have different levels of access, and each has its own data.

Incorta is a multi-tenant solution. The same Incorta server can support multiple tenants, each one of them with its own set of users/schemas/dashboards. A user needs to specify the tenant in the login page, or as part of the URL (in case of SSO login).  Data is never shared between tenants. An administrator can choose to create a tenant during installation, or add it after the installation.

Using the Tenant Management Tool

To manipulate your tenants, use the tool that ships with the product under the INSTALLATION_PATH/Incorta_Home/cmc/tmt folder. Running the bash shell script displays a list of commands to list, create, import, update, and drop tenants.

The following are the most commonly used commands for managing your metadata in Incorta Analytics.

Create a New Empty Tenant

Use the following steps to create a new empty tenant. If you are using the embedded Derby database, and the application server (Tomcat) is running, you must first stop the application server. This is because the Apache Derby does not support multiple users accessing the database concurrently, so accessing it is limited to one connection at a time.

  1. Navigate to the TMT directory. cd <Incorta_Home>/cmc/tmt
  2. Edit the new_tenant.properties files. You can skip this step to use the default configurations. On Linux/Mac: nano new_tenant.properties
  3. Start the server. (In the case of MySQL and Oracle, restart the application server to finish creating the new tenant.)

Create a New Tenant

Run the following command:

  • For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -c -on new_name -op new_tenant_full_path
  • For Windows: tmt.bat -clnm <CLUSTER_NAME>  -c -on new_name -op new_tenant_full_path

Create a New Tenant with Sample Data

Use the following steps to create a new tenant with demo schemas and dashboards. If you are using the embedded Derby database, and the application server (Tomcat) is running, you must first stop the application server. This is because the Apache Derby does not support multiple users accessing the database concurrently, so accessing it is limited to one connection at a time.

  1. Navigate to the TMT directory. cd <Incorta_Home>/cmc/tmt
  2. Edit new_tenant.properties. For Linux/Mac: nano new_tenant.properties
  3. Create a new tenant. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -c -s -on new_tenant_name. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -c -s -on new_tenant_name.
  4. Start the server. (In the case of MySQL and Oracle, restart the application server to finish creating the new tenant.)

Export or Copy an Existing Tenant

Use the following steps to create a duplicate copy of an existing tenant. If you are using the embedded Derby database, and the application server (Tomcat) is running, you must first stop the application server. This is because the Apache Derby does not support multiple users accessing the database concurrently, so accessing it is limited to one connection at a time.

  1. Navigate to TMT directory. For Linux, Mac, and Windows the command is cd <Incorta_Home>/cmc/tmt.
  2. Export the tenant to be duplicated. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -ex tenant_name tenant_name.zip. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -ex tenant_name tenant_name.zip.
  3. Edit tenant_name.properties. Skip this step to use the same configuration as the copied tenant. For Linux/Mac: nano tenant_name.properties
  4. Start the server. (In the case of MySQL and Oracle, restart the application server to finish creating the new tenant.)

Import a Tenant

If the data files are small enough, you can use the -cf flag to import the data files.

  1. Run the following command for Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -i tenant_name.zip -on tenant_name -cf <source_tenant_path>/data.
  2. To avoid the prompts to enter the username, password, and email separately using this command for Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -i tenant_name.zip -on tenant_name -su <super user username> -sp <super user password> -sm <super user email> -cf <source_tenant_path>/data. For Windows: tmt.bat -clnm <CLUSTER_NAME>   -i tenant_name.zip -on tenant_name <source_tenant_path>\data tmt.bat -clnm <CLUSTER_NAME> -i tenant_name.zip -on tenant_name -su <super user username> -sp <super user password> -sm <super user email> -cf <source_tenant_path>/data.
  3. Manually copy the data files and snapshots to the new directory.  

Change Login Name/Password of the Incorta Analytics Administrator (Superuser)

Use the following steps to change the login name and password of the super user for a certain tenant. If the application is running you must first stop the application server if you are using the embedded Derby database.

  1. Navigate to the TMT directory: cd <Incorta_Home>/cmc/tmt.
  2. Change superuser login name. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -u tenant_name superuser-login new_login_name. For Windows: tmt.bat -clnm <CLUSTER_NAME> -u tenant_name superuser-login new_login_name
  3. Change the superuser password. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -u tenant_name superuser-password new_password. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -u tenant_name superuser-password new_password.

Enable/Disable a Tenant

User the following steps to enable or disable a tenant. Disabled tenants are ignored on startup prevent users from logging in to them. If the application is running you must first stop the application server if you are using the embedded Derby database.

  1. Navigate to the TMT directory: cd <Incorta_Home>/cmc/tmt.
  2. Disable the tenant. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -d tenant_name. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -d tenant_name.
  3. Enable the tenant. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -e tenant_name. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -e tenant_name.

Edit Tenant Properties

Use the following steps to change multiple tenant properties at once.

Note: You must first stop application server if you are using the embedded Derby database.

  1. Navigate to the TMT directory: cd <Incorta_Home>/cmc/tmt.
  2. Export the tenant properties. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME> -lc tenant_name > tenant.properties. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -lc tenant_name > tenant.properties.
  3. Edit the tenant.properties. You can add new properties, edit existing properties, and more.

Update Tenant with New Properties

Linux/Mac

./tmt.sh -clnm <CLUSTER_NAME> -u tenant_name file tenant.properties

Windows

tmt.bat -clnm <CLUSTER_NAME>  -u tenant_name file tenant.properties

Remove a Tenant

Use the following steps to remove a tenant from the system. If the application is running you must first stop the application server if you are using the embedded Derby database.

  1. Navigate to the TMT directory: cd <Incorta_Home>/cmc/tmt.
  2. Remove the tenant. For Linux/Mac: ./tmt.sh -clnm <CLUSTER_NAME>  -r tenant_name. For Windows: tmt.bat -clnm <CLUSTER_NAME>  -r tenant_name.
  3. Manually remove the tenant files.

Restore a Removed Tenant from a Backup

Use the following steps to restore a removed tenant from the backup files. If the application is running you must first stop the application server if you are using the embedded Derby database.

  1. Navigate to the TMT directory: cd <Incorta_Home>/cmc/tmt.
  2. Restore tenant from backup.

Linux/Mac

./tmt.sh -clnm <CLUSTER_NAME> -i .bkp/tenant_name.bkp.zip

Windows

tmt.bat -clnm <CLUSTER_NAME>  -i .bkp\tenant_name.bkp.zip