Skip to content

Commit

Permalink
Release v1.14.0
Browse files Browse the repository at this point in the history
  • Loading branch information
compose-sdk-release-bot committed Jul 10, 2024
1 parent 8c3a603 commit 5cd47f1
Show file tree
Hide file tree
Showing 324 changed files with 6,066 additions and 4,018 deletions.
17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## [1.14.0] - 2024-07-09

### Added
- Implement additional components and hooks for dashboard rendering (internal testing): background filters, locked filters
- Implement components `DashboardById` and `Dashboard` in Angular and Vue for internal testing
- Add visual regression testing infrastructure and basic tests

### Changed
- Support additional datetime levels for Live models: 'seconds' and 'minutes'
- Make improvements to charts and pivot table: tooltips of `AreaRangeChart`, default line thickness to bold for `LineChart`, hidden pagination panel for single page result of `PivotTable`, handling of data options update for `TableChart`
- Make improvements to dashboard rendering: supporting `CustomFilter` in `CascadingFilterTile`, fixing UI issues of `DateRangeFilter`
- Make improvements for `Chatbot` component: list of data topics
- Improve performance by lowering priority of tracking API calls
- Handle properly empty returns of network calls

## [1.13.0] - 2024-06-26

### Added
Expand All @@ -12,7 +27,7 @@
- Change query cache key to work for all jaql elements
- Make improvements to charts: fixing broken charts when switching chart type, clearing point state on selection, parsing of ISO date strings with or without timezone offsets, fixing numeric values as string (highcharts error), tooltip of measure name for range charts
- Improve the translation of filter JAQL to `Filter` objects: exclude member filter, top/bottom ranking on measure, translation of deactivated members for `MembersFilter`
- Make improvements to components for dashboard rendering: numeric members in `MemberFilterTile`, dynamic resizing of `FiltersPanel`, theming for `DashboardById`
- Make improvements to dashboard rendering: numeric members in `MemberFilterTile`, dynamic resizing of `FiltersPanel`, theming for `DashboardById`
- Make improvements for `Chatbot` component: viewer role, scroll to bottom, input box autofocus, input length limit, hide history config

## [1.12.0] - 2024-06-11
Expand Down
17 changes: 16 additions & 1 deletion docs-md/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## [1.14.0] - 2024-07-09

### Added
- Implement additional components and hooks for dashboard rendering (internal testing): background filters, locked filters
- Implement components `DashboardById` and `Dashboard` in Angular and Vue for internal testing
- Add visual regression testing infrastructure and basic tests

### Changed
- Support additional datetime levels for Live models: 'seconds' and 'minutes'
- Make improvements to charts and pivot table: tooltips of `AreaRangeChart`, default line thickness to bold for `LineChart`, hidden pagination panel for single page result of `PivotTable`, handling of data options update for `TableChart`
- Make improvements to dashboard rendering: supporting `CustomFilter` in `CascadingFilterTile`, fixing UI issues of `DateRangeFilter`
- Make improvements for `Chatbot` component: list of data topics
- Improve performance by lowering priority of tracking API calls
- Handle properly empty returns of network calls

## [1.13.0] - 2024-06-26

### Added
Expand All @@ -12,7 +27,7 @@
- Change query cache key to work for all jaql elements
- Make improvements to charts: fixing broken charts when switching chart type, clearing point state on selection, parsing of ISO date strings with or without timezone offsets, fixing numeric values as string (highcharts error), tooltip of measure name for range charts
- Improve the translation of filter JAQL to `Filter` objects: exclude member filter, top/bottom ranking on measure, translation of deactivated members for `MembersFilter`
- Make improvements to components for dashboard rendering: numeric members in `MemberFilterTile`, dynamic resizing of `FiltersPanel`, theming for `DashboardById`
- Make improvements to dashboard rendering: numeric members in `MemberFilterTile`, dynamic resizing of `FiltersPanel`, theming for `DashboardById`
- Make improvements for `Chatbot` component: viewer role, scroll to bottom, input box autofocus, input length limit, hide history config

## [1.12.0] - 2024-06-11
Expand Down
119 changes: 75 additions & 44 deletions docs-md/sdk/getting-started/authentication-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,53 +12,60 @@ To retrieve data using Compose SDK you need to authenticate your application aga

There are several ways you can authenticate your application:

- [API Token](#api-token)
- [Web Access Token (WAT)](#web-access-token)
- [Single Sign On (SSO)](#single-sign-on)
- [Web Access Token (WAT)](#web-access-token)
- [API Token](#api-token)

### API Token

Sisense API Tokens are issued per user. Typically, in a production environment you create a Sisense user specifically for using Compose SDK. You grant that user the permissions you want to expose in your application and use that user's API Token.
### Single Sign On

#### Create an API Token
Single Sign On (SSO) allows the users of your application to authenticate with Sisense using an external identity provider.

You can get an API Token to use in your application in one of the following ways:
#### Set up SSO

- [Go to a user profile in the Sisense UI](https://sisense.dev/guides/restApi/using-rest-api.html#getting-the-api-token-from-user-profiles)
- Send a request to the [authentication/login](https://sisense.dev/guides/restApi/v1/?platform=linux&spec=L2023.6#/authentication/login) endpoint of the Sisense REST API
- Run the following command using the Compose SDK CLI tool:
Set up your Sisense instance to authenticate users with SSO using one of the following:

```sh
npx @sisense/sdk-cli@latest get-api-token --url <your_instance_url> --username <username>
```
- [JSON Web Token (JWT)](https://docs.sisense.com/main/SisenseLinux/single-sign-on-using-json-web-token.htm?tocpath=Security%7CImplementing%20Single%20Sign-On%7C_____3)
- [Security Assertion Markup Language 2.0 (SAML)](https://docs.sisense.com/main/SisenseLinux/single-sign-on-using-security-assertion-markup-language-20.htm?tocpath=Security%7CImplementing%20Single%20Sign-On%7C_____2)
- [OpenID Connect](https://docs.sisense.com/main/SisenseLinux/single-sign-on-using-openid-connect.htm?tocpath=Security%7CImplementing%20Single%20Sign-On%7C_____4)

Notes:
::: tip Note
If you're experiencing difficulties or unexpected behavior when using SSO, the cause may be a hidden feature configuration. To resolve the issue, you can:

- Be sure to replace `<your_instance_url>` with the URL to your Sisense instance and `<username>` with the username of the user you want to create the API token for.
- For Windows, use double quotes around the URL and username arguments. For Mac/Linux, only use double quotes for arguments that contain white space.
- Contact [support](https://www.sisense.com/support/) to validate you Fusion configuration settings
- See this [community post](https://community.sisense.com/t5/developer-forum/issue-with-sisense-compose-sdk-and-sso-authentication/m-p/18601/highlight/true#M40) to try to resolve the issue yourself
:::

#### Authenticate with an API token
#### Authenticate with SSO

Once you’ve obtained an API token, you can use it to authenticate within your application:
Once you’ve set up SSO access, you can use it to authenticate within your application:

- For React apps use the `token` property of the `<SisenseContextProvider />` component:
- For React apps use the `ssoEnabled` property of the `<SisenseContextProvider />` component:

```ts
<SisenseContextProvider
url="http://sisense-instance-url"
token="eRykZjVxkFdhMaGYzYmqJl..."
url="https://sisense-instance-url"
ssoEnabled=true
>
```

- For Angular apps use the `token` property of the `SisenseContextConfig` object:
- For Angular apps use the `ssoEnabled` property of the `SisenseContextConfig` object:

```ts
export const SISENSE_CONTEXT_CONFIG: SisenseContextConfig = {
url="http://sisense-instance-url"
token="eRykZjVxkFdhMaGYzYmqJl..."
url="https://sisense-instance-url"
ssoEnabled=true
};
```

- For Vue apps use the `ssoEnabled` property of the `<SisenseContextProvider />` component:

```ts
<SisenseContextProvider
:url="https://sisense-instance-url"
:ssoEnabled="true"
>
```

### Web Access Token

Sisense Web Access Tokens (WATs) impersonate specific Sisense users. Typically, in a production environment you create a Sisense user specifically for using Compose SDK. You grant that user the permissions you want to expose in your application and use a WAT that impersonates that user.
Expand Down Expand Up @@ -99,47 +106,71 @@ export const SISENSE_CONTEXT_CONFIG: SisenseContextConfig = {
};
```

### Single Sign On
- For Vue apps use the `wat` property of the `<SisenseContextProvider />` component:

Single Sign On (SSO) allows the users of your application to authenticate with Sisense using an external identity provider.
```ts
<SisenseContextProvider
:url="http://sisense-instance-url"
:wat="eykZjkFhMGYzYmJl…"
>
```

#### Set up SSO
### API Token

Set up your Sisense instance to authenticate users with SSO using one of the following:
Sisense API Tokens are issued per user. Typically, you create a Sisense user specifically for using Compose SDK. You grant that user the permissions you want to expose in your application and use that user's API Token.

- [JSON Web Token (JWT)](https://docs.sisense.com/main/SisenseLinux/single-sign-on-using-json-web-token.htm?tocpath=Security%7CImplementing%20Single%20Sign-On%7C_____3)
- [Security Assertion Markup Language 2.0 (SAML)](https://docs.sisense.com/main/SisenseLinux/single-sign-on-using-security-assertion-markup-language-20.htm?tocpath=Security%7CImplementing%20Single%20Sign-On%7C_____2)
- [OpenID Connect](https://docs.sisense.com/main/SisenseLinux/single-sign-on-using-openid-connect.htm?tocpath=Security%7CImplementing%20Single%20Sign-On%7C_____4)
:::warning
Be sure to use API tokens in a secure manner. Typically, API tokens are not a good choice for production environments.
:::

::: tip Note
If you're experiencing difficulties or unexpected behavior when using SSO, the cause may be a hidden feature configuration. To resolve the issue, you can:
#### Create an API Token

- Contact [support](https://www.sisense.com/support/) to validate you Fusion configuration settings
- See this [community post](https://community.sisense.com/t5/developer-forum/issue-with-sisense-compose-sdk-and-sso-authentication/m-p/18601/highlight/true#M40) to try to resolve the issue yourself
:::
You can get an API Token to use in your application in one of the following ways:

#### Authenticate with SSO
- [Go to a user profile in the Sisense UI](https://sisense.dev/guides/restApi/using-rest-api.html#getting-the-api-token-from-user-profiles)
- Send a request to the [authentication/login](https://sisense.dev/guides/restApi/v1/?platform=linux&spec=L2023.6#/authentication/login) endpoint of the Sisense REST API
- Run the following command using the Compose SDK CLI tool:

Once you’ve set up SSO access, you can use it to authenticate within your application:
```sh
npx @sisense/sdk-cli@latest get-api-token --url <your_instance_url> --username <username>
```

- For React apps use the `ssoEnabled` property of the `<SisenseContextProvider />` component:
Notes:

- Be sure to replace `<your_instance_url>` with the URL to your Sisense instance and `<username>` with the username of the user you want to create the API token for.
- For Windows, use double quotes around the URL and username arguments. For Mac/Linux, only use double quotes for arguments that contain white space.

#### Authenticate with an API token

Once you’ve obtained an API token, you can use it to authenticate within your application:

- For React apps use the `token` property of the `<SisenseContextProvider />` component:

```ts
<SisenseContextProvider
url="https://sisense-instance-url"
ssoEnabled=true
url="http://sisense-instance-url"
token="eRykZjVxkFdhMaGYzYmqJl..."
>
```

- For Angular apps use the `ssoEnabled` property of the `SisenseContextConfig` object:
- For Angular apps use the `token` property of the `SisenseContextConfig` object:

```ts
export const SISENSE_CONTEXT_CONFIG: SisenseContextConfig = {
url="https://sisense-instance-url"
ssoEnabled=true
url="http://sisense-instance-url"
token="eRykZjVxkFdhMaGYzYmqJl..."
};
```

- For Vue apps use the `token` property of the `<SisenseContextProvider />` component:

```ts
<SisenseContextProvider
:url="http://sisense-instance-url"
:token="eRykZjVxkFdhMaGYzYmqJl..."
>
```

## Cross-Origin Resource Sharing (CORS)

By default, browser same-origin policy prevents client-side web applications located in one domain from obtaining data from a different domain. That means an application you build with Compose SDK can't get data from your Sisense instance without some initial setup.
Expand Down
2 changes: 1 addition & 1 deletion docs-md/sdk/getting-started/quickstart-angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Quickstart Guide (Angular)
Follow this guide to get started developing applications with Compose SDK.

> **Note**:
> This guide is for [<img src="../img/angular-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 2px" /> Angular](./quickstart-angular.md). We also have a Quickstart Guide for [<img src="../img/react-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 3px" /> React](./quickstart.md) and [<img src="../img/vue-logo.png" height="14px" /> Vue](./quickstart-vue.md) (beta).
> This guide is for [<img src="../img/angular-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 2px" /> Angular](./quickstart-angular.md). We also have a Quickstart Guide for [<img src="../img/react-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 3px" /> React](./quickstart.md) and [<img src="../img/vue-logo.png" height="14px" /> Vue](./quickstart-vue.md).
## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions docs-md/sdk/getting-started/quickstart-vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Quickstart Guide (Vue)
---

# Compose SDK with Vue <Badge type="beta" text="Beta" />: Quickstart Guide
# Compose SDK with Vue: Quickstart Guide

Follow this guide to get started developing applications with Compose SDK.

> **Note**:
> This guide is for [<img src="../img/vue-logo.png" height="14px" /> Vue](./quickstart-vue.md) (beta). We also have a Quickstart Guide for [<img src="../img/react-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 3px" /> React](./quickstart.md) and [<img src="../img/angular-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 2px" /> Angular](./quickstart-angular.md) (beta).
> This guide is for [<img src="../img/vue-logo.png" height="14px" /> Vue](./quickstart-vue.md). We also have a Quickstart Guide for [<img src="../img/react-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 3px" /> React](./quickstart.md) and [<img src="../img/angular-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 2px" /> Angular](./quickstart-angular.md).
## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs-md/sdk/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Follow this guide to get started developing applications with Compose SDK.

> **Note**:
> This guide is for [<img src="../img/react-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 3px" /> React](./quickstart.md). We also have a Quickstart Guide for [<img src="../img/angular-logo.png" height="18px" style="vertical-align: text-bottom; padding-bottom: 2px" /> Angular](./quickstart-angular.md)
> and [<img src="../img/vue-logo.png" height="14px" /> Vue](./quickstart-vue.md) (beta).
> and [<img src="../img/vue-logo.png" height="14px" /> Vue](./quickstart-vue.md).
## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs-md/sdk/guides/ai-features/chatbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The AI chatbot allows your users to explore your data and generate queries through natural language questions powered by GenAI. The chatbot can suggest sample insights, provide narrative explanations in context, and produce data visualizations.

::: warning Note
This feature is currently under beta release for our managed cloud customers on version L2024.1 SU1 or above. It is subject to changes as we make fixes and improvements. We’re excited to work closely with customers who are eager to get hands-on, test, and help shape this game-changing feature.
This feature is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements. We’re excited to work closely with customers who are eager to get hands-on, test, and help shape this game-changing feature.

To be considered for the beta program, please sign up at [www.sisense.com/get/gen-ai-partner](https://www.sisense.com/get/gen-ai-partner/).
:::
Expand Down
2 changes: 1 addition & 1 deletion docs-md/sdk/guides/ai-features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ indexTopics:
Compose SDK contains generative AI (GenAI) React components and hooks for creating conversational analytics experiences.

::: warning Note
This feature is currently under beta release for our managed cloud customers on version L2024.1 SU1 or above. It is subject to changes as we make fixes and improvements. We’re excited to work closely with customers who are eager to get hands-on, test, and help shape this game-changing feature.
This feature is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements. We’re excited to work closely with customers who are eager to get hands-on, test, and help shape this game-changing feature.

To be considered for the beta program, please sign up at [www.sisense.com/get/gen-ai-partner](https://www.sisense.com/get/gen-ai-partner/).
:::
Expand Down
4 changes: 2 additions & 2 deletions docs-md/sdk/guides/ai-features/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ In this guide we present some examples of how to get started using:
- [Query recommendations](#query-recommendations)

::: warning Note
This feature is currently under beta release for our managed cloud customers on version L2024.1 SU1 or above. It is subject to changes as we make fixes and improvements. We’re excited to work closely with customers who are eager to get hands-on, test, and help shape this game-changing feature.
This feature is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements. We’re excited to work closely with customers who are eager to get hands-on, test, and help shape this game-changing feature.

To be considered for the beta program, please sign up at [www.sisense.com/get/gen-ai-partner](https://www.sisense.com/get/gen-ai-partner/).
:::
Expand Down Expand Up @@ -81,7 +81,7 @@ To change the chatbot's default behavior or text content, provide an object to t
config={{
enableFollowupQuestions: true,
numOfRecommendations: 4,
defaultContextTitle: 'Sample ECommerce',
dataTopicsList: ['Sample ECommerce'],
inputPromptText: 'Ask me anything',
welcomeText: 'Welcome to Sisense AI',
enableHeader: false,
Expand Down
Loading

0 comments on commit 5cd47f1

Please sign in to comment.