ISA95JobResponseProviderObjectType – OPC UA for ISA-95

6.2.7 ISA95JobResponseProviderObjectType

6.2.7.1 Overview

The ISA95JobResponseProviderObjectType contains a method to receive unsolicited job response requests as illustrated in Figure 6.

Figure 6 – ISA95JobResponseProvider Methods

Table 50 is the AddressSpace definition of an ISA95JobResponseProviderObjectType.

Table 50 – ISA95JobResponseProviderObjectType AddressSpace Definition

Attribute	Value
BrowseName	ISA95JobResponseProviderObjectType
IsAbstract	False

References	Node Class	BrowseName	Data Type	TypeDefinition	Other
Subtype of the BaseObjectType defined in OPC 10000-5
0:HasComponent	Method	RequestJobResponseByJobOrderID		See 6.2.7.2	M
0:HasComponent	Method	RequestJobResponseByJobOrderState		See 6.2.7.3	M
0:HasComponent	Variable	JobOrderResponseList	ISA95JobResponse DataType[]	BaseData VariableType	O
0:GeneratesEvent	ObjectType	ISA95JobOrderStatusEventType

Conformance Units
ISA-95 Job Response Provider V2

RequestJobResponseByJobOrderID – Defines the ISA95JobResponseRequest Method which receives requests for Job Responses by JobOrderID.

RequestJobResponseByJobOrderState – Defines the ISA95JobResponseRequest Method which receives requests for Job Responses by JobOrderState.

The ISA95JobOrderReceiverObjectType with the StoreAndStart Method may be paired with an ISA95JobResponseProviderObjectType and the RequestJobResponseByJobOrderID Method, to send a Job Order and query for a JobResponse. This transaction is illustrated in Figure 7.

Objects may generate Events of ISA95JobOrderStatusEventType for every change of the state of a job order managed by the Object. In that case, the JobResponse of the Event shall be identical to the entry in the JobOrderResponseList of the job order and the JobOrder to the counterpart job order receiver Objects JobOrderList.

Figure 7 – StoreAndStart and RequestJobResponseByJobOrderID Transaction Example

The JobOrderResponseList, if provided, shall contain one entry for each job order of the corresponding job order receiver Object provided in the JobOrderList which is not in the states AllowedToStart or NotAllowedToStart. That means, for all job orders that have at least started the execution and are still managed by the job order receiver Object, there shall be an entry. The states of the job orders in both lists (JobOrderList and JobOrderResponseList) shall match for each job order.

When a Job Order gets removed from the JobOrderList, it shall also get removed from the JobOrderResponseList.

6.2.7.2 RequestJobResponseByJobOrderID Method

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 51 and Table 52 specify the Arguments and AddressSpace representation, respectively.

Signature

	RequestJobResponseByJobOrderID (
		[in]	0:String				JobOrderID	
	[out]	ISA95JobResponseDataType	JobResponse
	[out]	0:UInt64	   	 		ReturnStatus
	);

Table 51 – RequestJobResponseByJobOrderID Method Arguments

Argument	Description
JobOrderID	Contains an ID of the job order, as specified by the method caller.
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.

B.2 defines common values for ReturnStatus.

Method Result Codes are defined as part of the Call service (see OPC 10000-4, or Annex B Table 94, and Table 95).

Table 52 – RequestJobResponseByJobOrderID Method AddressSpace Definition

Attribute	Value
BrowseName	RequestJobResponseByJobOrderID

References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory

6.2.7.3 RequestJobResponseByJobOrderState Method

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 53 and Table 54 specify the Arguments and AddressSpace representation, respectively.

Signature

	RequestJobResponseByJobOrderState (
		[in] 	ISA95StateDataType[]	 	JobOrderState
	[out]	ISA95JobResponseDataType[]	JobResponses
	[out]	0:UInt64	   	 		ReturnStatus
	);

Table 53 – RequestJobResponseByJobOrderState Method Arguments

Argument	Description
JobOrderState	Contains a job status of the JobResponse to be returned. The array shall provide at least one entry representing the top level state and potentially additional entries representing substates. The first entry shall be the top level entry, having the BrowsePath set to null. The order of the substates is not defined.
JobResponses	Contains a list of 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.

B.2 defines common values for ReturnStatus.

Method Result Codes are defined as part of the Call service (see OPC 10000-4, or Annex B Table 94, and Table 95).

Table 54 – RequestJobResponseByJobOrderState Method AddressSpace Definition

Attribute	Value
BrowseName	RequestJobResponseByJobOrderState

References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory