The OPC UA ISA-95 Information Model is a representation of the ISA-95 data model in OPC Methods, ObjectTypes, VariableTypes, DataTypes and ReferenceTypes.
This model generates standard types. All ISA-95 types will be defined in their own namespace and will begin with “ISA95”
The following conventions apply to ObjectType, VariableType and DataType naming:
- All ObjectTypes include “ObjectType” as part of the name
- All DataTypes that are structures include “DataType” as part of the name, this is to be able to differentiate them from any VariableTypes that will just end in Type.
- All enumerations will end in “Enum”, to clearly identify that it is an enumeration.
- All base DataTypes (int32, float, …) used in the OPC UA server will be those defined in OPC UA, see OPC 10000-6 for more detail on the representation of the datatypes.
The ISA95JobOrderReceiverObjectType contains a method to receive job order commands and optional definitions of allowable job order information as illustrated in Figure 4.
Figure 4 – Job Order Receiver Object Type Methods and Data
Table 12 is the AddressSpace definition of an ISA95JobOrderReceiverObjectType.
Table 12 – ISA95JobOrderReceiverObjectType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95JobOrderReceiverObjectType |
||||
IsAbstract |
False |
||||
References |
NodeClass |
BrowseName |
Data Type |
TypeDefinition |
Other |
Subtype of the BaseObjectType defined in OPC 10000-5 |
|||||
0:HasComponent |
Method |
ReceiveJobOrder |
|
See 6.2.1.2 |
M |
0:HasComponent |
Variable |
JobOrderList |
ISA95JobOrderDataType[] |
0:BaseDataVariableType |
M,RO |
0:HasComponent |
Variable |
WorkMaster |
ISA95WorkMasterDataType[] |
0:BaseDataVariableType |
M,RO |
0:HasComponent |
Variable |
MaterialClassID |
0:String[] |
0:BaseDataVariableType |
M,RO |
0:HasComponent |
Variable |
MaterialDefinitionID |
0:String[] |
0:BaseDataVariableType |
M,RO |
0:HasComponent |
Variable |
EquipmentID |
0:String[] |
0:BaseDataVariableType |
M,RO |
0:HasComponent |
Variable |
PhysicalAssetID |
0:String[] |
0:BaseDataVariableType |
M,RO |
0:HasComponent |
Variable |
PersonnelID |
0:String[] |
0:BaseDataVariableType |
M,RO |
ReceiveJobOrder - Defines the ReceiveJobOrder Method which receives job orders and job order commands.
JobOrderList - Defines a read-only list of job order information available from the server. The information returned is defined by the server and may be a complete copy of a received job order or may be just the IDs of the job orders. If there are no job orders available from the server, then this may be null.
WorkMaster – Defines a read-only set of work master IDs that may be specified in a job order, and the read-only set of parameters that may be specified for a specific work master. If there are no restrictions on what work master IDs can be sent with a job order, then this may be null.
MaterialClassID - Defines a read-only set of Material Classes IDs that may be specified in a job order. If there are no restrictions on what Material Classes IDs can be sent with a job order, then this may be null.
MaterialDefinitionID - Defines a read-only set of Material Classes IDs that may be specified in a job order. If there are no restrictions on what Material Classes IDs can be sent with a job order, then this may be null.
EquipmentID - Defines a read-only set of Equipment Class IDs and Equipment IDs that may be specified in a job order. If there are no restrictions on what Equipment IDs can be sent with a job order, then this may be null.
PhysicalAssetID - Defines a read-only set of Physical Asset Class IDs and Physical Asset IDs that may be specified in a job order. If there are no restrictions on what Physical Asset IDs can be sent with a job order, then this may be null.
PersonnelID - Defines a read-only set of Personnel IDs and Person IDs that may be specified in a job order. If there are no restrictions on what Personnel IDs can be sent with a job order, then this may be null.
This Method receives job orders and job order commands.
The signature of this Method is specified below. Table 13 and Table 14 specify the Arguments and AddressSpace representation, respectively.
Signature
ReceiveJobOrder (
[in]ISA95JobOrderCommandEnumJobOrderCommand
[in]ISA95JobOrderDataType JobOrder
[out]UInt64 ReturnStatus
);
Table 13 – ReceiveJobOrder Method Arguments
Argument |
Description |
JobOrderCommand |
Contains the command to the Information Receiver on the action to be taken on the job order. For example, it may contain a Start command to start a stored job order or a Cancel command to cancel an un-started Job Order. |
JobOrder |
Contains information defining the job order with all parameters and any material, equipment, or physical asset requirements associated with the order. |
ReturnStatus |
Returns the status of the method execution. |
Method Result Codes are defined as part of the Call service (see OPC 10000-4, Table 56, and Table 57).
Table 14 – ReceiveJobOrder Method AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ReceiveJobOrder |
||||
IsAbstract |
True |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |
The ISA95JobResponseProviderObjectType contains a method to receive unsolicited job response requests as illustrated in Figure 5.
Figure 5 – ISA95JobResponseProvider Methods
Table 15 is the AddressSpace definition of an ISA95JobResponseProviderObjectType.
Table 15 – ISA95JobResponseProviderObjectType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95JobResponseProviderObjectType |
||||
IsAbstract |
False |
||||
References |
NodeClass |
BrowseName |
Data Type |
TypeDefinition |
Other |
Subtype of the BaseObjectType defined in OPC 10000-5 |
|||||
0:HasComponent |
Method |
RequestJobResponse |
|
See 6.2.2.2 |
M |
RequestJobResponse – Defines the ISA95JobResponseRequest Method which receives requests for Job Responses.
The ISA95JobOrderReceiverObjectType with the ReceiveJobOrder method may be paired with an ISA95JobResponseProviderObjectType and the RequestJobResponse method, to send a Job Order and query for a JobResponse. This transaction is illustrated in Figure 6.
Figure 6 – ReceiveJobOrder and RequestJobResponse Transaction Example
This method is used to return Job Responses for unsolicited requests for responses from a job order.
The signature of this Method is specified below. Table 16 and Table 17 specify the Arguments and AddressSpace representation, respectively.
Signature
RequestJobResponse (
[in]String JobOrderID
[in] ISA95JobOrderStateEnum JobOrderState
[out]ISA95JobResponseDataType[]JobResponse
[out]UInt64 ReturnStatus
);
Table 16 – RequestJobResponse Method Arguments
Argument |
Description |
JobOrderID |
Contains an ID of the job order, as specified by the method caller. This argument shall be null if the JobOrderState is defined. |
JobOrderState |
Contains a job status of the JobResponse to be returned. This argument shall be null if the JobOrderID is defined. |
JobResponse |
Contains information about the execution of a job order, such as the current status of the job, actual material consumed, actual material produced, actual equipment used, and job specific data. |
ReturnStatus |
Returns the status of the method execution. |
If both JobOrderID and JobOrderState or neither are specified then an “Invalid Request” error shall be returned.
Method Result Codes are defined as part of the Call service (see OPC 10000-4, Table 56, and Table 57).
Table 17 – RequestJobResponse Method AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
RequestJobResponse |
||||
IsAbstract |
True |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |
A Job Response Receiver receives unsolicited Job Responses, usually as the result of completion of a job, or at intermediate points within the job as illustrated in Figure 7.
Figure 7 – ISA95JobResponseReceiverObjectType
Table 18 is the AddressSpace definition of an ISA95JobResponseReceiverObjectType.
Table 18 – ISA95JobResponseReceiverObjectType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95JobResponseReceiverObjectType |
||||
IsAbstract |
False |
||||
References |
NodeClass |
BrowseName |
Data Type |
TypeDefinition |
Other |
Subtype of the BaseObjectType defined in OPC 10000-5 |
|||||
0:HasComponent |
Method |
ReceiveJobResponse |
|
See 6.2.3.2 |
M |
ReceiveJobResponse – Defines the ReceiveJobResponse Method which receives unsolicited Job Responses.
The ISA95JobOrderReceiverObjectType with the ReceiveJobOrder method may often be paired with an ISA95JobResponseReceiverObjectType and the ReceiveJobResponse method, to send a Job Order and receive a JobResponse. This transaction is illustrated in Figure 8.
Figure 8 – ReceiveJobOrder and ReceiveJobResponse Transaction Example
The ReceiveJobResponse method is used to receive unsolicited Job Responses.
The signature of this Method is specified below. Table 19 and Table 20 specify the Arguments and AddressSpace representation, respectively.
Signature
ReceiveJobResponse(
[in]ISA95JobResponseDataType JobResponse
[out]UInt64 ReturnStatus
);
Table 19 – ReceiveJobResponse Method Arguments
Argument |
Description |
JobResponse |
Contains information about the execution of a job order, such as actual material consumed, actual material produced, actual equipment used, and job specific data. |
ReturnStatus |
Returns the status of the method execution. |
Method Result Codes are defined as part of the Call service (see OPC 10000-4, Table 56, and Table 57).
Table 20 – ReceiveJobResponse Method AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ReceiveJobResponse |
||||
IsAbstract |
True |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |
The ISA95EquipmentDataType is a subtype of OPC UA Structure that defines an equipment class or a specific piece of equipment, a quantity and unit of measure, an optional description, and an optional collection of properties.
The structure is defined in Table 21.
Table 21 – ISA95EquipmentDataType Structure
Name |
Type |
Description |
ISA95EquipmentDataType |
structure |
|
ID |
0:String |
An identification of an EquipmentClass or Equipment. |
Description |
0:String |
Optional: Additional information and description about the equipment. |
EquipmentUse |
0:String |
Optional: Information about the expected use of the equipment, see the ISA 95 Part 2 standard for defined values. |
Quantity |
0:DecimalString |
Optional: The quantity of the equipment. |
UoM |
0:String |
Optional: The Unit of Measure of the quantity. |
Properties |
ISA95PropertyDataType [] |
Optional: Any associated properties, or empty if there are no properties defined. |
Table 22 is the AddressSpace definition of an ISA95EquipmentDataType.
Table 22 – ISA95EquipmentDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95EquipmentDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95JobOrderDataType is a subtype of OPC UA Structure that defines the information needed to schedule and execute a job.
The structure is defined in Table 23.
Table 23 – ISA95JobOrderDataType Structure
Name |
Type |
Description |
ISA95JobOrderDataType |
structure |
|
ID |
0:String |
An identification of the Job Order |
Description |
0:String |
Optional: Addition information about the Job Order |
WorkMasterID |
ISA95WorkMasterDataType[] |
Optional: Work Master associated with the job order. If multiple work masters are defined, then the execution system can select the work master based on the availability of resources. If no WorkMaster is defined, then the server may use internal logic or human interactions to select the appropriate WorkMaster |
StartTime |
0:DateTime |
Optional: The proposed start time for the order, may be empty if not specified. |
EndTime |
0:DateTime |
Optional: The proposed end time for the order, may be empty of not specified. |
Priority |
0:Int16 |
Optional: The priority of the job order, may be empty of not specified. Higher numbers have higher priority. This type allows the Job Order clients to pick their own ranges, and the Job Order server only has to pick the highest number |
JobOrderParameters |
ISA95ParameterDataType[] |
Optional: Key value pair with values, not associated with a resource that is provided as part of the job order, may be empty if not specified. |
PersonnelRequirements |
ISA95PersonnelDataType[] |
Optional: A specification of any personnel requirements associated with the job order, may be empty if not specified. |
EquipmentRequirements |
ISA95EquipmentDataType[] |
Optional: A specification of any equipment requirements associated with the job order, may be empty if not specified. |
PhysicalAssetRequirements |
ISA95PhysicalAssetDataType[] |
Optional: A specification of any physical asset requirements associated with the job order, may be empty if not specified. |
MaterialRequirements |
ISA95MaterialDataType[] |
Optional: A specification of any material requirements associated with the job order, may be empty if not specified. |
Table 24 is the AddressSpace definition of an ISA95JobOrderDataType.
Table 24 – ISA95JobOrderDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95JobOrderDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95JobResponseDataType is a subtype of OPC UA Structure that defines the information needed report on the execution of a job order.
The structure is defined in Table 25 .
Table 25 – ISA95JobResponseDataType Structure
Name |
Type |
Description |
ISA95JobResponseDataType |
structure |
|
ID |
0:String |
A unique identification of the Job Response |
Description |
0:String |
Optional: Addition information about the Job Response |
JobOrderID |
0:String |
An identification of the job order associated with the job response. |
StartTime |
0:DateTime |
Optional: The actual start time for the order. |
EndTime |
0:DateTime |
Optional: The actual end time for the order, may be empty if the job has not yet completed. |
JobState |
ISA95JobOrderStateEnum |
The current state of the job. |
JobResponseData |
ISA95ParameterDataType[] |
Optional: Key value pair with values, not associated with a resource that is provided as part of the job response, may be empty if not specified. |
PersonnelActuals |
ISA95PersonnelDataType[] |
Optional: A specification of any personnel actuals associated with the job response, may be empty if not specified. |
EquipmentActuals |
ISA95EquipmentDataType[] |
Optional: A specification of any equipment actuals associated with the job response, may be empty if not specified. |
PhysicalAssetActuals |
ISA95PhysicalAssetDataType[] |
Optional: A specification of any physical asset actuals associated with the job response, may be empty if not specified. |
MaterialActuals |
ISA95MaterialDataType[] |
Optional: A specification of any material actuals associated with the job response, may be empty if not specified. |
Table 26 is the AddressSpace definition of an ISA95JobResponseDataType.
Table 26 – ISA95JobResponseDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95JobResponseDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95MaterialDataType is a subtype of OPC UA Structure that defines a material resource, and an optional description, material use, quantity and unit of measure, description, and collection of properties.
The structure is defined in Table 27.
Table 27 – ISA95MaterialDataType Structure
Name |
Type |
Description |
ISA95MaterialDataType |
structure |
|
MaterialClassID |
0:String |
Optional: An identification of a Material Class, or null if the Material Class is not used to identify the material. Note: Either a MaterialClassID, MaterialDefinitionID, MaterialLotID, or MaterialSublotID must be defined. |
MaterialDefinitionID |
0:String |
Optional: An identification of a Material Definition, or null if the Material Definition is not used to identify the material. |
MaterialLotID |
0:String |
Optional: An identification of a Material Lot, or null if the Material Lot is not used to identify the material. |
MaterialSublotID |
0:String |
Optional: An identification of a Material Sublot, or null if the Material Sublot is not used to identify the material. |
Description |
0:String |
Optional: Additional information and description about the material. |
MaterialUse |
0:String |
Optional: Information about the expected use of the material. Defines values from ANSI/ISA 95 Part 2 are:
|
Quantity |
0:DecimalString |
Optional: The quantity of the material. |
UoM |
0:String |
Optional: The Unit of Measure of the quantity. Units of Measure. |
Properties |
ISA95PropertyDataType[] |
Optional: Any associated properties of the material, or empty if there are no material properties defined.
|
Table 28 is the AddressSpace definition of an ISA95MaterialDataType.
Table 28 – ISA95MaterialDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95MaterialDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95PersonnelDataType is a subtype of OPC UA Structure that defines a personnel resource and an optional description, personal use, quantity and unit of measure, description, and collection of properties.
The structure is defined in Table 29.
Table 29 – ISA95PersonnelDataType Structure
Name |
Type |
Description |
ISA95PersonnelDataType |
structure |
|
ID |
0:String |
An identification of a Personnel Class or Person. |
Description |
0:String |
Optional: Additional information and description about the resource. |
PersonnelUse |
0:String |
Optional: Information about the expected use of the personnel, see the ISA 95 Part 2 standard for defined values. |
Quantity |
0:DecimalString |
Optional: The quantity of the resource |
UoM |
0:String |
Optional: The Unit of Measure of the quantity. |
Properties |
ISA95PropertyDataType[] |
Optional: Any associated properties, or empty if there are no properties defined. |
Table 30 is the AddressSpace definition of an ISA95PersonnelDataType.
Table 30 – ISA95PersonnelDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95PersonnelDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95PhysicalAssetDataType is a subtype of OPC UA Structure that defines a physical asset resource and an optional description, physical asset use, quantity and unit of measure, description, and collection of properties.
The structure is defined in Table 31.
Table 31 – ISA95PhysicalAssetDataType Structure
Name |
Type |
Description |
ISA95PhysicalAssetDataType |
structure |
|
ID |
0:String |
An identification of a Physical Asset Class or Physical Asset. |
Description |
0:String |
Optional: Additional information and description about the physical asset. |
PhysicalAssetUse |
0:String |
Optional: Information about the expected use of the physical asset, see the ISA 95 Part 2 standard for defined values. |
Quantity |
0:DecimalString |
Optional: The quantity of the physical asset. |
UoM |
0:String |
Optional: The Unit of Measure of the quantity |
Properties |
ISA95PropertyDataType[] |
Optional: Any associated properties, or empty if there are no physical asset properties defined. |
Table 32 is the AddressSpace definition of an ISA95PhysicalAssetDataType.
Table 32 – ISA95PhysicalAssetDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95PhysicalAssetDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95PropertyDataType is a subtype of OPC UA Structure that defines an ID (which is a unique identifier for a property within the scope of the associated resource), the associated value, (which is the data for the property), and optional description, unit of measure of the value, and subproperties. The structure is defined in Table 33.
Table 33 – ISA95PropertyDataType Structure
Name |
Type |
Description |
ISA95PropertyDataType |
structure |
|
ID |
0:String |
Unique identifier for a property within the scope of the associated resource |
Value |
0:BaseDataType |
Value for the property |
Description |
0:String |
Optional: An optional description of the property. |
UoM |
0:String |
Optional: The Unit of Measure of the value |
Subproperties |
ISA95PropertyDataType[] |
Optional: Sub properties of the property |
Table 34 is the AddressSpace definition of an ISA95PropertyDataType.
Table 34 – ISA95PropertyDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95PropertyDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95ParameterDataType is a subtype of OPC UA Structure that defines an ID (which is a unique identifier for a parameter), the associated value, (which is the data for the parameter), and optional description, unit of measure of the value, and subproperties. The structure is defined in Table 33.
Table 35 – ISA95ParameterDataType Structure
Name |
Type |
Description |
ISA95ParameterDataType |
structure |
|
ID |
0:String |
A unique identifier for a parameter |
Value |
0:BaseDataType |
Value of the parameter. |
Description |
0:String |
Optional: An optional description of the parameter. |
UoM |
0:String |
Optional: The Unit of Measure of the value |
Subparameters |
ISA95ParameterDataType[] |
Optional: Sub parameters of the parameter |
Table 36 is the AddressSpace definition of an ISA95PropertyDataType.
Table 36 – ISA95ParameterDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95ParameterDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95ReturnEnum describes the possible return status from a Method call. The ISA95ReturnEnum is defined in Table 37.
Table 37 – ISA95ReturnEnum values
Name |
Value |
Description |
Undefined |
0 |
Undefined value, should never be seen. |
NoError |
1 |
There were no errors in processing the method. |
InvalidJobOrderID |
2 |
The referenced job order ID is invalid or not known to the receiver. |
UnableToAcceptJobOrder |
3 |
The server is currently unable to accept job orders. |
UnableToAcceptJobOrderCommand |
4 |
The server is currently unable to accept job order commands for the specified job order. |
UnableToReturnJobResponse |
5 |
The server is unable to provide a Job Response for the specified Job Order. |
The ISA95WorkMasterDataType is a subtype of OPC UA Structure that defines a Work Master ID and optional description and parameters for the Work Master.
The structure is defined in Table 38.
Table 38 – ISA95WorkMasterDataType Structure
Name |
Type |
Description |
ISA95WorkMasterDataType |
structure |
|
ID |
0:String |
An identification of the Work Master. |
Description |
0:String |
Optional: Additional information and description about the Work Master. |
Parameters |
ISA95ParameterDataType[] |
Optional: Defined parameters for the Work Master. |
Table 39 is the AddressSpace definition of an ISA95WorkMasterDataType.
Table 39 – ISA95WorkMasterDataType AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
ISA95WorkMasterDataType |
||||
IsAbstract |
False |
||||
Reference |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
Subtype of the Structure defined in OPC 10000-5 |
The ISA95JobOrderCommandEnum listed in Table 40 describes the defined job order commands.
Table 40 – ISA95JobOrderCommandEnum values
Name |
Value |
Description |
Undefined |
0 |
Undefined value, should never be seen. |
Store |
1 |
Command to store the job order in local storage, but not to start the order. |
StoreAndStart |
2 |
Command to store the job order and start it as soon as the Job Order receiver is ready to start. |
Start |
3 |
Command to start a stored job order as soon as the receiver is ready to start. Only the Job Orders ID is used to identify the stored job order, all other information is not used. No changes are made to the stored order. If multiple Job Orders have been commanded to Start, then the priority and timing values in the Job Orders shall be used to determine the order of execution of the orders. |
Update |
4 |
Command to update a stored Job Order that has not yet been started, with the new order information. All previously stored information is replaced. |
Stop |
5 |
Command to stop a started job order, report on any work done on the order, and remove the stored information. Only the Job Orders ID is used to identify the job order, all other information is not used. |
Cancel |
6 |
Cancel an un-started job order and remove the stored information. Only the Job Orders ID is used to identify the job order, all other information is not used. |
Clear |
7 |
Command to allow the Information Receiver to clear any maintained information on the Job Order (usually sent after a receipt of a Job Response with a status of Finished.) Only the Job Orders ID is used to identify the job order, all other information is not used. |
The ISA95JobOrderStateEnum listed in Table 41 describes the defined job statuses.
Table 41 – ISA95JobOrderStateEnum values
Name |
Value |
Description |
Undefined |
0 |
Undefined value, should never be seen. |
Waiting |
1 |
The necessary pre-conditions have not been met and the order is not ready to run. |
Ready |
2 |
The necessary pre-conditions have been met and the order is ready to run, awaiting a Start command. |
Loaded |
3 |
In situations where only one job may be in active memory and is able to be run, then the job is loaded in active memory, the necessary pre-conditions have been met, and the order is ready to run, awaiting a Start command. |
Running |
4 |
The order is executing. |
Completed |
5 |
The order has been completed and is no longer in execution. |
Aborted |
6 |
The order was aborted. |
Held |
7 |
The order has been temporarily stopped due to a constraint of some form. |
Suspended |
8 |
The order has been temporarily stopped due to a deliberate decision within the execution system. |
Closed |
9 |
The order has been completed and fully reconciled. No further changes, or restatement of actuals is expected. |
Error |
10 |
The Job is in error and requires attention. |