Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldTypeDescriptionExample
name
StringName of the connector displayed on the data sources page. Overrides the value returned by getName() method.
description
StringDescription of the connector displayed on the data sources page
logo
StringPath to the logo 64x64px image file. Should be placed inside the same package as custom connector main class.
wizard
BooleanDetermines 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 ObjectsContains steps of which the connector settings wizard is composed
steps[].index
IntegerIndex of the step
steps[].name
StringName of the step
steps[].description
StringDescription of the step
steps[].elements[]
Array of ObjectsContains elements that are displayed after each other inside the table with two columns. 
steps[].elements[].id
StringID of the element, is stored in data-id attribute.

Values of all elements are stored in hidden <span> elements below the step description:

Code Block
languagexml
<div style="display:none">
	<span data-value="false" data-id="el_9"></span>
	<span data-value="tests" data-id="el_5"></span>
	<span data-value="second value" data-id="el_2"></span>
	<span data-value="test" data-id="el_1"></span>
</div> 
steps[].elements[].label
StringLabel of the element. Content of <th> element
steps[].elements[].type
String

Type of the element. Available element types:

  • INPUT_SELECT
  • INPUT_RADIO
  • INPUT_TEXT
  • INPUT_TEXTAREA
  • INPUT_DATE
  • INPUT_NUMBER
  • INPUT_BOOLEAN
  • HTML
  • LINK
  • PASSWORD
steps[].elements[].property
StringProperty corresponding to PropertyValueApi provided by DataProviderApi implementation. Collected input values from elements are stored to these properties. 
steps[].elements[].value
StringDefault value 
steps[].elements[].values
Array

Contains values that are displayed in the select and radio fields. Supported in element types:

  • INPUT_SELECT
  • INPUT_RADIO
Code Block
.. "values" : [ "a", "b" ], ..
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. 

...