MES Stateless API

GetJobExecEnts Method

Save PDF

GetJobExecEnts Method

Save PDF

Last UpdatedNov 06, 2025
5 minute read

The GetJobExecEnts() method retrieves a list of all the entities that can run jobs and that the specified user is currently logged on to.

Syntax

'Declaration
 
Public Shared Function GetJobExecEnts( _
   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.GetJobExecEnts(sessionId, userId, startTime)

public static DataSet GetJobExecEnts( 
   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 whose logged on to entities that are being retrieved.

startTime

Required. Holds a date/time that identifies a session start time by which to filter the entities that are being retrieved. If a time is provided, only those entities that the user has logged on to after the specified start time are retrieved.

To not include this parameter as a filter, pass a null.

Return Value

Returns a DataSet that contains the records from the Job_Exec table that correspond to supplied user ID and, optionally, start time parameters. 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, from the Ent_Logon table.
job_pos	An integer that is the job position if this entity is capable of running more than one job at a time.
ent_name	A string that contains the name of the entity, from the ent.ent_name column linked to this Ent_Logon record.
next_job_only	A Boolean that is a flag that indicates whether to select the next job only or select any – an inverse of the override queue privilege, but by physical entity rather than by user group.
item_based_desc	A Boolean that is a flag that indicates whether messages use the item and not the operation description.
job_end_confirm_msg	A string that contains a confirmation message while ending an operation.
def_to_ent_id	An integer that is the ID of the default storage entity for good production items, and rejects if def_reject_ent_id is null.
def_to_ent_name	A string that contains the name of the entity from ent.ent_name linked to this def_to_ent_id column.
def_reject_ent_id	An integer that is the ID of the default storage location for rejected items.
def_reject_ent_name	A string that contains the name of the entity from the ent.ent_name linked to this def_reject_ent_id column.
def_from_ent_id	An integer that is the ID of the default storage entity for the item issues.
def_from_ent_name	A string that contains the name of the entity, from ent.ent_name linked to this def_from_ent_id.
def_prod_reas_cd	An integer that is the default reason code for good production.
def_prod_reas_desc	A string that contains the reason description, from the item_reas.reas_desc linked to this def_prod_reas_cd column.
def_cons_reas_cd	An integer that is the default reason code for normal consumption.
def_cons_reas_desc	A string that contains the description of the reason, from the item_reas.reas_desc linked to this def_cons_reas_cd.
def_lot_no	A string that contains the default lot number for production.
def_sublot_no	A string that contains the default sublot number for production.
autoload_job_specs	A Boolean that is a flag that indicates whether this entity should automatically load job specifications to tags.
auto_seq_start_option	An integer that specifies when to automatically start the job with the next sequence number: 0 = Do not start the job with the next sequence number automatically 1 = Start the job with the next sequence number when the job with the previous sequence number is completed
auto_job_start_option	An integer that specifies when to automatically start the next job: 0 = Do not start the next job automatically 1 = Start the next job when ready and the previous job has completed
auto_job_end_option	An integer that specifies when to automatically end the job: 0 = Do not end the job automatically 1 = End the job when the quantity produced is equal to or greater than the required quantity
incl_class_reas	A Boolean that is a flag that indicates whether this item reason for the item class should also be available to choose from, if there are entity-related item reasons defined.
must_complete_steps	A Boolean that is a flag that indicates whether all steps must be completed/bypassed to end jobs running on this entity.
must_prod_reqd_qty	A Boolean that is a flag that indicates whether a job must produce required quantities (good) to end a job.
local_movable_cons_ent	Unused.
local_movable_prod_ent	Unused.
run_without_operator	A Boolean that is a flag that indicates whether jobs can run without an operator logged on to this entity. If false, running jobs are suspended when the last operator logs off. If this entity can collect labor, this means when no more labor is being attributed to the job, which might be prior to having no operator logged on this entity.
apply_post_exec_fc_counts	A Boolean that is a flag that indicates whether the production counts received from a custom application when no job is running should be applied to the last job that ran on the entity. If set to false, such counts are ignored. Note: Not currently used.
suppress_start_qty_prompt	A Boolean that is a flag that indicates whether the prompt to specify a quantity to start, typically displayed when the Start Some button is pressed, is to be suppressed.
allow_zero_qty_split	A Boolean that is a flag that indicates whether the default quantities to be used for start some are 0.
auto_alloc_qty_to_running_job	A Boolean that is a flag that indicates whether averages in reported production are to be covered by moving quantities from a scheduled, non-running job if available.
cur_wo_id	A string that contains the current work order running on this entity.
cur_oper_id	A string that contains the current operation on this entity.
cur_seq_no	An integer that is the current operation split.
cur_step_no	An integer that is the last step started on this entity.
cur_step_start	A date/time that indicates when the last step was started on this entity (in UTC).
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.
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 value that indicates when the record was created or last modified.

MES Stateless API