Skip to main content

Edit Properties

Edit Properties are how Simflofy creates configuration fields for all types of connectors and processors.

EditProperty represents a single field in a connector or processor configuration.

Attributes

editPropertyType: The type of input created in the UI, uses the EditPropertyType enumeration. Default is EditPropertyType.TEXT

EditPropertyTypes
  • CHECKBOX - creates a checkbox
  • DATETIME - creates a datetime-local input with the format yyyy-MM-dd HH:mm
  • TEXT - basic text input
  • TEXTAREA - basic textarea. 5 rows, stretchable
  • INTEGER - creates a number input with "step" set to 1
  • LONG - creates a number input with "step" set to 1
  • DECIMAL - creates a number input with "step" set to any
  • DOUBLE - creates a number input with "step" set to any
  • READONLY - generates a block of read only text
  • PASSWORD - generates a password input with an attached button to show the password
  • HIDDEN - creates a hidden input
  • INTERVAL - creates a combination number/dropdown combination. Example value would be 5m for 5 minutes
  • CODE - creates a javascript code block using the ace.js library
  • SELECT - creates a select dropdown with supplied options. Can be flagged with 'multiple' for a multi-select
  • INFO - like the READONLY type, except it is formatted using bootstrap's alert-info class. Can accept raw html at text to enable adding links
  • RADIO - creates a set of radio button using supplied options
  • TAGS - creates a text input which takes individual tags as input. Use this for comma delimited lists

id: String. A string representing the property's unique key. Will be used to set the id and name attribute for an input in HTML.

displayName: String. The name of the field the user will be see.

description: String. An optional field to further explain how the property functions.

value: String. Represents the current value of the property. Empty by default. Will need to be parsed for non-string inputs

multiValued: Boolean. Only usable for SELECT types, flags the property to be a multi-select.

readOnly: Boolean. Flags the field as read-only. Requires the editPropertyType to be READONLY

options: List<EditPropertyOption>, which are simple key/value objects with a Display and Value field. Used by SELECT and RADIO to supply options

validator: TEXT only. Run client side checks on text fields. Validator must produce a true for illegal values using js regex.test(str).

Validator Example

[^A-Za-z0-9\\/\\s] will detect if non-alphanumeric, slash, or whitespace characters are present and show the input as invalid. Note the negation carat (^) at the front

minValue: Long. The minimum allowable value for a field. For Number fields, this will set the min HTML attribute. Optionally, for DATE fields, supply a timestamp to enforce as the earliest allowable date for the field. For TAGS fields, this will be the minimum allowable tag size

maxValue: Long. The maximum allowable value for a field. For number fields, this will set the max HTML attribute. Optionally, for date fields, supply a timestamp to enforce as the latest allowable date for the field. For TAGS fields, this will be the maximum allowable tag size

Methods

All attributes have a get/set methods.

Last updated on by Carolyn Satchell (Kat)