Loading

Response message from PRISMAdirect to the query QueueStatus without a subscription to status updates

The response message returns the status of orders and jobs in their queue order.

The relevant parameters for PRISMAdirect

The Response element:

  • ID

    PRISMAdirect generates a response ID. In this example, "Response-00000012" which means that this is the 12th response message of PRISMAdirect. PRISMAdirect restarts numbering when the JDF service is restarted.

  • Type

    The type of response message. In this example, a response to the query QueueStatus.

  • refID

    The ID of the initial query QueueStatus. This ID is required to stop the subscription on status updates.

  • Subscribed

    • False: the query has not subscribed to automatic status updates

    • True: the query has subscribed to automatic status updates

The Queue element:

  • DeviceID

    The name of the JDF endpoint to which the query has been sent.

The QueueEntry element. One occurrence per order or job. So, five QueueEntries means five jobs / orders:

  • QueueEntryID

    The unique ID of the job generated by PRISMAdirect.

  • JobID

    The unique ID of the job generated by PRISMAdirect.

  • JobPartID

    The unique ID of the order to which the job belongs.

  • Priority

    PRISMAdirect sets a default priority of 1.

  • Status = Running

    The order is submitted to PRISMAdirect. This status does not refer to the state of the job.

  • StatusDetails

    The StatusDetails can contain a single status, e.g. StatusDetails="Accepted". This is the order state which is equal to the "communication state" in PRISMAdirect.

    The StatusDetails can contain a double status, separated by a pipe symbol, e.g. StatusDetails="Exported|Accepted". These are the job states which are equal to the "internal job state|communication state" in PRISMAdirect.

How to read the QueueEntryID , JobID and JobPartID in response messages

The response message to the command SubmitQueueEntry only contains a QueueEntryID. The QueueEntryID is the unique ID of the job generated by PRISMAdirect. However, a job in PRISMAdirect must be part of an order. You can use the response message to the query QueueStatus to identify which job or jobs belong to which order. This response message contains three IDs: QueueEntryID, JobID and JobPartID. The JobPartID identifies the order.

Example of the IDs for an order that contains a single job. The order ID is marked in bold:

Order containing a single job

QueueEntryID

JobID

JobPartID

Order that contains a single job

ID001

ID001

ID001

The job of the order that contains a single job

ID002

ID002

ID001

Example of the IDs for an order that contains two jobs:

Order containing multiple jobs

QueueEntryID

JobID

JobPartID

Order that contains two jobs

ID003

ID003

ID003

First job of the order

ID004

ID004

ID003

Second job of the order

ID005

ID005

ID003