Interface SisenseContextProviderProps
Configurations and authentication for Sisense Context.
Use one of the following to authenticate:
Properties
Sisense App
appConfig
appConfig?:
AppConfig
Application specific configurations such as locale and date formats.
defaultDataSource
defaultDataSource?:
DataSource
Default data source explicitly set to be used by child components that are not defined with a data source.
url
url:
string
URL of the Sisense environment the app connects to
Sisense App Error Handling
onError
onError?: (
error,errorDetails?) =>ReactNode|void
Callback function that is triggered when an error occurs within the Sisense context.
Return React node to render a custom error UI. Return undefined to use the default error UI.
This callback is useful for handling errors that happen during the initialization or runtime of the Sisense context, such as incorrect configuration, invalid authentication, or network-related issues.
Parameters
| Parameter | Type | Description |
|---|---|---|
error | Error | The error object containing details about the issue. |
errorDetails? | object | Additional details about the error, such as the component name and props that caused this error. |
errorDetails.componentName? | string | The name of the component that caused the error. |
errorDetails.componentProps? | unknown | The props of the component that caused the error. |
Returns
ReactNode | void
showRuntimeErrors
showRuntimeErrors?:
boolean
Boolean flag to show or hide run-time errors that involve Sisense context in the UI. Example errors include incorrect Sisense URL or invalid authentication. Note that this flag does not hide run-time errors in the console. If disabled - it's recommended to specify an onError callback to handle errors.
If not specified, the default value is true.
Sisense Authentication
enableSilentPreAuth
enableSilentPreAuth?:
boolean
Boolean flag to enable sending silent pre-authentication requests to the Sisense instance. Used to check if user is already authenticated, check is performed in an ivisible iframe. Used only with SSO authentication. If not specified, the default value is false.
ssoEnabled
ssoEnabled?:
boolean
Single Sign-On toggle.
Set to true to use SSO authentication. When true, this overrides any other authentication methods. Defaults to false.
token
token?:
null|string
Token for bearer authentication.
To signify that the token is pending (e.g., being generated), set the value to null. This is supported for React and Vue only.
useFusionAuth
useFusionAuth?:
boolean
Flag to delegate authentication to Fusion.
Defaults to false.
wat
wat?:
null|string
To signify that the token is pending (e.g., being generated), set the value to null. This is supported for React and Vue only.