Parameters

Common Settings

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

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

name

• Type: String

• Required

• Internal parameter name. This is the key to the resulting object.

• Can contain arbitrary characters.

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

label

• Type: String

• Required

• Parameter label for the user which is displayed in GUI.

help

• Type: String

• Parameter description for the user which is displayed in GUI.

type

• Type: String

• Default: text

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

• Always enter types in lowercase.

• Available types of parameters are:

  • ​array - array of items of the same type,

  • ​boolean - true or false value,

  • ​buffer - binary buffer,

  • ​cert - certifcate in PEM format,

  • ​collection - an object,

  • ​color - hexadecimal color input,

  • ​date - date or date with time,

  • ​email - allows only a valid email address to be filled in,

  • ​file - file selection,

  • ​filename - file name,

  • ​filter - an advanced parameter used for filtering,

  • ​folder - folder selection,

  • ​hidden - parameter of this type is hidden from the user,

  • ​integer - whole number,

  • ​number - a number,

  • ​path - a path to a file or a folder,

  • ​pkey - private key in PEM format,

  • ​port - a whole number in the range from 1 to 65535,

  • ​select - a selection from predefined values,

  • ​text - text value,

  • ​time - time in hh:mm or hh:mm:ss or hh:mm:ss.nnn format,

  • ​timestamp - unix timestamp,

  • ​timezone - time zone name (e.g. Europe/Prague),

  • ​uinteger - positive whole number,

  • ​url - URL address,

  • ​uuid - UUID.

required

• Type: Boolean

• Default: false

• Specifies if the parameter is required.

default

• Type: The type of 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 behind a checkbox in GUI.

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.

• 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.
parameters	array	An array of parameters of the extra form. Uses regular parameters syntax.

semantic

• Type: String

• Specification of a semantic type

• Formatted as type:meaning , for example file:data.