From 70b88b14b5bcb1247427109cd8ac649087ee40cc Mon Sep 17 00:00:00 2001 From: kalsky Date: Wed, 6 Mar 2024 16:31:41 -0600 Subject: [PATCH] cs insight bi folders and wip files --- .../cs-insight-bi/_category_.json | 4 +++ .../cs-insight-bi/bi-terminology.md | 7 ++++ .../_category_.json | 4 +++ .../add-data-source-table.md | 26 ++++++++++++++ ...ackup-restore-elasticube-and-dashboards.md | 7 ++++ .../create-dashboards-and-widgets.md | 11 ++++++ .../create-customize-dashboards/index.md | 12 +++++++ .../inner-join-connections.md | 14 ++++++++ .../_category_.json | 4 +++ .../elasticube-data-stores.md | 7 ++++ .../elasticube-tables.md | 7 ++++ .../cs-insight-bi-elasticube-tables/index.md | 16 +++++++++ .../_category_.json | 4 +++ .../config-cs-to-enbl-sis-dashbds.md | 26 ++++++++++++++ .../embed-dashboards-externally/index.md | 16 +++++++++ .../share-with-unregistered-users.md | 9 +++++ docs/install-configure/cs-insight-bi/index.md | 21 +++++++++++ .../insight-dashboards/_category_.json | 7 ++++ .../manage-users-and-permissions.md | 9 +++++ .../using-insight-dashboards.md | 13 +++++++ .../cs-insight-bi/insight-sso/_category_.json | 4 +++ .../insight-sso/configure-sso-in-cs.md | 30 ++++++++++++++++ .../insight-sso/configure-sso-in-sisense.md | 7 ++++ .../insight-sso/grant-admin-privilege.md | 14 ++++++++ .../cs-insight-bi/insight-sso/index.md | 14 ++++++++ .../insight-sso/sso-to-insight-workflow.md | 29 +++++++++++++++ .../install-insight/_category_.json | 8 +++++ .../cs-insight-bi-components.md | 7 ++++ .../install-insight/download-install-files.md | 16 +++++++++ .../insight-configuration/_category_.json | 4 +++ .../insight-configuration/build-elasticube.md | 7 ++++ .../insight-configuration/configure-https.md | 35 +++++++++++++++++++ .../grant-permissions.md | 22 ++++++++++++ .../import-dashboards.md | 7 ++++ .../insight-configuration/index.md | 17 +++++++++ .../insight-configuration/install-addons.md | 7 ++++ .../insight-configuration/install-sisense.md | 7 ++++ .../insight-configuration/map-dashboards.md | 7 ++++ .../install-insight/install-checklist.md | 7 ++++ .../install-insight/install-sisense.md | 23 ++++++++++++ .../cs-insight-bi/install-insight/rebrand.md | 7 ++++ .../install-insight/requirements.md | 9 +++++ .../install-insight/synchronization.md | 7 ++++ .../key-points-and-limitations.md | 7 ++++ .../cs-insight-bi/sisense-bi-components.md | 7 ++++ src/css/custom.css | 5 +++ 46 files changed, 538 insertions(+) create mode 100644 docs/install-configure/cs-insight-bi/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/bi-terminology.md create mode 100644 docs/install-configure/cs-insight-bi/create-customize-dashboards/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/create-customize-dashboards/add-data-source-table.md create mode 100644 docs/install-configure/cs-insight-bi/create-customize-dashboards/backup-restore-elasticube-and-dashboards.md create mode 100644 docs/install-configure/cs-insight-bi/create-customize-dashboards/create-dashboards-and-widgets.md create mode 100644 docs/install-configure/cs-insight-bi/create-customize-dashboards/index.md create mode 100644 docs/install-configure/cs-insight-bi/create-customize-dashboards/inner-join-connections.md create mode 100644 docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-data-stores.md create mode 100644 docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-tables.md create mode 100644 docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/index.md create mode 100644 docs/install-configure/cs-insight-bi/embed-dashboards-externally/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/embed-dashboards-externally/config-cs-to-enbl-sis-dashbds.md create mode 100644 docs/install-configure/cs-insight-bi/embed-dashboards-externally/index.md create mode 100644 docs/install-configure/cs-insight-bi/embed-dashboards-externally/share-with-unregistered-users.md create mode 100644 docs/install-configure/cs-insight-bi/index.md create mode 100644 docs/install-configure/cs-insight-bi/insight-dashboards/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/insight-dashboards/manage-users-and-permissions.md create mode 100644 docs/install-configure/cs-insight-bi/insight-dashboards/using-insight-dashboards.md create mode 100644 docs/install-configure/cs-insight-bi/insight-sso/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-cs.md create mode 100644 docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-sisense.md create mode 100644 docs/install-configure/cs-insight-bi/insight-sso/grant-admin-privilege.md create mode 100644 docs/install-configure/cs-insight-bi/insight-sso/index.md create mode 100644 docs/install-configure/cs-insight-bi/insight-sso/sso-to-insight-workflow.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/install-insight/cs-insight-bi-components.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/download-install-files.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/_category_.json create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/build-elasticube.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/configure-https.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/grant-permissions.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/import-dashboards.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/index.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-addons.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-sisense.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/insight-configuration/map-dashboards.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/install-checklist.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/install-sisense.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/rebrand.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/requirements.md create mode 100644 docs/install-configure/cs-insight-bi/install-insight/synchronization.md create mode 100644 docs/install-configure/cs-insight-bi/key-points-and-limitations.md create mode 100644 docs/install-configure/cs-insight-bi/sisense-bi-components.md diff --git a/docs/install-configure/cs-insight-bi/_category_.json b/docs/install-configure/cs-insight-bi/_category_.json new file mode 100644 index 0000000000..1b90f3a7e9 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "CloudShell Insight BI", + "position": 3 +} diff --git a/docs/install-configure/cs-insight-bi/bi-terminology.md b/docs/install-configure/cs-insight-bi/bi-terminology.md new file mode 100644 index 0000000000..16571f1ea2 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/bi-terminology.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# BI Terminology + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/create-customize-dashboards/_category_.json b/docs/install-configure/cs-insight-bi/create-customize-dashboards/_category_.json new file mode 100644 index 0000000000..aa42cfd566 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/create-customize-dashboards/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Creating and Customizing Dashboards", + "position": 6 +} diff --git a/docs/install-configure/cs-insight-bi/create-customize-dashboards/add-data-source-table.md b/docs/install-configure/cs-insight-bi/create-customize-dashboards/add-data-source-table.md new file mode 100644 index 0000000000..09b3721386 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/create-customize-dashboards/add-data-source-table.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/create-customize-dashboards/backup-restore-elasticube-and-dashboards.md b/docs/install-configure/cs-insight-bi/create-customize-dashboards/backup-restore-elasticube-and-dashboards.md new file mode 100644 index 0000000000..b8d7535011 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/create-customize-dashboards/backup-restore-elasticube-and-dashboards.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Back Up and Restore ElastiCube and Dashboards + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/create-customize-dashboards/create-dashboards-and-widgets.md b/docs/install-configure/cs-insight-bi/create-customize-dashboards/create-dashboards-and-widgets.md new file mode 100644 index 0000000000..c994353274 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/create-customize-dashboards/create-dashboards-and-widgets.md @@ -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). \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/create-customize-dashboards/index.md b/docs/install-configure/cs-insight-bi/create-customize-dashboards/index.md new file mode 100644 index 0000000000..27f2b38acd --- /dev/null +++ b/docs/install-configure/cs-insight-bi/create-customize-dashboards/index.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/create-customize-dashboards/inner-join-connections.md b/docs/install-configure/cs-insight-bi/create-customize-dashboards/inner-join-connections.md new file mode 100644 index 0000000000..08bf057775 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/create-customize-dashboards/inner-join-connections.md @@ -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/) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/_category_.json b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/_category_.json new file mode 100644 index 0000000000..fadac96cf3 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "CloudShell Insight BI ElastiCube Tables", + "position": 8 +} diff --git a/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-data-stores.md b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-data-stores.md new file mode 100644 index 0000000000..c979be0804 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-data-stores.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# ElastiCube Data Stores + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-tables.md b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-tables.md new file mode 100644 index 0000000000..671e6c9f57 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/elasticube-tables.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# ElastiCube Tables + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/index.md b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/index.md new file mode 100644 index 0000000000..43f235a678 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/cs-insight-bi-elasticube-tables/index.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/embed-dashboards-externally/_category_.json b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/_category_.json new file mode 100644 index 0000000000..72514a6e7e --- /dev/null +++ b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Creating and Customizing Dashboards", + "position": 7 +} diff --git a/docs/install-configure/cs-insight-bi/embed-dashboards-externally/config-cs-to-enbl-sis-dashbds.md b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/config-cs-to-enbl-sis-dashbds.md new file mode 100644 index 0000000000..fe89e850b8 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/config-cs-to-enbl-sis-dashbds.md @@ -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**. diff --git a/docs/install-configure/cs-insight-bi/embed-dashboards-externally/index.md b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/index.md new file mode 100644 index 0000000000..71ab1e0330 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/index.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/embed-dashboards-externally/share-with-unregistered-users.md b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/share-with-unregistered-users.md new file mode 100644 index 0000000000..b6df7e4f3b --- /dev/null +++ b/docs/install-configure/cs-insight-bi/embed-dashboards-externally/share-with-unregistered-users.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/index.md b/docs/install-configure/cs-insight-bi/index.md new file mode 100644 index 0000000000..8a7f9aebae --- /dev/null +++ b/docs/install-configure/cs-insight-bi/index.md @@ -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. +::: \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/insight-dashboards/_category_.json b/docs/install-configure/cs-insight-bi/insight-dashboards/_category_.json new file mode 100644 index 0000000000..b292fe4ba7 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-dashboards/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Insight Dashboards", + "position": 9, + "link": { + "type": "generated-index" + } +} diff --git a/docs/install-configure/cs-insight-bi/insight-dashboards/manage-users-and-permissions.md b/docs/install-configure/cs-insight-bi/insight-dashboards/manage-users-and-permissions.md new file mode 100644 index 0000000000..5899648403 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-dashboards/manage-users-and-permissions.md @@ -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). \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/insight-dashboards/using-insight-dashboards.md b/docs/install-configure/cs-insight-bi/insight-dashboards/using-insight-dashboards.md new file mode 100644 index 0000000000..d3837b7bee --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-dashboards/using-insight-dashboards.md @@ -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. \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/insight-sso/_category_.json b/docs/install-configure/cs-insight-bi/insight-sso/_category_.json new file mode 100644 index 0000000000..214e7e9e44 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-sso/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Single Sign On (SSO) to Insight", + "position": 5 +} diff --git a/docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-cs.md b/docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-cs.md new file mode 100644 index 0000000000..f0aedd0646 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-cs.md @@ -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**. \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-sisense.md b/docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-sisense.md new file mode 100644 index 0000000000..c95bd4be44 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-sso/configure-sso-in-sisense.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Configure Sisense to Work with SSO + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/insight-sso/grant-admin-privilege.md b/docs/install-configure/cs-insight-bi/insight-sso/grant-admin-privilege.md new file mode 100644 index 0000000000..ad2bb1a1f0 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-sso/grant-admin-privilege.md @@ -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) diff --git a/docs/install-configure/cs-insight-bi/insight-sso/index.md b/docs/install-configure/cs-insight-bi/insight-sso/index.md new file mode 100644 index 0000000000..a872585b58 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-sso/index.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/insight-sso/sso-to-insight-workflow.md b/docs/install-configure/cs-insight-bi/insight-sso/sso-to-insight-workflow.md new file mode 100644 index 0000000000..496ebbdcc6 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/insight-sso/sso-to-insight-workflow.md @@ -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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/_category_.json b/docs/install-configure/cs-insight-bi/install-insight/_category_.json new file mode 100644 index 0000000000..73fbe10ec5 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/_category_.json @@ -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." + } +} diff --git a/docs/install-configure/cs-insight-bi/install-insight/cs-insight-bi-components.md b/docs/install-configure/cs-insight-bi/install-insight/cs-insight-bi-components.md new file mode 100644 index 0000000000..045af09081 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/cs-insight-bi-components.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# CloudShell Insight BI Components + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/download-install-files.md b/docs/install-configure/cs-insight-bi/install-insight/download-install-files.md new file mode 100644 index 0000000000..62c240c3ad --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/download-install-files.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 3 +--- + +# Download the Installation Files + +CloudShell Insight comprises the following: + +- Sisense installation file. +- CloudShell Insight BI packages + +These are available from [CloudShell Insight BI Download Page](https://support.quali.com/hc/en-us/articles/360037643914?flash_digest=29cf37c0615fa17b607b198da534b5eaa644d1f7), per CloudShell version. + +:::note +Registration to the Quali support portal is required. If you have not registered, click this [link](https://support.quali.com/hc/en-us/restricted?return_to=https%3A%2F%2Fsupport.quali.com%2Fhc%2Fen-us) to register. +::: \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/_category_.json b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/_category_.json new file mode 100644 index 0000000000..ff89449b7b --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Insight Dashboard Configuration", + "position": 6 +} diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/build-elasticube.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/build-elasticube.md new file mode 100644 index 0000000000..7026499466 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/build-elasticube.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Build the Insight ElastiCube + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/configure-https.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/configure-https.md new file mode 100644 index 0000000000..818b55d54b --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/configure-https.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 8 +--- + +# Configure HTTPS Connection Between CloudShell Portal and Sisense + +Due to an internet browser limitation, iframes are not displayed in internet browsers over HTTP. + +Since Insight dashboards are based on iframes, you will need to configure CloudShell Portal and Sisense to work over HTTPS to allow the dashboards to display in these browsers. The steps below apply to Sisense version 8.2 and up. For additional information, see this official [Sisense knowledgebase article](https://support.sisense.com/kb/en/article/breaking-changes-with-google-chrome-80-samesitenone-secure-cookie-settings-updated-march-12-2020). + +To resolve the issue: + +1. Perform the steps in [Configuring CloudShell Portal to Work in HTTPS Mode](https://help.quali.com/Online%20Help/0.0/Portal/Content/IG/Appendices/cs-portal-https.htm). +2. Open Sisense Configuration Manager (URL: `:3030`) select the following 2 checkboxes: + + - Enable SSL + - Force secure cookies attribute + + ![](/Images/BI/SisenseSSL.png) + +3. Upload the SSL certificate. +4. Set the port number. +5. Click Save. +6. Confirm services restart if prompted. + +7. Open the Sisense web app and click Admin>Security Settings. +8. Change Support Cross Site Cookies for Embedding to None. + + ![](/Images/BI/CrossSiteCookiesForEmbedding.png) + +9. Click Close in the confirmation message. +10. Click Save. +11. In Chrome, go to Settings>Privacy and security>Cookies and other site data and select Allow all cookies or at least Block third-party cookies in Incognito. + + ![](/Images/BI/ChromeSettings.png) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/grant-permissions.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/grant-permissions.md new file mode 100644 index 0000000000..425e313276 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/grant-permissions.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 6 +--- + +# Grant Data Security Permissions to ElastiCube Name + +This procedure limits CloudShell Portal users to only see Insight data that applies to their domains, and is a prerequisite for SSO integration with Sisense. + +**To configure data security permissions:** + +1. Go to `C:\Program Files (x86)\QualiSystems\CloudShell\Portal\customer.config` file, and add the following key: + + `` + +2. In the "value" field of the BiCube key, specify the name of the Sisense elasticube. + +3. Save the file. +4. Restart the **CloudShell Portal IIS** service. + +## Related Topics + +- [Configure Sisense SSO in CloudShell (Manage>Integrations page)](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/sis-mng-sso.htm) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/import-dashboards.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/import-dashboards.md new file mode 100644 index 0000000000..00fd251dbe --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/import-dashboards.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Import the Insight Dashboard + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/index.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/index.md new file mode 100644 index 0000000000..9c8afee010 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/index.md @@ -0,0 +1,17 @@ +# Insight Dashboard Configuration + +It is possible to use both the new dashboards (released in CloudShell 2021.2) and our legacy dashboards. The new dashboards address much the same contents as the legacy dashboards but also contain several new KPIs. + +:::note +There are three legacy dashboards that are not yet included in the new versions - Virtualization, Automation Suites and Automation Test. For details about the legacy dashboards, contact your Quali Account Manager. The installation and configuration of the legacy dashboards is explained in [CloudShell 2021.1 Help](https://help.quali.com/Online%20Help/2021.1/Portal/Content/CSP/BI/CS-Insight-BI.htm). +::: + +To set up the new dashboards, you need to do the following: + +- [Install Sisense Add-Ons](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/instl-sis-addons.htm) +- [Load the Insight ElastiCube](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/cnfg-sis-db-connection.htm) +- [Build the Insight ElastiCube](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/bld-elasticube.htm) +- [Import the Insight Dashboards](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/imprt-dshbrds.htm) +- [Map the Insight Dashboards to the Overview Dashboard](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/BI/map-dshbrds.htm) +- [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) \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-addons.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-addons.md new file mode 100644 index 0000000000..421e3f59b6 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-addons.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Install Sisense Add-Ons + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-sisense.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-sisense.md new file mode 100644 index 0000000000..308ca18131 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/install-sisense.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Load the Insight ElastiCube + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/map-dashboards.md b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/map-dashboards.md new file mode 100644 index 0000000000..ac52630760 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/insight-configuration/map-dashboards.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 5 +--- + +# Map the Insight Dashboards to the Overview Dashboard + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/install-checklist.md b/docs/install-configure/cs-insight-bi/install-insight/install-checklist.md new file mode 100644 index 0000000000..b20610cad6 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/install-checklist.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Installation Checklist + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/install-sisense.md b/docs/install-configure/cs-insight-bi/install-insight/install-sisense.md new file mode 100644 index 0000000000..4f7173e164 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/install-sisense.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 4 +--- + +# Install Sisense on the BI Server + +CloudShell uses Sisense, a powerful 3rd party BI and analytics platform. You get Sisense with View permissions, which allows you and your CloudShell users to view the out-of-the-box dashboards. To create/customize dashboards or use any legacy dashboards, you will need more robust Sisense permissions. For details, contact your Technical Account Manager. + +:::info +It is also possible to install Sisense in an offline environment. +::: + +**To install Sisense on the BI Server:** + +1. Browse to the location where the BI solution pack was downloaded and select the Sisense installation file (.exe). Run this file to install and configure Sisense on your server. + :::note + Sisense server cannot be installed on the Quali Server. + ::: + +2. In the Sisense installation wizard, click **Activate**. +3. Sign in with your Sisense user account or create a new one. +4. Click **Install**, select the **Custom Installation** option and follow the wizard. +5. Launch Sisense. \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/rebrand.md b/docs/install-configure/cs-insight-bi/install-insight/rebrand.md new file mode 100644 index 0000000000..3acdeb7817 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/rebrand.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 7 +--- + +# Rebrand Insight (White Labeling) + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/requirements.md b/docs/install-configure/cs-insight-bi/install-insight/requirements.md new file mode 100644 index 0000000000..df5b1a17ff --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/requirements.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 2 +--- + +# Requirements (Insight BI) + +- SSL is mandatory on both Cloudshell Portal and Sisense. + +For additional requirements, please contact your Technical Account Manager. \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/install-insight/synchronization.md b/docs/install-configure/cs-insight-bi/install-insight/synchronization.md new file mode 100644 index 0000000000..9e819958a6 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/install-insight/synchronization.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 8 +--- + +# Synchronization + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/key-points-and-limitations.md b/docs/install-configure/cs-insight-bi/key-points-and-limitations.md new file mode 100644 index 0000000000..31da884967 --- /dev/null +++ b/docs/install-configure/cs-insight-bi/key-points-and-limitations.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Key Points and Limitations + +WIP \ No newline at end of file diff --git a/docs/install-configure/cs-insight-bi/sisense-bi-components.md b/docs/install-configure/cs-insight-bi/sisense-bi-components.md new file mode 100644 index 0000000000..870aa826af --- /dev/null +++ b/docs/install-configure/cs-insight-bi/sisense-bi-components.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Sisense BI Components + +WIP \ No newline at end of file diff --git a/src/css/custom.css b/src/css/custom.css index e0be098d21..024221d8c8 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -27,6 +27,11 @@ --ifm-color-primary-lightest: #ffffff; } + +.menu__link { + font-size: 15px; +} + .markdown h1:first-child { --ifm-h1-font-size: 2.4rem; }