Property attributes

The attributes of properties are defined in this documentation.

Property attributes are as follows:

  • Name – an internal name that uniquely identifies the property
  • Label – the name of the property that is shown in user interfaces. This can be translated in resource bundles associated with the connector so that the label is shown in your native language.
  • Description – information about the property that is shown in tool tips when you hover over a property label. This can also be translated into various native languages.
  • Scope – properties are defined to apply to connections or actions, and further can be defined to apply only to source or target actions. A property with the scope Connection displays when a connecction is being configured. A property with the scope Source or Target or Any Action displays when configuring a source, target, or any action respectively.
  • Type – a property’s type can be set to any of these values:
    • String – a string value.
    • Integer – an integral value.
    • Boolean – a boolean value.
    • Datetime – a date/time value. Additional property attributes, Include Date, and Include Time, determine whether the date/time picker will include date or time respectively.
    • Multiline – a string value which can have multiple lines. A text area is displayed for this property value rather than a single-line entry field.
    • Masked – a masked string value. Fields with sensitive data, such as passwords, should have type Masked so that their value is not displayed.
    • Table – a table property contains columns. To define the columns of a table, properties beneath the table property must be named <table>.<column> where table is the name of the table property and column is the identifier of the column. Additional property attributes define the behavior of the table.
      • Can Add Rows – allows for rows to be added to the table.
      • Can Select All – allows for multiple selection of rows in the table.
      • Can Search – displays a search box above the table so that table cells can be searched.
      • Can Sort – for a column property of a table, this determines whether ascending and descending sort icons are displayed for the column.
    • Input File – a file that is used for reading.
    • Output File – a file that is used for writing.
    • Label – a string that is displayed in the user interface (advanced use only).
    • Button – a button that is displayed in the user interface (advanced use only).
  • Required – determines whether a value for the property must be provided.
  • Advanced – some properties are not intended for common use and should only be displayed if a user enabled the Advanced view of properties. The Advanced toggle defines whether a property should only be seen in the basic or advanced view.
  • Default – a default value can be provided for a property.
Additional property attributes are found under the More Attributes link in the properties editor. These include:
  • Short Command – when properties are represented by a command line, the Short Command is the terse value for the command line option.
  • Long Command - when properties are represented by a command line, the Long Command is the verbose value for the command line option.
  • Validation Expression – a regular expression that defines valid values for the property.
  • Validation Message – a message to be returned if the property value is invalid according to the validation expression evaluation.
  • Maximum Length – the maximum length for string property values.
  • Minimum Value – the minimum value for integer property values.
  • Maximum Value - the maximum value for integer property values.
  • Multiple Columns – Determines whether the property appears on its own line in the user interface, or may appear side-by-side with an adjacent property.
  • Hidden – specifies that the property is not displayed in the user interface.
  • Read Only – specifies that the value of the property cannot be edited.
  • Names Action – specifies that the property’s value shall be used when determining the name of a schema generated by this connector.