RecipePlus

Quickstart

1. RecipPlus Example
The recipe example is for a Hot Sauce manufacturing firm.
It has been designed for operators that will be required to input information about the Hot
Sauce being manufactured. Depending on the spice level of the sauce the ingredient data
will be saved in three different tag sets of the recipe. The ingredient recipe information is
then downloaded to a tag set in the controller and is used to animate the manufacturing
process.
The example consists of two files:
RecipePlusComplete.apa
RecipePlusController.acd

2. What are Recipes

The general purpose of a recipe system is to allow the user to read and write a set of
values to/from a set of tags in a single operation. The ingredient data values of the recipe
are saved into the recipe file and can be downloaded to/uploaded from a controller in a
single action. A single recipe can contain up to 15 000 ingredients. The recipe file can
also be restored into the RecipePlus Table during runtime to view the ingredient data
values from the recipe.
The RecipePlus Table is also used to modify the recipe data values during runtime. The
RecipePlus Table can be set as view-only to prevent modifications during runtime.
During runtime the values of the data set and tag set can be compared. Moreover, the
recipe system can also be used to compare two configured recipes or compare a data set
pair or a tag set pair of a single recipe.

3. RecipePlus Components
RecipePlus feature allows users to read/write a set of values to a set of tags in a single operation. The
RecipePlus can also be used to compare two recipes and determine their difference.
The RecipePlus consists of several components:

RecipePlus Setup used to specify whether recipe files will be a part of the HMI project or not,
and where the files will be stored for retrieval at run time.

RecipePlus Editor used to create and edit the recipe files by specifying the ingredients of the
recipe, the data sets, the tag sets and the recipe units. The editor can also be used to compare data
sets and tag sets within a single recipe.

RecipePlus table object used to display, modify and save the contents of a recipe at run time.
The table also shows the differences between the recipe data values and the tags associated with

the recipe (i.e. data set and tag set)

RecipePlus button object used to initiate recipe operations at run time (i.e. download, upload,
upload and create, save, restore)

RecipePlus selector object used to select from a list of created recipes

4. Steps to configure the RecipePlus setup

Follow steps a) to b) to configure the RecipePlus Setup

a) Double-click on
RecipePlus Setup.
The RecipePlus
Folder is near the
bottom of the
Explorer window

* b) Select where you

want the recipe files to be
saved.

*NOTE:
If you select Recipe files are part of the HMI project, all of the recipe files in the HMI project
will be included in the ME runtime application.

If you select Recipe files are NOT part of the HMI project, the recipe files will be saved
in an alternative location for recipe files at run time. When this option is selected, none of
the recipe files in the HMI project or in the specified folder will be included in the ME
runtime application.

5. Configure the RecipePlus Editor

5.1 Configure the General Tab of the RecipePlus Editor
Recipes have two tag settings that are used to determine the results of various recipe
operations during runtime.
The first tag is called the Status Tag and it shows the results of download and upload
operations. The result status of these operations can be start, successful or with
errors.
4

The second tag is called the Percent Complete Tag. The recipe system writes to this tag
during any recipe download/upload operation to show what percent of ingredients
currently being processed have been completed.
Follow steps a) to c) to setup the General Tab in the RecipePlus Editor.

a) Double-click on the
RecipePlus Editor,
located near the
bottom of the
Explorer window.

b) In the Runtime
recipe name box, type
in the name of the recipe.
This name will be
displayed at runtime.

c) Click on to add
the Status and Percent
Complete Tags.

5.2 Configure the Ingredients Tab of the RecipePlus Editor

In this section you will add and setup recipe Ingredients and the corresponding Data Sets
and Tag Sets.

Ingredients they can be either of type String or Numeric. If numeric, the user
can specify a minimum and maximum data value for the ingredient. Numeric
ingredients can be boolean, integer or floating point numbers. If you were to add a
type String ingredient, the Min and Max value field will be left empty and the
data type will be set to String. Note: One recipe can have up to 15000
ingredients.

Data Set Each recipe can contain up to 50 data sets. Each data set represents the
set of data values where each data value is associated with a specific ingredient.
The data sets are to be downloaded (or uploaded) to a controller. The data in the
Data Set is saved in the recipe file with the extension .rpp.

Tag Set Each recipe can contain up to 50 tag sets where each tag set represents
the set of tags to write to during a download (or read during an upload) operation.
Each of the tag names is associated with a specific ingredient.

To add a Tag to the

tag set of this
ingredient press
CTRL+T to open a
Tag Browser or
right-click and
choose the Tag
Browser from the
list.

Add/Rename Data Sets to the RecipePlus Editor

Follow steps a) to f) to add and rename Data Sets in the RecipePlus. Ensure that the
Ingredient tab of the RecipePlus Editor is open.

a) From the menu of

RSView Studio, click
on Recipe to open a
submenu.

b) Click on Rename Data

Set. This menu can be used
to also Insert, Delete and
Rename both Data and Tag
sets. Moreover, it is used to
compare two recipes or the
Data/Tag sets of a single
recipe.

c) Under Enter new

data set name delete
the current name and
type in a new name.

d) From the menu of RSView

Studio, click on Recipe to open
a submenu.

e) Click on Insert Data

Set, to insert a new data
set.

Note:
The same Recipe menu can be used to also Insert, Delete and Rename both Data and
Tag sets. Moreover, it is used to compare two recipes or the Data/Tag sets of a single
recipe. The compare functionality will be explained in more details towards the end of
this document.

5.3 Configure the Units Tab of the RecipePlus Editor

Follow steps a) to e) to configure the Units tab in RecipePlus Editor. We will add an
8

additional unit and rename the existing unit.

Units - A unit is a data set paired with a tag set. For example, you could pair 10
data sets with a single tag set. This pairing is called units. A single recipe can
contain up to 2500 recipe units. The maximum number of data sets is 50 and the
maximum number of tag sets is 50. It is the recipe units that are acted upon at
runtime (e.g. Download unit).

a) Select the
Units tab.

b) Click on Edit to edit

Unit 1. You can change
the name of the recipe
unit and also edit other
properties of the unit.

c) Under Unit Name type the

new name and select the Data
Set and Tag Set pair.

d) Click Insert to
insert a new Unit.

10

Note:

To delete a Unit, select the unit to be deleted and click on Delete.

At the end of the recipe configuration you will click on Close and will be asked to save
the recipe.

6. Additional RecipePlus features

6.1 Compare Recipe data sets
You can compare two data sets or two tag sets of a single recipe or between two recipes
configured in the application. To use this comparison functionality follow steps a) to g).
a) Open the
configured recipe by
double-clicking on it.

11

b) Under Recipe
menu select
Compare
Recipes.

c) Select Compare with a

Single Recipe to compare
the values of a single recipe.
If you need to compare
between two recipes then
select Compare across two
recipes.

d) Choose the recipe to do the comparison

with, by clicking on . The default
location of the recipe for this application is
located at: C:\Documents and Settings\All
Users\Documents\RSView
Enterprise\ME\HMI
projects\RecipePlusComplete\RecipePlus.
Select Recipe.rpp.

12

e) Select to
compare only
data sets of the
chosen recipe.

f) Choose which data sets to

compare using the downward
arrow.
Select DataSet#1_Mild and
DataSet#2_Hot.

g) Click Compare to
compare the data sets. A text
file will pop open to display
the results of the comparison.
The CompareReport.txt
will be stored in the
RecipePlus folder of this
application.

Note:
As mentioned above, you can also compare the data in the Tag Sets of a single Recipe or
compare the data in the Data Set and Tag Set of two separate recipes.

7. How to configure the RecipePlus display objects

After configuring the recipe we need to setup a display to view and modify the recipes
during runtime.

13

The sample application contains the following pre-designed RecipePlus display which is
also included in the library files of RSView Studio 4.0. This library file can be imported
into the displays.

Follow steps a) to b) to manually add all the display components of the RecipePlus
system. These components are RecipePlus Selector, RecipePlus Table and RecipePlus
Buttons. The purpose of these components has been explained in the RecipePlus
Components section of this document.

a) Click on the
Objects menu
item.
14

b) Click on
RecipePlus, then
select RecipePlus
Selector or
RecipePlus Table or
RecipePlus Button
and draw the object
on the open display

7.1. RecipePlus components Properties

RecipePlus Table:
During runtime the RecipePlus Table can be read-only. In this case the ingredient data
values of the recipes cannot be modified at runtime.
To select the read-only property do the steps a) to c).

a) Double-click on the
RecipePlus Table object of the
RecipeComponents display.
This property window can also be
used to modify other properties of
the recipe objects.

b) In the RecipePlus
Table Properties click on
the Recipe tab.

15

c) You can set the RecipePlus

Table to be read-only (cannot
modify at runtime), by
checking the View only
property.

RecipePlus Button:
The RecipePlus system has a button with five different action properties. The button
types and their functionality descriptions are summarized in the table below:

Button Type
Download

Description
Writes the data values of all the ingredients to the tags in the
controller.

Upload

Reads the ingrediant values from the tag set and saves them to the
data set in the recipe file.

Upload and
Create

Reads the tag values in the tag set and creates a new recipe unit by
writing those values to a new data set.
16

Save
Restore

Saves the data value changes made in the Table back to the recipe
file.
Restore means to read the recipe file and display it in the table.
Viewing the recipe in the table will show the user the data values in
the recipe, the data values currently in the controller and the tag
names used.

Review the configured button action properties to learn about how to set them up.
Follow steps a) to e) to learn how to setup button properties.
a) Double-click on the
configured buttons to
open the button
properties.

b) Click on the General tab

of the RecipePlus Button
Properties.

17

c) Using the downward

arrow, select the
Action of the button. In
this case it is
Download.

d) Click on the Label

tab of the RecipePlus
Button Properties.
e) In the Caption
space, you can type in
the text that you would
like to appear on the
button.

18

8. How to Read and Write Ingredients at Runtime

8.1 Restore a recipe unit into a Recipe Table
The RecipePlus Selector object is used to view all units of all the configured recipes.
You can select any of the units in the RecipePlus Selector and restore the ingredients
into the RecipePlus Table, using the Restore button.
Before using the Recipe Buttons the application of the two RecipePlus diagnostics tags,
Status Tag and Percent Complete Tag will be explained.
Read steps a) to b) and view the Diagnostics while using the buttons at runtime.
a) The Percent Complete Tag
can be used in combination
with a bar graph, showing the
percent progress of actions
executed with the Recipe
Buttons, i.e. Restore,
Download, Upload, Upload and
Create.
b) The Status Tag can be used, in
combination with a multistate
indicator, to show the status of the
button actions, i.e. Upload,
Download, and Upload and
Create. The status is either
Starting, Successful or With
Errors.

Follow steps a) to c) to restore a recipe unit into a table.

19

a) Use the navigation

buttons to scroll up/down
in the Recipe Selector to
select a Recipe Unit.

b) Press the restore

button to restore the Recipe
Unit selected in the Recipe
Selector into the Recipe
Table.

c) This area will display

the unit currently restored
in the RecipePlus Table.

8.2 Modify the ingredient data values

After restoring the recipe unit, the Recipe Table lists all of the ingredients, the
corresponding recipe values, controller values, the tags and a visual comparison indicator
between the recipe data values and controller tag values.
The definitions of what each column represents during runtime of a RecipePlus Table is
summarized below:
Column Name

Definition

Ingredient Name

Displays the Ingredient name of the recipe.

Current Value

Displays the current value in the tag associated

with the ingredient. This is last refreshed data
in the controller.

Recipe Value

Displays the recipe's data value for the

ingredient. This data value can be modified by
selecting the ingredient row in the table and
pressing Enter. This is the data in the Data Set.
When this Recipe Value is modified and saved
the values are stored in the Data Set and hence
20

in the RecipePlus file (.rpp).

Compare Status

If the tag value and the recipe data value differ,

an X appears in this column to alert the
operator of the difference.

Tag Name

Displays the name of the tag associated with

the ingredient in the tag set.

To modify the data values of an ingredient of a recipe unit, follow steps a) to d).
a) Using the navigation buttons,
scroll to the ingredient that you
would like to modify. Choose the
ingredient Tomato Sauce Spice
Mixture.

b) Click on the enter button to

open a keypad (numeric
ingredient) or keyboard (string
ingredient) popup. The
keypad/keyboard can be used to
input new data values.

c) Using the keypad, type the

new desired ingredient value
and press enter. You can use
your keyboard or the popup
keypad buttons to type.

After changing the value of the ingredient the Recipe column will update to the new
data value for the corresponding ingredient.
21

8.3 Using the RecipePlus Buttons

Using the buttons we can save the recipe data values, download to a controller, upload
from a controller and upload and create a new unit.
Follow steps a) to d) to save the recipe data values and download to a controller.
a) Press the Save
button to save the
modified ingredient
value to the recipe file.

b) The Compare column

indicates with an X that
the controller ingredient
value and the value in the
recipe differ.

c) Download the
recipe data to the
controller by
pressing the
Download
button.

d) To view the updated

controller tag value,
press Restore and view
the updated value in the
Current column of the
Recipe Table.

Follow steps a) to d) to Upload the controller values to the recipe and Create a new
Recipe Unit.
The new unit will represent a Green Hot Sauce. Using the same Recipe file we can make
multiple recipe units during runtime, allowing us to create both Green Sauce and Red
Sauce without going offline. Both of these units are using the same Recipe Ingredients
with different data values.

22

a) Press on the
Update and Create
button create a new
recipe unit.

b) Click on Unit Name to open

a keyboard popup and type in
Green Sauce Hot as the new
recipe unit name.

c) Press enter to complete

the addition of a new
Recipe Unit.

23

d) Check in the Recipe Selector

that the new Recipe Unit Green
Sauce Hot has been successfully
added.
The Status tag in the Diagnostics
should also display that the unit

24