MES Stateless API

GetByKey Method (JobExec)

Save PDF

GetByKey Method (JobExec)

Save PDF

Last UpdatedNov 06, 2025
4 minute read

The GetByKey() method retrieves the specified job exec record from the Job_Exec table.

Syntax

'Declaration
 
Public Shared Function GetByKey( _
   ByVal entId As Integer, _
   ByVal jobPos As Integer _
) As DataSet

'Usage
 
Dim entId As Integer
Dim jobPos As Integer
Dim value As DataSet
 
value = JobExec.GetByKey(entId, jobPos)

public static DataSet GetByKey( 
   int entId,
   int jobPos
)

Parameters

entId: Required. Holds the ID of the entity on which the job is running.
jobPos: Required. Holds the job position of the job that is being retrieved.

Return Value

Returns a DataSet that contains all the records in the Job_Exec table that satisfy the specified filters. 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 on which the job is running.
job_pos	An integer that is the job position.
ent_name	A string that is the unique name of the entity on which the job is running, from the ent.ent_name column.
next_job_only	A Boolean that is a flag the specifies whether to start next job.
item_based_desc	A Boolean that is a flag the specifies whether the description is item-based.
job_end_confirm_msg	A string that is the job end confirm message.
def_to_ent_id	An integer that is the ID of the default storage entity for the production item.
def_to_ent_name	A string that is the name of the default/preferred parent entity, from the ent.ent_name column.
def_reject_ent_id	An integer that is the ID of the default storage entity that is to receive reject production.
def_reject_ent_name	A string that is the name of the default reject entity, from the ent .ent_name column.
def_from_ent_id	A string that is the ID of the default storage entity for item issues, from the Job_Exec table.
def_from_ent_name	A string that is the name of the default source entity, from ent.ent_name column.
def_prod_reas_cd	An integer that is the default reas_cd for good production.
def_prod_reas_desc	A string that is the default production reason description.
def_cons_reas_cd	An integer that is the default reason code for normal consumption.
def_cons_reas_desc	A string that is the default consumption reason description.
def_lot_no	A string that is the default lot no.
def_sublot_no	A string that is the default sub lot.
autoload_job_specs	A Boolean that is a flag that specifies whether an auto load job spec to tags or not.
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 specifies whether to include item class reasons with the entity reason.
must_complete_steps	A Boolean that is a flag that specifies whether to complete/bypass the end.
must_prod_reqd_qty	A Boolean that is a flag that specifies whether the required quantity must be produced (good) to end the job.
local_movable_cons_ent	A Boolean that is a flag that specifies whether to move storage entities supplying consumption that need to be located at/in the entity doing the consumption.
local_movable_prod_ent	A Boolean that is a flag that specifies whether to move storage entities receiving production that need to be located at/in the entity doing the production.
run_without_operator	A Boolean that is a flag that specifies whether jobs can run without an operator logged onto this entity.
apply_post_exec_fc_counts	A Boolean that is a flag that specifies whether to apply post-execution counts from a custom application. Note: Not currently used.
suppress_start_qty_prompt	A Boolean that is a flag that specifies whether to suppress the prompt to specify a quantity to start that is typically displayed when the Start Some button is pressed.
allow_zero_qty_split	A Boolean that is a flag that specifies whether to set the default starting and required quantities to 0 when start some is pressed.
auto_alloc_qty_to_running_job	A Boolean that is a flag that specifies whether to tell the system to automatically split sufficient quantities from a scheduled, non-running job to the running job to cover production reported that is greater than allowed.
cur_wo_id	A string that is current work order ID.
cur_oper_id	A string that is the current operation ID.
cur_seq_no	An integer that is the current sequence number.
cur_step_no	An integer that is the current step number.
cur_step_start	A datetime that is when the last step was started on this entity.
spare1	A string that is the contents of the spare1 field, from the Job_Exec table.
spare2	A string that is the contents of the spare2 field, from the Job_Exec table.
spare3	A string that is the contents of the spare3 field, from the Job_Exec table.
spare4	A string that is the contents of the spare4 field, from the Job_Exec table.
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 datetime that indicates when the record was added or last updated.

MES Stateless API

GetByKey Method (JobExec)

Table of Contents

GetByKey Method (JobExec)

In This Topic

MES Stateless API

GetByKey Method (JobExec)

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic