Entity Types#
Resource Attributes#
Additional changes to the Resource entity type.
The table below describes the properties for this entity type:
| Name | Type | Is Mandatory | Data Type | Description |
|---|---|---|---|---|
| AutomationEquipment Address | Attribute | No | String | Address to use on connection to Equipment |
| AutomationEquipment DeviceId | Attribute | No | Integer | Equipment Device Id for SecsGem Interfaces |
| AutomationEquipment IPPort | Attribute | No | Integer | IP Port to use on connection to Equipment |
| AutomationEquipment CustomLibrary | Attribute | No | String | Custom Library for Equipment Communication |
| StorageGroupLocation | Attribute | No | String | Defines the default storage group location for the Resource |
| AutomationEquipment SkipEstablishCommunication | Attribute | No | Boolean | Establish Communication Request |
| AutomationEquipment SkipSetOnline | Attribute | No | Boolean | Set Online Request |
| AutomationEquipment DeleteReportMode | Attribute | No | Look Up Table Value | Depending on the configuration deletes the Reports |
| AutomationEquipment SkipDefineReportMode | Attribute | No | Boolean | Define Reports Mode |
| AutomationEquipment EnableDisableEventsMode | Attribute | No | Look Up Table Value | Depending on the configuration enables reports |
| AutomationEquipment EnableDisableAlarmsMode | Attribute | No | Look Up Table Value | Depending on the configuration enables reports |
| AutomationEquipment WaitOnSetupTimeOut AndRetryIfErrorOccurs | Attribute | No | Boolean | If Error occurs during setup phase, send warning at first error and retry connection on a defined time. Do not send error to On Setup Result |
| WalkingRouteStation | Attribute | No | String | Defines the default walking route station for the Resource |
SemiDataCollectionInstanceProtocolInstanceRelation#
Protocol Instance link to the DCI data as the main DCI of the Protocol
The table below describes the properties for this entity type:
| Name | Type | Is Mandatory | Data Type | Description |
|---|---|---|---|---|
| CreatedBy | Property | Yes | String | Identification of creation user |
| CreatedOn | Property | Yes | DateTime | Creation Date |
| DataGroupId | Property | Yes | BigInt | Unique dataGroup identifier |
| DataGroupName | Property | No | String | DataGroup Name |
| Description | Property | No | String | Description for the instance |
| DocumentationURL | Property | No | URL | Documentation of the instance |
| EntityPicture | Property | No | BigInt | Entity Picture of the instance |
| Id | Property | Yes | BigInt | Unique identifier instance |
| Image | Property | No | CmfImage | Image of the instance |
| LastOperation HistorySeq | Property | Yes | BigInt | Last operation history sequence |
| LastService HistoryId | Property | Yes | BigInt | Last service history identifier |
| ModifiedBy | Property | Yes | String | Identification of last modifier user |
| ModifiedOn | Property | Yes | DateTime | Last Modification Date |
| Name | Property | Yes | String | Name of the instance |
| SourceEntity | Property | Yes | EntityType DataCollectionInstance | Unique identifier of Source entity type |
| TargetEntity | Property | Yes | EntityType ProtocolInstance | Unique identifier of target entity type |
| UniversalState | Property | Yes | Enum UniversalState | Status of the instance in the system |