Parameters

For each resource, action, or workflow, the platform administrator can add an unlimited number of parameters of one of the following types:

• “Array” — a list of values;
• “Boolean” — a boolean value;
• “Date” — a date;
• JSON — text in JSON format;
• “Entities” — an entity, one of whose parameters can be selected as the value;
• “Enum” — an enumeration of values with a key and a displayed value;
• “List” — a list of values with the ability to select one of them;
• Markdown — text in Markdown format;
• “Number” — a number;
• “Object” — an arbitrary object in JSON format;
• “Percentage” — a percentage;
• “String” — a string;
• YAML — text in YAML format;
• “Teams” — teams;
• URL — a string in URL format;
• “Users” — users.

Resources

Once a parameter has been added for a resource, it is displayed for all entities of that resource, both in their cards and in the catalog table. A default value can be set for each parameter. The value of each parameter can be changed individually for each entity.

Whether parameters are filled in is checked for each entity, and the check result is shown in the header of the entity’s card.

Synchronizing resource parameters

For various reasons, entities may end up with parameters that the resource no longer has. To remove such parameters, use the “Synchronize parameters” button in the resource menu.

When synchronizing parameters:

• the identifier of each resource parameter is retrieved;
• the list of parameters is retrieved for each entity of the resource;
• entity parameters whose name does not match any of the resource’s parameter identifiers are removed from the entity’s specification.

Actions and workflows

Each action and workflow has a user form consisting of parameters that the user must fill in when launching it.

Restrictions

The identifier of each parameter must:

• contain only the characters a-z, A-Z, digits, or underscores;
• not start with a digit.

Configuration

• “Editable parameter” — for each parameter, you can allow or disallow the user from editing it. If editing is disallowed, the user will not be able to change the parameter’s value when launching actions or workflows, meaning the default value will always be used.
• “Required parameter” — each parameter can be either required or optional. The value of a required parameter cannot be empty when launching actions or workflows. The value of an optional parameter, however, can remain empty without affecting the action’s operation.
• “Hidden parameter” — a hidden parameter is not displayed in entity tables and cards, or when launching actions or workflows.

Parameter types

Date

A parameter of type “Date” can hold a date value with a user-defined format. In the specification, the value is always stored in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ).

Parameter configuration

• “Format” — configures how the date is displayed. If no format is explicitly set, the default format is used: YYYY-MM-DDTHH:mm:ss.sssZ. A description of the format configuration is available in the Day.js documentation. The format setting affects:
  • how the date is displayed in entity tables and cards;
  • the parameter’s value when launching actions or workflows.
• “Current date by default” — substitutes the current date as the default value when editing entities, as well as when launching actions or workflows.
• “Default value” — a predefined default value. Not applied if the “Current date by default” toggle is enabled.

When launching actions or workflows, values cannot be substituted into a “Date”-type parameter using Go template.

List

A parameter of type “List” allows selecting a single value from a predefined list.

Enum

A parameter of type “Enum” allows selecting a single item from a predefined list. Unlike the “List” type, the “Enum” parameter uses a key-value pair, where the key is stored in the specification and the value is displayed to the user. This allows the displayed text to be changed without changing the keys.