Xerox FreeFlow Output Manager Support & Software Merkblatt
FreeFlow Output Manager
CLI operation and commands
Command Line User Guide
3-9
Operand:
queue:jobId:docId
Options:
None
Returns:
0 if successful
DOCUMENT_NOT_FOUND (25) if document does not exist
JOB_ERROR (13) if attempting to cancel last document in
the job
DOCUMENT_NOT_FOUND (25) if document does not exist
JOB_ERROR (13) if attempting to cancel last document in
the job
Examples:
xomcandoc
myQueue:14:3
cancel-job
This command cancels a job (i.e., sets its job-state to canceled). As much as is practical, no
further processing or printing will occur on a cancelled job; if it is printing when the cancel is
issued, FFOM will attempt to stop printing. The job-state is set to "aborted" and job-state-
reasons is set to "job-canceled-by-operator".
further processing or printing will occur on a cancelled job; if it is printing when the cancel is
issued, FFOM will attempt to stop printing. The job-state is set to "aborted" and job-state-
reasons is set to "job-canceled-by-operator".
FFOM will accept or reject the cancel operation depending on the job’s state. The following
table shows the effect the cancel operation has on job-state.
table shows the effect the cancel operation has on job-state.
A canceled job is not necessarily removed from the system. If, for example, the job’s job-
retention-period attribute has a value, the job will stay in FFOM until the retention period
expires.
retention-period attribute has a value, the job will stay in FFOM until the retention period
expires.
Command name:
xomcanjob
Operand:
queue:id
Current job-status
New job-status
Status
pending
aborted
Ok, cancel occurs immediately
held
aborted
Ok, cancel occurs immediately
processing
aborted
Ok, may return before completed
aborted
aborted
Operation returns an error
completed
completed
Operation returns an error