Recipe schema¶

BrowseName: RecipeSchema
SuperType: Object (BaseObjectType)
TypeView path: Tipi > Ricette > Schema ricetta

Set of variables/ingredients with which to configure one or more recipes.

Configuring the object

Configure the ingredients

Right-click Recipes, then select New > Recipe Schema: the new object appears.
To add ingredients, the node that contains the corresponding variables must be indicated: from Project, drag the node of interest onto the value of the Destination node property.
Double-click Recipe Schema: the editor for selecting ingredients opens.
Select the ingredients and click Apply.

Note

if the destination node contains variables nested in other variables, to display them and select them, in the editor’s toolbar, click , then select Show nested variables.

To automatically configure a table in the database in which to store the recipes, do the following:
1. To set the name of the table, type the name in the Table name property, otherwise leave the property without a value to name the table with the BrowseName of the Recipe Schema.
2. In the Store property, select the database desired (see Working with databases): a table with a column for each ingredient is automatically configured in the database.

Properties¶

Name	BrowseName	DataType	Description
Store	Store	NodeId	Database in which to store the recipes
Table name	TableName	String	Name to assign to the table of the database containing the recipes. If empty, the name of the table corresponds to the BrowseName of the Recipe schema.
Target node	TargetNode	NodeId	Parent node inside of which to select variables to use as ingredients
Timeout	Timeout	Duration	Timeout for the loading of values of the ingredients from UNIQO to the field variables.
Root	Root	Object

Methods¶

Create recipe¶

BrowseName: CreateRecipe

InputArguments

Name	DataType	Description
NewBrowseName	QualifiedName	Name of the new recipe
ParentId	NodeId	NodeId of the parent node of the Edit model node
ReferenceTypeId	NodeId
NamespaceIndex	UInt16	Namespace index

OutputArguments

Name	DataType	Description
NewRecipeId	NodeId

Execute Refactor Recipe¶

BrowseName: RefactorRecipe

InputArguments

Name	DataType	Description
Recipe	NodeId

Create edit model from recipe¶

BrowseName: CreateEditModelFromRecipe

InputArguments

Name	DataType	Description
SourceRecipe	NodeId	Source Recipe
TargetNode	NodeId
NewBrowseName	QualifiedName	New BrowseName
InPlaceEdit	Boolean	In-place edit
ParentId	NodeId	Parent NodeId
ReferenceTypeId	NodeId	Reference Type NodeId
NamespaceIndex	UInt16	Namespace index

OutputArguments

Name	DataType	Description
NewModelId	NodeId

Create edit model from recipe framework¶

BrowseName: CreateEditModelFromSchema

Create an Edit model with the Recipe schema ingredients.

InputArguments

Name	DataType	Description
TargetNode	NodeId	Node of the Edit model
NewBrowseName	QualifiedName	New BrowseName of the Edit model
InPlaceEdit	Boolean	In-place edit
ParentId	NodeId	NodeId of the parent node of the Edit model node
ReferenceTypeId	NodeId
NamespaceIndex	UInt16	Namespace index

OutputArguments

Name	DataType	Description
NewModelId	NodeId

Validate Tree¶

BrowseName: ValidateTree

InputArguments

Name	DataType	Description
Source	NodeId
Target	NodeId

OutputArguments

Name	DataType	Description
Result	Boolean

Copy¶

BrowseName: Copy

Copy in the Edit model the values of the ingredients on the PLC.

InputArguments

Name	DataType	Description
SourceNode	NodeId	Source node of values of the ingredients on the PLC
DestinationNode	NodeId	Target Edit model node for values
ErrorPolicy	CopyErrorPolicy	Error criteria

Create recipe¶

BrowseName: CreateStoreRecipe

Add a row in the database for a new recipe.

InputArguments

Name	DataType	Description
NewRecipeName	String	Name of the new recipe

Delete recipe on store¶

BrowseName: DeleteStoreRecipe

Delete a recipe in the database.

InputArguments

Name	DataType	Description
RecipeName	String	Name of the recipe to delete

Create edit model from recipe on store¶

BrowseName: CreateEditModelFromStoreRecipe

Create an Edit model from the ingredients and relative values of a recipe stored in the database.

InputArguments

Name	DataType	Description
SourceRecipeName	String	Name of the recipe in the database
TargetNode	NodeId	Node of the Edit model
NewBrowseName	QualifiedName	BrowseName of the Edit model
ParentId	NodeId	NodeId of the Edit model parent node
ReferenceTypeId	NodeId
NamespaceIndex	UInt16	Namespace index

OutputArguments

Name	DataType	Description
NewModelId	NodeId

Copy from recipe on store¶

BrowseName: CopyFromStoreRecipe

Copy the values of an existing recipe in the database into the Edit model.

InputArguments

Name	DataType	Description
RecipeName	String	Name of the recipe in the database
DestinationNode	NodeId	Target Edit model node
ErrorPolicy	CopyErrorPolicy	Error criteria

Copy to recipe on store¶

BrowseName: CopyToStoreRecipe

Copy the values of the recipe in the Edit model to the recipe in the database.

InputArguments

Name	DataType	Description
SourceNode	NodeId	Source Edit model node
RecipeName	String	Name of the recipe in the database
ErrorPolicy	CopyErrorPolicy	Error criteria

Events¶

Recipe application event¶

BrowseName: RecipeApplicationEvent