PauseJob() method

Use the PauseJob() method to pause the specified job if the following conditions exist:

• The job is in a running or in a suspended state.

• The operator is authorized to end jobs.

• The job is On Hold and the operator has the privilege to take a job off hold.

Syntax

PauseJob(woId,operId,seqNo,woDesc,jobDesc,statusNotes,canAppendNotes,
canReplaceNotes,selJobState,editTime,userCancelled
[,concurrentLink]);

Parameters

woID

A string that indicates the work order ID of the job to be ended.

operID

A string that indicates the operation ID of the job to be ended.

seqNo

An integer that represents the sequence number of the job to be ended.

woDesc

A string that indicates the WO description used in the confirmation dialog box.

jobDesc

A string that indicates the Job description used in the confirmation dialog box.

statusNotes

A string that holds the status notes of the job that are shown in the confirmation dialog box. These notes can be appended to or edited on this dialog box if the operator has the privileges to do so.

canAppendNotes

A Boolean value that is True if the operator can append to the Status Notes in the confirmation dialog box.

canReplaceNotes

A Boolean value that is True if the operator can replace the Status Notes in the confirmation dialog box.

selJobState

An enumeration data type that indicates the state of the selected job, which is to be ended. The enumerated data type can have the following values:

• NoJob (A value to set a current job state property to JobStates, if no job is running)= -1

• New (A job that is scheduled but not yet ready to run) = 1

• Ready ( A job that is ready to run) = 2

• Running (A job that is currently running on an entity) = 3

• Complete (A job that has finished) = 4

• Suspended (A job that has not run to completion, but is no longer running on an entity) = 5

• Onhold (A job that is no longer ready to run) = 6

• Cancelled (A job that no longer needs to be run) = 7

editTime

A string that indicates the last edit time for the specified job to ensure the operator is working on the latest data for the job.

userCancelled

A Boolean value that is returned as True if the operator cancels this action when prompted for confirmation.

concurrentLink

An integer value for the specified job that is used to determine if this is a batch of jobs or not. If this value is greater than 0 and other jobs in the queue contain the same value, then this job is part of a batch. This is an optional parameter and the default value is 0.