# 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                                                                                                                                  |
| :----------------------------------------------------------------- | :-------- | :----------: | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------- |
| SemiControlState                                                   | Attribute |      No      | String              | Current Semi Control State                                                                                                                   |
| SemiE30ProcessingState                                             | Attribute |      No      | String              | Current Semi Processing State                                                                                                                |
| SemiIsLoadPortInUse                                                | Attribute |      No      | Boolean             | If set with true, then currently docked carrier is locked for sorter operation purposes                                                      |
| SemiRequiresMaterialMovement                                       | Attribute |      No      | Boolean             | Check if resource is a sorter equipment                                                                                                      |
| AutomationEquipment<br>Address                                     | Attribute |      No      | String              | Address to use on connection to Equipment                                                                                                    |
| AutomationEquipment<br>DeviceId                                    | Attribute |      No      | Integer             | Equipment Device Id for SecsGem Interfaces                                                                                                   |
| AutomationEquipment<br>IPPort                                      | Attribute |      No      | Integer             | IP Port to use on connection to Equipment                                                                                                    |
| AutomationEquipment<br>CustomLibrary                               | Attribute |      No      | String              | Custom Library for Equipment Communication                                                                                                   |
| AutomationEquipment<br>SkipEstablishCommunication                  | Attribute |      No      | Boolean             | Establish Communication Request                                                                                                              |
| AutomationEquipment<br>SkipSetOnline                               | Attribute |      No      | Boolean             | Set Online Request                                                                                                                           |
| AutomationEquipment<br>DeleteReportMode                            | Attribute |      No      | Look Up Table Value | Depending on the configuration deletes the Reports                                                                                           |
| AutomationEquipment<br>SkipDefineReportMode                        | Attribute |      No      | Boolean             | Define Reports Mode                                                                                                                          |
| AutomationEquipment<br>SkipLinkEvents                              | Attribute |      No      | Boolean             | Link Reports                                                                                                                                 |
| AutomationEquipment<br>EnableDisableEventsMode                     | Attribute |      No      | Look Up Table Value | Depending on the configuration enables reports                                                                                               |
| AutomationEquipment<br>EnableDisableAlarmsMode                     | Attribute |      No      | Look Up Table Value | Depending on the configuration enables reports                                                                                               |
| AutomationEquipment<br>WaitOnSetupTimeOut<br>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 |
| AutomationEquipment<br>SerialPortName                              | Attribute |      No      | String              | Contains (Serial/TCP) COM port name to use                                                                                                   |
| AutomationEquipment<br>SerialBaudRate                              | Attribute |      No      | Integer             | Contains the (Serial/TCP) Connection Speed (bps)                                                                                             |
| AutomationAllowDownloadRecipeAtTrackIn                             | Attribute |      No      | Boolean             | Check if the tool is able to download recipes at TrackIn                                                                                     |
| AutomationEquipment<br>ProtocolDefinition                          | Attribute |      No      | Look Up Table Value | Defines which SECS protocol will be defined                                                                                                  |
| AutomationValidateModelAndSoftwareRevision                         | Attribute |      No      | Boolean             | Defines if Model and Software Revision are validated                                                                                         |
| AutomationEquipmentModelNumber                                     | Attribute |      No      | String              | Equipment  Model Number                                                                                                                      |
| AutomationEquipmentSoftwareRevision                                | Attribute |      No      | String              | Equipment Software Revision                                                                                                                  |
| AutomationModuleName                                               | Attribute |      No      | String              | Module Name                                                                                                                                  |
| SemiProceedOnSlotMapMismatch                                       | Attribute |      No      | Boolean             | If set with true, then the SlotMap validation should proceed with carrier                                                                   |

## 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<br>HistorySeq | Property |     Yes      | BigInt                            | Last operation history sequence         |
| LastService<br>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    |

## Step Attributes

Additional changes to the Step entity type.

The table below describes the properties for this entity type:

| Name                       | Type            | Is Mandatory | Data Type                   | Description                    |
| :------------------------- | :-------------- | :----------: | :-------------------------- | :----------------------------- |
| SemiRequiresSorterForLogistics              | Attribute       |      No      | Boolean                     | Enable/Disable the Requires Sorter For Logistics on current Step                |

## Material Attributes

Additional changes to the Material entity type.

The table below describes the properties for this entity type:

| Name                       | Type            | Is Mandatory | Data Type                   | Description                    |
| :------------------------- | :-------------- | :----------: | :-------------------------- | :----------------------------- |
| SemiIsFlipped              | Attribute       |      No      | Boolean                     | Semi Is Flipped                |
| SemiPendingResourceJobType | Custom Property |      No      | LookupValue ResourceJobType | Semi Pending Resource Job Type |

## ResourceJob Attributes

Additional changes to the ResourceJob entity type.

The table below describes the properties for this entity type:

| Name             | Type      | Is Mandatory | Data Type | Description                                                                   |
| :--------------- | :-------- | :----------: | :-------- | :---------------------------------------------------------------------------- |
| SemiIsAborting   | Attribute |      No      | Boolean   | Internal Semi state for aborting, used by SemiProcessAborted generic workflow |

## ResourceJobMaterial Attributes

Additional changes to the ResourceJobMaterial entity type.

The table below describes the properties for this entity type:

| Name             | Type      | Is Mandatory | Data Type | Description                                                                   |
| :--------------- | :-------- | :----------: | :-------- | :---------------------------------------------------------------------------- |
| SemiResourceJobRole   | Custom Property |      No      | LookupValue SemiResourceJobRole   | Semi Resource Job Role |

## ResourceJobContainer Attributes

Additional changes to the ResourceJobContainer entity type.

The table below describes the properties for this entity type:

| Name             | Type      | Is Mandatory | Data Type | Description                                                                   |
| :--------------- | :-------- | :----------: | :-------- | :---------------------------------------------------------------------------- |
| SemiResourceJobRole   | Custom Property |      No      | LookupValue SemiResourceJobRole   | Semi Resource Job Role |