EndJob(Int32,String,String,String,Nullable<DateTime>,String,String,Nullable<Int32>,String,Nullable<Boolean>,Nullable<Boolean>,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>) Method

• Visual Basic
• C#

'Declaration
 
Public Overloads Shared Sub EndJob( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal jobEndTimeUtc As Nullable(Of Date), _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Nullable(Of Integer), _
   ByVal statusNotes As String, _
   ByVal checkPrivs As Nullable(Of Boolean), _
   ByVal checkCerts As Nullable(Of Boolean), _
   ByVal clientType As Nullable(Of Integer), _
   ByVal jobPos As Nullable(Of Integer), _
   ByVal noPropagation As Nullable(Of Integer) _
) 

'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim entName As String
Dim siteName As String
Dim jobEndTimeUtc As Nullable(Of Date)
Dim woId As String
Dim operId As String
Dim seqNo As Nullable(Of Integer)
Dim statusNotes As String
Dim checkPrivs As Nullable(Of Boolean)
Dim checkCerts As Nullable(Of Boolean)
Dim clientType As Nullable(Of Integer)
Dim jobPos As Nullable(Of Integer)
Dim noPropagation As Nullable(Of Integer)
 
JobExec.EndJob(sessionId, userId, entName, siteName, jobEndTimeUtc, woId, operId, seqNo, statusNotes, checkPrivs, checkCerts, clientType, jobPos, noPropagation)

public static void EndJob( 
   int sessionId,
   string userId,
   string entName,
   string siteName,
   Nullable<DateTime> jobEndTimeUtc,
   string woId,
   string operId,
   Nullable<int> seqNo,
   string statusNotes,
   Nullable<bool> checkPrivs,
   Nullable<bool> checkCerts,
   Nullable<int> clientType,
   Nullable<int> jobPos,
   Nullable<int> noPropagation
)

Parameters

sessionId

Required. Holds the ID of the session from which the job is being ended.

userId

Required. Holds the ID of the user who is ending the job.

entName

Required. Holds the name of the entity on which the job is to be ended.

siteName

Optional. Holds the site name of the entity

jobEndTimeUtc

Optional. Holds the end time (in UTC format) of the job.

Note: Ending a job more than 90 days in the past will exclude the creation of hourly buckets more than 90 days old in the job_hourly_history table.

woId

Optional. Holds the work order ID of the job.

operId

Optional. Holds the operation ID of the job.

seqNo

Optional. Holds the job sequence number.

statusNotes

Optional. Holds notes associated with the state change. Default is null.

checkPrivs

Optional. Holds a flag that, if set to true, specifies that the user’s privileges should be checked before executing this action. Default is false.

checkCerts

Optional. Holds a flag that, if set to true, specifies that the produced quantities should be checked before allowing this job to be ended. Default is false.

clientType

Optional. Holds the type of client application that is trying to end the job. Defaults to 37 (Operator).

jobPos

Optional. Holds the job position. If the job position is greater than 1, jobs are running on this entity.

noPropagation

Optional. Holds the value to denote propagation.