Recipe element

In a recipe class, recipe elements are used to define which data belongs to this recipe.

A recipe element refers to a process variable whose value is to be saved in the recipe data.

Recipe elements can be added to the recipe definition using the Select variables dialogue. In addition to manually editing the Sort index parameter, the Sort recipe elements dialogue can be used to change the order of the elements.

At runtime, the list of all recipe elements can be called up via the recipe class object and displayed as a list in the user interface. In addition to the properties of the variables, such as the name/alias, the value, the data type, a language-switchable variable text, an upper and lower limit, further parameters for the display can be defined here in the recipe element. The sort index can be used for sorting the elements if this is to be independent of alphabetical sorting. The Text parameter can be used to define and display an additional language-switchable text for the recipe element that is independent of the variable text. The Default value parameter can be used in a special action to initialise the recipe buffer (see chapter Data transfer in general: Initialisation).

Parameters

Name Description of the
Definition active Determines whether the object definition is valid. (only Cross-Platform Server)
Comment Optional commentary on the object.
Sort index Defines the order of the recipe elements.
Default value Defines the default value for the recipe variable.
Text Localisable text for the object.
Variable Defines a variable whose value is to be contained in the recipe.

See also