Parameters

Common settings

These settings are standard common settings for all types of parameters.

Common settings

{
    "name": <String>,
    "label": <String>,
    "help": <String>,
    "required": <Boolean>,                // default: false
    "default": <Object>,
    "advanced": <Boolean>                 // default: false
}

name

• Type: String

• Required

• An internal parameter name. This is the key to access the value in the resulting object.

• Can contain arbitrary characters.

• Avoid setting it to any of the Make reserved words.

label

• Type: String

• What the user sees in the UI instead of the parameter name.

help

• Type: String

• A more detailed description about the parameter and/or how to use it. Used when the label alone is insufficient.

type

• Type: String

• Required

• Type of the parameter. Each type has its own documentation page.

• Always enter types in lowercase.

• Available types of parameters are:

  • Array - An array of items of the same type

  • Boolean - A true or false value

  • Buffer - A binary buffer (file data)

  • Cert - A certificate in PEM format

  • Collection - An object with key: value pairs

  • Color - Hexadecimal color input

  • Date - Date or date with time (ISO 8601)

  • Email - Allows only a valid email address to be filled in

  • File - A file selection for use with RPCs

  • Filename - A file name with extension

  • Filter - An advanced parameter used for filtering

  • Folder - A folder selection for use with RPCs

  • Hidden - A parameter that is hidden from the user

  • Integer - A whole number

  • JSON - A valid JSON string

  • Number - A number that can include a decimal or fractional parts

  • Password - Marks passwords and secrets when creating a connection to avoid exposing them

  • Path - A path to a file or a folder

  • Pkey - A private key in PEM format

  • Port - A whole number in the range from 1 to 65535

  • Select - A selection from predefined values (dropdown or checkboxes)

  • Text - A plain text value

  • Time - Time in hh:mm format

  • Timestamp - A timestamp in Unix epoch format (number of second since 01/01/1970 00:00:00 UTC)

  • Timezone - A time zone name in IANA ID format (e.g. Europe/Prague)

  • Uinteger - A positive whole number, 0 and above

  • URL - A URL address

  • UUID - UUID

mappable

• Type: Boolean

• Default: true

• Specifies if the user can map a value to the field by inputting a value from another module, manually typing it, or using functions. When set to false, the user can only select a value instead. Used for types such as select or boolean.

editable

This property should only be used in Connection parameters. For module parameters, use mappable instead.

• Type: Boolean

• Default: false

• Specifies if the parameter is editable. Use this property to set parameters that should be possible to change when users want to update a connection.

required

• Type: Boolean

• Default: false

• Specifies if the parameter is required. The module will show an error when the user tries to save it without providing all the required parameters.

default

• Type: The same type as the parameter

• Specifies the default value of the parameter.

advanced

• Type: Boolean

• Default: false

• Specifies if the parameter is advanced or not. Advanced parameters are hidden by default and can be shown by selecting a checkbox in the module UI. Advanced parameters should be put at the end of the list, for better UX.

Advanced Settings

disabled

• Type: Boolean

• Default: false

• If set to true, the field is disabled by default.

rpc

• Type: Object

• Adds an extra button to the field which opens an extra form. When the form is submitted, a specified RPC is called and the result is set as a new value of the parameter. When the RPC outputs an array, the options are shown to the user so they can pick which one to map.

Available parameters:

Parameter	Type	Specification
label	string	The text which is displayed on the button.
url	string	The URL of the RPC to be called. rpc://myRpcName
parameters	array	An array of parameters for the RPC form. Uses regular parameters syntax.

semantic

• Type: String

• Specification of a semantic type

• Formatted as type:meaning . Commonly used values: file:data and file:name, to enable easy mapping of files.