Recipe Exchange API

DownloadRecipeToBatchExecutive

This method downloads a recipe to the batch executive. The method returns a string that is included in the batch log. The method signature is:

string DownloadRecipeToBatchExecutive(
   RecipeInfo recipeInfo,
   string nodeName,
   bool bPermitDownloadOfCheckedoutItems,
   bool bPermitDownloadOfUnauthorizedItems
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

recipeInfo

Instance of RecipeInfo data contract

RecipeInfo

RecipeInfo instance

nodeName

The name of the DeltaV workstation with the Batch subsystem

String

Name of node 

bPermitDownloadOfCheckedoutItems

Permission to download checked-out recipes.

Boolean

True = allow download

False = do not allow download

bPermitDownloadOfUnauthorizedItems

Permission to download unauthorized recipes.

Boolean

True = allow download

False = do not allow download