TeamConnect Business Intelligence (Linux) Integration Guide

Linux L2025.4 SP1

• Generic version link RKE: https://data.sisense.com/linux/sisense_linux_L2025.4.0.331.tar.gz
• OfflineRKE: https://data.sisense.com/linux/sisense_installer-L2025.4.0.331-DockerHub-offline-installer.tar.gz

Single-Node Deployment on RKE

To initialize Sisense in a Linux environment:

1. Using the sudo user you created, in the Linux CLI, enter the following command to download the Sisense tar.gz file.

wget [sisense-linux-deployment-link]

2. Extract the tar.gz file into the {sisense-version} folder:

tar zxf [sisense-linux-deployment-package-name]

3. Navigate to the {sisense-version} directory where you extracted the tar.gz file.

cd sisense-[sisense-version]

4. Edit the single_config.yaml file.

vim single_config.yaml

5. In the single_config.yaml file, you must enter values for the following parameters:

Example of Single_config.yaml

### INSTALLATION PARAMETERS

## Single Node - define the following:
#1. Internal IP of the machine.
#2. External IP of the machine.
k8s_nodes:
  - { node: node1, internal_ip: 10.7.13.74, external_ip: 10.7.13.74 }

## Deployment size is used to determine the maximum pod limits for application
## Possible values: small/large
deployment_size: "small"

## Sisense will use Kubernetes ClusterRole in order to manage the tenant
cluster_visibility: true

## In case of offline installation (private or public docker registry is required) - true/false
## If your docker registry is private Sisense will generate a pull secret for you
offline_installer: false

## Relevant for offline installer only, to save space on current server
## Delete local images and the images .tar files after upload to registry - true/false
delete_local_images: false

docker_registry: "quay.io/sisense_release"
docker_username: ""
docker_password: ""

## Whether installer should pull RKE and Sisense images from your own private registry
private_docker_registry: false

## If below is true and k8s secret for pull Docker images (${pull_secrets_name}) already exists, then it'll overwrite it
overwrite_docker_secret: false

## In case of running installation from Bastion/Remote machine define to yes/true.
remote_installation: false

## Update current installation. - true/false
update: false

## show maintanace page during upgrade process
notify_on_upgrade: true

## Update current Kubernetes version - true/false
update_k8s_version: false

## Recover Kubernetes componentes - true/false
# This will restore from the last existing ETCD snapshot (up to 12 hours back)
# (ETCD snapshots location: /opt/rke/etcd-snapshots)
recover_kubernetes: false

## Container network interface  - calico/flannel
cni_plugin: calico

## Enable delta approach for shared dashboards/widgets
enable_widget_deltas: false

## Application DNS Name.
#1. When empty, first node external_ip will be configured
#2. When is_ssl is true, configure the CN name
#3. Add http:// or https:// as a prefix when using external Load Balancer for Common name
application_dns_name: ""

## Linux user of the servers (UID 1000)
linux_user: "tcbi"

## SSH Key Path or Password is required, when ssh_key is empty, password will be prompted
ssh_key: "/home/tcbi/.ssh/id_rsa"

## To define user other than UID 1000, configure the following parameters
run_as_user: 1000
run_as_group: 1000
fs_group: 1000

## Name of Namespace
namespace_name: sisense

## Gateway port of api-gateway service - endpoint of Sisense in Non-Secured mode.
gateway_port: 30845

## System time zone.
## Format for example: UTC | US/Central | US/Pacific | US/Eastern | Asia/Jerusalem | Asia/Tokyo | Etc/GMT+6
timezone: "UTC"

### SSL SETUP
## Activate Secured Sisense in HTTPS, define key and cert certificates. - true/false
is_ssl: false
ssl_key_path: ""
ssl_cer_path: ""

### PROXY SETTINGS
# Set these proxy values in order to update package manager and docker daemon to use proxies
# http_proxy:
# https_proxy:
# no_proxy:

## Enable Horizontal Pod Autoscaler (HPA) with CPU-based scaling.
## Note: On non-RKE clusters, ensure metrics-server is installed.
hpa:
  enabled: false

### MONITORING
## Grafana and Prometheus - true/false
internal_monitoring: true

## Fluentd With Logz.io Dashboards - true/false
external_monitoring: true

## Enable image signature validation - true/false
## When enabled, Kyverno will validate the signatures of all pods images in the 'sisense' namespace
## and in the 'monitoring' namespace (if enabled)
signature_validation: false

### UNINSTALL SISENSE
## In cluster installed by Sisense - Uninstall whole K8S cluster with Sisense services - true/false
## In cluster installed by customer - Uninstall Cluster services such as: kube-prometheus-stack, nfs
uninstall_cluster: false

## Uninstall Sisense, Removing only Sisense services and remaining K8S Cluster alive, true/false
uninstall_sisense: false

## Removing all Sisense data - true/false
remove_user_data: false

6. Run the configuration script. Your configuration settings are displayed with a message to confirm that you want to deploy Sisense with these settings.

./sisense.sh single_config.yaml

7. Enter Yes to confirm that you want to deploy Sisense, or enter No to abort the deployment. If there are any issues when the deployment script finishes, view the installation logs as follows:

[installation-dir]/sisense-installer.log

8. After the installation completes, a list of endpoints for accessing and managing Sisense will be displayed.

9. You can also retrieve the Sisense application URL using:

kubectl cluster-info

10. Open this URL in your browser to access Sisense. To verify that all services are running correctly, append /app/test to the URL along with the port number. For example:

0.0.0.0:PORT/app/test

11. To connect to your Kubernetes dashboard, enter the following URL in your browser:

https://{IP}:6443/api/v1/namespaces/kube-system/services/https:kubernetes-dashboard:/proxy

12. Once the installation is complete, some Sisense pods will remain in the Init state until the license activation.

13. To activate the license, navigate to the Sisense web application URL (without extra paths such as /app/account/login) in your browser and enter your license credentials.

How does it work?

The dwh.db.product property in the teamconnect.properties file controls the visibility of the Legacy Report link. Specify the type of database used for the data warehouse as the value of this property.

Enable the Legacy Report link

1. Open the teamconnect.properties file for the client environment.
2. Set the dwh.db.product property to the appropriate value i.e the type of database used for the data warehouse.
3. Save the file.
4. Apply the configuration change according to your environment's standard deployment process (for example, restart or redeploy the application).

Disable the Legacy Report link

1. Open the teamconnect.properties file for the client environment.
2. Clear the value of the dwh.db.product property.
3. Save the file.
4. Apply the configuration change according to your environment's standard deployment process.

How to Install the Plugins?

To install the Sisense plugins in a Linux environment:

1. Using a sudo-enabled user, in the Linux CLI, verify that wget is installed by entering the following command:

[tcbi@node1 ~]$ wget
-bash: wget: command not found

2. If the command returns -bash: wget: command not found, install wget.

sudo dnf install wget

3. Make sure the plugin package is available on the server and includes install.sh. From the directory that contains install.sh, run below command:

sh install.sh

4. When prompted, enter the required parameters:

5. After you provide all parameters, the installer completes the plugin installation.

Fix plugin folder permissions

After installation, verify the plugin folders are owned by the same user used during the Sisense installation.

1. Go to the plugins directory:

cd /opt/sisense/storage/plugins

2. Check folder ownership and permissions:

ls -la

3. If any installed plugin folder is owned by a different user (for example, root), change ownership to the user used during the Sisense installation (example below uses tcbi):

tcbi@node1:/opt/sisense/storage/plugins$ sudo chown -R tcbi:tcbi TeamConnect
tcbi@node1:/opt/sisense/storage/plugins$ sudo chown -R tcbi:tcbi manageColors
tcbi@node1:/opt/sisense/storage/plugins$ sudo chown -R tcbi:tcbi metadata

4. To ensure new files created under these folders inherit the correct group, set the setgid bit:

tcbi@node1:/opt/sisense/storage/plugins$ sudo chmod g+s TeamConnect
tcbi@node1:/opt/sisense/storage/plugins$ sudo chmod g+s manageColors
tcbi@node1:/opt/sisense/storage/plugins$ sudo chmod g+s metadata

External plugins

For external plugins usually the addon comes with its own package that is the case of:

Expand Pivot on PDF

External plugins typically include their own installation package and instructions. The Expand Pivot on PDF add-on is delivered as a separate package Sisense.ExpandPivotOnDashboardPDF.1.1.14.zip

Extract the add-on package and follow the installation instructions included with the package. If the package includes the l-addon-script.sh installer script, use the following commands.

Enable FileManager option

To enable the File Management option in Sisense:

1. In the Sisense application, go to Admin > System Management > Configuration.
2. On the Configuration page, press the Sisense logo five times to open the advanced configuration options.
3. Go to Base Configuration > FileManagement, and then set enable to Enabled.

4. After you enable FileManagement, go to Admin > App Configuration > FileManagement > Plugins.
5. Inside the folder you can upload the folder of the add-on from a previous functional Working Sisense Server.
6. For this case you upload the folder expandPivotOnDashboardPDF — this folder is different from the installation package.

Email configuration

To configure email settings in Sisense:

In the Sisense application, go to Admin > Server & Hardware > Email Configuration.

Update the required email settings for your environment, and then save your changes.

Display name deactivation

To deactivate the display name feature in Sisense:

1. In the Sisense application, go to Admin > System Management > Configuration.

2. On the Configuration page, press the Sisense logo five times to open the advanced configuration options.

3. In Base configuration, search for displayname.

4. Set displayname.enabled to Disabled (or False), and then save your changes.

SSO configuration

To configure Single Sign-On (SSO) in Sisense:

1. In the Sisense application, go to Admin > Security & Access > Single Sign On.
2. Enable Single Sign-On Configuration.
3. In the Remote Login URL, enter your current Sisense site URL.
4. Save your changes.

Team Connect Embedding Sisense page Support

Support Cross Site Cookies for Embedding:

To support embedding Sisense pages for TeamConnect:

1. In the Sisense application, go to Admin > Security & Access > Security Settings.
2. Set Support Cross Site Cookies for Embedding to None, and then save your changes.

Force security cookies & adding proxy URL:

1. To force secure cookies and configure a proxy URL, go to Admin > Server & Hardware > System Management, and then select Configuration.

2. On the Configuration page, press the Sisense logo five times to open the advanced configuration options.
3. In Deployment Service, enable security.ForceSecureCookies, and then save your changes.

4. To set the proxy URL, go to Base configuration > Web Server.
5. Set the proxy URL to your environment's proxy URL, and then save your changes.

4. After you save, Sisense signs you out. Sign in again to continue.

Sisense Linux Configuration Related to features

PDF Exporting

To configure PDF exporting for scheduled reports:

1. In the Sisense application, open the schedule for the report. Set the delivery option to send the report as a PDF attachment.
2. Enable the image scaling setting (PDF attachment scaling). When this setting is enabled, Sisense scales the exported image to fit within the email.

Pivot Table Limits

To configure pivot table limits in Sisense:

1. In the Sisense application, go to Admin > Configuration.
2. Search for Pivot Table. Update the following settings as needed:
   • Maximum number of columns displayed in a pivot table
   • Maximum number of rows displayed in a pivot table

3. Save your changes.

Kubernetes Deployment configuration

In order to avoid Java.Lang.OutOfMemory when you query your dashboards it is recommended to increase the resource limits for the query deployment. To do that, in the Sisense Linux server you execute the following command:

kubectl -n sisense edit deployments.apps query

This will open the editor and you can look for the resources > limits section and change to the following values:

limits:
   cpu: "4.5"
   Memory: 6Gi
requests:
   cpu: 300m
   memory: 2Gi