RecipeManagement

[ Class ]

Provides functions for managing recipes using the RecipeManagement server extension.

Static functions

listRecipeTypes

Supplies a list of all existing system recipes.

listRecipeTypesEx

Supplies a list of all existing system recipes.

watchRecipeTypesList

Monitors the list of all recipe types that exist in the system for changes.

watchRecipeType

Monitors an existing recipe type in the system for changes.

getRecipeType

Provides the definition of a recipe type.

getRecipeTypeEx

Provides the definition of a recipe type.

createRecipeTypeFolder

Creates a new folder for recipe types.

createRecipeTypeFolderEx

Creates a new folder for recipe types.

renameRecipeTypeFolder

Renames a recipe type folder.

renameRecipeTypeFolderEx

Renames a recipe type folder.

deleteRecipeTypeFolder

Deletes a folder for recipe types.

deleteRecipeTypeFolderEx

Deletes a folder for recipe types.

createRecipeType

Creates a new recipe type.

createRecipeTypeEx

Creates a new recipe type.

updateRecipeType

Changes a recipe type.

updateRecipeTypeEx

Changes a recipe type.

renameRecipeType

Renames a recipe type.

renameRecipeTypeEx

Renames a recipe type.

deleteRecipeType

Deletes a recipe type.

deleteRecipeTypeEx

Deletes a recipe type.

listRecipes

Supplies a list of all existing system recipes.

listRecipesEx

Supplies a list of all existing system recipes.

createRecipeFolder

Creates a new folder for recipes.

createRecipeFolderEx

Creates a new folder for recipes.

renameRecipeFolder

Renames a recipe folder.

renameRecipeFolderEx

Renames a recipe folder.

deleteRecipeFolder

Deletes a folder for recipes.

deleteRecipeFolderEx

Deletes a folder for recipes.

createRecipe

Creates a new recipe type.

createRecipeEx

Creates a new recipe type.

getRecipe

Supplies the definition of a recipe.

getRecipeEx

Supplies the definition of a recipe.

watchRecipeList

Monitors the list of all recipes that exist in the system for changes.

watchRecipe

Monitors an existing recipe in the system for changes.

updateRecipe

Updates the definition of a recipe.

updateRecipeEx

Updates the definition of a recipe.

readFromTarget

Reads the current values from the target system.

readFromTargetEx

Reads the current values from the target system.

teach

Reads the current values from the target system and writes them into the specified recipe.

teachEx

Reads the current values from the target system and writes them into the specified recipe.

teachAsNewRecipe

Reads the current values from the target system and writes them into a new recipe.

teachAsNewRecipeEx

Reads the current values from the target system and writes them into a new recipe.

activate

Writes all values of a recipe into the target system, thus activating it.

activateEx

Writes all values of a recipe into the target system, thus activating it.

getActiveRecipes

Supplies a list of all active recipes.

getActiveRecipesEx

Supplies a list of all active recipes.

watchActiveRecipes

Monitors the list of all active recipes in the system for changes.

renameRecipe

Renames a recipe.

renameRecipeEx

Renames a recipe.

deleteRecipe

Deletes a recipe.

deleteRecipeEx

Deletes a recipe.

Interfaces

IRecipeOptions

Recipe management options

IRecipeTypeListResultObject

Result of a listRecipeTypes call.

FolderRecipeType

Definition of a recipe type folder.

RecipeType

Definition of a recipe type.

IRecipeListResultObject

Result of a listRecipe call.

FolderRecipe

Definition of a recipe folder.

Recipe

Definition of a recipe type.

IRecipeWatchOptions

Recipe management options for the watch functions.

IGetRecipeResultObject

Result of a getRecipe call.

IReadFromTargetResultObject

Result of a ReadFromTarget call.

IGetActiveRecipesResultObject

Saves a list of recipes.

IRecipeTypeGetResultObject

Result of a getRecipeType call.

IWatchResultObject

Result of a watch call.

RecipeManagement 1:

Available from version 1.10.1171.21