Connector template settings

Creating a Connector from a template allows us to explicitly specify what properties a new Connector should have via the _definitions.yaml file. Some properties take a string input or a boolean, whilst others take one of the 3 settings: hide, optional and required.

• hide - do not display the property in the Connector creation window
• optional - disply the property, but make it optional
• required - display the property and make it required

By default, most properties are hidden.

Properties

ConnectorTitle

The title of the Connector template

Default value: String

CredentialSelect

Allows a connector configuration to read oauth access tokens from one or more existing oauth-enabled connectors

Default: hide

AccessCodeServiceEndpoint

The endpoint used by the OAuth-compatible API to prompt the user for authorization. Normally, this endpoint should ask the user to login, agree to allow access to specified scopes and then return an authorization code which can be exchanged for an access token

Default: hide

AccessTokenServiceEndpoint

The endpoint which provides the API access token in exchange for the authorization code

Default value: hide

ApiEndPoint

The Url of the API endpoint for the Connector to use

Default value: String

UserName

Input to specify the user name

Default value: hide

UserPassword

Input to specify the user password

Default value: hide

ClientId

Input for a client id if present

Default value: hide

ClientSecret

Input for a client secret if present

Default value: hide

Personalized

When set to false the connector only runs once at the start of a Component's lifecycle e.g. initial Card render. This option is aimed at shared data that doesn't change often and can be shared across multiple users e.g. weather data. When set to true the Connector will make individual requests each time a component is rendered. This option works well with dynamic and personalized data that requires OAuth authorization e.g. displaying the user's latest code commit.

Default: true

ApiKey

The API key used to authenticate with the API service

Default value: hide

ServiceUrl

If the API endpoint Url needs to be dynamic e.g. varies between production and development environments, this field can be used to input the endpoint dynamically by the user during the Component creation

Default value: hide

ServiceUrlHint

A hint to explain the input to the user shown bellow the ServiceUrl input

Default value: hide

XML2JSON

Input to specify if XML to JSON conversion is necessary

Default value: hide

ImpersonateOAuth

Generally, OAuth is used to retrieve individual-level data, however if an API you use requires OAuth for data that would normally be shared between multiple users you can set the Connector to 'impersonate' OAuth for other users to access that data

Default value: hide

Interface

Specifies the interfaces used by the Connector

Default value: hide

Custom (1-3)

Specify whether an input for custom data should be shown

Default value: hide

CustomLabel(1-3)

Specify the label for custom data input

Default value: hide

CustomHint(1-3)

Specify the hint to show bellow the custom data input

Default value: hide

Scopes

This specifies the scopes that will be asked to give permission to access. Scope will return an array of elements and to add a scope you can use the following notation:

Scopes:
- ScopeName: scopeName
  ScopeDescription: Scope Description
  IsDefault: false

IsDefault specifies whether the scope is required and if set to true will disable the toggle for the user.

Default value: hide