HPOSSOD 1.0 Technical Note

HP Web Services for Output Server 20
Using HP Web Services for Output Server
Multiple-document print failure
Pausing jobs
The pauseJobs API is used to pause HP Output Server jobs. The structure of the API is:
Web Service Name: pauseJobs
Web Service Parameters
Parameter 1 - XML pauseJobs contract
For .NET clients,
Input param- pauseJobs object
pauseJobs will have only one argument.
1. XML pauseJobs contract
Response- pauseJobsResponse object
You can pause a job when it is in the pre-processing, document-transfer-pending, transferring,
pending, queue, held, or interrupted job state. When the job state is aborting, processing,
paused, or retained, you cannot pause a job. Users are authorized at the HP Output Server level to pause jobs.
No request attribute is passed for the pauseJobs functionality. The operation attribute is a DLM job ID. You can
pause multiple DLM jobs at the same time. This API achieves the same functionality as the pdpause command on
HP Output Server.
The following is an example of a pauseJobs request:
<wsg-request>
<operation-attributes>
<job-client-id>dlm:1:72</job-client-id>
</operation-attributes>
</wsg-request>
The following is an example of a pauseJobs response:
<wsg-response>
<status-code>0</status-code>
<status-message>success</status-message>
<operation-attributes/>
<job-info>
<subjob-info>
<destination>lmail</destination>
<job-identifier>jqm:2530598</job-identifier>
<status-code>0</status-code>
<status-message>success</status-message>
</subjob-info>
</job-info>
</wsg-response>
Pausing subjobs
The pauseSubJobs API is used to pause HP Output Server subjobs. The structure of the API is:
Web Service Name: pauseSubJobs
Table 1-12. pauseJobs attributes
Type Name Value
Operation Attributes job-client-id DLM ID