DataTypes – OPC UA for OPEN-SCS – Serialization Object Model: OPEN-SCS

6.4 DataTypes

6.4.1 OPENSCSAggregationDataType

The OPENSCSAggregationDataType is a type of structure that identifies a parent element and a collection of packed elements. This is used in the aggregation packing and unpacking methods.

The structure is defined in Table 48

Table 48 – OPENSCSCollectionDataType Structure

Name	Type	Description
OPENSCSAggregationDataType	structure
ParentElement	OPENSCSLabelDataType	Identifies the single serial number representing the aggregation which acts as the parent
ParentElementCollection	OPENSCSLabelCollectionDataType	Identifies the Serial Number Collection that was added to, or removed from, the parent element.

Table 49 is the AddressSpace definition of an OPENSCSCollectionDataType.

Table 49 – OPENSCSAggregationDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSAggregationDataType
IsAbstract	False

Reference	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the Structure defined in OPC 10000-5

6.4.2 OPENSCSCollectionDataType

The OPENSCSCollectionDataType is an abstract subtype of OPC UA Structure that defines a collection of Serial Numbers and associated Collection information. No instances of this type can exist.

There is always at least one Serial Number in the collection.

The structure is defined in Table 50.

Table 50 – OPENSCSCollectionDataType Structure

Name

Type

Description

OPENSCSCollectionDataType	structure
ID	0:String	An identification of the Collection. It usually refers to a specific packaging level of a specific product. However, several products may share the same Pool ID if manufacturer or serial number authority wants to ensure globally unique serial numbers across all products.
Description	0:String	Additional information and description about the Collection.
State	OPENSCSSerialNumberStateEnum	State of the Serial Numbers in the Collection as defined in Table 1 – Serial Number State Definitions.
AssociatedPoolID	0:String	An identification of the Serial Number Pool from which the Serial Numbers were obtained.
SerialNumbers	String []	Array of Serial Numbers in the collection.

Table 51 is the AddressSpace definition of an OPENSCSCollectionDataType.

Table 51 – OPENSCSCollectionDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSCollectionDataType
IsAbstract	True

Reference	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the Structure defined in OPC 10000-5

6.4.3 OPENSCSEventStreamArgumentDataType

The OPENSCSEventStreamArgumentDataType is a subtype of OPC UA Structure that defines the generateOptions argument for an EPCISStream GenerateFileForWrite method. It defines the serial number format information for object events and for aggregation events, and event context information. The structure is defined in Table 54.

Table 52 – OPENSCSEventStreamArgumentDataType Structure

Name	Type	Description
OPENSCSEventStreamArgumentDataType	structure
SNFormat	0:String	The format for of serial numbers in object events, can be a null string if there are no object events in the transferred events.
ParentSNFormat	0:String	The format for of parent serial numbers in aggregation events, can be a null string if there are no aggregation events in the transferred events.
PackedElementSNFormat	0:String	The format for of packed element serial numbers in aggregation events, can be a null string if there are no aggregation events in the transferred events.
EventContext	OPENSCSKeyValueDataType[]	Zero or more key value pairs that define additional context information for the event, such as order number or lot number.

Table 55 is the AddressSpace definition of an OPENSCSEventStreamArgumentDataType.

Table 53 – OPENSCSEventStreamArgumentDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSEventStreamArgumentDataType
IsAbstract	False

Reference	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the Structure defined in OPC 10000-5

6.4.4 OPENSCSKeyValueDataType

The OPENSCSKeyValueDataType is a subtype of OPC UA Structure that defines two linked data items: the key, which is a unique identifier for some item of data, and the value, which is the data that is identified. The structure is defined in Table 54.

Table 54 – OPENSCSKeyValueDataType Structure

Name	Type	Description
OPENSCSKeyValueDataType	structure
Key	0:String	unique identifier for some item of data
Value	0:String	data that is identified

Table 55 is the AddressSpace definition of an OPENSCSKeyValueDataType.

Table 55 – OPENSCSKeyValueDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSKeyValueDataType
IsAbstract	False

Reference	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the Structure defined in OPC 10000-5

6.4.5 OPENSCSLabelDataType

The OPENSCSLabelDataType describes a subtype of Structure type that defines a single serial number and label, which may be associated with an SID, and collection of properties in the form of OPENSCSKeyValueDataType. The structure is defined in Table 56.

Table 56 – OPENSCSLabelDataType Structure

Name	Type	Description
OPENSCSLabelDataType	structure
ID	0:String	The serial number of the label in the SID or EPC format.
LabelProperties	OPENSCSKeyValueDataType[]	An optional array of additional properties in the form of Key/Value pairs

Table 57 is the address space definition of an OPENSCSLabelDataType.

Table 57 – OPENSCSSNLabelDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSLabelDataType
IsAbstract	False

Reference	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the Structure defined in OPC 10000-5

6.4.6 OPENSCSLabelCollectionDataType

The OPENSCSLabelCollectionDataType describes a type that defines a collection of Labels with Serial Numbers and associated Collection information. The structure is defined in Table 58.

Table 58 – OPENSCSLabelCollectionDataType Structure

Name	Type	Description
OPENSCSLabelCollectionDataType	structure
LabelCollection	OPENSCSLabelDataType[]	The collections of labels with serial numbers
LabelCollectionProperties	OPENSCSKeyValueDataType[]	An optional array of additional properties in the form of Key/Value pairs which are valid for the whole collection

Table 59 is the AddressSpace definition of an OPENSCSLabelCollectionDataType.

Table 59 – OPENSCSLabelCollectionDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSLabelCollectionDataType
IsAbstract	False

Reference	NodeClass	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of the OPENSCSCollectionDataType

6.4.7 OPENSCSLabelPropertyDataType

The structure is defined in Table 60.

Table 60 – OPENSCSLabelPropertyDataType Structure

Name	Type	Description
OPENSCSLabelPropertyDataType	structure
PropertyID	0:String	An identification of the label property.
PropertyDescription	0:String	Additional information and description about the label property.
PropertyValue	0:String	Defines value for the specific label property. The format is not defined in this specification and must be negotiated between Information Providers and Information Requesters during design or change management of a system.

Table 61 is the AddressSpace definition of an OPENSCSLabelPropertyDataType.

Table 61 – OPENSCSLabelPropertyDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSLabelPropertyDataType
IsAbstract	False

References	Node Class	BrowseName	Data Type	TypeDefinition	Modelling Rule
Subtype of Structure defined in OPC 10000-5

6.4.8 OPENSCSReturnEnum

The OPENSCSReturnEnum describes the possible return status from an OPENSCS Method call.

The OPENSCSReturnEnum is defined in Table 62.

Table 62 – OPENSCSReturnEnum values

Name	Value	Description
Undefined0	0	Undefined value, should never be seen.
NoError1	1	There were no errors in processing the method.
InvalidSerialNumberCollection2	2	The Serial Number Collection ID does not match a Serial Number Collection managed by the server.
InsufficientSerialNumbers3	3	Fewer Serial Numbers are available from the pool, then are requested.
InvalidSerialNumbersFormat4	4	The serial number format is not known or defined in the server.
InvalidRequestToken5	5	The Request Token has a value not understood by the server.
InvalidSelectionCriteria6	6	The Selection Criteria is not known or defined in the server.
UnableToAcceptSerialNumberEvents7	7	The server cannot accept Serial Number events.
UnableToAcceptLabelEvents8	8	The server cannot accept Label events.
UnableToAcceptSIDEvents9	9	The server cannot accept SID events.
UnknownAggregationSID10	10	The SID of the aggregation for packing or unpacking is unknown.
InsufficientPrivilegeToExecute11	11	The server has determined that the client does not have sufficient privilege for the method to execute.

6.4.9 OPENSCSSerialNumberStateEnum

The OPENSCSSerialNumberStateEnum listed in Table 63 describes the possible serial number states.

Table 63 – OPENSCSSerialNumberStateEnum values

Name	Value	Description
Unassigned0	0	See Table 1.
Unallocated1	1	See Table 1.
Allocated2	2	See Table 1.
SNInvalid3	3	See Table 1.
Encoded4	4	See Table 1.
LabelSampled5	5	See Table 1.
LabelScrapped6	6	See Table 1.
Commissioned7	7	See Table 1.
Sampled8	8	See Table 1.
Inactive9	9	See Table 1.
Destroyed10	10	See Table 1.
Released11	11	See Table 1.

6.4.10 OPENSCSSIDClassPropertyDataType

The structure is defined in Table 64.

Table 64 – OPENSCSSIDClassPropertyDataType Structure

Name	Type	Description
OPENSCSSIDClassPropertyDataType	structure
PropertyID	0:String	An identification of the SID Class Property.
PropertyDescription	0:String	Additional information and description about the SID Class Property.
PropertyValue	0:String	Defines value for the specific SID Class Property. The format is not defined in this specification and must be negotiated between Information Providers and Information Requesters during design or change management of a system.
LabelProperty	OPENSCSLabelPropertyDataType[]

Table 65 is the AddressSpace definition of an OPENSCSSIDClassPropertyDataType.

Table 65 - OPENSCSSIDClassPropertyDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSSIDClassPropertyDataType
IsAbstract	False

References	Node Class	BrowseName	Data Type	TypeDefinition	Modelling Rule
Subtype of Structure defined in OPC 10000-5

References

Node Class

BrowseName

Data Type

TypeDefinition

Modelling Rule

Subtype of Structure defined in OPC 10000-5

6.4.11 OPENSCSSNCollectionDataType

The OPENSCSSNCollectionDataType describes a subtype of OPENSCSCollectionDataType type that defines a collection of Serial Numbers and associated Collection information.

Table 66 is the AddressSpace definition of an OPENSCSSNCollectionDataType.

Table 66 – OPENSCSSNCollectionDataType AddressSpace Definition

Attribute	Value
BrowseName	OPENSCSSNCollectionDataType
IsAbstract	False

Reference	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the OPENSCSCollectionDataType