ProcedureIDUnitRequirements
The
ProcedureIDUnitRequirements
item returns the set of unit requirements configured within the specified recipe structure.This table shows the input and output formats for this item.
Format | Description | ||
|---|---|---|---|
Input Format | Request: ProcedureIDUnitRequirements | ||
<ProcedureID> | is | ASCII - String, the unique path to the recipe step. This path begins with the CreateID . Use BLCreateID_x item to retrieve the CreateID . | |
for an Operation Recipe: | |||
<Operation Level> | is <CreateID> | ||
for a Unit Procedure Recipe: | |||
<Unit Procedure Level> | is <CreateID> | ||
<Operation Level> | is <CreateID> \t Operation Name | ||
for a Procedure Recipe: | |||
<Procedure Level> | is <CreateID> | ||
<Unit Procedure Level> | is <CreateID> \t UnitProcedure Name | ||
<Operation Level> | is <CreateID> \t UnitProcedure Name \t Operation Name | ||
Output Format | The ProcedureIDUnitRequirements item returns in this format: | ||
<UnitRequirements> | is | <NullList> | <UnitReqList> | |
<UnitReqList> | is | <UnitRequirement> | <UnitRequirement> \crlf <UnitReqList> | |
<UnitRequirement> | is | <UnitReqName> /t <UnitReqID> /t <UnitReqType> /t <UnitReqClassOrInstanceName> <AssocStepList> /t $END <DownstreamUnitReqList> | |
<AssocStepList> | is | <NullList> | /t <AssocSteps> | |
<AssocSteps> | is | <ElemID> | <ElemID> /t <AssocSteps> | |
<DownstreamUnitReqList> | is | <NullList> | /t <DownstreamUnitReqs> | |
<DownstreamUnitReqs> | is | <DownstreamUnitReqID> | <DownstreamUnitReqID> /t <DownstreamUnitReqs> | |
where <PhaseDesc> is: | |||
Field Name | Format | Description | |
<UnitReqName> | ASCII - String | Unit Requirement Name | |
<UnitReqID> | ASCII - Integer | Unique ID assigned to Unit Requirement | |
<UnitReqType> | ASCII - Integer | Unit Requirement Type Code:
1 = Unit Class
2 = Unit Instance | |
<UnitReqClassOr
InstanceName> | ASCII - String | Name of Unit Class or Unit Instance associated with Unit Requirement | |
<ElemID> | ASCII - Integer | Unique ID of step associated with this Unit Requirement | |
<DownstreamUnit
ReqID> | ASCII - Integer | Unique ID of configure downstream Unit Requirement | |
This is an example of the return on this request.
A request on
object
.
GetItem(17UnitRequirements)
could return:MAX_SPEED \t 13 \t 1 \t MIXER \t 127 \t $END \t 14 \crlf
TEMP \t 14 \t 1 \t FREEZER \t 128 \t $END
Provide Feedback