The Preview Service generates a preview image of the first page of a PDF Document. The service can either be consumed manually, using a graphical user interface, or automatically, using an API based on XJDF.
This Interoperability Conformance Specificaion (ICS) specifies the communication between a cloud based Preview Generation Service (Worker) the Consumer (Manager) of the service.
This ICS document describes in particular the request to the service (Worker) for a preview generation of a PDF document as well as the response, which also contains the generated preview image.
The following table illustrates the notation of Manager and Worker requirements in ICS tables:
| Notation | Name | Description |
|---|---|---|
| w | Write Required | The element or attribute SHALL be written by the Manager or Worker |
| w? | Write Optional | The element or attribute MAY be written by the Manager or Worker |
| w← | Write Conditional | The element or attribute SHALL be written by the Manager or Worker depending on conditions. The details of the conditions will be specified in the description. |
| w! | Write Forbidden | The element or attribute SHALL NOT be written by the Manager or Worker. |
| r | Read Required | The element or attribute SHALL be read by the Manager or Worker. |
| r? | Read Optional | The element or attribute MAY be read by the Manager or Worker. |
| r← | Read Conditional | The element or attribute SHALL be read by the Manager or Worker depending on conditions. The details of the conditions will be specified in the description. |
All transactions SHALL conform to XKDF.
Manager and Worker SHALL implement a synchronous http transport protocol. The Preview Service (Worker) SHALL be accessible by the Manager, but not vice versa.
Each transaction SHALL be packaged as a ZIP Package containing all dependencies. Dependencies outside the ZIP Packages are not valid. In general a ZIP package contains a XJMF Message called *root.xjmf', an XJDF Document as well as additional assets referred by the XJDF Document.
Specificaion of the XJMF Message.
The XJMF element SHALL be the root element of the XJMF Message.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @xmlns | w r |
r w |
The value SHALL be 'http://www.CIP4.org/JDFSchema_2_0' |
| Header | w r |
r w |
Element containing informatoin about the parties involved in the transaction |
| CommandSubmitQueueEntry | w | r | Element has to be written by the Manager during a Request |
| CommandReturnQueueEntry | r | w | Element has to be written by the Worker during a Response |
The Header element is a container element for information about the parties that are involved in the transaction.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @DeviceID | w r? |
r? w |
The devices identifier which generated the parent element. |
| @Time | w r? |
r? w |
The timestamp when the parent element has been generated |
The XJMF Command SubmitQueueEntry requests a new preview generation.
| Name | Manager | Worker | Description |
|---|---|---|---|
| Header | w | r? | Information about the Manager |
| QueueSubmissionParams | w | r | Details about the perview generation request |
Details about the preview generation request.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @URL | w | r | Reference to the XJDF Document within the ZIP Package. |
The XJMF Command ReturnQueueEntry is a synchronuos response of a preview generation.
| Name | Manager | Worker | Description |
|---|---|---|---|
| Header | r? | w | Information about the Worker |
| ReturnQueueEntryParams | r | w | Details about the preview generation result |
Details about the preview generation response.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @URL | r | w | Reference to the XJDF Document within the ZIP Package. |
Specificaion of the XJDF Document containing the preview generation details.
The XJMF element SHALL be the root element of the XJDF Document.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @JobID | w r? |
r? w |
The jobs identifier. |
| @Types | w r |
r w |
The value SHALL be "Interpreting Rendering PreviewGeneration" |
| @ICSVersions | w r |
r w |
The unique identifier of this ICS Document: "PREVIEW_ICS" |
| @xmlns | w r |
r w |
The XJDF 2.0 namespace specificaion: http://www.CIP4.org/JDFSchema_2_0 |
| AuditPool | r | w | Container element for metadata as well as feedback from the Worker to the Manager |
| ResourceSet [@Name="RunList"] | w | r | Reference to the customers artwork PDF |
| ResourceSet [@Name="PreviewGenerationParams"] | w | r | Paramters regarding to the preview generation. |
Container element for feedback from the Worker to the Manager.
| Name | Manager | Worker | Description |
|---|---|---|---|
| AuditResource | r | w | Container element for resources generated by the Worker |
Container element for resources generated by the Worker.
| Name | Manager | Worker | Description |
|---|---|---|---|
| Header | r | w | Metadata about the worker. |
| ResourceInfo | r | w | Container element for a single ResourceSet |
Container elemnet for a single ResourceSet.
| Name | Manager | Worker | Description |
|---|---|---|---|
| ResourceSet | r | w | Container for a Preview Resource |
Container element for similar resources.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @Name | w r |
r w |
The name of the Specific Resource (see XJDF Spec.) |
| @Usage | w r |
r w |
The usage of the Resource (see XJDF Spec.) Valid values SHALL be "Input" and "Output" |
| Resource | w r |
r w |
Container for the specific Resource |
Container element for a single specific Resource (see XJDF Spec)
| Name | Manager | Worker | Description |
|---|---|---|---|
| Specific Resource | w r |
r w |
The specific resource element |
A RunList Resource references binary data.
| Name | Manager | Worker | Description |
|---|---|---|---|
| FileSpec | w | r | The reference to the file |
Reference to a single file.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @URL | w | r | The reference to the artwork PDF |
Details and requirements regarding to the preview generation.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @Resolution | w | r | The required resolution of the preview in x- and y-directions. |
The details and reference to the generated preview image.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @PreviewFileType | r | w | The type of the preview image. Allowed value is "PNG" |
| FileSpec | r | w | Reference to the preview binary data |
Reference to the preview file.
| Name | Manager | Worker | Description |
|---|---|---|---|
| @URL | r | w | The reference to the preview file |
The XJMF Command Message SubmitQueueEntry in the request ZIP package in order to submit the referenced XJDF Document.
<XJMF xmlns="http://www.CIP4.org/JDFSchema_2_0">
<Header DeviceID="MY_DEV_ID" Time="2019-10-15T21:26:07+02:00" />
<CommandSubmitQueueEntry>
<Header DeviceID="MY_DEV_ID" Time="2019-10-15T21:26:07+02:00"/>
<QueueSubmissionParams URL="preview-request.xjdf"/>
</CommandSubmitQueueEntry>
</XJMF>The XJDF Document in the request ZIP package referenced by the XJDF Command Message SubmitQueueEntry. The document contains all information needed for the preview generation.
<XJDF JobID="42" Types="Interpreting Rendering PreviewGeneration" ICSVersions="PREVIEW_ICS" xmlns="http://www.CIP4.org/JDFSchema_2_0">
<AuditPool>
<AuditCreated>
<Header DeviceID="DEV_ID" Time="2019-10-15T21:26:07+02:00" />
</AuditCreated>
</AuditPool>
<ResourceSet Name="RunList" Usage="Input">
<Resource>
<RunList>
<FileSpec URL="file-1.pdf" />
</RunList>
</Resource>
</ResourceSet>
<ResourceSet Name="PreviewGenerationParams" Usage="Input">
<Resource>
<PreviewGenerationParams Resolution="72 72" />
</Resource>
</ResourceSet>
</XJDF>The XJMF Command Message ReturnQueueEntry in the response ZIP package in order to return the referenced XJDF Document.
<xjdf:XJMF xmlns:xjdf="http://www.CIP4.org/JDFSchema_2_0">
<xjdf:Header DeviceID="PreviewService" Time="2019-11-19T13:32:24Z"/>
<xjdf:CommandReturnQueueEntry>
<xjdf:Header DeviceID="PreviewService" Time="2019-11-19T13:32:24Z"/>
<xjdf:ReturnQueueEntryParams QueueEntryID="QE-42" URL="myUrl"/>
</xjdf:CommandReturnQueueEntry>
</xjdf:XJMF>The XJDF Document in the response ZIP package referenced by the XJDF Command Message ReturnQueueEntry. The document contains all information regarding to the preview generation.
<xjdf:XJDF ICSVersions="PREVIEW_ICS" JobID="42" Types="Interpreting Rendering PreviewGeneration" xmlns:xjdf="http://www.CIP4.org/JDFSchema_2_0">
<xjdf:AuditPool>
<xjdf:AuditCreated>
<xjdf:Header DeviceID="PreviewService" Time="2019-11-19T13:32:24Z"/>
</xjdf:AuditCreated>
<xjdf:AuditResource>
<xjdf:Header DeviceID="PreviewService" Time="2019-11-19T13:32:24Z"/>
<xjdf:ResourceInfo>
<xjdf:ResourceSet Name="Preview" Usage="Output">
<xjdf:Resource>
<xjdf:Preview PreviewFileType="PNG">
<xjdf:FileSpec URL="preview.png"/>
</xjdf:Preview>
</xjdf:Resource>
</xjdf:ResourceSet>
</xjdf:ResourceInfo>
</xjdf:AuditResource>
</xjdf:AuditPool>
<xjdf:ResourceSet Name="RunList" Usage="Input">
<xjdf:Resource>
<xjdf:RunList>
<xjdf:FileSpec URL="tu-dublin.pdf"/>
</xjdf:RunList>
</xjdf:Resource>
</xjdf:ResourceSet>
<xjdf:ResourceSet Name="PreviewGenerationParams" Usage="Input">
<xjdf:Resource>
<xjdf:PreviewGenerationParams Resolution="72.0 72.0"/>
</xjdf:Resource>
</xjdf:ResourceSet>
</xjdf:XJDF>