Skip to main content
Mitratech Success Center

TeamConnect Business Intelligence Integration Guide (6.2.2)

 

This guide details the installation and integration instructions for TeamConnect Business Intelligence for version 6.2.2.

Introduction

Note: If you are reading this document as a PDF, you can click this link to view the most recent version online.

TeamConnect Business Intelligence provides colorful visual reports embedded within TeamConnect. Interactive dashboards provide multiple visualizations of similar data in one screen for easy user consumption and analysis, and users can drill directly into dashboards to report on specific data. Designers can build ad-hoc reports and dashboards that can include cross-object data and reportable custom fields and objects in the TeamConnect system.

Before you begin:

  • Review system and software requirements in Reporting Requirements for TeamConnect Business Intelligence.
  • Ensure your TeamConnect instance has TeamConnect (TCE) 6.2.2 installed.
  • Note that any email in TeamConnect must be blank or follow the standardized w3 format
  • Make sure you have an active account able to install Sisense; this account is provided by Mitratech.  The license should have long index support and your account should have two unique admins - one web UI admin and one TC Integration admin.
  • Mitratech recommends a single node deployment. If a multi-node, high availability setup is needed, contact Mitratech.

Preparing the TeamConnect 6 Instance

Important: if using Data Warehouse, make sure Data Warehouse is installed before continuing with TeamConnect Business Intelligence integration. TeamConnect version should be 6.2.2.

Installing Sisense

This step will install the Sisense Server Console, Sisense Web Application, ElastiCube Manager, and ElastiCube Server. To install Sisense, you must have Administrative privileges on the machine and the ability to install on the C:\ drive. Make sure you have an active account able to install Sisense; this account is provided by Mitratech.

To install Sisense on a single Windows Server:

The instructions below detail how to install Sisense on your Windows server. Follow these steps before completing the Sisense plugin installation.

  1. On the Welcome to Sisense screen, click Activate.
  2. On the Sisense Activation screen, sign in with the account given to you by Mitratech. If you are copy and pasting your credentials into the fields, make sure you are not pasting an extra space at the end.
  3. Click Install.
  4. Click Custom Installation.
  5. On the Custom Installation screen, if you need to use a port other than 8081, make a note of the port number for configuring the firewall.
  6. Change the Web Server Type to Microsoft IIS and click Continue.  Do not use Microsoft IIS Express.
  7. If you expect to have more than 1 million records in the source database, select Long Index Edition.
  8. After Sisense is installed, create a new firewall rule firewall named Sisense Web and open the TCP 8081 and 443 ports (the port mentioned in the previous steps) for both inbound and outbound communication.
  9. On the Sisense server, create a folder to contain the ElastiCubes.

To install the Sisense Plugin:

  1. Open the Sisense installer .EXE file provided by Mitratech Holding, Inc.
  2. Click on the Installer icon with the Application file type (do not click on the Installer folder).
  3. The TeamConnect Business Intelligence Setup pop-up will appear. Enter your administrator credentials and the site URL, then click Next.
    621_Install1.png
     
  4. The Choose file location screen will appear. Click Install if you are satisfied with the location.
    621_Install_FileLocation.png
     
  5. TeamConnect Business Intelligence will begin installing in the next screen. Once it is finished loading, you will be taken through the Setup screens in order to finish the installation. Click Finish when this screen appears.
    621_Install_Finish.png
     
  6. Once the plugin is successfully installed, an Uninstall option will appear in the same folder as the installation icon.
  7. To verify that the plugin was installed navigate through the following folder path: Program files > Sisense > PrismWeb > plugins > TeamConnect > and verify that the plugin.json file is in the TeamConnect folder.

 

To select a partition:

  1. Choose a partition with enough disk space and create a folder (for example, E:\ElastiCubeData).
  2. Open the Sisense Server Console as an administrator.
    clipboard_e5f70a416a94482498e253fabbb6d1eb0.png
  3.  Click the clipboard_e4028e855e67b8d60b715b11db4fc6d60.pngicon to edit server preferences.
  4. On the Edit Server Preferences dialog box, click the Browse button for the Default Server data folder and select the partition and folder created in Step 1.
  5. Stop and start the Sisense Server.

Creating an ElastiCube for the TeamConnect Database

Creation of the ElastiCube can take hours to create the schema and move the data. For example, creating an ElastiCube for a nearly empty database can take 2 hours, but a fully populated database could potentially take more than 20 hours.

Before you begin:

  • Make sure the user has DBA access on the server machine from which they will be running syncs. To check if the user is already a DBA:
    •  type lusrmgr in the Microsoft Windows search field and open lusrmgr.
    • In the lusrmgr window, click Groups in the navigation pane and then ora_dba to see the list of oracle DBAs on the server.
    • If the user is not in the ora_dba group, click the Add button and add the user.
  • Grant the database schema access to create a materialized view by logging into sqlplus as sysdba and typing the command:  
    GRANT CREATE MATERIALIZED VIEW TO <DBUsername>;

    where <DBUsername> is the database username for your database. For example:
    GRANT CREATE MATERIALIZED VIEW TO TCTESTCSM;
  • For SQL Server, the login that you provide for TCBI's use must have the following roles:
    • public role
    • db_owner role

To create the Elasticube:

  1. On the Medusa Release folder, in the TC_BusinessIntelligence  directory follow this path (TC_BusinessIntelligence >  TCBI_Plugin_Installer.zip > installer >TCBI_Install_Package-77.zip) and open the autoCube.properties file with a text editor. Define the values for the following properties. Note that these values are case sensitive.
    • database.hostname – the fully qualified domain name of the server that hosts the database
    • database.portnumber – the database port number
    • database.dbname – the database sid or database service name
    • database.dbtype – the database type (for example, Oracle or SQL Server)
    • database.driverClassName – the database driver class name (for example: oracle.jdbc.driver.OracleDriver or sqlserver.jdbc.SQLServerDriver)
    • database.connectionString – the database connection string for Sisense. This property is only needed if you are using load balancing or clustering.
    • database.username – the database username
    • database.userpassword – the database encrypted password (To encrypt the password, use the same encrypt.jar that encrypts the password in the teamconnect.properties file.)
    • sisense.cubename  – the name of the ElastiCube, not including the .ecube extension
    • sisense.serverName – the fully qualified domain name of the server that hosts Sisense
    • sisense.buildRetryLimit – the allowed number of attempts to automatically install or sync the cube (due to an issue in Sisense, the first attempt often fails)
    • sisense.pluginLocation –  the location of the Sisense plugin folder, excluding the "metadata\translations" subfolder and in the path, use \\ in stead of \, for example, C:\\Program Files\\Sisense\\PrismWeb\\plugins. This parameter allows the autoCube to copy the .json file to the translations folder automatically. If the folder location is changed, this property needs to be updated. If this property is left blank, the autoCube will not copy the json file.
    • enable.fail.email.notification -  YES if you want email notifications for failed builds, NO if you do not
    • enable.success.email.notification - YES if you want email notification for successful builds,  NO if you do not
    • email.recipient - the email of the recipient; If you want to send notifications to multiple recipients, separate the values with a comma
    • email.sender - a valid email address for the sender
    • email.server - the IP address of the email server
  2. Open a command prompt as an administrator.
  3. Change the directory to the TeamConnect_BI folder that you extracted in step 2. This directory contains the TCBI_SchemaSync.bat file.
  4. Execute TCBI_SchemaSync.bat. The ElastiCube is created, integrated into Sisense, and is now available for use.
  5. After cube is created, open the log file in the /TeamConnect_BI/autoCube_logs/ directory and check for any error keywords such as error and fail.
 

Sharing the ElastiCube with the Admin Account

Before the TeamConnect admin configures the integration, the ElastiCube needs to be shared with the Sisense administrator account user manually. You can share ElastiCubes through the Admin page of the Sisense Web Application.

To share an ElastiCube:

  1. In the Sisense Web Application, select Admin > Data Sources and then the menu button for the relevant ElastiCube.
  2. Click Share.
  3. Type and select the Sisense administrator account given to you by Mitratech. The information for this account is listed in the center of the window.
  4. Click Save.

Note: The following items pertain to configuring a high-availability configuration only.

  • For a high-availability environment, add the ElastiCube to an ElastiCube set, share both the individual ElastiCubes and the ElastiCube set with the appropriate Sisense administrator account, and then use the name of the ElastiCube set in the report integration.
  • If an ElastiCube is not secured by sharing it with the Sisense administrator account, the ElastiCube will always appear in the selection list when the dataset for a report is selected.

Configuring Single Sign-On

In order to embed dashboards, Single sign-on (SSO) must be configured and working. Single sign-on (SSO) is configured on the Admin tab in Sisense.

  1. Log into Sisense Web Application as an administrator.
  2. Click the Admin tab.
  3. In the navigation pane, click Single Sign-on.
  4. Enable SSO using the Single Sign-on Configuration toggle.
  5. Select the method.
  6. In the Remote Login URL, type the URL TeamConnect instance with the suffix of webservice/sso, typically in the form:

    http://<ServeNamer>:<Port>/<Context>/webservice/sso 

    where

    <ServerName> is the name of the TeamConnect server
    <Port> is the number of the port used to connect to the server
    <Context> is the context path for TeamConnect

    For a multi-tenant environment you can set the remote login URL to any URL or page as this user should never actually be used.

  7. Click Save.

Configuring Report Integration in TeamConnect

Integrating TeamConnect with an external report system requires the following steps:

Turning On Matter Level Security

Out of the box, Matter level security defaults to OFF upon installation of 6.2.2. This means that anyone viewing a Dashboard will be able to see any Matter listed regardless of their TeamConnect security limitations. It is turned OFF because removing the security results in up to a 2x performance improvement. Best practice is to turn off matter security for analytical reports because it could cause perceived inaccuracies if security restrictions limit a user from seeing all the data and therefore, the complete picture. It is possible for a Report Designer to manage some security concerns when building reports. If your organization requires Matter level security, execute the following script to turn it back ON. This change can only be made by someone with SQL access to the TeamConnect database.

If Matter Security is turned ON, it will stay ON after future upgrades. There is no need to manually reset it every time.

Please Note: enabling matter security on the ecube may significantly impact performance of the schema and data syncs.  It will also impact the aggregated values displayed in the dashboards.  For example, a chart that sums financial information will be limited to summing values for only matters that the user can access and may result in an inaccurate financial picture.  Mitratech recommends leaving security disabled and instead using dashboard design to mitigate security concerns.  If enabling security is desired, please consult with your Services or Support representative to discuss these impacts.

The following script should be run against the database where 'YES' is changed to 'NO'. This will cause the necessary security table to be built which will restrict Matters to be displayed only if the user has rights. Once the script is run, restart the appServer. 

UPDATE Y_SYSTEM_SETTING SET SETTING_VALUE = 'YES' WHERE SETTING_KEY = 'disableTcbiSecurity';

After the script is executed, TCBI schemaSync has to be performed. Once the schemaSync completed, user/group sync for the Report Integration has to be run from TeamConnect. Instructions on how to trigger a schemaSync and a user/group sync follow. 

Preparing the TeamConnect Instance

  1. After TeamConnect and Data Warehouse (if applicable) are installed and running correctly, open the teamconnect.properties file in the TeamConnect .WAR file and add the location of the Sisense server to the sisense.server.location property, including the http prefix and the port number. Redeploy the .WAR file.
  2. In TeamConnect, click the Documents tab and select Top Level from the left pane.
  3. Click the System folder and then click the Report Integration folder.
  4. Click New Folder and the name specifying the name of the integration you are adding. For the Sisense integration, the folder must be named Sisense and is case sensitive.
  5. Drop the appropriate .class files and .properties files into this folder. For example, for a Sisense integration:
    • Sisense.properties
    • SisenseReportAdapter.class
    • SisenseReportPortlet.class
      clipboard_e10687997a73396850da90fc04a0205da.png

Assigning Reporting Privileges to Users in TeamConnect

A user must be assigned rights to the Report Integration tool in order to use reporting.  

To assign Report Integration rights:

  1. In TeamConnect, click the Admin tab and select a user.
  2. Click Tool Rights in the navigation pane and click the Edit button.
  3. Select Report Integration.
    clipboard_edb42b8d75e6af5c1ce1eac13f28eb326.png
  4. Click Save and Close.

Designer and Viewer rights are assigned to users through Group rights.  

To assign Designer and Viewer rights to a group:

  1. Search for a group and open it.
  2. In left navigation pane, click System Rights.
  3. From the View drop-down list, select Report.
  4. Click the Edit button.
    • To assign a Viewer rights, select View Report records (Legacy and New).
    • To assign Designer rights, select Create/Edit/Delete Reports (New).
  5. Click a save option.

Note: if you are updating the reporting rights of a new or existing user and you already have a TeamConnect Business Intelligence integration with Sisense configured, sync the users and groups with the integration. However, if you are in the process of configuring the integration, you do not need to sync at this point. 

Adding an Integration to TeamConnect

In TeamConnect, click Tools and select Report Integration.

  1. In the Report Integrations table, click the Edit icon in the Actions column for the Sisense integration.
    clipboard_e0e6bf4f5e9ed5e084a826884a8adeaf5.png
  2. The values displayed on the page correspond to the values in the the Sisense.properties file. Type the password, SharedSecret, Sisense admin username, ClientID, Environment, ElastiCube name in the appropriate fields.
    clipboard_eb147e94f7aae624ab04fce3564abefe0.png
     
  3. Note that you must re-type any secured fields such as Password or SharedSecret when you are updating an integration.
  4. Click Add Report Integration.
    Note: Upon initial setup of the report integration, the Client ID and Environment are configured and a new Sisense group is created with all the users in the TeamConnect instance. This group (<Environment>_<ClientID>) allows ElastiCube access for TeamConnect users. This information is used by TeamConnect to create a unique identifier for users on the report server and must not be changed after the initial saving of the settings in the Report Integration Tool.
  5. Click the Sync User and Groups button.

Troubleshooting the Report Integration Tool

Adding the Sisense Admin to the Tenant Group

To enable report sharing with the Sisense admin, add the admin to the Sisense group that contains all the TeamConnect users.

  1. Log into Sisense Web Application as an administrator.
  2. Click the Admin tab.
  3. In the navigation pane, click Groups.
  4. Find the group with the <Environment>_<ClientID> that was created  when the report integration was added.
  5. Click the Edit (pencil) icon.
  6. Add the the Sisense administrator account given to you by Mitratech.
  7. Click Save.

Configuring Syncs

Synchronizing Data between TeamConnect and Sisense

During the initial configuration of the integration between TeamConnect and Sisense, you do not need to manually sync the data but you do need to schedule the task for automatic sync. Schedule schema syncs on a regular basis for maintenance of the system, even if no structural changes are made (changing/adding objects & fields), to ensure deletions and updates are handled properly.

A data sync loads database records and permissions that have been added, modified, or deleted since the last sync so that the most recent information is included in the reports.The data sync can take hours to complete, but reporting functionality is still available during the data sync.

Important: Changing a user's reporting rights and deleting users must be done in TeamConnect so that they are synced in Sisense correctly. Do not delete or modify rights from Sisense; changes made in Sisense will not be reflected in TeamConnect.

To schedule automatic sync at regular intervals:

  1. Schedule the TCBI_DataSync.bat task using a scheduler such as Microsoft Windows Task Scheduler.
  2. Because the data sync and the schema sync tasks cannot run at the same time, configure the scheduler to not run the task if the other job is running.

To display the most relevant and recent information or if the connection between the database and the ElastiCube has been lost, you can manually sync the data.

To manually sync the data for reporting:

  1. Make sure a data or schema sync is not already running.
  2. On the Sisense server, open a command prompt as an administrator.
  3. Change the directory to the AutoCube folder that you extracted when creating the ElastiCube. This directory contains the TCBI_DataSync.bat file.
  4. Execute TCBI_DataSync.bat. The records in the database are loaded into the ElastiCube and are now available for reporting.
  5. After cube is created, open the log file in the /TeamConnect_BI/autoCube_logs/ directory and check for any error keywords such as error and fail.

You can now run a report to display the updated records.

Synchronizing Semantic Schema between TeamConnect and Sisense

Note: During the initial configuration of the integration between TeamConnect and Sisense, you do not need to manually sync the schema but you do need to schedule the task for automatic sync.

A schema sync loads the database schema updates (including new, modified, or deleted custom fields and objects) from the TeamConnect database into the ElastiCube. The schema can take hours to complete.

Before scheduling or running a sync, take note of the following:

  • Schedule schema syncs during non-business hours to prevent the following issues:
    • Changes made to the database during the schema sync can cause the sync to fail and render the ElastiCube unusable.
    • Reporting functionality is not available during the schema sync and users will receive an error. 
  • Never have two or more Elasticubes syncing against the same database at the same time.

Scheduling a Schema Sync

To schedule automatic schema sync at regular intervals:

  1. Schedule the TCBI_SchemaSync.bat task using a scheduler such as Microsoft Windows Task Scheduler.
  2. Because the data sync and the schema sync tasks cannot run at the same time, configure the scheduler to not run the task if the other job is running.

Including or Removing a Custom Object

Notes:

  • Starting in TeamConnect Business Intelligence 6.1, you can use the Setup tool to include or remove custom objects. If you are using 6.0, refer to the instructions in this link.
  • Account Budget and Spend, Matter Cost Center, and Invoice Cost Center reportable objects are based on the Financial Module. Clients that are on Legal Module but without Financial Module won't be able to use these three objects. If similar objects are needed, contact Professional Services for assistance on making these objects reportable.
  • Matter Cost Center, Invoice Cost Center, Invoice Vendors, and Line Item Timekeepers have been customized using views. Therefore, these fields cannot be removed from reporting because they are built-in to the integration. If the Matter object is reportable, the Matter Cost Center automatically will be reportable. You can only remove the Matter Cost Center object from being reportable. Removing this field from reporting allows you to report on Matter Cost Center without its custom relation to Matter. If the Matter Cost Center, Invoice Cost Center, Invoice Vendors, or Line Item Timekeepers need to be removed from being reportable when the Matter object is reportable, contact Mitratech Support for instructions on how to disable these fields from being reportable.

Including or Removing Objects and Fields from Reporting

Administrators can include or remove entire custom and system objects from TeamConnect Business Intelligence reporting so that reports display the most relevant information and data syncs are faster.

  • If an object is reportable, all fields associated to the object are reportable, except fields explicitly designated as removed from reporting.
  • If a parent object is removed from reporting, then all of its child objects or fields are removed from reporting, regardless of the reporting designation for the child or field. The eCube will not create fields that do not already eixst, so if you want to report on a specific child object, the parent object must be included in reporting.
  • Business Intelligence does not differentiate between child and embedded objects. Thus, all child and embedded objects will be added to the ElasticCube and be reportable.

Custom objects are removed from reporting by default except the objects in the following table. Admins can change this setting in the Setup tool. By default, the following objects are reportable:

Code Type Object
ACCT System Account
CONT System Contact
INVC System Invoice
LNI$ System Line Item
ACPT  OOTB Custom Advice and Counsel Involved Party (Legal)
ADCO  OOTB Custom  Advice and Counsel (Legal)
ALLE  OOTB Custom  Allegation (Legal)
ASSE  OOTB Custom  Liability Asset (Legal)
AWAR  OOTB Custom  Award (Legal)
COAC  OOTB Custom  Corrective Action (Legal)
COCE  OOTB Custom  Dispute Cost Center (Legal)
DAMA  OOTB Custom  Damage (Legal)
DISP  OOTB Custom  Matter (Legal)
INPA  OOTB Custom  Matter Involved Party (Legal)
NEGO  OOTB Custom  Negotiation (Legal)
PART  OOTB Custom  Coverage Involved Party (Legal)
PROV  OOTB Custom  Matter Provision (Legal)
RADC  OOTB Custom  Related Advice and Counsel Matter (Legal)
RTAC  OOTB Custom  Related Advice Matter (Legal)
SANC  OOTB Custom  Sanction (Legal)
TCOC  OOTB Custom  Transaction Cost Center (Legal)
TENA  OOTB Custom  Lessee (Legal)
TERM  OOTB Custom  Matter Term (Legal)
TRAN  OOTB Custom Coverage (Legal)
VIOL  OOTB Custom  Violation (Legal)
MTR$  OOTB Custom  Matter (Essentials)
INP$  OOTB Custom  Matter Involved Party (Essentials)

(Objects that are provided with TeamConnect and its modules are considered “out-of-the-box” (OOTB) custom objects.)

Note:

  • On average, adding an additional custom object to be reportable will add ~3 minutes to the schema sync and ~1 minute for each category that the custom object has. The time it takes to load the data into the ecube depends on the size of the table in the database.
  • If you have removed an object from reporting and that object is used in a report widget, the widget will return an error stating that the field no longer exists. Remove the non-reportable field manually by editing the widget.
  • If you are upgrading TeamConnect, before any modules are installed, the admin needs to manually make the module’s “out-of-the-box” (OOTB) custom objects reportable or run a specifically provided script in order for the items to be reportable.
  • When an object has the Remove from Reporting (Business Intelligence) checkbox selected, the object is only removed from TeamConnect Business Intelligence reports; Native reports with Data Warehouse are not changed. However, custom fields are now controlled separately. There are two options in Setup to include a field in Reporting - Include in Reporting (Data Warehouse/Native Reports) and Include in TCBI Reporting (ecube/Dashboards). A field must be set to YES for Include in Reporting to be able to also Include in TCBI Reporting

To add or remove an object from reporting:

  1. Click Setup and select Object Definitions from the Go to… menu.
  2. Select the object and click the General tab.
  3. To exclude the object from dashboard reporting, select the Remove from Reporting (Business Intelligence) checkbox. To include the object in reporting, clear the Remove from Reporting (Business Intelligence) checkbox.
  4. Click OK. After the next schema sync, the object will be included or removed from TeamConnect Business Intelligence reporting but will still be included in Native reports using Data Warehouse.

To add or remove a custom field from reporting:

  1. Click Setup and select Object Definitions from the Go to… menu.
  2. Select the object.
  3. On the Custom Fields tab, select the appropriate fields and click Edit Selected. You will now have the option to Include in Reporting (Data Warehouse/Native reports) and Include in TCBI Reporting (ecube/Dashboards). You must select YES for Include in Reporting to also Include in TCBI Reporting but a field included in Reporting does not have to be included in TCBI Reporting. Note: Best practice is to minimize the fields included in TCBI Reporting to only what you need in order to optimize performance.
  4. Click OK. After the next schema sync, the field will be included or removed from both TeamConnect Business Intelligence reporting and Native reports using Data Warehouse.
  5. If you are adding new custom fields, please note that the Include in TCBI Reporting option will not show up unless you have selected YES for Include in Reporting.

Manually Running a Schema Sync

To display the most relevant and recent information or if the connection between the database and the ElastiCube has been lost, you can manually sync the schema. You can also schedule automatic schema sync on an ongoing basis. If a reportable field is deleted and then re-added, a schema sync is needed to prevent the data sync from failing.

Note: During the initial configuration of the integration between TeamConnect and Sisense, you do not need to manually sync the schema but you do need to schedule the task for automatic sync.

To manually run a schema sync for reporting:

  1. Make sure a data or schema sync is not already running.
  2. Make sure that no one will be modifying the TeamConnect database during the schema sync. Changes to the database during the sync can cause the build to fail and render the ElastiCube unusable.
  3. On the Sisense server, open a command prompt as an administrator.
  4. Change the directory to the AutoCube folder that you extracted when creating the ElastiCube. This directory contains the TCBI_SchemaSync.bat file.
  5. Execute TCBI_SchemaSync.bat.
  6. After cube is updated, open the log file in the /TeamConnect_BI/autoCube_logs/ directory and check for any error keywords such as error and fail.

You can now run a report to display the updated records.

Optimizing Performance

For optimal TeamConnect Business Intelligence performance and lower synchronization,  (and sync updates), we recommend:

  • Only include the objects and fields that users need in their reports. Each additional object will add around 3 minutes to the sync, on average small object. For more information, see Including and Removing Object and Fields from Reporting.
  • Limit the number of users with reporting rights to less than 100. This number includes both view only and designer users combined.
  • Google Chrome is the fastest browser. Mozilla Firefox and Microsoft Internet Explorer may be slower to load.
  • Limit the number of widgets per dashboard to 6.
  • Watch out for many-to-many relationships and queries.

Embedding Reports on Home Pages and Portal Panes

TeamConnect Admins and Solution Designers can embed reports into customizable home pages, allowing users to quickly view reports as soon as they log in, without opening the Reports tab. For more information, see Creating Home Pages and Portal Panes.

When embedding reports in portal panes:

Troubleshooting

View a list of Known Issues in our release notes for a list of known limitations related to TCBI and TeamConnect. If you cannot view the page please reach out to Support.

Connections

Why do I receive an error when trying add an ElastiCube to the report integration?
Confirm that the ElastiCube is shared with Sisense admin user.

Why is TeamConnect not connecting with Sisense?

  • Verify that the Sisense web server is running.
  • Verify the ElastiCube Manager is running.
  • Ping the machines from the TeamConnect server to make sure the server is available from the TeamConnect server.
  • Check the logs and make sure the shared secret, admin user, and password are correct.
  • If the logs show this error when configuring the report integration using the Report Integration Tool in TeamConnect:
    "Caused by: java.lang.LinkageError: loader constraint violation: when resolving method 'org.springframework.http.client.HttpComponentsClientHttpRequestFactory.<init>(Lorg/apache/http/client/HttpClient;)V' "
    Verify that you do not have a conflicting version of the HttpClient JAR in System\Libraries. If so, remove it and retry.

Why do I receive a message stating that it looks like I'm lost?
The system may be upgrading or installing licenses. Try again later.

What can I do if I'm having trouble accessing Sisense through TeamConnect?

The Sisense Web Admin can bypass SSO and directly access the Sisense machine using this URL template: http://localhost:8081/app/account#/login

The variables in this URL are the SSL, Port number and localhost. Make sure to replace these variables to reflect your Sisense instance.

Users

Why isn't a user appearing in Sisense?

Users must have an email address in TeamConnect in order to integrate with Sisense correctly. If a user with reporting rights in TeamConnect does not have an email address, the user will not have an account created in Sisense.  If a user does not have an email address, the integration will create a "dummy" email address for the user and log an error in the user/group sync. You should create a validly formatted primary email address for the contact record for the user and the "dummy" email address will be replaced with the new email address after a user/group sync occurs.

Why aren’t users created in a second ElastiCube when they were already created in one?
Each TeamConnect user with an automatically created Sisense account must have a unique email address per Sisense server. This means that an on-premise client with a single Sisense server cannot have a TEST ElastiCube  and a PROD ElastiCube with users with the same email. The second time an email account is used, the user will not be created automatically on the Sisense server.
The fix is to have separate Sisense servers for each TC instance in the environment (for example, one Sisense server for TEST and one for PROD.) (TC-16847)

Why are User/Group syncs failing?

Sisense validates email addresses using a standardized w3 format. Any email in TeamConnect must either be blank (in which case the integration assigns a properly formatted generated email address) or follow this format, or you will receive an error during User/Group sync.

ElastiCube Syncs and Builds

Why did Sisense fail when creating a new ElastiCube or rebuilding an existing one?

  • This issue may be caused by a possible caching issue in Sisense. Make sure that the ElastiCube was removed after the failed attempt, that the folder in which was created is deleted, and that it is not appearing on the Server Console Use the Sisense Server Console to stop and restart the Sisense server and try again. TC-18801, TC-19219
  • Note that the values in the autocube.properties file are case sensitive and an incorrect value can cause errors when a ElastiCube is built.
  • If you are manually building a cube, make sure you are running the command as an administrator. Verify that you have Admin privilege on your machine, otherwise you may still be running it as a non-privileged user.
  • If you are running low on RAM or receiving the error "Accumulative Changes Log Creation Failed Error Create Patch [The requested operation could not be completed due to a file system limitation ]", this may be due to the fact that Sisense saves temporary copies of the ElastiCube during the build on the C:\ drive in C:\ProgramData\Sisense\PrismServer\Patches.To move this location to another drive:
    • Using a text editor, open C:\ProgramData\Sisense\PrismServer\ElastiCubeConfiguration.xml.
    • On the second to last line, just before the </ElastiCubeConfiguration> closing tag add the the following text:
      <DefaultPatchesDirectory>D:\</DefaultPatchesDirectory>
      where D:\ is the new patches location.
    • Restart the ElastiCubeManagementService.
    • If the problem still occurs, navigate to the Sisense Server Console preferences and deselect Compress on build or defragment the affected drive.

Why are my syncs failing?

  • Make sure the server has enough disk space.
  • Make sure the server has enough available RAM.
  • Make sure that the sisense.includeObject property in autoCube.properties file in the TeamConnect_BI directory on the Sisense server does not include any objects that are not reportable (for example, CSM$ is not reportable).
  • Because the data sync and the schema sync tasks cannot run at the same time, configure the scheduler to not run the task if the other job is running.
  • Make sure no custom objects in TeamConnect have a Unique Code starting with numeric value.
  • Make sure a reportable field has not been deleted and then re-added. If this happens, perform a schema sync before performing a data sync.
  • If you are manually syncing a cube, make sure you are running the command as an administrator. Verify that you have Admin privilege on your machine, otherwise you may still be running it as a non-privileged user.

After I updated a report integration, why can’t I sync the data?
When updating the report integration in the Report Integration tool, re-type any hidden field such as Password or SharedSecret to make sure that the integration saves the field correctly.

Why am I receiving this error when attempting to sync the ElastiCube:

  • ERROR java.io.FileNotFoundException: D:\ElastiCube.xml (The system cannot find the file specified)
    • Use localhost or 127.0.0.1 (loopback address) as the Sisense host instead of the IP address of the server on which you are running the sync.
  • GetTableSchema failed: unknown result
    • Check that the database user name is specified in all uppercase if using an Oracle data source.
  • ORA-00600: internal error code, arguments: [kkogbro: no kkoaptyp], [0], [], [], [], [], [], [], [], [], [], []
    • Option 1: The best way to resolve this corruption is to restore a copy of the affected datafile from before the error and to recover the database so these changes are applied to the restored datafile and brought forward to the current time. This action is possible only if the archivelog feature for your database is enabled. (Enabling this feature ensures that all changes to the database are saved in archived redo logs.)
    • Option 2: Create a copy of the corrupted schema into a new schema using Oracle’s export/import feature.

How do I regenerate a Sisense catalog?

Sisense requires some free space on the C: drive, otherwise the catalog can become corrupted. To recover a catalog:

  1. Open the Start menu or Task Manager and search for Services.
  2. Stop the ElastiCubeManagementService service.
  3. Open C:\ProgramData\Sisense\PrismServer and rename the ElastiCubeCatalog to ElastiCubeCatalog1.
  4. Restart the ElastiCubeManagementService service. Starting the service may take longer than normal as Sisense creates a new catalog folder.

How do I clear the RabbitMQ queue?

The data cache of RabbitMQ can fill the drive. The lack of disk space can cause all cubes to detach from Sisense and all builds to fail. To clear the RabbitMQ queue:

  1. Open a command prompt as an administrator.
  2. Navigate to the folder C:\Program Files\Sisense\Infra\Rabbitmq\sbin.
  3. Type the following command: rabbitmq-plugins enable rabbitmq_management
  4. If you receive an error, restart the pulse/broker service and proceed to the next step.
  5. Navigate to "http://localhost:15672" (on the server) and log in with the Username: guest and Password: guest.
  6. Open the Queues tab and if you see 0 messages, the issue is not related.
  7. If you see many hanging massages, clear the massages by clicking Queue sisense.ecs.build.logs.persist.
  8. Click Purge and repeat until there are no more in the queue.

Reports

Why are the widgets showing a $0 value for budget allocated?
By design, the "Account Total Allocated" field pulls budget data from the "Fees" and "Expenses" level. If you budget on a different level, you will see these values return as $0 in your widgets even when you know there is a budget allocated. If you need to build reports on a different level budget; i.e. Vendor level or Matter level, contact Services to run the customized script that will pull "Account Total Allocated" from the correct location.

Why does nothing appear on the Reports tab?
If you are using SSL, make sure that both TeamConnect and Sisense are configured using SSL. 

Why is there a null record on my report?
An addition dummy/null record is created on the core system entities to support outer joins in Sisense. This record has blank values across the table except for system_modified_on. You can avoid this record on your reports by adding a filter on one of the entity fields:
1.    In the report, select the entity field in the filters (for example, Contact Name)
2.    On the list of values that appears, deselect N/A values to filter out the null values. 

Why isn't data appearing on my report?
If one of the ElastiCubes in an ElastiCube set is showing “Invalid Status” due to a failed schema sync, data will not appear in the reports that involve that ElastiCube set. Run a schema sync on the failed ElastiCube.

Duplicate reports on the same dashboard can also cause a report to fail. In rare instances, a "ghost widget" may appear on a dashboard, which is a duplicate but hidden widget. It can be removed by editing the .dash file of the dashboard or deleting it in the Application Database. 

Why are deleted records still appearing in reports? Why is outdated information shown on the report?

Schedule schema syncs on a regular basis for maintenance of the system, even if no structural changes are made (changing/adding objects & fields), to ensure deletions and updates are handled properly.

Why are newly created users unable to view reporting data even after schema sync?

TeamConnect Business Intelligence components must be on the same minor release. For an x.y.z release, the components must match the x.y version. For example, for a TeamConnect 6.1.2 release, the report adapter must be at 6.1.z and the BI code must also be at 6.1.z.

Why are dates in the reports off by one day as compared to the value you see in the TeamConnect Ui?

Sisense gets the data directly from the database, which is stored in GMT time. Convert any custom fields from timezone dependent into timezone independent (via script), then perform a schema sync to update the data.

Version Information

How do I find the version number of my TeamConnect Business Intelligence installation?

In the TeamConnect_BI directory where the autoCube.properties file is located, open the version.txt file

Updating an Integration

In rare instances, you may need to update the report integration. For example, the TeamConnect instance might need to be integrated with a different ElastiCube, or the ClientID/Environment  might need to be changed.

To update an integration:

  1. In the Sisense Web Application, delete all the existing users for the original TeamConnect environment. Otherwise, a user duplicate email issue will occur.
  2. In TeamConnect, click Tools and select Report Integration.
  3. In the Report Integrations table, click the Edit icon in the Actions column for the Sisense integration.
  4. Type your updates in the appropriate fields.
  5. Re-type any secured fields such as Password or SharedSecret. Even though the fields appear to have stored hidden values, the values must be re-entered manually.

Logging

How can I configure the reporting logs?
In TeamConnect, on the Admin tab, click Logging and then System. Here, you can change the logging level for Reports.

Common data and log file paths

    Prism Server logs: C:\ProgramData\SiSense\PrismServer\PrismServerLogs

    Sisense Web log: C:\ProgramData\Sisense\PrismWeb\Logs

    ElastCube build logs: C:\ProgramData\SiSense\PrismServer\ElastiCubeProcessLogs<YourElastCubeName>

    MongoDB: C:\ProgramData\Sisense\PrismWeb\DB

    iisnode (web server) logs: C:\Program Files\Sisense\PrismWeb\vnext\iisnode

Appendix

Creating Separate Admin Accounts on Sisense

Each TeamConnect instance requires its own Sisense administrative account.

In order for reports to appear on portal panes, the TeamConnect user has to share the report with their admin. Since a single Sisense Server can have shared tenancy, you can create a separate Sisense Admin for each TeamConnect instance so that the reports can be shared with the appropriate Admin.

To add a new admin account: 

  1. On the Admin tab in Sisense, click the + User button.
  2. Type the user's information in the appropriate fields.
  3. In the Role drop-down list, select Admin.
  4. To set the password, toggle the Define Password option to ON and enter a password. If you enter a password for the admin, the system does not notify the admin of the password; notify the admin directly.
  5. Click Save. The admin then receives an email from Sisense that redirects the user to activate their account.
  6. Add the Admin to the tenant group.

Removing Parts of a Reporting Integration

Uninstalling an ElastiCube

To uninstall an ElastiCube, run the TCBI_Uninstall.bat script from the original installation files. This script uninstalls the ElastiCube and removes all related objects from the TeamConnect database, but does not remove any object related to the TeamConnect instance.

The TCBI_Uninstall.bat file can be run as described in the above instructions. In version 6.2.1, the uninstall contains 2 additional files: TCBI_UninstallECube and TCBI_UninstallDBObjects

TCBI_UninstallECube can be used to delete the eCube but keep the database objects. One scenario the TCBI_UninstallECube is used is when the eCube has corrupted or missing tables or columns - the TCBI_UninstallECube and then TCBI_SchemaSync can be run to recreate the eCube from scratch.

TCBI_UninstallDBOjects can be used to drop the database objects but keep the eCube. One scenario the TCBI_UninstallDBObjects is used is when the database object is corrupted but the eCube is working well. Running TCBI_UninstallDBObjects will fix the database objects and then TCBI_SchemaSync to refresh and the rebuild the database object, and refresh the eCube. 

Removing the Plugins

To uninstall the Sisense plugins and email templates:

You must have administrative access/credentials to complete this process. 

  1. Open your Control Panel, navigate to Programs, and select Uninstall a Program.
  2. Find Mitratech + TeamConnect Business Intelligence, select it, then click Uninstall.
    621_UninstallProgramsScreen.png
     
  3. Follow the command prompts as they appear to successfully uninstall the plugin. First, ensure that the file is uninstalling from the correct location, then click Next.
    621_Uninstall_FilePath.png
     
  4. Enter your administrator credentials, then click Uninstall
    621_Uninstall_Creds.png
     
  5. Click Finish in the last uninstall prompt.
    621_Uninstall_Finish.png

A success message should appear after the program is successfully uninstalled. 

Removing Related Objects in the Database

You can remove objects related to the ElastiCube from the TeamConnect database without removing the ElastiCube. This script drops all all the tables, views, functions, mviews, and procedures which support the creation and maintenance of the ElastiCube. The script will not remove objects related to the TeamConnect instance.

To remove related objects in the TeamConnect database:

  1. Using your preferred database tool, make a backup of your TeamConnect database.
  2. Login to your query tool as an administrative user.
  3. In the TeamConnect_BI folder from the original installation files that were extracted during installation, open the 040_DropIfExist.sql file.
  4. Run the SQL script.

Removing a Sisense or Data Warehouse Integration

If both Sisense and Data Warehouse are installed and one of them is removed, run wh_install/schemasync on the remaining reporting integration server in order to recreate the indices.