The Settings object contains configuration parameters such as the name of the REST provider, the name of the connector to be displayed in the ElastiCube Manager, the maximum number of data records to be scanned when determining a document's schema, and additional Configuration parameters.
Provider system name. This name is used by Sisense to identify your connector and should start with the prefix "rest-" . For example, rest-marketo, rest-facebook, etc.
If you have multiple connectors using the same data source each with their own settings, the Provider system name should be unique, for example,
This string has the following limitations:
The value of this key should be set to _rest.tag when you want Sisense to automatically copy the REST Connector DLL file to you connector’s folder.
The advantage of this method is you do not need to add the Sisense REST Connector DLL file each time you upgrade Sisense.
When defining this key’s value, the FileList key must contain the name of your connector’s configuration files.
The list of configuration files associated with your custom connector.
Typically, the values of this key are config.json, and oath.json.
This key is only mandatory when ConnectorAssemblyFileName is set to _reg.tag.
Name of the connector to be displayed in the ElastiCube Manager. If no value is set, the value of Provider is displayed.
|The name of the file with the schema. This file must be located in the same directory as your other Custom REST files.|
|The name of the schema catalog.|
|StringColumnLength||Integer||No||The string column length for a table.|
Maximum number of records fetched from a resource. This is used to determine a data schema.
Number of records fetched before caching data. For example, if FetchSize = 1000 and PageSize = 400, three calls will be executed before buffering. On the third call it will be calculated that current number of fetched records is more than 1000 and the next execution will be stopped for buffering.
File name of the OAuth2 configuration file. This value should be the same name as the Oauth2 configuration file located in your Connector folder.
When True, accumulative builds are supported for the relevant tables within the ElastiCube Manager.
By default, this value is false.
To define which tables support accumulative builds, see AccumulativeSettings.
String -> String key-value pairs that can be used as parameters in other configuration sections. For more information, see Configuration.
The retry policy array defines how and when Sisense should retry to query a custom REST data source when an error occurs.
In the Actions (Tables) object, you define which errors trigger the relevant retry policy.
The RetryPolicyConfigs array has the following properties:
true: (Default) Continue execution.
false: Throw an exception and stop execution.