This topic explains the job history that can be retrieved from retrieveJobInformation
in more details.
The job history is comprised of a list of chronological events. Each event is represented by an <event>
element with the following attributes:
stage
– (required) identifies what the event applies to, e.g. a particular task or the entire job.status
– (required) the status value that the event represents. This is always interpreted in the scope of the stage
value.date
– (optional) a date value for status values that are associated with dates, such as the estimated completion date
or the start
date of a stage.additionalInformation
– (optional) any additional information that is associated with the event, if applicable. For example the reason specified why a job was rejected through a call to rejectJob
.timeStamp
– (required) the time and date that the event was recorded in the history.The different values and how they work together is in the following sections.
The following table explains the possible values for the stage
attribute of a history event.
Value | Meaning |
---|---|
job |
Overall job status |
quotation |
Quotation in progess, the quote is being created or has been created but has not yet been accepted. |
evaluation |
Evaluation of the job |
pre-translation |
Preparatory work before actual translation work commences |
translation |
Translation work and directly related activities |
post-translation |
Work after the translation stage has completed |
engineering |
Localisation engineering work |
internationalisation |
Internationalisation work |
quality assurance |
Quality Assurence work |
miscellanous |
General/unspecified localization work |
(other) | Application defined (custom) work stage and/or status scope. |
The following table explains the possible values for the status
attribute of a history event.
Value | Meaning |
---|---|
start |
Work stage started at the time indicated by the timeStamp value. |
complete |
Work stage completed at the time indicated by the timeStamp value. |
cancelled |
Work stage cancelled at the time indicated by the timeStamp value. |
on hold |
The work task was put on hold by the the Web Service Host at the time indicated by the timeStamp value. |
suspended |
The job was suspended by the Web Service Client through a call to suspendJob at the time indicated by the timeStamp value. This status value can currently only be used with stage="job" . |
resumed |
A suspended job was resumed by the Web Service Client through a call to resumeJob at the time indicated by the timeStamp value. This status value can currently only be used with stage="job" . |
resource associated |
A resource was associated with the job through a call to associateResource . The timestamp value indicates when the actual association was made, which could in fact be before the job was created. The additional information attribute contains the URI of the associated resource. This value can only be used with stage="job" . |
resource disassociated |
A resource was detached from the job through a call to disassociateResource . The timestamp value indicates when the association between the resource and the job was terminated. The additional information attribute contains the URI of the disassociated resource. This value can only be used with stage="job" . |
estimated completion |
An estimated completion date for the work task was set by the Web Service Host. The estimated completion date is indicated by the date value. The timeStamp value indicates the time this estimation was published. |
retrieved |
The completed job was downloaded by a call to retreiveJob at the time indicated by the timeStamp value.This value can only be used with stage="job" . |
required by |
A new deadline was specified for the job. The new required completion date is indicated by the date value. The deadline update was recorded at the time indicated by the timeStamp value.This value can only be used with stage="job" . |
rejected |
The completed job was rejected by the Web Service Client through a call to rejectJob at the time indicated by the timeStamp value. The information about why the job was rejected is available through the additional information attribute.This value can only be used with stage="job" . |
x-(other) | Application defined (custom) status value or a free form comment in clear text, prefixed by x- to make it easy to distinguish from the values defined in this specification. |
There is no way for the caller to explicitly set a new “Required By” date. This can only be achieved through communication not covered by this version of the standard. This will be addressed in a future version of the specification.
Just like in real life the past, here in the shape of already recorded events, should never change during the lifetime of a job and beyond.
As the job progresses or properties of the job changes new events will be added after the already existing events in the history. It should always be possible to get an overview of the entire job history, including all events relevant for the job, by looking at the history. This can be important in order to find out what really happened during a job at a later stage.
The job history can also be important as a means of communicating changes in expected delivery dates. Below is an example that illustrates this.
The current job status can be deducted from the job history. In this example it looks like this:
<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>
The original estimated completion date
for the job
stage (i.e. the whole job) was 2005-02-01, as can be seen from the third event in the list. The timestamp
further indicates that this original estimate was made on 2004-12-01.
The last event in the list contains a second estimated completion date
for the job, which indicates that the completion of the job is expected to slip to 2005-02-08. The timestamp indicates that this updated estimate was recorded on 2005-01-06.
The order of events in the history should be chronological, so by searching for the last occurence of the estimated completion date
for the stage with value job
you should always be able to find the most recent estimated date of completion.
Note that estimated completion date
can also be used for other stage values, in which they simply provide an indication on when that particular stage of the job is estimated to be completed.