MES Stateless API

GetStatusInfoByUser Method

Save PDF

GetStatusInfoByUser Method

Save PDF

Last UpdatedMar 17, 2026
7 minute read

The GetStatusInfoByUser() method retrieves the current status information for the entity that the specified user is currently controlling.

Syntax

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

'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim value As DataSet
 
value = Ent.GetStatusInfoByUser(sessionId, userId)

public static DataSet GetStatusInfoByUser( 
   int sessionId,
   string userId
)

Parameters

sessionId: Required. Holds the session ID from which this method call is being made.
userId: Required. Holds the ID of the user who is controlling the entity whose status information is being retrieved.

Return Value

Returns a DataSet that includes the status information for the entity currently controlled by the specified user.

The columns of the returned DataSet are described below.

Column Names	Description
ent_id	A string that is the entity ID, from the Ent table.
ent_name	A string that is the entity name, from the Ent table.
cur_shift_id	An integer that is the current shift on this entity, from the Ent table.
cur_shift_desc	A string that is the shift description, from the Shift table. A null is returned if the shift was deleted.
cur_shift_start_time_utc	A datetime that identifies the current shift start time for the entity in UTC, from the Ent table.
cur_shift_start_time_local	A datetime that identifies the current shift start time for the entity in local time, from the Ent table.
cur_shift_start_time	A datetime that identifies the current shift start time for the entity.
tree_icon	A string that is the key for retrieving the hierarchy tree icon image from the Graphics table. Not currently implemented
job_pos	An integer that is the number of jobs run concurrently on the entity, from the Job_Exec table. Returns 0 when only a single job can run on the entity at a time.
cur_wo_id	A string that is the current work order on the entity, from the Job_Exec table.
cur_wo_desc	A string that is the current work order description, from the WO table.
cur_oper_id	A string that is the ID of the current operation on the entity, from the Job_Exec table.
cur_seq_no	An integer that is the current operation split, from the Job_Exec table.
cur_job_desc	A string that is the description of the job, from the Job table.
cur_job_notes	A notes type that holds the specific notes for this job (typically for the operator to read), from the Job table.
batch_size	A double that is the amount of product per batch, from the Job table.
job_state_cd	An integer that is the state ID, from the Job table.
cur_step_no	An integer that is the last step started on the entity, from the Job_Exec table. A null is returned if steps are not being used.
next_job_only	A Boolean type flag that indicates whether to start the next job only or not, from the Job_Exec table.
spare1	A string that is the spare1 entry, from Job_Exec table.
spare2	A string that is the spare2 entry, from Job_Exec table.
spare3	A string that is the spare3 entry, from Job_Exec table.
spare4	A string that is the spare4 entry, from Job_Exec table.
target_perf	A double that is the target performance value, from the Oee_Exec table.
current_perf	A double that is the current performance value, from the Oee_Exec table.
target_qual	A double that is the target quality value, from the Oee_Exec table.
current_qual	A double that is the current quality value, from the Oee_Exec table.
target_oee	A double that is the target OEE, from the Oee_Exec table.
current_oee	A double that is the current OEE, from the Oee_Exec table.
mo_id	A string that is the manufacturing order, for grouping different final parts, from the WO table.
cust_info	A string that is the customer information for given work order, from the WO table.
item_id	A string that is the item resulting from given job, from the Job table.
job_priority	An integer that is the operation priority, from the Job table.
req_finish_time_utc	A datetime that identifies the required completion date/time in UTC, from the Job table.
req_finish_time_local	A datetime that identifies the required completion date/time in local time, from the Job table.
req_finish_time	A datetime that identifies the required completion date/time.
qty_reqd	A double that is the quantity of the item required, from the Job table.
qty_prod	A double that is the quantity of the item made so far, from the Job table.
qty_rejected	A double that is the quantity of the item rejected so far, from the Job table.
qty_at_start	A double that is the quantity of the item that is expected to be produced if there are no scrap/waste/rejects, from the Job table.
sched_start_time_utc	A datetime that identifies the scheduled start time in UTC, from the Job table.
sched_start_time_local	A datetime that identifies the scheduled start time in local time, from the Job table.
sched_start_time	A datetime that identifies the scheduled start time.
sched_finish_time_utc	A datetime that identifies the estimated completion time in UTC, from the Job table.
sched_finish_time_local	A datetime that identifies the estimated completion time in local time, from the Job table.
sched_finish_time	A datetime that identifies the estimated completion time.
util_cur_state_cd	An integer that is the current state of the given entity, from the Util_Exec table.
cur_reas_cd	An integer that is the current reason for the given entity, from the Util_Exec table.
target_util	A double that is the target entity utilization, from the Util_Exec table.
current_util	A double that is the current entity util = RT/(RT+DT) , from the Util_Exec table.
cur_reas_start_utc	A datetime that identifies when the current entity reason started in UTC, from the Util_Exec table.
cur_reas_start_local	A datetime that identifies when the current entity reason started in local time, from the Util_Exec table.
cur_reas_start	A datetime that identifies when the current entity reason started.
reas_reqd	A Boolean flag that indicates whether a final reason is required for the entity, from the Util_Exec table.
qty_to_do	A double that is the quantity of the item still required to be made (qty_reqd - qty_prod).
def_lot_no	A string that is the default lot number for production, from the Job_Exec table.
def_prod_reas_cd	An integer that is the default reason code for good production, from the Job_Exec table.
def_cons_reas_cd	An integer that is the default reason code for normal consumption, from the Job_Exec table.
def_to_ent_id	An integer that is the ID of the default storage entity for good production, from the Job_Exec table.
def_from_ent_id	An integer that is the ID of the default storage entity for the item issues, from the Job_Exec table.
hourly_cost	A double that is the hourly cost of running this entity, from the Ent table.
def_to_ent_name	A string that is the name of the default storage entity for good production, from the Ent table.
def_reject_ent_id	An integer that is the ID of the default storage entity for reject production items, from the Job_Exec table.
def_reject_ent_name	A string that is the name of the default storage entity for reject production items, from the Ent table.
def_from_ent_name	A string that is the name of the default storage entity for the item issues, from the Ent table.
def_prod_reas_desc	A string that is the description of the default reason code for good production, from the Item_Reas table.
def_cons_reas_desc	A string that is the description of the default reason code for normal consumption, from the Item_Reas table.
run_without_operator	A Boolean flag that indicates whether jobs can be run without an operator logged onto the entity, from the Job_Exec table. If set to false, running jobs are suspended when the last operator logs off. If the entity can collect labor, then no more labor will be attributed to the job, which could be prior to having no operator logged onto the entity.
item_desc	A string that is the description of the item, from the Item table.
uom_id	An integer that is the ID of the unit of measure, from the Item table.
description	A string that is the description of the unit of measure, from the Uom table.
abbreviation	A string that is the abbreviation of the unit of measure, from the Uom table.
serial_no_lvl	An integer that is the serial number level, from the Item table. 0 = the lot number is the serial number >0 = a particular sublot level is the serial number –1 = there are no serial numbers
util_state_desc	A string that is the state description, from the Util_State table.
util_color	An integer that is the background color, from the Util_State table.
reas_desc	A string that is the reason description, from the Util_Reas table.
job_state_desc	A string that is the description of state, from the Job_State table.
job_color	An integer that is the RGB background color, from the Job_State table.
apply_post_exec_fc_counts	A Boolean flag that indicates whether production counts received from a custom application when no job is running should be applied to the last job that ran on the entity, from the Job_Exec table. Note: Not currently used.
suppress_start_qty_prompt	A Boolean flag that indicates whether the prompt to specify a quantity to start that is typically displayed when the Start Some button is pressed is to be suppressed , from the Job_Exec table.
allow_zero_qty_split	A Boolean flag that indicates whether default quantities to be used for Start Some are 0 (true) or 1 (false), from the Job_Exec table.
auto_alloc_qty_to_running_job	A Boolean flag that indicates whether overages in reported production are to be covered by moving quantities from a scheduled, non-running job if available, from the Job_Exec table. If set to false, then reporting an overage will result in an error.

MES Stateless API

GetStatusInfoByUser Method

Table of Contents

GetStatusInfoByUser Method

In This Topic

MES Stateless API

GetStatusInfoByUser Method

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic