10.10 EntityDataType

This structure provides the identification data for a given entity in the system. The structure is defined in Table 226.

Table 226 – EntityDataType Structure
Name Type Description Optional
EntityDataTypestructureSubtype of the 0:Structure defined in OPC 10000-5.
Name0:String

It is the name of the entity identifier.

Examples: VIN, Program Id, etc.

Note: Application can send custom names which could be a combination of different terms in the system.

True
Description0:String

It is the description of the entity. Any additional information for the entity can be sent using this property.

Examples: Name of the program in the given system.

True
EntityId0:TrimmedString

It is the identifier of the given entity.

Examples: JoiningProcessId, JointId, etc.

False
EntityOriginId0:TrimmedString

It is the origin identifier of the given entity. It is provided only when it is applicable and available for a given entity.

Examples: JoiningProcessOriginId, JointOriginId, etc.

True
IsExternal0:Boolean

It indicates if EntityId is provided by the external system or not.

Example: VIN is provided by an external system.

True
EntityType0:Int16

It provides the type of Entity. It has the following pre-defined values which shall be used for each instance of this type.

Important Note: EntityType >=0 is defined as part of this specification.

For application specific extensions, EntityType < 0 can be used.

0 – UNDEFINED

1 – OTHER

2 – ASSET

3 – CONTROLLER

4 – TOOL

5 – SERVO

6 – MEMORY_DEVICE

7 – SENSOR

8 – CABLE

9 – BATTERY

10 – POWER_SUPPLY

11 – FEEDER

12 – ACCESSORY

13 – SUB_COMPONENT

14 – SOFTWARE

15 – RESULT

16 – EVENT

17 – ERROR

18 – SYSTEM

19 – LOG

20 – VEHICLE

21 – PRODUCT

22 – PART

23 – JOINT

24 – MODEL

25 – ORDER

26 – JOINING_PROCESS

27 – PROGRAM

28 – JOB

29 – BATCH

30 – RECIPE

31 – TASK

32 – PROCESS

33 – CONFIGURATION

34 – SOCKET

35 – CHANNEL

36 – STATION

37 – PRODUCTION_LINE

38 – LOCATION

39 – USER

40 – PARENT

41 – VIRTUAL_STATION

42 – JOINT_COMPONENT

False

Its representation in the AddressSpace is defined in Table 227.

Table 227 – EntityDataType Definition
Attribute Value
BrowseNameEntityDataType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the 0:Structure defined in OPC 10000-5.
Conformance Units
IJT Result Internal Identifiers
IJT Result External Identifiers
IJT Event Payload Associated Entities
IJT Start Joining Process