Ents Class Methods
- Last UpdatedNov 06, 2025
- 6 minute read
For a list of all members of this type, see Ents members.
| Name | Description | |
|---|---|---|
  | AddEntity | The AddEntity() method adds a new entity to the specified parent entity and returns the entity ID that is generated. |
| AddEntLink | The AddEntLink() method adds a link record to define the specified parent entity as a parent of the specified child identity. |
| CopyEntityShiftSchedule | The CopyEntityShiftSchedule() method copies the shift schedules from the specified source entity to those entities specified in an entity list that can schedule shifts. Optionally, a shift ID list can be included to specify the shifts that will be copied. If the shift ID list is null, then all shifts from the source entity will be copied. |
| DeleteEntity | The DeleteEntity() method removes the specified entity from the database. |
| DeleteEntLink | The DeleteEntLink() method deletes any link record that defines the specified parent entity as a parent of the specified child entity. |
| GetAllShiftSchedules | The GetAllShiftSchedules() method retrieves all shift schedules for all entities. |
| GetCountsAndDuration | Overloaded. The GetCountsAndDuration() method returns a DataSet containing one row for each utilization state, reason group, or reason for the specified entity. It has columns for the ID, description, count or duration, color (valid only for utilization states and reasons), and an active flag that is set true for the current utilization state, reason group, or reasonOEEExec. |
| GetEntChildren | The GetEntChildren() method retrieves all of the children entities for the specified entity that can have jobs scheduled to them. |
| GetEntityFromComboBoxEntry | Overloaded. The GetEntityFromComboBoxEntry() method retrieves the entity ID and entity name for the entity selected in the combo box. For this overload of the method, if no entity is selected, it returns a -1 for the entity ID. |
| GetEntProperties | Overloaded. The GetEntProperties() method retrieves the configured properties for entities. This overload of the method retrieves the configured properties for all entities from the database. The caller must catch any exception if this call fails. |
| GetOEEExecData | The GetOEEExecData() method retrieves OEE Exec data (that is, the extra configuration data required for an entity that is capable of tracking OEE data) for the entity. |
| GetOEEValue | The GetOEEValue() method retrieves the current OEE value for the specified KPI. The KPI can be specified using duration, time unit, start time, and end time filter items. |
| GetUtilExecData | The GetUtilExecData() method retrieves Util Exec data (that is, the extra configuration data required for an entity that is capable of collecting utilization data) for the entity. |
| NumberOfJobsRunning | The NumberOfJobsRunning() method retrieves the number of jobs currently running on the specified entity. |
| PopulateEntityComboBox | Overloaded. This overload of the PopulateEntityComboBox() method populates the specified combo box with the data in the Ent table. It includes an empty entry in the combo box, if requested. Each entity is added as an entity object to the combo box. The entity object includes the entity name and the entity ID. The name is displayed in the combo box. A flag indicates whether an empty entry should be added to the combo box |
| PrepareProductionAttributes | Overloaded. This overload of the PrepareProductionAttributes() method accepts a set of values for all production attributes of an entity identified by its ID and creates a data entry job to support logging utilization against these attributes. |
| RegisterForOEEChanges | The RegisterForOEEChanges() method registers the specified entity to receive callback events for OEE changes. |
| RegisterForUtilizationChanges | The RegisterForUtilizationChanges() method registers the specified entity to receive callback events for utilization changes. |
| SelectEntityInComboBox | Overloaded. The SelectEntityInComboBox() method selects the specified entity in the supplied combo box. For this overload of the method, if an empty entry has been added to the combo box, it can be selected by setting the entity ID to -1. |
| UpdateEntity | Overloaded. The UpdateEntity() method updates the specified entity with the new parameter values supplied. |
| UpdateJobExec | Overloaded. The UpdateJobExec() method updates the job exec record for the specified job position for the specified entity. |
| UpdateOEEExec | Overloaded. The UpdateOEEExec() method updates the OEE Exec record for the specified entity. |
| UpdateUtilExec | Overloaded. The UpdateUtilExec() method updates the Util Exec record for the specified entity. |