Skip to content

Commit

Permalink
insight bi wip completed
Browse files Browse the repository at this point in the history
  • Loading branch information
lizoron committed Mar 8, 2024
1 parent 315e12b commit d36409d
Show file tree
Hide file tree
Showing 10 changed files with 280 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,32 @@ sidebar_position: 2

# Configure Sisense to Work with SSO

WIP
Use the instructions in the following procedure to configure Insight to work with SSO. This requires configuring SSO on Sisense, the BI analytics tool used by Insight. You can do this via CloudShell's **Insight** tab or directly through the Sisense application.

**Prerequisites:**

- [Grant Data Security Permissions to ElastiCube Name](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/Grnt-dtsec-prms.htm)
- [Configure HTTPS Connection Between CloudShell Portal and Sisense](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/sis-https.htm) (mandatory if the CloudShell Portal is configured to use HTTS)

**To configure Sisense to work with SSO:**

1. In the **Insight** tab, click **Admin** and select **Single Sign On** from the left menu.
2. Enable the **Single Sign On Configuration** check box.
3. Select the SSO method to use: **JWT**.
4. In the **Remote Login URL** field, add the following URL:

http://\[CloudShell Portal Address\]:\[CloudShell Portal Port\]/Account/SisenseLogin

:::note Notes:
- \[CloudShell Portal Address\] is the IP address or hostname that users enter in order to browse to CloudShell Portal.
- \[CloudShell Portal Port\] is the port to use (required if default port 80 is not used).
:::

![](/Images/BI/Configure-Sisense-to-Work_2.png)

5. Copy the Shared Secret string.
6. Go to `C:\Program Files (x86)\QualiSystems\CloudShell\Portal\customer.config` file, and add the following key:

`<add key="BiSSOSecret" value="shared-secret-value"/>`

7. Save the file and restart the **CloudShell Portal IIS** service.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,20 @@ sidebar_position: 4

# CloudShell Insight BI Components

WIP
The CloudShell Insight BI package includes the following components:

- **CS\_BI\_Cube**: the default data structure that ElastiCube collects from CloudShell (`*.smodel` file)
- **Default Dashboards**: out-of-the-box dashboards that present valuable information (`*.dash` files) . CloudShell 2021.2 introduces new and improved dashboards, which can live side by side with the legacy ones:
- **Overview**: High-level overview of CloudShell. The **Overview** dashboard includes areas of the other dashboards. Click an area's title to drill down into that dashboard. When moving from the **Overview** dashboard by clicking a dashboard title, filters are preserved to allow you to continue your investigation.
- **Blueprints**: Blueprint usage and resource allocation over time
- **Inventory**: Resource utilization by family, model, resource/subresource name, and global view per shell
- **Sandboxes**: Sandbox and consumption licenses, including number of activated/denied/ended sandboxes
- **Users**: User activity (logins, sandbox launches)
- **Utilization**: Resource utilization data. Helps to identify bottlenecks and unused resources
-  **Yearly Utilization**: Monthly resource utilization over the last 12 months

:::note Notes:
- Data related to **Sandbox Save and Restore** is stored in the **Insight** database and can be displayed in customized dashboards.
- In order to add/customize dashboards and connect to additional data sources, contact your Quali Account Manager.
- Legacy dashboards are still available as a paid add-on, and include test automation and virtualization dashboards. For details, contact your Quali Account Manager.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,16 @@ sidebar_position: 3

# Build the Insight ElastiCube

WIP
**To build the Insight ElastiCube:**

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

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

2. Click the **Data** tab.
3. Click **Build** and click **Build** again in the popup window.

Wait for the build to complete. This may take several minutes.

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

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,55 @@
sidebar_position: 4
---

# Import the Insight Dashboard
# Import the Insight Dashboards

WIP
Download 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)) and follow the steps in the following procedure.

**To configure the CloudShell Insight BI dashboards:**

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

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

2. Click the **Analytics** tab.
3. In the left pane, click the **Options** button \[+\] and then from the context menu click **Import Dashboards**.

![](/Images/BI/import-dashboards-cloudshell.png)

4. Import each dashboard as follows:
1. Browse to the location where the Quali Insight Package was downloaded.

2. Double-click a dashboard. Click **OK** in the confirmation window.

The dashboard is added to the **Dashboards** pane in Sisense.
:::note
If you don't see any data in the dashboard. It's probably because you modified the ElastiCube name during import. To correct this, select the ElastiCube for each dashboard:
![](/Images/BI/ElastiCubeName.png)
:::
3. Repeat the previous step to import the rest of the Insight dashboards.
5. Share the dashboards with all CloudShell users.
1. Hover over a dashboard, click the options button and select **Share**.
2. In the window that pops up, start typing "everyone" and select the **Everyone** group.

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

3. Click **Save**.
4. If a confirmation message pops up, click **Share**.
5. Repeat these steps to share the rest of the dashboards.

At this point, the dashboards are in Sisense and shared, but do not display any data.

6. Enable CloudShell users to access the relevant dashboards.
1. Click the **Admin** tab.
2. From the left pane, under **Data Management**, select **Data Sources**.
3. Locate the ElastiCube entry (titled "CS\_BI\_Cube"), click the options button and select **Data Security**.

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

4. In the **Data Security** page, click the **Add Field** button.

5. Search for the term "email".

6. Select the "email" in the result.

7. Return to the **Analytics** tab and note it is no longer possible for the admin to see dashboard data.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,12 @@ sidebar_position: 1

# Install Sisense Add-Ons

WIP
Insight requires the use of several free Sisense add-ons. Download and install the following free add-ons from the [Sisense Marketplace](https://www.sisense.com/marketplace/) library:

| Add-on | Installation instructions |
| --- | --- |
| Blox | Allows creating dynamic and interactive content in your widgets and dashboards and enhances the look and feel of your graphs.<br/>The **Overview** dashboard contains customized images, which need to be added to Blox. To add the images, copy all `*.svg` files from the **`Attachments`** folder in the BI package to<br/>`C:\Program Files\Sisense\app\plugins\BloX\blox-images` |
| Dynamic Buckets | Allows filtering and drilling down in column charts.<br/>Restart the Sisense IIS website after applying the dynamic buckets. |
| Jump to Dashboard | Enables the different dashboard links. These include the widget title links from the **Overview** dashboard to the different dashboards and the **Go to Overview** link from each dashboard. |

After installing the add-ons, you would need to enable them in Sisense under the Admin tab > System Configuration > Add Ons.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,36 @@ sidebar_position: 2

# Load the Insight ElastiCube

WIP
The Insight ElastiCube is a database containing all the data needed to successfully use our out-of-the-box dashboards.

Download 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)) and follow the steps in the following procedure.

**To define the Insight Database Insight BI Dashboards:**

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

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

2. In the **Data** tab, do the following:
1. Click **Import Model** and browse to the location where the Quali Insight Package was downloaded. Double-click the `*.smodel` file (Select **Overwrite** if necessary). Click **Import**.
2. In the left pane, click the **Group by Data Source** button.

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

3. Expand **Data Sources**.

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

4. Hover over the **MS SQL** item, click the database's options button and select **Connection Settings\>Change Provider**. Define the Quali database provider in Sisense, as explained in [Connecting to SQL Server](https://documentation.sisense.com/latest/managing-data/connectors/sql-online.htm#gsc.tab=0).
5. Hover over the **MS SQL** item, click the database's options button and select **Connection Settings\>Change Connection**.

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

6. Specify the SQL Server details.

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

7. Click **Next**.
8. From the **Database** page, select the "QualiInsight" database (or corresponding name if it has been renamed).
9. On the **Table Entry Page**, click the **Parse All** link, and select the **Table Query**'s checkbox (make sure all checkboxes are selected).
10. Click **Done**.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,37 @@ sidebar_position: 5

# Map the Insight Dashboards to the Overview Dashboard

WIP
This procedure links the different out-of-the-box Insight dashboards to the **Overview** dashboard, enabling their **Go to Overview** link.

![](/Images/BI/Insight-2021.2-Go-to-Overview-link.gif)
:::important
The mapping is done by running a dedicated script that is provided with the CloudShell Insight BI package. However, you can only run this script once. As such, if you need to relink the dashboards, after changing the Sisense App's http protocol or port for example, you will need to completely remove the dashboards, add them again and then rerun the script.
:::
**To map the CloudShell Insight BI dashboards to the Overview dashboard:**

1. Open the CloudShell Insight BI package you previously downloaded.

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

2. Open the `/Attachments` folder.
3. Unzip the `Quali_setup_links.zip` file.
4. In the unzipped folder, edit the `dashboards_links.cfg.json` file.
5. Specify the Sisense App server's URL (including http protocol, hostname and port), and a log folder. If the log folder is missing, create it.

For example:

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

6. Save the file.
7. Open command-prompt from the `/Attachments` folder and run the `Quali_setup_links.exe`.

8. In the command-prompt that opens, specify the Sisense admin username and password, when prompted.

![](/Images/BI/Quali_setup_links-cli.png)
:::note
Password must be typed, not pasted.
:::
9. Press **\[Enter\]**.
10. Close the command-prompt when the process finishes.

![](/Images/BI/quali_setup_links_cli_end.png)
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,15 @@ sidebar_position: 1

# Installation Checklist

WIP
Use the following checklist to ensure you have a complete installation:

|| **Topic** | **Link** |
| --- | --- | --- |
| | Ensure that the BI server meets the minimum requirements | [Requirements (Insight BI)](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/rqrmnts.htm#_Ref436052117) |
| | Download the installation files | [Download the Installation Files](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/dwnld-th-instln-fls.htm) |
| | Install Sisense on the BI server | [Install Sisense on the BI Server](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/instl-sis-on-bi-srver.htm) |
| | Configure the official CloudShell ElastiCube, install the BI dashboards, and enable direct access to Insight within CloudShell Portal | [Insight Dashboard Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/cnfg-Insight.htm) |
| | Update automation dashboards report links | Only in case you are using the Job Scheduling module |
| | Install and activate the rebranding package | [Rebrand Insight (White Labeling)](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/rbrnd-insght.htm#_Ref436052204) |
| | Configure SSO to enable single sign on access between CloudShell and Sisense | [Single Sign On (SSO) to Insight](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/sso.htm#_Ref436052228) |
|   | SSL is mandatory on both Cloudshell Portal and Sisense | |
61 changes: 60 additions & 1 deletion docs/install-configure/cs-insight-bi/install-insight/rebrand.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,63 @@ sidebar_position: 7

# Rebrand Insight (White Labeling)

WIP
Use the steps described in this procedure to rebrand (white label) and customize the look and feel of your Insight dashboards, as well as the logos, icons and web text. The folders and files referred to in this article are those that were downloaded in [Download the Installation Files](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/dwnld-th-instln-fls.htm).
:::note
White labeling must be enabled in your Sisense license. See this Sisense Docs [article](https://documentation.sisense.com/latest/administration/embedded-analytics/rebranding-sisense/white-label.htm) for details.
:::
**To rebrand Insight:**

1. Browse to the `resources` folder in the path where Sisense is installed. If the path does not exist, create it. For example:

`C:\Program Files\Sisense\app\resources`

2. Create a new sub-folder under `resources`. For example:

`C:\Program Files\Sisense\app\resources\QualiSystemsBrand`
:::note
If you are using version 9.1 or below, use: `~\Sisense\PrismWeb\resources\QualiSystemsBrand`
:::
3. Browse to the location where the CloudShell Insight BI Package was downloaded. The required files are located in the `ReBrandingFiles` folder.

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

4. Copy the `.png` and `.ico` files to `C:\Program Files\Sisense\app\resources\QualiSystemsBrand`.
5. To set the **Overview** dashboard as the **Insight** landing page, do the following:

1. In Sisense, open the **Overview** dashboard and copy the URL.
2. Open the `RebrandingQualiJSON.txt` text file.
3. In the **homepage** value, paste the dashboard URL and add "embed=true&r=false" to the end of the value.

For example, for dashboard URL "http://sisense:8081/app/main#/dashboards/60ed2d2dbd87562ac4eac9e1?", the expected homepage value will be:

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

4. Save the file.
6. Log into CloudShell Portal as the Sisense administrator.
7. In the main menu, click **Insight**.

![](/Images/BI/Enable-Direct-Access-to-Insight_1.png)

8. In the top toolbar, click **Admin**. Then click **Rest API**.

![](/Images/BI/admin-menuR.png)

9. In the top right corner, click **0.9** and then click **branding**.

![](/Images/BI/0.9-brandingR.png)

10. Click **Add new branding**.

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

11. Click **Try it out** and delete the branding text box contents.

![](/Images/BI/branding-try-it-out.png)
:::note
A pair of curly brackets will remain ({}). You will need to delete these later.
:::
12. From your `QualiSystemsBrand` folder, copy all the contents from the `RebrandingQualiJSON.txt` text file and paste them into the branding text box AFTER the curly brackets \{\}.
13. Return to the top of the branding text box, delete the first pair of curly brackets, and then click **Execute**.
14. In CloudShell Portal, refresh the browser to see your changes.

![](/Images/BI/Rebrand-Insight_7.png)
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,25 @@ sidebar_position: 8

# Synchronization

WIP
In order for SiSense ElastiCube data to be refreshed, you must define a synchronization schedule. During the synchronization, CloudShell copies data from the Quali DB to the Insight DB and locks several tables in the Insight DB in the process.

**To define a synchronization schedule:**

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

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


2. Click the **Data** tab.
3. Hover over the **QS\_ElastiCube** tile, click the options button and select **Schedule Build**.

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

4. Set the build schedule.
:::tip
We recommend running a daily build at 2 AM since at 1 AM CloudShell updates the utilization reports.
:::
![](/Images/BI/BuildSchedule.png)


4. Click **Save**.

0 comments on commit d36409d

Please sign in to comment.