Manage Recipe Body#

Recipe.Edit

Overview#

This operation is used to set and manage the Recipe Body.

Setup#

No specific setup is required other than to meet the precondition of the transaction.

Preconditions#

• The Recipe exists in the system and it is Active.

Sequence of Steps#

Step 1: Manage Body#

Once the Recipe has been created, proceed to specifying the Recipe Body. Open the Body tab and fill in the required fields:

1. Specify the Source of the Recipe Body, by selecting one of the following options:

   • DownloadedFromEquipment - in this case, a Resource whose RecipeManagement property is enabled and whose automation mode is online and that supports Recipe download, must be selected, as well as the Resource's local Recipe name. In this case, the format is always binary; press the button Get Recipes to retrieve a list of available Recipes at the Resource.

   • EquipmentSupplier - in this case, the user must specify the format:

     • Text, a file can be uploaded and optionally edited in the Body Text.
     • Binary, a file must be uploaded.
     • URL, the URL must be provided in the Body text.

   • HumanEdited - in this case, the user must specify the format:

     • Text, a file can be uploaded and optionally edited in the Body Text.
     • Binary, a file must be uploaded.
     • URL, the URL must be provided in the Body text.

   • None - in this case, the Recipe contains no Body.

2. Optionally, select the Format of the Recipe Body. In case the selected Recipe Body Source was None, the Recipe Format will automatically be set to Null; otherwise you wil be prompted to select one of the following Recipe Formats:

   • Binary - set as default for DownloadedFromEquipment, but can be overridden to Text.
   • Text (default), Binary, URL - for Human Edited / Equipment Supplier.

3. Provide a Body for the Recipe. In case the selected Source was None, the Recipe's Body can be left blank; otherwise content must be entered in this field:

   • For DownloadedFromEquipment, the user must specify a Resource (with Resource property IsRecipeManagementEnabled set to true and Automation Mode set to Online) and a resource recipe (retrieved with the use-case Get Recipes At Equipment).
   • For HumanEdited / EquipmentSupplier:
     • If Format = URL - provide a URL.
     • If Format = Binary - provide a file.
     • If Format = Text - optionally, load a file and edit the contents manually.

4. Select Update to complete the operation.