MES Stateless API

GetUtilExecEnts Method

Save PDF

GetUtilExecEnts Method

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetUtilExecEnts() method retrieves the records from the Util_Exec table for the utilization exec entities that the user has logged on to.

Syntax

'Declaration
 
Public Shared Function GetUtilExecEnts( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal startTime As Date _
) As DataSet

'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim startTime As Date
Dim value As DataSet
 
value = Session.GetUtilExecEnts(sessionId, userId, startTime)

public static DataSet GetUtilExecEnts( 
   int sessionId,
   string userId,
   DateTime startTime
)

Parameters

sessionId: Required. Holds the session ID and thus the user who is making this method call.
userId: Required. Holds the ID of the user who has logged on to the session.
startTime: Required. Holds the date/time that indicates the session start time.

Return Value

Returns a DataSet that contains all the records in the Util_Exec table of the utilization execs that the specified user has logged onto. If a non-null value for the startTime parameter is supplied, then the DataSet is limited to the utilization exec entities that the user has logged onto after the supplied start time. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
ent_id	An integer that is the ID of the entity that can capture utilization, from ent.ent_id column.
ent_name	A string that is the name of the entity from ent.ent_name column linked to this ent_id.
cur_state_cd	An integer that is the code that indicates the current state of this entity.
state_desc	A string that is the description of the entity’s state, from the util_state.state_desc column linked to this state.
color	An integer that indicates the background color that should be displayed on the user interface when this row is selected.
cur_reas_cd	An integer that is the current reason code for this entity.
reas_desc	A string that is the description of the utilization reason, from the util_reas.reas_desc linked to this cur_reas_cd column.
cur_reas_start_utc	A date/time that is when this reason was started, in UTC.
cur_reas_start_local	A date/time that is when this reason was started, in local time.
cur_raw_reas_cd	A string that is the current raw reason code for this entity.
reas_reqd	A Boolean that is a flag that indicates whether this entity is waiting for the user to enter/override a final reason.
cur_log_id	An integer that is the current event’s log_id from the Util_Exec table. The cur_log_id represents the current utilization event from the Util_History table, and a reference to that log_id is stored in the Util_Exec table.
target_util	A double that is the target entity utilization.
current_util	A double that is the current entity utilization.
jobstart_reas_cd	An integer that is the default reason code for job starts.
jobstart_reas_desc	A string that is the description of the reason, from the util_reas.reas_desc linked to this jobstart_reas_cd.
jobend_reas_cd	An integer that is the default reason code for job ends.
jobend_reas_desc	A string that is the description of the reason, from the util_reas.reas_desc linked to this jobend_reas_cd.
shift_start_reas_cd	An integer that is the default reason code for shift starts.
shift_start_reas_desc	A string that is the description of the reason, from the util_reas.reas_desc linked to this shift_start_reas_cd.
shift_end_reas_cd	An integer that is the default reason code for shift ends.
shift_end_reas_desc	A string that is the description of the reason, from the util_reas.reas_desc linked to this shift_end_reas_cd.
unkn_stop_reas_cd	An integer that is the default unknown stop reason code for machine stops received from I/O.
unkn_stop_reas_desc	A string that is the description of the reason, from the util_reas.reas_desc linked to this unkn_stop_reas_cd.
spare1	A string that is the contents of the user-defined spare1 field.
spare2	A string that is the contents of the user-defined spare2 field.
spare3	A string that is the contents of the user-defined spare3 field.
spare4	A string that is the contents of the user-defined spare4 field.
cur_reas_duration	A string that is the current duration, in ‘hh:mi:ss’ format. Leading zeros are eliminated.
last_edit_comment	A string that contains comments about why the record was added or updated.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A date/time that indicates when the record was added or last updated.

MES Stateless API