MES Stateless API

GetAll Method (OperStep)

Save PDF

GetAll Method (OperStep)

Save PDF

Last UpdatedNov 06, 2025
6 minute read

The GetAll() method retrieves one or more operation step records from the Oper_Step table, as specified by the filter parameters. Passing no filter parameters will retrieve all operation step records from the table.

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal processId As String, _
   ByVal operId As String, _
   ByVal stepNo As Nullable(Of Integer), _
   ByVal stepSeq As Nullable(Of Integer), _
   ByVal stepName As String, _
   ByVal actionType As Nullable(Of Integer), _
   ByVal completeCond As Nullable(Of Integer), _
   ByVal enterData As Nullable(Of Boolean), _
   ByVal stepGrpId As Nullable(Of Integer), _
   ByVal spcChar As String, _
   ByVal dataLogGrpId As Nullable(Of Integer), _
   ByVal controlType As Nullable(Of Integer), _
   ByVal spare1 As String, _
   ByVal spare2 As String, _
   ByVal spare3 As String, _
   ByVal spare4 As String, _
   ByVal spare5 As String, _
   ByVal spare6 As String, _
   ByVal lastEditBy As String, _
   ByVal lastEditAt As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim processId As String
Dim operId As String
Dim stepNo As Nullable(Of Integer)
Dim stepSeq As Nullable(Of Integer)
Dim stepName As String
Dim actionType As Nullable(Of Integer)
Dim completeCond As Nullable(Of Integer)
Dim enterData As Nullable(Of Boolean)
Dim stepGrpId As Nullable(Of Integer)
Dim spcChar As String
Dim dataLogGrpId As Nullable(Of Integer)
Dim controlType As Nullable(Of Integer)
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim spare5 As String
Dim spare6 As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = OperStep.GetAll(processId, operId, stepNo, stepSeq, stepName, actionType, completeCond, enterData, stepGrpId, spcChar, dataLogGrpId, controlType, spare1, spare2, spare3, spare4, spare5, spare6, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   string processId,
   string operId,
   Nullable<int> stepNo,
   Nullable<int> stepSeq,
   string stepName,
   Nullable<int> actionType,
   Nullable<int> completeCond,
   Nullable<bool> enterData,
   Nullable<int> stepGrpId,
   string spcChar,
   Nullable<int> dataLogGrpId,
   Nullable<int> controlType,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string spare5,
   string spare6,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

processId: Optional filter parameter. Holds the ID of the process to which an operation step belongs.
operId: Optional filter parameter. Holds the ID of the operation to which an operation step belongs.
stepNo: Optional filter parameter. Holds a step number.
stepSeq: Optional filter parameter. Holds a step sequence number.
stepName: Optional filter parameter. Holds the name of a step.
actionType: Optional filter parameter. Holds an enumeration that indicates the step's action type:

0 = Normal (default)

1 = Log data

2 = Add production

3 = Add consumption

4 = Operator acknowledge

5 = Enter form data

6 = Enter SPC data
completeCond: Optional filter parameter. Holds an enumeration that indicates the step's complete condition:

2 = std. time elapses

3 = operator completes manually (default)

4 = message is dismissed (only allowable if actionType = 4)
enterData: Optional filter parameter. Holds a flag that indicates whether step data can be entered.
stepGrpId: Optional filter parameter. Holds the ID of the step group for a step.
spcChar: Optional filter parameter. Holds the SPC characteristic to be collected at a step.
dataLogGrpId: Optional filter parameter. Holds the ID of the data log group for a step.
controlType: Optional filter parameter. Holds a control type.
spare1: Optional filter parameter. Holds the contents of the user-defined spare1 field.
spare2: Optional filter parameter. Holds the contents of the user-defined spare2 field.
spare3: Optional filter parameter. Holds the contents of the user-defined spare3 field.
spare4: Optional filter parameter. Holds the contents of the user-defined spare4 field.
spare5: Optional filter parameter. Holds the contents of the user-defined spare5 field.
spare6: Optional filter parameter. Holds the contents of the user-defined spare6 field.
lastEditBy: Optional filter parameter. Holds the ID of a user who added or last updated an operation step record.
lastEditAt: Optional filter parameter. Holds the date/time when a operation step record was added or last updated.

Return Value

Returns a DataSet that contains records for all the operation steps that satisfy the specified filters. The returned records include columns from the Oper_Step, Oper_Step_Grp, Oper, and Process tables. If no matching operation steps are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
processId	A string that is the ID of the process for which the operation route is defined.
operId	A string that is the ID of the operation for this process.
step_no	An integer that is the step number.
step_seq	An integer that is the sequence number for this step.
step_name	A string that is the name that briefly describes the step and that is shown in the user interface.
step_desc	A string that is the description for this step
action_type	An integer that is the action type value.
std_time	A double that is the hours allowed for this step.
complete_cond	An integer that is the complete condition value. The completeCond input parameter holds the value, which is an enumeration of what completes the step: 2 = standard time elapses 3 = user completes manually (the default) 4 = message is dismissed (only allowable if action_type = 4)
allow_bypass	A Boolean that is a flag that specifies whether the user can bypass this step or not.
enter_data	A Boolean that is a flag that specifies whether the data entry is required at this step or not.
step_grp_id	An integer that is the step group ID.
step_grp_desc	A string that is the description for this step group ID, from the Oper_Step_Grp table.
spc_char	A string that is the SPC characteristic that is collected at this step.
form_name	A string that is the link to an optional form for this step
Data_Log_grp_id	An integer that is the ID of the data log group for this step.
reqd_rep_pct	A double that is the percentage of lots or sublots for which this step must be performed.
control_type	An integer that identifies the control type value.
high_limit	A double that is the maximum allowable value if control_type = 1; otherwise, it is null (the default).
low_limit	A double that is the minimum allowable value if control_type = 1; otherwise, it is null (the default).
limit_warning	A Boolean that is a flag that specifies, when control_type is 1, whether an entered value is outside the maximum and minimum limits, warning the user but permitting entry anyway. If false (the default), control_type is 1, and the entered value is outside the limits, the entry is not allowed. This flag has no effect if control_type is not 1 or the entered value is within the limits.
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.
spare5	A string that is the contents of the user-defined spare5 field.
spare6	A string that is the contents of the user-defined spare6 field.
oper_desc	A string that is the operation description, from the Oper table.
process_desc	A string that is the process description, from the Process table.
step_grp_seq	A string that is the sequence number of the step group, from the Oper_Step_Grp table.
repeatability	An integer that is the repeatability of steps in this group.
can_log_data	A Boolean that is a flag that specifies whether the step can log data.
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.
mod_id	The current modification ID of the record in the table. This ID is binary number that increments each time the record’s table row is modified. Optionally used for optimistic concurrency control when performing updates or deletes.
step_grp_last_edit_at	A datetime that indicates when the related step group record was created or last updated, from the Oper_Step_Grp table.
row_id	An integer that is the row ID.

MES Stateless API