Functional explanation
The Recipe Manager shows the built-in EnvisionSCADA recipe manager on a page. It is used for loading, saving, and managing recipe parameter sets directly from runtime.
The object is useful when recipe handling must be part of the operator workflow on the current page instead of being handled from a separate screen. It combines the page design with recipe-oriented controls and the system numpad behavior used for numeric recipe entry.
Use it when operators must manage recipes as part of normal production work.
Setup workflow
Before the Recipe Manager can load or apply recipes at runtime, the recipe type, its variables, and the target link must all be in place. The object placed on the page acts as the target, while the recipe data and variable links are configured from within the Recipe Manager interface itself.
- Place the Recipe Manager object on a page and give it a clear Object Name. The Object Name identifies the object within the page design and is not a recipe target.
- Link the variables that make up the parameter set. On each variable set Recipe Targets to the name of the target the variable belongs to (or a comma-separated list when the variable belongs to several targets), and set Recipe Parameter Name to the name the recipe uses for that value. Both fields must be filled in before a variable takes part in a recipe. This is done on each variable's configuration page (Modbus TCP, OPC UA, EtherNet/IP, DNP3, MQTT, or Local Variables).
- From the Recipe Manager interface, use Link Targets to connect the recipe type to the targets the variables define. A target appears in that list as soon as one variable names it in Recipe Targets, with the {Device} placeholder resolved to the owning device name.
- Add one or more recipes to the recipe type. Each recipe stores a value for every linked variable.
- At runtime, operators select a recipe and Apply it to write all values to the linked variables, or Snapshot the current variable values into a new or existing recipe.
Runtime operations
The following actions are available to operators directly from the Recipe Manager object at runtime. Availability of each action depends on the user's group and the object's access control settings.
| Action | Description |
|---|---|
| Apply | Write the selected recipe's parameter values to all linked variables of the linked target. |
| Snapshot | Read the current values of all linked variables and save them as a new recipe or overwrite an existing one. |
| Add Recipe | Create a new, empty recipe in the current recipe type. |
| Edit Recipe | Edit the name, description, and parameter values of an existing recipe. |
| Delete Recipe | Remove a recipe from the current recipe type. |
| Import / Export | Import recipes from a JSON file, or export selected recipes to a JSON file. |
| Edit Recipe Types | Administrators only. Create, rename, and delete recipe types, manage target links and the Recipe Type Parameters from the gear icon. |
| Editor icon | Administrators only. Shown on every row of the parameter table. A solid icon opens the Recipe Type Parameters dialog on that parameter; a dashed icon means the recipe carries a parameter the recipe type does not declare yet and asks whether to add it. |
No rows match the filter.
Object name
Set the object name shown in the recipe manager decorator context.
| Setting | Description | Example | Units |
|---|---|---|---|
| Object Name | Name used to identify the Recipe Manager object. | RecipeManager | Text |
No rows match the filter.
Settings
Configure the numpad behavior used when operators enter numeric recipe values.
| Setting | Description | Example | Units |
|---|---|---|---|
| Recipe List Width | Width of the recipe list left of the splitter. The operator can drag the splitter; a drag in the designer updates this setting and is saved with the page. The minimum is 240 px, the maximum the object width minus 100 px. | 280 | px |
| Numpad | Enables the system numpad for numeric recipe parameter input. | true | Boolean |
| Decimal Symbol | Allows a decimal symbol on the system numpad when Numpad is enabled. | true | Boolean |
| Minus Symbol | Allows a minus symbol on the system numpad when Numpad is enabled. | true | Boolean |
No rows match the filter.
Theme
Configure the color theme applied to all elements of the Recipe Manager.
| Setting | Description | Example | Units |
|---|---|---|---|
| Outer Background | Background color of the outer recipe manager container. | #FFFFFF | Color |
| Frame Background Color | Background color of the inner frame panels. | #F8F9FA | Color |
| Input Background Color | Background color of the recipe value fields in the parameter table: the text fields, the selection lists and the checkbox cells. Slightly lighter than the frame by default, so the editable cells stand out from the reference columns. | #FFFFFF | Color |
| Reference Cell Color | Tint of the CurrentValue, Units, Min, Max and Description cells, which show the live values of the target variable. Laid over the frame color, so a semi-transparent value keeps the frame visible. | rgba(73, 80, 87, 0.12) | Color |
| Read-only Cell Color | Tint of a recipe value cell whose parameter has no variable in the selected target. The value cannot be written to that target on Load, so the cell is locked. | rgba(108, 117, 125, 0.16) | Color |
| Text Color | General text color used throughout the recipe manager. | #212529 | Color |
| Outer Border Color | Border color of the outer recipe manager container. | #CED4DA | Color |
| Frame Border Color | Border color of inner frame panels. | #DEE2E6 | Color |
| Table Border Color | Border color of table rows and cells. | #DEE2E6 | Color |
| Checkbox Background Color | Background color of unchecked checkboxes. | #FFFFFF | Color |
| Checkbox Border Color | Border color of checkboxes. | #CED4DA | Color |
| Checkbox Checked Background Color | Background color of checked checkboxes. | #0D6EFD | Color |
| Button Background Color | Background color of action buttons. | #0D6EFD | Color |
| Button Text Color | Text color of action buttons. | #FFFFFF | Color |
| Button Border Color | Border color of action buttons. | #0D6EFD | Color |
| Button Hover Background Color | Background color of buttons on hover. | #0B5ED7 | Color |
| Button Hover Text Color | Text color of buttons on hover. | #FFFFFF | Color |
| Selected Recipe Background | Background color of the currently selected recipe row. | #E8F0FE | Color |
| Selected Recipe Text Color | Text color of the currently selected recipe row. | #212529 | Color |
No rows match the filter.
Colors follow the theme. A color that is left at its default follows the Viewer colors of the active theme (the Viewer Background Color, Viewer Font Color, Viewer Row Hover Color, Viewer Row Alternate Color and Viewer Line Color parameters, resolved for the Dark or Light theme of the client), so the object switches with the theme like the Alarm Viewer and the Navigator. A color chosen in the decorator keeps that value on every theme; a Color Library name can be used to give it a value per theme.
Position / Size
Configure the position and size of the Recipe Manager object.
| Setting | Description | Example | Units |
|---|---|---|---|
| Height | Height of the object. | 400 | px |
| Width | Width of the object. | 800 | px |
| Top | Top position of the object. | 100 | px |
| Left | Left position of the object. | 100 | px |
| Z-Index | Stack order of the object relative to other objects on the page. | 10 | Integer |
No rows match the filter.
Access Control
Configure access control for the Recipe Manager object.
| Setting | Description | Example | Units |
|---|---|---|---|
| Access Control Enable | Enables access control evaluation for the object. | true | Boolean |
| Access Control | Expression controlling who can use or see the object. | SYSTEM.UserGroups == "Operators" | Expression |
| Access Control Filter | CSS filter applied when access control is active to alter the object appearance. | blur(0px) contrast(30%) | CSS filter |
No rows match the filter.
Visibility
Configure the runtime visibility and blinking behavior for the Recipe Manager object.
| Setting | Description | Example | Units |
|---|---|---|---|
| Visibility | Expression controlling whether the object is visible at runtime. | PLC1.RecipeEnabled | Expression |
| Blink | Expression or boolean controlling recipe manager blinking. | PLC1.AlarmActive | Boolean or expression |
| Blink Speed | Blink speed used during runtime. | 500 | ms |
| Blink Offset | Offsets the blink phase to stagger blinking between multiple objects. | false | Boolean |
No rows match the filter.
Notes
The Recipe Manager object requires recipes to be configured at Variables before they appear at runtime.
Recipe values are edited as text unless the recipe type declares the parameter as a Recipe Type Parameter with a Checkbox or Selection editor. A parameter whose target variable is a BOOL or Boolean variable is edited with a checkbox without any configuration. A Selection value that is not in the list is shown as Custom and blocks Load until a listed option is chosen. See the Recipes article under Advanced for the Recipe Type Parameters dialog.
Add Recipe, Edit Recipe, Delete Recipe, Add Parameter, value changes, Snapshot and Import require the Recipe Edit Right of the user group; Load requires the Recipe Load Right in addition to the write rights on each linked variable. Members of the Administrators group hold both rights. Buttons a user may not use are not shown.
With Part 11 compliance mode enabled and Download recipes to the process selected under Signature Required Actions, Load opens the Electronic Signature dialog and writes the values after a valid signature. Cancel leaves the target unchanged.
When Numpad is enabled, the Decimal Symbol and Minus Symbol options become available and control whether those keys appear on the numpad during recipe parameter entry.
Access control on the Recipe Manager restricts operator interaction with the entire recipe manager interface, including loading, saving, and editing recipe values.