CommandMeta CommandMapping

Command Meta – Command Mappings

The command mappings are part of the command meta and contain more information on every datastore variable defined by a command. Some fields may not be present if their value was not set, e.g. in case no information is present to fill it with.

The following fields are defined for the command mapping.

Field name Description Example

Field name	Description	Example
`allowedValues`	A list of values that the variable is allowed to hold. Values not part of the allowed values are not accepted and should throw an exception. An empty list indicates that all values are allowed.	`[]`, `[ALL, NONE, A_PART_OF]` or `["Yes","No","Maybe"]`
`isAllowedValueSuggestion`	Boolean-flag that indicates if the given values defined in `allowedValues` are only meant as a suggestion. This means that the processor will be less restrictive when processing the command.	`true`, `false`
`range`	Object which defines an inclusive range for numerical mappings.	`{ "lowerLimit" : 0, "upperLimit" : 100 }`
`defaultConstant`	Default value of the variable for the case no value will be set in the context. NOTE: This value is not set with Java Commands as the default value is derived from the initialized value in the command itself.	`default://uri_to_repo`
`documentation`	A description for the datastore variable to explain what it is for. Can be shown to a workflow developer.	„The URI is needed to know what instance to clone. Use only github URIs!“
`group`	The name of the group of the variable. Only one of the variables within the same group needs to be filled with a value.	`Group_For_Uri_Inputs`
`deprecated`	Flag to tell if the mapping is deprecated and should not be used anymore.	`true` or `false`
`deprecatedDocu`	Tells why the mapping is deprecated. This can be shown to workflow developers.	Mapping is deprecated as the api does not support this functionality anymore!
`key`	Name of the datastore variable.	`gitUri`
`mandatory`	Flag that indicates if a value must exist in the datastore before executing the command.	`true` or `false`
`pattern`	A regex to check String values against. Only values that fulfill the regex are allowed.	`^.+World$`
`patternExample`	Examples of Strings allowed by the pattern. Used for user documentation so they know what is matched by the pattern.	HelloWorld, All Strings ending with World
`scope`	Determines whether the variable is to be read-only, written or both.	`read`, `write` or `both`
`type`	Data type of the variable.	`string`, `boolean`, `integer`, `decimal`, `char`, `array` or `object`

allowedValues

A list of values that the variable is allowed to hold. Values not part of the allowed values are not accepted and should throw an exception. An empty list indicates that all values are allowed.

[], [ALL, NONE, A_PART_OF] or ["Yes","No","Maybe"]

isAllowedValueSuggestion

Boolean-flag that indicates if the given values defined in allowedValues are only meant as a suggestion. This means that the processor will be less restrictive when processing the command.

true, false

range

Object which defines an inclusive range for numerical mappings.

{
  "lowerLimit" : 0,
  "upperLimit" : 100
}

defaultConstant

Default value of the variable for the case no value will be set in the context.

NOTE: This value is not set with Java Commands as the default value is derived from the initialized value in the command itself.

default://uri_to_repo

documentation

A description for the datastore variable to explain what it is for. Can be shown to a workflow developer.

„The URI is needed to know what instance to clone. Use only github URIs!“

group

The name of the group of the variable. Only one of the variables within the same group needs to be filled with a value.

Group_For_Uri_Inputs

deprecated

Flag to tell if the mapping is deprecated and should not be used anymore.

true or false

deprecatedDocu

Tells why the mapping is deprecated. This can be shown to workflow developers.

Mapping is deprecated as the api does not support this functionality anymore!

key

Name of the datastore variable.

gitUri

mandatory

Flag that indicates if a value must exist in the datastore before executing the command.

true or false

pattern

A regex to check String values against. Only values that fulfill the regex are allowed.

^.+World$

patternExample

Examples of Strings allowed by the pattern. Used for user documentation so they know what is matched by the pattern.

HelloWorld, All Strings ending with World

scope

Determines whether the variable is to be read-only, written or both.

read, write or both

type

Data type of the variable.

string, boolean, integer, decimal, char, array or object