Custom REST Connector Config: Settings

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.

Properties

Provider Details

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, rest-facebook1 and rest-facebook2

This string has the following limitations:

• The null character (\u0000) cannot be part of a path name.
• The following character ranges are not rendered well: \u0001 - \u0019 and \u007F - \u009F.
• The following character ranges are not allowed: \ud800 - \uF8FFF, \uFFF0 - \uFFFF, \uXFFFE - \uXFFFF (where X is a digit 1 - E), \uF0000 - \uFFFFF.

RetryPolicyConfigs Details

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 members have the following properties:

UIParameters Details

The UIParameters object is an optional object that you can add to the Settings object inside your configuration file. This object displays a UI in the ElastiCube Manager for passing information for Oauth2 authentication.

During OAuth2 authentication, the resource provider requires certain details such as the ClientId and ClientSecret to authenticate the user and provide the connector with access to the requested resources. The ClientId is a string used by the resource provider’s API to identify the application, and is also used to build authorization URLs that are presented to users. The ClientSecret is used to authenticate the identity of the application to the resource provider’s API. The UIParameters object enables your users to dynamically define their ClientID and ClientSecret keys without having to expose these values in the configuration file.

In addition to ClientId and ClientSecret, Sisense has four other optional parameter types you can use to pass information to the resource provider. Each type of parameter provides some validation for the value the user can enter. For example, datetime parameters can accept only values in a date and time format, and integers can only accept numeric values.

You can redefine any of the fields to pass only the relevant information to the resource provider. The format of your code in the JSON file should be as follows:

{
   "parameter-name" :  "description;type"
}

These are the types you can use for UIParams:

For example, if you want to display a Date field that allows the user to open a datepicker, the code should be defined as follows:

"Date": "Select a date: datetime",

{
   "Date" :  "Select a date;datetime"
}

The follow code sample is an example of a UI window that includes the ClientID and Client Secret as well as the four additional parameters.

"UIParameters": {
   "ClientId": "Client id;string",
   "ClientSecret": "Client Secret;string",
   "Date": "Current Date;datetime",
   "New User?": "Boolean data;bool",
   "User ID": "Enter User ID;int",
   "Version": "Enter API Version;real"  
}

When defining the UIParameters object, the parameters are case insensitive, however, the parameters need to match the names of parameters expected by your resource provider’s API.

Within the Value fields, you can also pass Configuration parameters such as InMemory parameters as described here. For example, if you wish to define an access key that has been saved in memory, your user can enter [@accesstoken] as the value of the field.

Example

{
    "Settings": {
        "Provider": "rest-marketo",
        "ConnectorAssemblyFileName": "_rest.tag",
        "FileList":  [  
           "config.json",
           "oauth2Config.json"
        ],
        "DisplayName": "Marketo",
        "SchemaMapFile": "schema.json",
        "SchemaMapCatalog": "zendeskSchema",
        "StringColumnLength": 1000,
        "MaxDocs": 100,
        "FetchSize": 1000,
        "OAuth2Config": "oauth2Config.json",
        "IsAccumulativeSupported": true,
        "Parameters": {
            "uri": "https://123-OXE-123.mktorest.com",
            "startDate": "2016-01-1"
        },
        "UIParameters": {
            "ClientId": "Client id;string",
            "ClientSecret": "Client Secret;string",
            "Date": "Current Date;datetime",
            "New User?": "Boolean data;bool",
            "User ID": "Enter User ID;int",
            "Version": "Enter API Version;real"          
         },
        "RetryPolicyConfigs":[
         {
            "Name":"default",
            "NumberOfRetries":5,
            "Delay":70,
            "Factor":1,
            "ContinueOnError":true
         },
         {
            "Name":"quick",
            "NumberOfRetries":3,
            "Delay":10,
            "Factor":1,
            "ContinueOnError":true
         },
         {
            "Name":"average",
            "NumberOfRetries":10,
            "Delay":65,
            "Factor":1,
            "ContinueOnError":true
         }
      ]
    }
}