StartStep(Int32,String,String,String,Int32,String,String,Nullable<Int32>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Int32>) Method
- Last UpdatedNov 06, 2025
- 3 minute read
The StartStep() method starts a step for a specified job on a specified entity.
This overload of the method uses the entity name and site name to specify the entity.
'Declaration
Public Overloads Shared Sub StartStep( _
ByVal sessionId As Integer, _
ByVal userId As String, _
ByVal entName As String, _
ByVal siteName As String, _
ByVal stepNo As Integer, _
ByVal lotNo As String, _
ByVal subLotNo As String, _
ByVal stateCd As Nullable(Of Integer), _
ByVal checkCert As Nullable(Of Boolean), _
ByVal laborOption As Nullable(Of Boolean), _
ByVal jobPos As Nullable(Of Integer) _
)
'Usage
Dim sessionId As Integer
Dim userId As String
Dim entName As String
Dim siteName As String
Dim stepNo As Integer
Dim lotNo As String
Dim subLotNo As String
Dim stateCd As Nullable(Of Integer)
Dim checkCert As Nullable(Of Boolean)
Dim laborOption As Nullable(Of Boolean)
Dim jobPos As Nullable(Of Integer)
JobExec.StartStep(sessionId, userId, entName, siteName, stepNo, lotNo, subLotNo, stateCd, checkCert, laborOption, jobPos)
public static void StartStep(
int sessionId,
string userId,
string entName,
string siteName,
int stepNo,
string lotNo,
string subLotNo,
Nullable<int> stateCd,
Nullable<bool> checkCert,
Nullable<bool> laborOption,
Nullable<int> jobPos
)
Parameters
- sessionId
- Required. Holds the ID of the session from which the call is being made.
- userId
- Required. Holds the ID of the user who is starting the step.
- entName
- Required. Holds the name of the entity on which the step is to be started. This will identify the job that contains this step.
- siteName
- Optional. Holds the site name of the entity
- stepNo
- Required. Holds the number of the step that is being started.
- lotNo
- Required. Holds the lot number on which this step is being performed.
- subLotNo
- Optional. Holds the sublot number on which this step is being performed.
- stateCd
- Optional. Holds the state of the step. The only valid state codes are 3 (Running) or 8 (Bypassed). Default is Running.
- checkCert
- Optional. Holds a flag that, if set to true, specifies that the user’s certifications should be checked before starting the job (requires the Certification module). Default is false.
- laborOption
- Optional. Holds a flag that, if set to true, specifies that labor usage be captured by the step. Default is false. (Requires the Labor option to be licensed.)
- jobPos
- Optional. Holds the job position. If greater than 1, jobs are running on this entity.
If this step has never been started on this lot_no, then a new record is added to the Job_Step_Data table. If it has previously been started, then the state_cd and start_user_id fields of the existing record are updated to the new values.
If the labor_option flag is true, then this method will also log this user into this step for the purpose of capturing labor usage against the step. This is equivalent to calling the StepLogin() method.
For the method to succeed, the following must be true:
- The specified job is not already running on the entity.
- All preceding steps within the group for the supplied lot number have already been completed or bypassed, and all preceding steps within all proceeding groups have been completed or bypassed.
- If the checkCert flag is true, the user has the required certifications to start the step.