Page History
...
Field | Type | Description | Example | |||||
---|---|---|---|---|---|---|---|---|
name | String | Name of the connector displayed on the data sources page. Overrides the value returned by getName() method. | ||||||
description | String | Description of the connector displayed on the data sources page | ||||||
logo | String | Path to the logo 64x64px image file. Should be placed inside the same package as custom connector main class. | ||||||
wizard | Boolean | Determines whether the connector settings should be displayed in wizard mode. If true, content of steps element are then used to define particular step content. Window with parameters otherwise. | Properties mode: Wizard mode: | |||||
steps | Array of Objects | Contains steps of which the connector settings wizard is composed | ||||||
steps[].index | Integer | Index of the step | ||||||
steps[].name | String | Name of the step | ||||||
steps[].description | String | Description of the step | ||||||
steps[].elements[] | Array of Objects | Contains elements that are displayed after each other inside the table with two columns. | ||||||
steps[].elements[].id | String | ID of the element, is stored in data-id attribute. | Values of all elements are stored in hidden <span> elements below the step description:
| |||||
steps[].elements[].label | String | Label of the element. Content of <th> element | ||||||
steps[].elements[].type | String | Type of the element. Available element types:
| ||||||
steps[].elements[].property | String | Property corresponding to PropertyValueApi provided by DataProviderApi implementation. Collected input values from elements are stored to these properties. | ||||||
steps[].elements[].value | String | Default value | ||||||
steps[].elements[].values | Array | Contains values that are displayed in the select and radio fields. Supported in element types:
|
| |||||
steps[].elements[].required | Boolean | (Optional) Determines whether the field is required or not. If true, the user required to enter the values in this field. Empty means false. |
...
Overview
Content Tools