StepLogout(Int32,String,String,String,Int32,String,String,Nullable<DateTime>,Nullable<Int32>) Method
- Last UpdatedNov 06, 2025
- 2 minute read
The StepLogout() method logs a user out of a step/lot for the purpose of ending labor capturing for the step/lot.
This overload of the method uses the entity name and site name to specify the entity.
'Declaration
Public Overloads Shared Sub StepLogout( _
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 eventTime As Nullable(Of Date), _
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 eventTime As Nullable(Of Date)
Dim jobPos As Nullable(Of Integer)
JobExec.StepLogout(sessionId, userId, entName, siteName, stepNo, lotNo, subLotNo, eventTime, jobPos)
public static void StepLogout(
int sessionId,
string userId,
string entName,
string siteName,
int stepNo,
string lotNo,
string subLotNo,
Nullable<DateTime> eventTime,
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 working on the step.
- entName
- Required. Holds the name of the entity on which the step is being run. This will identify the job that contains the step.
- siteName
- Optional. Holds the site name of the entity.
- stepNo
- Required. Holds the number of the step that is being worked on.
- 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.
- eventTime
- Optional. Holds the start time of this labor. Used to synchronize times if required. Default is the current time.
- jobPos
- Optional. Holds the job position. If greater than 1, jobs are running on this entity.
This method stops the collection of labor for this user on this step/lot.
All current rows for this user and entity (the user could be logged onto other steps/lots) are closed off after updating their durations.
If this user was currently logged onto other step/lot combinations, then the percentage of labor freed up by this logoff is allocated to those step/lot combinations and new labor records are created for them.
If this user was not currently logged onto other step/lot combinations, then the percentage of labor freed up by this logoff is allocated to a new row with a null step and lot_id values (as the user is still logged onto the entity itself).
For this method to succeed, the user must already have logged onto this step/lot combination.