MES Stateless API

GetStepBOMData Method

Save PDF

GetStepBOMData Method

Save PDF

Last UpdatedNov 06, 2025
4 minute read

The GetStepBOMData() method retrieves details of all step data for the specified job, including any BOM data if a BOM item is linked to this step.

Syntax

'Declaration
 
Public Shared Function GetStepBOMData( _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Integer, _
   ByVal stepNo As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim woId As String
Dim operId As String
Dim seqNo As Integer
Dim stepNo As Nullable(Of Integer)
Dim value As DataSet
 
value = JobExec.GetStepBOMData(woId, operId, seqNo, stepNo)

public static DataSet GetStepBOMData( 
   string woId,
   string operId,
   int seqNo,
   Nullable<int> stepNo
)

Parameters

woId: Required. Holds the work order ID of the job.
operId: Required. Holds the operation ID of the job.
seqNo: Required. Holds the job sequence number.
stepNo: Optional. Holds a job step number by which to filter the steps whose details are being retrieved. If specified, the returned data includes only a single row of data for the specified step number, if it exists.

Return Value

Returns a DataSet that contains details records for each step of the specified job, or for a single step of the optional step number filter is used. If no matching job steps are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
wo_id	A string that is the work order ID, from the job_step.wo_id column.
oper_id	A string that is the operation ID, from the job_step.oper_id column.
seq_no	An integer that is the sequence number, from the job_step.seq_no column.
step_no	A string that is the step number, from the job_step column.
step_desc	A string that is the step description, from the job_step.step_dec column.
action_type	An integer that is the Action type, from the job_step.action_type column. 0 = Normal 1 = Log data 2 = Add production 3 = Add consumption 4 = Operator acknowledge 5 = Enter form data 6 = Enter SPC data 7 = Specifications
std_time	A double that is the hours allowed for this step, from the job_step.std_time column.
complete_cond	An integer that is what completes the step, from the job_step.complete_cond column.
allow_bypass	A Boolean that is a flag that indicates whether the user can by-pass the step, from the job_step.allow_bypass column.
enter_data	A Boolean that is a flag that indicates whether the data entry required at the step, from the job_step.enter_data column.
step_grp_id	An integer that is step grid ID, from the job_step.step_grid_id column.
spc_char	A string that is the SPC characteristic to be collected at this step, from the job_step.spc_char column.
form_name	A string that is the link to an optional form for this step, from the job_step.form_name column.
js_spare1 to js_spare6	A string that is the contents of the user-defined spare1 to spare6 fields for the job step, from the Job_Step table.
bom_pos	An integer that is the BOM position, from the job_bom_step.bom_pos column.
jbs_qty_per_parent_item	A double that is the nominal quantity of the item per unit of the immediate parent item for this step, from the job_bom_step.qty_per_parent_item column.
bom_pos	An integer that is BOM position, from the job_bom.bom_pos column.
item_id	A string that is the item ID, from the job_bom.item_id column.
reqd_grade_cd	An integer that is required grade code, from the job_bom. reqd_grade_cd column.
instruction	A string that explains how to produce or consume the item, from the job_bom.instruction column.
jb_qty_per_parent_item	A double that is the nominal quantity of item per unit of the immediate parent item for this step, from the job_bom.qty_per_parent_item column.
max_qty_per_parent_item	A double that is the maximum acceptable column quantity of BOM component per parent item, from the job_bom. max_qty_per_parent_item column.
min_qty_per_parent_item	A double that is the minimum acceptable column quantity of BOM component, from the job_bom. min_qty_per_parent_item column.
update_inv	A Boolean that is a flag that indicates whether to update inventory for item consumption, from the job_bom.update_inv column.
backflush	A Boolean that is a flag that indicates whether to backflush consumption, from the job_bom.backflush column.
def_reas_cd	An integer that is the default item reason code, from the job_bom.def_reas_cd column.
def_lot_no	A string that is the default lot from which to consume, from the job_bom.def_lot_no column.
def_storage_ent_id	An integer that is the default storage entity from which to get an item (or put by-product), from the job_bom.def_storage_ent_id column.
scaling_factor	A double that is the scaling factor to get correct units from counts, from the job_bom.scaling_factor column.
must_consume_from_inv	A Boolean that is a flag that indicates whether consumption must occur from inventory for the item, from the job_bom. must_consume_from_inv column.
may_choose_alt_inv_loc	A Boolean that is a flag that indicates whether the user can select alternate inventory locations when consuming or producing the item, from the job_bom. may_choose_alt_inv_loc. column.
may_create_new_lots	A Boolean that is a flag that indicates whether the user can create new lots when consuming or producing the item, from the Job_Bom table.
must_consume_from_wip	A Boolean that is a flag that indicates whether the lots consumed during a job must be limited to those lots in an upstream job of the same work order, from the job_bom. must_consume_from_wip column.
must_consume_before_prod	A Boolean that is a flag that indicates whether to prevent any production transactions until acceptable quantities of BOM components have been consumed, from the job_bom.must_consume_before_prod column.
constant_qty	A Boolean that is a flag that indicates whether the quantities consumed of this item are independent of the quantity of the parent item produced, from the job_bom. constant_qty column.
jb_spare1 to jb_spare4	A string that is the contents of the user-defined spare1 to spare6 fields for the job BOM, from the Job_Bom table.

MES Stateless API

GetStepBOMData Method

Table of Contents

GetStepBOMData Method

In This Topic

MES Stateless API

GetStepBOMData Method

Syntax

Parameters

Return Value

See Also

Reference

In This Topic