Add Method (OperStep)

• Visual Basic
• C#

'Declaration
 
Public Shared Sub Add( _
   ByVal sessionId As Integer, _
   ByVal processId As String, _
   ByVal operId As String, _
   ByVal stepNo As Integer, _
   ByVal stepSeq As Integer, _
   ByVal stepName As DBString, _
   ByVal stepDesc As String, _
   ByVal actionType As Integer, _
   ByVal stdTime As Double, _
   ByVal completeCond As Integer, _
   ByVal allowBypass As Boolean, _
   ByVal enterData As Boolean, _
   ByVal stepGrpId As Integer, _
   ByVal spcChar As DBString, _
   ByVal formName As DBString, _
   ByVal dataLogGrpId As DBInt, _
   ByVal reqdRepPct As Double, _
   ByVal controlType As Integer, _
   ByVal highLimit As DBDouble, _
   ByVal lowLimit As DBDouble, _
   ByVal limitWarning As Boolean, _
   ByVal spare1 As DBString, _
   ByVal spare2 As DBString, _
   ByVal spare3 As DBString, _
   ByVal spare4 As DBString, _
   ByVal spare5 As DBString, _
   ByVal spare6 As DBString, _
   ByVal lastEditComment As DBString, _
   ByVal reSequence As Boolean, _
   ByRef modId As String _
) 

'Usage
 
Dim sessionId As Integer
Dim processId As String
Dim operId As String
Dim stepNo As Integer
Dim stepSeq As Integer
Dim stepName As DBString
Dim stepDesc As String
Dim actionType As Integer
Dim stdTime As Double
Dim completeCond As Integer
Dim allowBypass As Boolean
Dim enterData As Boolean
Dim stepGrpId As Integer
Dim spcChar As DBString
Dim formName As DBString
Dim dataLogGrpId As DBInt
Dim reqdRepPct As Double
Dim controlType As Integer
Dim highLimit As DBDouble
Dim lowLimit As DBDouble
Dim limitWarning As Boolean
Dim spare1 As DBString
Dim spare2 As DBString
Dim spare3 As DBString
Dim spare4 As DBString
Dim spare5 As DBString
Dim spare6 As DBString
Dim lastEditComment As DBString
Dim reSequence As Boolean
Dim modId As String
 
OperStep.Add(sessionId, processId, operId, stepNo, stepSeq, stepName, stepDesc, actionType, stdTime, completeCond, allowBypass, enterData, stepGrpId, spcChar, formName, dataLogGrpId, reqdRepPct, controlType, highLimit, lowLimit, limitWarning, spare1, spare2, spare3, spare4, spare5, spare6, lastEditComment, reSequence, modId)

public static void Add( 
   int sessionId,
   string processId,
   string operId,
   int stepNo,
   int stepSeq,
   DBString stepName,
   string stepDesc,
   int actionType,
   double stdTime,
   int completeCond,
   bool allowBypass,
   bool enterData,
   int stepGrpId,
   DBString spcChar,
   DBString formName,
   DBInt dataLogGrpId,
   double reqdRepPct,
   int controlType,
   DBDouble highLimit,
   DBDouble lowLimit,
   bool limitWarning,
   DBString spare1,
   DBString spare2,
   DBString spare3,
   DBString spare4,
   DBString spare5,
   DBString spare6,
   DBString lastEditComment,
   bool reSequence,
   out string modId
)

Parameters

sessionId

Required. Holds the session ID and thus the user who is making this method call.

processId

Required. Holds the ID of the process to which the operation belongs.

operId

Required. Holds the ID of the operation to which the step belongs.

stepNo

Required. Holds the step number.

stepSeq

Required. Holds the step sequence number.

stepName

Required. Holds the step name.

stepDesc

Required. Holds the step description.

actionType

Required. 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

stdTime

Required. Holds the number of hours allowed for the step.

completeCond

Required. 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)

allowBypass

Required. Holds a flag that, if set to true, indicates that a user can bypass this step.

enterData

Required. Holds a flag that, if set to true, indicates that step data can be entered.

stepGrpId

Required. Holds the ID of the step group for the step.

spcChar

Required. Holds the SPC characteristic to be collected at this step.

formName

Required. Holds the link to an optional form (usually in a 'Forms' application) for this step.

dataLogGrpId

Required. Holds the ID of the data log group for the step.

reqdRepPct

Required. Holds the percentage of lots/sublots for which this step must be performed.

controlType

Required. Holds the control type. If controlType = 1, then the highLimit, lowLimit, and limitWarning parameters are in affect.

highLimit

Required. Applicable if controlType = 1. Holds the maximum allowable value.

lowLimit

Required. Applicable if controlType = 1. Holds the minimum allowable value.

limitWarning

Required. Applicable if controlType = 1. Holds a flag that indicates whether a warning message should be displayed when the limit has been exceeded. If set to true and the entry exceeds the limit, a warning message is displayed but the entry is allowed. If set to false and the entry exceeds the limit, the entry is not allowed.

spare1

Optional. Holds the contents of the user-defined spare1 field.

spare2

Optional. Holds the contents of the user-defined spare2 field.

spare3

Optional. Holds the contents of the user-defined spare3 field.

spare4

Optional. Holds the contents of the user-defined spare4 field.

spare5

Optional. Holds the contents of the user-defined spare5 field.

spare6

Optional. Holds the contents of the user-defined spare6 field.

lastEditComment

Optional. Holds comments that describe why this record is being added.

reSequence

Required. Holds a flag that, if set to true, specifies that all of the step numbers equal to or greater than the step number supplied be resequences. This allows a step to be inserted in the middle of a sequence of steps, and renumbers the subsequent steps.

modId

Output. Holds the modification ID assigned to this record when it is added. The modId parameter is used by other methods that modify or delete this type of record for optimistic concurrency control.