ISA-95-4 Job Control - 6.3 DataTypes

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

6.3.2 ISA95JobOrderDataType

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

6.3.3 ISA95JobResponseDataType

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

6.3.4 ISA95MaterialDataType

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: consumable: resources that are not normally included in bills of material or are not individually accounted for in specific operations requests or are not lot tracked. material consumed: raw and intermediate material normally included in bills of material or are individually accounted for in specific operations requests or are material lots tracked. material produced: finished goods material normally included in bills of material or are individually accounted for in specific operations requests or are material lots tracked. co-product produced: a planned product typically produced in conjunction with a main planned product per the material master. A product that is usually manufactured together or sequentially because of product or process similarities. by-product produced: tracked waste, undesirable materials, material of value produced as a residual of or incidental to the production process. The ratio of by-product to primary product is usually predictable. By-products may be recycled, sold as-is, or used for other purposes
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

6.3.5 ISA95PersonnelDataType

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

6.3.6 ISA95PhysicalAssetDataType

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

6.3.7 ISA95PropertyDataType

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

6.3.8 ISA95ParameterDataType

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

6.3.9 ISA95ReturnEnum

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.

6.3.10 ISA95WorkMasterDataType

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

6.3.11 ISA95JobOrderCommandEnum

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.

6.3.12 ISA95JobOrderStateEnum

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.