Recipe

About 4 min read

TwRecipe · Category: Operations

Settings

These settings are in the properties panel on the right while the widget is selected. The default value is the value the widget has when it is first added to a page.

Recipe

Setting	Type	Default	Description
Recipe Group Id recipeGroupId	Selection	—	Recipe group selected when the widget opens. If it is empty or no longer exists, the first group is selected. The applied recipe is written to the state tags under Internal.RecipeState (e.g. currentRecipeName, currentRecipe_[groupId]_Name); bind them to other widgets from the "Recipe state" section of the tag picker's System tab. Options: the list is filled from the project at runtime
Recipe Id recipeId	Selection	—	Recipe selected when the widget opens. If it is empty or not in the group, the group's preferred or first recipe is selected. Options: the list is filled from the project at runtime
Show Recipe Group Id Box showRecipeGroupIdBox	Checkbox	On	Shows a numeric Id box next to the group list, so a group can be selected by its id.
Show Recipe Id Box showRecipeIdBox	Checkbox	On	Shows a numeric Id box next to the recipe list, so a recipe can be selected by its id.
Enable Recipe Group Selection enableRecipeGroupSelection	Checkbox	On	When off, users cannot change the recipe group at runtime; only the configured group is used.

Buttons

Setting	Type	Default	Description
New showNewButton	Checkbox	On	Shows the New button, which creates a new recipe in the selected group.
Edit showEditButton	Checkbox	On	Shows the Edit button, which changes the name and description of the selected recipe.
Show Apply Button showApplyButton	Checkbox	On	Shows the Apply button, which writes the selected recipe to the devices after confirmation.
Import showImportButton	Checkbox	On	Shows the Import button, which loads a recipe from a CSV file after a preview.
Delete showDeleteButton	Checkbox	On	Shows the Delete button, which deletes the selected recipe after confirmation.
Save showSaveButton	Checkbox	On	Shows the Save button, which saves the table values to the selected recipe after confirmation.
Template showTemplateButton	Checkbox	On	Shows the Template button, which downloads a CSV template for the selected group.
Save as showSaveAsButton	Checkbox	On	Shows the Save as button, which saves the current values as a new recipe with a new name.
Export showExportButton	Checkbox	On	Shows the Export button, which downloads the selected recipe as a CSV file.
Read From Device showReadFromDeviceButton	Checkbox	On	Shows the Read From Device button, which fills the table with the current Tag values from the devices; the values are not saved.

Synchronization

Setting	Type	Default	Description
Show Apply Result Panel showApplyResultPanel	Checkbox	On	After a recipe is applied, shows a panel with the total, applied and failed item counts and the errors.
Ignore Null Values In Auto Tag Sync autoTagValueSyncIgnoreNull	Checkbox	On	When the group uses automatic Tag sync: Tags whose value is empty (null) do not change the value in the table.
Require Good Quality In Auto Tag Sync autoTagValueSyncRequireGoodQuality	Checkbox	On	When the group uses automatic Tag sync: the table is only updated from Tag values with Good quality.

Other settings

Setting	Type	Default	Description
Enable Flashing enableFlashing	Checkbox	Off	Makes the widget blink (an opacity pulse every second). Usually bound to an alarm condition.
Log Button logButton	Checkbox	Off	At runtime shows a chart icon when hovering the widget; clicking it adds the Tags bound to the widget to the log Tag list.

Bindings

In the Bindings (Rules) section of the properties panel, a Tag can be bound to the following properties of this widget with a Direct binding. The binding types (Direct, IntRange, FloatRange, Boolean, Bit) are the same for all widgets; they are described on the Widget Reference page.

title, visible, authorization, x, y, width, height, rotation, class, foregroundColor, backgroundColor, borderColor, borderStyle, borderWidth, borderRadius, borderTopLeftRadius, borderTopRightRadius, enableFlashing, logButton, recipeGroupId, recipeId, showRecipeGroupIdBox, showRecipeIdBox, enableRecipeGroupSelection, showNewButton, showImportButton, showTemplateButton, showExportButton, showEditButton, showDeleteButton, showSaveAsButton, showReadFromDeviceButton, showApplyButton, showSaveButton, showApplyResultPanel, autoTagValueSyncIgnoreNull, autoTagValueSyncRequireGoodQuality

Common sections

While this widget is selected, the properties panel also shows these common sections: General, Layout, Appearance, Bindings (Rules). These sections are described on the Page Editor page.