Add(Int32,Int32,Int32,String,String,Int32,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,String,String,String,String,Nullable<Double>,Nullable<Double>,Nullable<Double>,Nullable<Double>,String,DateTime) Method

• Visual Basic
• C#

'Declaration
 
Public Overloads Shared Sub Add( _
   ByVal sessionId As Integer, _
   ByVal keyId As Integer, _
   ByVal keyType As Integer, _
   ByVal category As String, _
   ByVal valueName As String, _
   ByVal triggerType As Integer, _
   ByVal triggerPeriod As Nullable(Of Integer), _
   ByVal entriesRequired As Nullable(Of Integer), _
   ByVal displaySeq As Nullable(Of Integer), _
   ByVal stringSpare1 As String, _
   ByVal stringSpare2 As String, _
   ByVal stringSpare3 As String, _
   ByVal stringSpare4 As String, _
   ByVal numberSpare1 As Nullable(Of Double), _
   ByVal numberSpare2 As Nullable(Of Double), _
   ByVal numberSpare3 As Nullable(Of Double), _
   ByVal numberSpare4 As Nullable(Of Double), _
   ByVal lastEditComment As String, _
   ByRef lastEditAt As Date _
) 

'Usage
 
Dim sessionId As Integer
Dim keyId As Integer
Dim keyType As Integer
Dim category As String
Dim valueName As String
Dim triggerType As Integer
Dim triggerPeriod As Nullable(Of Integer)
Dim entriesRequired As Nullable(Of Integer)
Dim displaySeq As Nullable(Of Integer)
Dim stringSpare1 As String
Dim stringSpare2 As String
Dim stringSpare3 As String
Dim stringSpare4 As String
Dim numberSpare1 As Nullable(Of Double)
Dim numberSpare2 As Nullable(Of Double)
Dim numberSpare3 As Nullable(Of Double)
Dim numberSpare4 As Nullable(Of Double)
Dim lastEditComment As String
Dim lastEditAt As Date
 
DataEntrySched.Add(sessionId, keyId, keyType, category, valueName, triggerType, triggerPeriod, entriesRequired, displaySeq, stringSpare1, stringSpare2, stringSpare3, stringSpare4, numberSpare1, numberSpare2, numberSpare3, numberSpare4, lastEditComment, lastEditAt)

public static void Add( 
   int sessionId,
   int keyId,
   int keyType,
   string category,
   string valueName,
   int triggerType,
   Nullable<int> triggerPeriod,
   Nullable<int> entriesRequired,
   Nullable<int> displaySeq,
   string stringSpare1,
   string stringSpare2,
   string stringSpare3,
   string stringSpare4,
   Nullable<double> numberSpare1,
   Nullable<double> numberSpare2,
   Nullable<double> numberSpare3,
   Nullable<double> numberSpare4,
   string lastEditComment,
   out DateTime lastEditAt
)

Parameters

sessionId

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

keyId

Required. Holds the primary key or row_id value of a row for which data is being collected. This would be an entity ID if linked to an entity or a group ID if linked to a user group. For all others, it will be a row ID.

keyType

Required. Holds a number that represents the type of data collection being done (0=entity, 1=user group, 2=standard operation, 3=standard operation step, 4=operation, 5=operation step, 6=job, and 7=job step).

category

Required. Holds the category of the data collection (examples: "Yield KPI", "Defect Data", "Datalog Group"...).

valueName

Required. Holds the specific data or set of values to be collected within this category. (examples: "KPI 123", "Line 3 Defect Data", "Datalog Group ABC" ...).

triggerType

Required. Holds a number that represents the trigger mechanism for the data collection (0=shift start, 1=shift end, 3=daily, 4=weekly, 5=minutes).

triggerPeriod

Optional. Holds the number of minutes between collection triggers if the trigger type is minutes (Default = 1).

entriesRequired

Optional. Holds the number of entries required each time data collection is triggered. (Default = 1).

displaySeq

Optional. Holds the number of the display sequence of this data entry schedule.

stringSpare1

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

stringSpare2

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

stringSpare3

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

stringSpare4

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

numberSpare1

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

numberSpare2

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

numberSpare3

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

numberSpare4

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

lastEditComment

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

lastEditAt

Output. Holds the returned date/time when this record was added, for optimistic concurrency control. The lastEditAt parameter is used by other methods that modify or delete this type of record for optimistic concurrency control.