Response parameters
- Last UpdatedOct 24, 2024
- 3 minute read
RootFolder section
Contains details about the root folder of the hierarchy.
<RootFolder>
<DisplayName>Material Movements</DisplayName>
<Folders>
<Folder>
<DisplayName>Coal Site 1 Movements</DisplayName>
<Folders />
|
Parameter |
Description |
|---|---|
|
DisplayName |
The DisplayName value of the root folder. |
|
Folders |
Contains the set of children folders in the hierarchy. |
|
Folder |
Contains details about an individual folder. |
|
DisplayName |
The DisplayName value of the Material Movement folder. |
Fields section
Contains the set of parameters belonging to a field.
<Fields>
<AllowedValues>
<Value>SP1</Value>
<Value>SP2</Value>
<Value>SP3</Value>
<Value>SP4</Value>
</AllowedValues>
<AssociatedModel>None</AssociatedModel>
<Category>Contributors</Category>
<ClrType>System.String</ClrType>
<DisplayName>Supplier</DisplayName>
<DisplayOrder>50002</DisplayOrder>
<IsMandatory>false</IsMandatory>
<Name>Supplier</Name>
<SubCategory>Field Data</SubCategory>
<Minimum i:nil="true" />
<Maximum i:nil="true" />
<HasAllowedValues>true</HasAllowedValues>
</Fields>
|
Parameter |
Description |
|---|---|
|
AllowedValues |
A string collection of values that are permitted for the field. |
|
AssociatedModel |
The associated model type for this field. None, Equipment, Personnel, Material. |
|
Category |
The category to group fields in, when displayed in user input forms. |
|
ClrFormat |
Format for the field value. Most often applies to numerical data, or time and dates. |
|
ClrType |
This value specifies the Common Language Runtime (CLR) type; it is much like a data type.For example, System.Int32, System.String, System.DateTime. |
|
DisplayName |
The name that appears in Production Analyst. |
|
DisplayOrder |
This value is a calculation that reflects the combined values of the DisplayOrderGroup and the DisplayOrderIndex to determine the order of display. |
|
IsMandatory |
Specifies whether a field is mandatory. If mandatory, the value must be entered before an event can be confirmed. |
|
Name |
The name given to identify an item in Studio. |
|
SubCategory |
The subcategory to group fields in, when displaying in user input forms. |
|
Units |
The units of measurement used in the field values. |
|
Minimum |
Defines the minimum value that a user can enter into a numerical datatype field when the field is edited in AVEVA™ Production Management. |
|
Maximum |
Defines the maximum value that a user can enter into a numerical datatype field when the field is edited in AVEVA Production Management. |
|
HasAllowedValues |
Indicates whether the field has allowed values. Can be True or False. |
Items section
Contains the set of routine material movement items in a folder location.
<Items>
<Item>
<CustomFields />
<DestinationMaterial>Material Model.Processed Coal</DestinationMaterial>
<DestinationEquipment>Enterprise.Coal Site 1.TLO.Train or Carriage LoadOut Bin</DestinationEquipment>
<Direction>Internal</Direction>
<DisplayName>CV1 to TLO</DisplayName>
<Name>Material Movements.Coal Site 1 Movements.CV1 to TLO</Name>
<SourceMaterial>Material Model.Processed Coal</SourceMaterial>
<SourceEquipment>Enterprise.Coal Site 1.Product Coal.CV1</SourceEquipment>
<DestinationLotIdentifierCreationMethod>UserProvided</DestinationLotIdentifierCreationMethod>
<DestinationQuantityMode>UseSourceQuantity</DestinationQuantityMode>
<MaterialClassConstraints />
<MaterialConstraints>
<MaterialConstraint>
<DestinationMaterial>Material Model.Crushed Coal</DestinationMaterial>
<SourceMaterial>Material Model.Uncrushed Coal</SourceMaterial>
</MaterialConstraint>
</MaterialConstraints>
</Item>
|
Parameter |
Description |
|---|---|
|
Item |
Contains details about an individual routine material movement item. |
|
CustomFields |
Contains the set of custom fields belonging to a routine material movement item. |
|
DestinationEquipment |
The Destination Equipment value of the Material Movement item. |
|
Direction |
The Direction value of the Material Movement item. |
|
DisplayName |
The Display Name value of the Material Movement item. |
|
Name |
The Name value of the Material Movement item. |
|
SourceEquipment |
The Source Equipment value of the Material Movement item. |
|
DestinationLotIdentifierCreationMethod |
Specifies the creation method for the destination lot identifier. Valid values are: UseSourceLotIdentifier, LotGenerator, None. |
|
DestinationQuantityMode |
Specifies the mode to determine destination quantity. Valid values are: UseSourceQuantity, Expression. |
MaterialClassConstraints section
Limits the allowed materials for the movement.
<MaterialClassConstraints />
<MaterialConstraints>
<MaterialConstraint>
<DestinationMaterial>Material Model.Crushed Coal</DestinationMaterial>
<SourceMaterial>Material Model.Uncrushed Coal</SourceMaterial>
</MaterialConstraint>
</MaterialConstraints>
|
Parameter |
Description |
|
MaterialConstraints |
Contains the set of material constraints. |
|
MaterialConstraint |
Limits the allowed materials for the movement. |
|
DestinationMaterial |
The allowed material at the destination location. |
|
SourceMaterial |
The allowed material at the source location. |