To support management of submitted/accepted jobs the Web Service must provide means for the caller to:
retrieveActiveJobsList
), or get a list of all jobs whether active or not (retrieveFullJobsList
)retrieveJobInformation
)retrieveJobInformation
)retrieveJob
)suspendJob
)resumeJob
)cancelJob
)Typical use cases are described in separate sections below.
In the initial version of this specification there will be no active notification mechanism. Instead a polling mechanism will need to be used by the caller. The polling mechanism has the advantage that it does not require the caller to provide a means to be contacted explicitly by the Web Service.
It is the caller’s responsibility to check the Web Service to find out if things have changed.
Note: Presentation of a return Web Service or BPEL4WS notification messages may be used in future versions.
A list of active jobs can be retrieved using retrieveActiveJobsList
. For any job ticket retrieveJobInformation
can be used to get the status information.
Call 1 | |
retrieveActiveJobsList |
The caller gets a list of all active jobs associated with their account. This is returned as a list of job tickets |
Call 2 | |
retrieveJobInformation |
The caller gets status information for each job. |
history
section of the response. Here is an example of what this section could look like:
<history> <event stage=”job” status=”start” timeStamp=”2004-12-01T18:00:00.000Z”> <event stage=”evaluation” status=”start” timeStamp=”2004-12-01T18:00:00.000Z”> <event stage=”job” status=”estimated completion” date=”2005-02-01T18:00:00.000Z” timeStamp=”2004-12-01T18:00:00.000Z”> <event stage=”evaluation” status=”complete” timeStamp=”2005-01-05T13:34:10.000Z”> <event stage=”pre-translation” status=”start” timeStamp=”2005-01-05T13:34:10.100Z”> <event stage=”job” status=”estimated completion” date=”2005-02-08T18:00:00.000Z” timeStamp=”2005-01-06T18:32:00.000Z”> </history>
From this example we can see that the job has completed evaluation stage and is currently in pre-translation, and that the estimated completion date for the whole job has slipped to 2005-02-08.
More information about the job history can be found in the Job History section.
At any time the list of active jobs can be retrieved using retrieveActiveJobsList
. Then for each job ticket retrieveJobInformation
can be used to get the status information. The caller can then check whether a job is complete and if so use retrieveJob
to get the document returned.
Call 1 | |
retrieveActiveJobsList |
The caller gets a list of all active jobs associated with their account. This is returned as a list of job tickets. |
Call 2 | |
retrieveJobInformation |
For each Job the caller can get the status information. If the history in the response has an event where stage="job" and status="complete" then the job is completed and can be downloaded. |
Call 3 | |
retrieveJob |
The caller downloads the completed job. |