ResourcesListX

The
ResourcesListX
data item returns a directory (list) of all resources and their corresponding resource ID and type.
TIP:
For large resource lists, use the
ResourcesListX
data item. Using the
ResourcesList
item for large area models may cause performance issues.
Example Input of ResourcesListX
:
object.GetItem(ResourcesListX)
Output of ResourcesListX
:
<ResourcesListX>
<ResourceIndexData>
</ResourcesListX>
where ResourceIndexData is
:
<Res ID = "Value" Type = "Value" />
where:
Res ID (integer) – A unique Equipment ID for a Resource. Resource IDs can also be zero or negative. Zero is reserved for the
Operator
object and negative IDs are used for Recipe Procedures.
Type (positive integer) =
  • 1 = Process Cell
  • 2 = Unit
  • 3 = Phase
  • 4 = Resource
  • 5 = Procedure
  • 7 = Operation Sequence
A client request to retrieve the value of the
ResourcesListX
data item could return:
<ResourcesListX>
<Res ID="-82" Type="5" />
<Res ID="2" Type="1" />
<Res ID="3" Type="2" />
<Res ID="7" Type="3" />
<Res ID="20" Type="4" />
<Res ID="-83" Type="5" />
</ResourcesListX>
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal