Import the plugin Recipes from the Cloud. (Software Maintenance Required)
Built with v10.
Summary
The Plugin Recipes automates the creation of models and recipes using already existent Tags within your solution.
Initial Setup
When importing the plugin for the first time, the necessary tables must be created if they do not already exist.
To recreate these tables, set the following Tag Values:
- RecipeTableConfirmString: DELETE
- RecipeTablesConfirmation: 1
In the bottom-left corner of both the Model and Recipe screens, there is a small question mark button (?) that provides a Console for the User. When the user clicks and holds the button, the console view temporarily opens, allowing quick access to diagnostic information. If the user double-clicks the button instead, the console remains permanently open until manually closed. This feature is useful for advanced users who need to inspect or interact with the underlying system.
Model Display
This screen allows you to create (New Model), edit (Edit Model), open (Open Model), Delete (Delete selected Model) Models and go to the Recipes Page (Recipes)
Model Creation
This screen is where you create new Models (New Model):
Main Fields:
| Field | Description |
|---|---|
| Model Name | Text field where the user defines a unique name for the model being created. This name will be used to identify the model across the application. |
| Model Description | (Optional) Multi-line text area used to provide a detailed description of the model’s purpose, behavior, or scope. Useful for documentation and maintenance. |
| Choose Element | Tree-view list containing available tags or elements (e.g., SetPoints, I/O tags, variables). Add Tag: Adds the selected tag(s) from the tree (Choose Elements) to the Tag Table below. Remove Tag: Removes the selected tag(s) from the Tag Table (not from the tree view). |
| Tags Table | Displays the list of tags that have been added to the model. Each row shows: Tag Name: Identifier of the selected Tag; Description: Optional field where the user can enter a brief explanation of the tag’s role in the model. |
| Save Model | Saves the model with the specified configuration and associated tags. |
Note: The tags used for model creation must be outside the “Root Tags” folder.
Recipes Display
This screen allows you to create new recipes (New Recipe), edit existing ones (Edit Recipes), open saved recipes (Open Recipes), delete selected recipes (Delete Selected Recipe), load recipes (Load Data) and navigate to the main Recipes page (Recipes).
Recipe Creation
This screen is where you create new Recipes (New Recipe):
To create a new Recipe, you must first create a Model. Otherwise, you will receive the following message:
“No Model has been created, please create a Model First.”
Main Fields:
| Field | Description |
|---|---|
| Recipe Name | Text field where the user defines a unique name for the recipe being created. This name will be used to identify and manage the recipe across the system. |
| Recipe Description | (Optional) Multi-line text area used to provide a description of the recipe’s purpose, context, or operational details. Helpful for documentation and operator understanding. |
| Recipe Model | Drop-down list where the user selects an existing model to base the recipe on. The model defines the structure (tags) of the recipe. If no model is available, a new one must be created. |
| New Model | Opens the Model Creation screen to allow the user to create a new model. Required if no model has been defined yet. |
| View Model | Opens a view of the currently selected model, allowing the user to review the associated tags and structure. |
| Tags Table | Table displaying the tags defined by the selected model. Each row require the user to input the corresponding Tag Value for that tag. |
| Save Recipe | Saves the recipe using the entered information and tag values. Requires a selected model and a valid recipe name. |
Load Data
The Load(Load Data) button retrieves the values assigned to each tag in the selected recipe and applies them directly to the corresponding setpoints or control tags in the project. In essence, it executes the recipe by pushing its configured values to the live system, updating the actual process variables accordingly.
In this section: