Skip to content

Commit

Permalink
cs insight bi folders and wip files
Browse files Browse the repository at this point in the history
  • Loading branch information
kalsky committed Mar 6, 2024
1 parent 872baa3 commit 70b88b1
Show file tree
Hide file tree
Showing 46 changed files with 538 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/install-configure/cs-insight-bi/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "CloudShell Insight BI",
"position": 3
}
7 changes: 7 additions & 0 deletions docs/install-configure/cs-insight-bi/bi-terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# BI Terminology

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Creating and Customizing Dashboards",
"position": 6
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_position: 2
---

# Add a New Data Source Table

**To add a data source table:**

1. As Sisense administrator, run the Sisense web application.

![](/Images/BI/AdminLogin.png)

2. Click the **Data** tab.
3. Locate the CS\_BI\_Cube.

![](/Images/BI/ElastiCube.png)

4. Click **\+ Data** to add a new data source.
5.  Select the data type. For example, Microsoft Excel.
6.  Upload the data source.
7.  Select the uploaded file and click **Next**.
8.  Choose the contents you wish to include in Insight and click **Done**.

The data sources are added to ElastiCube and can be connected to other data sources via the Relationships button in the top right:

![](/Images/BI/DataSource.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Back Up and Restore ElastiCube and Dashboards

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 4
---

# Create Dashboards and Widgets

For details about how to create or edit dashboards, check the following pages:

Windows: [link](https://docs.sisense.com/win/SisenseWin/creating-dashboards.htm).

Linux: [link](https://docs.sisense.com/main/SisenseLinux/creating-dashboards.htm).
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
You can create and customize dashboards and widgets, back up and restore ElastiCube and dashboards, add new data source tables, and define inner join connections between tables.

:::warning
Removing or changing fields or relations in ElastiCube tables may corrupt the ElastiCube and cause failures in the dashboards.
:::

## Related Topics

- [Back Up and Restore ElastiCube and Dashboards](./backup-restore-elasticube-and-dashboards.md)
- [Add a New Data Source Table](./add-data-source-table.md)
- [Inner Join Connections](./inner-join-connections.md)
- [Create Dashboards and Widgets](./create-dashboards-and-widgets.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 3
---

# Inner Join Connections

Connections between tables define an inner join operation between the tables. This means that if table A is connected to table B and you query both tables from your dashboard, then only the records from table A that have a matching record in table B are presented.

Records that exist in table A and that do not have matching records in table B are ignored and vice versa.

For more details about joining tables, click the following links:

- [Creating and Removing a Relationship between Tables](http://www.sisense.com/documentation/v5/prism-elasticube-manager/search-for-tables-and-fields/create-and-remove-relationship-between-tables/)
- [Joining Multiple Sources 101: Inner and Outer Joins](http://www.sisense.com/blog/joining-multiple-sources-101-inner-outer-joins/)
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "CloudShell Insight BI ElastiCube Tables",
"position": 8
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# ElastiCube Data Stores

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# ElastiCube Tables

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# CloudShell Insight BI ElastiCube Tables

Insight ElastiCube's tables are provided with the CloudShell Insight BI package (see [Download the Installation Files](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/dwnld-th-instln-fls.htm)).

Information is collected from CloudShell databases and the flexible Sisense platform presents the data in meaningful and useful dashboards. The Insight ElastiCube consists of tables and their relationships, as depicted in the following diagram.

![](/Images/BI/CloudShell-Insight-BI-ElastiCube_572x330.png)

:::warning
Removing or changing fields or relationships in the ElastiCube may corrupt the ElastiCube and cause failures in the dashboards.
:::

## Related Topics

- [ElastiCube Data Stores](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/elsticub-dtastrs.htm)
- [ElastiCube Tables](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/eslticub-tbls.htm)
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Creating and Customizing Dashboards",
"position": 7
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_position: 2
---

# Configure CloudShell to Enable Sharing Insight Dashboards

*Before you perform this procedure, make sure SSO is enabled - see [Configure Sisense to Work with SSO](../insight-sso/configure-sso-in-sisense.md).*

This article explains how to share specific dashboards with other users. You can embed dashboards in your white labeled environments by concatenating parameters to the URL of your dashboard or widget. It is possible to embed an **Insight** widget on your team website using iframe HTML tags. For additional information and customization options, see [here](http://www.sisense.com/documentation/embedding-dashboards-widgets/).

**To enable Insight dashboards to be shared with unregistered users:**

1. In the Insight tab, click the dashboard you want to share.
2. In the dashboard's toolbar, click the **Share** button.

![](/Images/BI/Configure-CloudShell-to-Enable_2.png)

3. In the **Share** window, enter names, email addresses, groups or **Everyone**, as illustrated below.

![](/Images/BI/Configure-CloudShell-to-Enable_3.png)

4. Set the dashboard user permissions from the **Can View** menu.

![](/Images/BI/Dashboard-User-Permissions.png)

5.  Click **Save**.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Embedding Dashboards in External Websites

Sisense dashboards can be shared with unregistered users, as follows:

- By sharing a dashboard or widget with users who do not have a Sisense user account.

- Embedding a Sisense dashboard or widget in external web sites (for example, show productivity charts in team websites). 

:::note
The Sisense license limits the number of user profiles. The creation process might therefore result in an error if the maximum available user profiles is reached.
:::

## Related Topics

- [Share Sisense Dashboards with Unregistered Users](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/shrng-sis-dshbds.htm)
- [Configure CloudShell to Enable Sharing Insight Dashboards](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/cnfg-cs-to-enbl-sis-dshbds.htm)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---

# Share Sisense Dashboards with Unregistered Users

If you enable SSO, when a dashboard is requested directly from Sisense and not via the CloudShell Portal Insight tab, a default ‘Anonymous’ Sisense account is used.

![anon1.png](/Images/BI/Sharing-Sisense-Dashboards_356x244.png)
21 changes: 21 additions & 0 deletions docs/install-configure/cs-insight-bi/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# CloudShell Insight BI

CloudShell Insight Business Information (BI) online help describes the installation procedure for installing Sisense, describes the data collected from CloudShell, and provides basic guidelines for dashboard customization.

CloudShell Insight BI provides out-of-the-box dashboards with useful information such as inventory utilization and resource allocation. The information is collected from CloudShell databases and can be queried using Sisense, which is an advanced BI platform that is designed for extensive data analysis.

Sisense is a flexible platform that can present large amounts of data in meaningful and useful dashboards. You can use the default dashboard provided with CloudShell Insight BI package or build customized dashboards to reflect your business needs.

CloudShell Insight BI enables you to transform your raw data into meaningful business information by presenting it in dynamic, interactive, web-based dashboards that are customized to highlight the information. The flow of data from CloudShell databases to CloudShell Insight BI is depicted in the following diagram:

![](/Images/BI/CloudShell-Insight-BI-Overview.png)

For details about each of the CloudShell Insight BI components in this diagram, see [Sisense BI Components](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/sis-bi-cmpnts.htm).

For details about Sisense user roles, see this official Sisense docs [article](https://documentation.sisense.com/latest/getting-started/user-roles.htm).

See Sisense [Documentation](https://documentation.sisense.com/#gsc.tab=0) and [Tutorials](https://documentation.sisense.com/latest/tutorials.htm#gsc.tab=0) for more details.

:::note
CloudShell only supports Sisense over Windows.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Insight Dashboards",
"position": 9,
"link": {
"type": "generated-index"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---

# Manage Users and Permissions

For details how to add or remove users and groups, click these links: [Managing Dashboard Users](https://documentation.sisense.com/latest/administration/user-management/manage-dashboard-user.htm#gsc.tab=0) and [Managing User Groups.](https://documentation.sisense.com//latest/administration/user-management/manage-user-group.htm#gsc.tab=0)

For details how to integrate with Active Directory, click this link [Integrating Active Directory](https://documentation.sisense.com/latest/administration/user-management/integrate-active-directory.htm#gsc.tab=0).
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 2
---

# Using Insight Dashboards

CloudShell's Insight is based on Sisense, a powerful business intelligence, AI-driven tool.

Here are some useful links:

- [Sisense documentation](https://documentation.sisense.com/)
- [Sending Dashboards as Email Reports](https://documentation.sisense.com/latest/reporting/send-email-dash-report.htm#gsc.tab=0)
- [Sisense Pulse](https://documentation.sisense.com/8-6/sisense-pulse-and-alerting/sisense-pulse.htm#gsc.tab=0) allows you to organize important KPIs from your dashboards in a single location.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Single Sign On (SSO) to Insight",
"position": 5
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_position: 3
---

# Configure Sisense SSO in CloudShell

SSO integration is a two-step process. First, you configure Sisense SSO in CloudShell and then you set up the Sisense SSO.

**Prerequisites:**

- [Grant Data Security Permissions to ElastiCube Name](../install-insight/insight-configuration/grant-permissions)

**To set up Sisense SSO in CloudShell:**

1. Log into CloudShell Portal as administrator.
2. Click **Manage>Integrations>Sisense Settings**.
3. Do the following:

- For legacy dashboards, set **Integration Type** to **Legacy**.
- For new dashboards (dashboards provided for CloudShell 2021.2 and up), specify the following:

1. Set **Integration Type** = **New**
2. Specify the **BI Host Address** hostname or IP address in the format `https://x.x.x.x:443`.

Click **Test Connection** to verify connectivity to the BI host.

3. Sisense Admin credentials:
- Sisense administrator **User Name** and **Password**
- **Admin token**: Click **Generate** (Click **Revoke** to prevent users from accessing Insight)
4. Click **Submit**.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# Configure Sisense to Work with SSO

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 4
---

# Grant Insight Admin/Designer Privilege to CloudShell Users

To allow a CloudShell user to create and edit dashboards, this user must have a Designer or Admin role in Sisense.

**To create new SSO user profiles:**

1. Users must login to CloudShell Portal.
2. Click **Insight** to create the SSO profiles. (By default users have Viewer access to Sisense).
3. Login to the Sisense portal as administrator.
4. Specify user roles, such as Designer and Admin. For details, see this official Sisense doc: [https://documentation.sisense.com/latest/administration/user-management/manage-dashboard-user.htm](https://documentation.sisense.com/latest/administration/user-management/manage-dashboard-user.htm)
14 changes: 14 additions & 0 deletions docs/install-configure/cs-insight-bi/insight-sso/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Single Sign On (SSO) to Insight

Use Single Sign On to have direct access from CloudShell to Sisense without requiring an additional user name and password.

:::note
After SSO is enabled, Sisense opens with the same user profile that was used for CloudShell.
:::

## Related Topics

- [SSO to Insight Workflow](./sso-to-insight-workflow.md)
- [Configure Sisense to Work with SSO](./configure-sso-in-sisense.md)
- [Configure Sisense SSO in CloudShell (Manage>Integrations page)](./configure-sso-in-cs.md)
- [Grant Insight Admin/Designer Privilege to CloudShell Users](./grant-admin-privilege.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 1
---

# SSO to Insight Workflow

In Sisense, the SSO option must be enabled. Thereafter:

- When a user accesses a Sisense dashboard, Sisense requests CloudShell to provide the user’s credentials (identity).

- CloudShell returns the user's email address (user emails are mandatory for Sisense SSO).

The flow of information between CloudShell Portal and Sisense is depicted in the following diagram:

![SSO1.png](/Images/BI/SSO-Workflow_520x343.png)

Authenticating the user’s SSO profile:

- If the user's SSO profile is already defined in Sisense, the user is immediately authenticated.

- If this is a first time login and the user is not yet defined in Sisense, Sisense first creates the user’s SSO profile and then proceeds to authenticate the user.

:::note
The Sisense license limits the number of user profiles. The creation process might therefore result in an error if the maximum available user profiles is reached.
:::

The authentication steps between CloudShell and Sisense is depicted in the following flowchart:

![SSO2.png](/Images/BI/SSO-Workflow_1_280x299.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Installing CloudShell Insight BI",
"position": 4,
"link": {
"type": "generated-index",
"description": "This section explains how to download the installation files, install and build the Insight ElastiCube."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 4
---

# CloudShell Insight BI Components

WIP
Loading

0 comments on commit 70b88b1

Please sign in to comment.