Runtime Parameter Model and API

Name

Type

Description

ParameterType

RuntimeParameter
Type

Get the type of parameter that is being exposed.

ID

Integer

Gets the ID.

Name

String

Gets the name.

EquipmentParameterDescription

String

Gets the Equipment parameter description.

FormulaParameterDescription

String

Gets the Formula parameter description. It will be null if Formula parameter mapping is not available for a Capability parameter.

CapabilityName

String

Gets the name of the capability the parameter belongs to.

Empty string is returned for Formula parameters.

Alias

String

Gets the instance name of the capability the parameter belongs too.

Empty string is returned for Formula parameters.

DataType

DataType

Gets the data type. (See DataType Enum)

CustomDataType
Name

String

Gets the name of the custom data type. Returns an empty string if the DataType is Boolean, Double, Integer, or String.

Group

String

Gets the name of the group the parameter belongs to.

Target

Object

Gets or sets the value of the target. The data type of the target will match the DataType of the parameter.

MinValue

Object

Gets the minimum value. Null is returned for undefined or for types that don’t support MinValue.

MaxValue

Object

Gets the maximum value. Null is returned for undefined or for types that don’t support MaxValue.

UnitOfMeasure

String

Gets the unit of measure.

ExtValues

ParameterExtensions

Used to get and set the extension values. (See ParameterExtensions)

Name

Description

GetAll(string, RuntimeParameterType)

Returns all the parameters currently being used by the assigned formula/recipe.

If the equipment currently has a formula assigned, the RuntimeParameterType is ignored.

Change(RuntimeParameter)

The passed in runtime parameter is used to update values on the server.

Change(ICollection
<RuntimeParameter>)

The passed in collection is used to update values on the server.

Name

Description

GetAllFormulas(string equipmentName)

Return all approved formulas available for execution for the given equipment.

AssignFormula(string equipmentName, string formulaName)

Assigns the formula to equipment. Uses the default batch size.

AssignFormula(string equipmentName, string formulaName, double batchSize)

Assigns the formula to equipment. Uses the passed in batch size.

GetAllRecipes(string equipmentName)

Return all approved recipes available for execution for the given equipment.

AssignRecipe(string equipmentName, string recipeName)

Assigns the recipe to equipment. Uses the default batch size.

AssignRecipe(string equipmentName, string recipeName, double batchSize)

Assigns the recipe to equipment. Uses the passed in batch size.

Start(string equipmentName)

Starts the recipe when the recipe is assigned to equipment.
Starts downloading formula when the formula is assigned to equipment.