FileNet P8 Rendition Engine, Version 5.2.1            

Job tickets for publishing

For IBM® FileNet® Rendition Engine, the publishing handler generates a job ticket that is passed to LIQUENT Insight Rendering. The job ticket is an XML file that specifies what kind of conversion is to be done. When generating a job ticket, the document MIME type is not used; the document file name extension is used instead. For example, .doc is used for Microsoft Word documents. The main element is the workflow steps, such as retrieve, render, and convert. The order from top to bottom of these steps determines the execution order of the business services.

The following sections provide examples of various job tickets.

Word document to PDF conversion

The following XML is an example of an actual job ticket:

 <?xml version="1.0" encoding="utf-8" ?>
 - <workflow job-name="{080070D4-233C-49E4-8F59-E1F239941D02}" product="P8Publishing(PDF)"   submitter="suser@server1">
  -<retrieve>
   - <request name="retrieve-embedded" tag="request1">
      <preserve-filename type="bool">1</preserve-filename> 
      <primary-filename type="string">WordTestDoc_With_Several_Images</primary-filename> 
      <content-type type="string">doc</content-type> 
      <embedded-document type="string"></embedded-document> 
      </request>
    </retrieve>
  - <render>
    - <request name="render-xml" tag="request1">
       <local-path from="retrieve/request[@tag='request1']/local-path" type="string" /> 
       <content-type type="string">doc</content-type> 
       <force-rendition type="bool">1</force-rendition> 
      </request>
     </render>
   - <convert>
    - <request name="pdf" tag="request1">
      <local-path from="render/request[@tag='request1']/local-rendition-path" type="string" /> 
      </request>
     </convert>
   - <zip>
    - <request name="zip-file" tag="request1">
       <source-file from="convert/request[@tag='request1']/output-path" type="string" /> 
       <preserve-paths type="bool">1</preserve-paths> 
       <zip-file-name type="string">WordTestDoc_With_Several_Images</zip-file-name> 
      </request>
     </zip>
   - <distribute>
     - <request name="distribute-base64" tag="request1">
        <local-path from="zip/request[@tag='request1']/zip-file-path" type="string" /> 
        <content-type type="string">zip</content-type> 
       </request>
      </distribute>
    </workflow>

Word document to PDF conversion with Watermark

The following XML is an example of an actual job ticket:

  <?xml version="1.0" encoding="utf-8" ?> 
- <workflow job-name="{7D7280E2-2447-448C-9955-AEA7C0FB4246}" product="P8Publishing(PDF)" submitter="suser@server1" job-id="{9493d17c-82a8-459e-9391-a804cd30df92}">
 - <retrieve work-step="1">
  - <request name="retrieve-embedded" tag="request1">
    <preserve-filename type="bool">1</preserve-filename> 
    <primary-filename type="string">WordTestDoc_With_Several_Images</primary-filename> 
    <content-type type="string">doc</content-type> 
    <embedded-document type="string"></embedded-document> 
   </request>
  </retrieve>
- <render work-step="2">
 - <request name="render-xml" tag="request1">
    <local-path from="retrieve/request[@tag='request1']/local-path" type="string" /> 
    <content-type type="string">doc</content-type> 
    <force-rendition type="bool">1</force-rendition> 
   </request>
  </render>
- <convert work-step="3">
 - <request name="pdf" tag="request1">
    <local-path from="render/request[@tag='request1']/local-rendition-path" type="string" /> 
   </request>
  </convert>
- <watermark work-step="4">
 - <request name="watermark-pdf" tag="request1">
    <source-document from="convert/request[@tag='request1']/output-path" type="string" /> 
    <output-path from="convert/request[@tag='request1']/output-path" type="string" /> 
    <text type="string">THIS is A WaterMARK</text> 
    <intensity type="integer">0</intensity> 
    <position type="integer">5</position> 
   </request>
  </watermark>
- <zip work-step="5">
 - <request name="zip-file" tag="request1">
    <source-file from="convert/request[@tag='request1']/output-path" type="string" /> 
    <preserve-paths type="bool">1</preserve-paths> 
    <zip-file-name type="string">WordTestDoc_With_Several_Images</zip-file-name> 
   </request>
  </zip>
- <distribute work-step="6">
 - <request name="distribute-base64" tag="request1">
    <local-path from="zip/request[@tag='request1']/zip-file-path" type="string" /> 
    <content-type type="string">zip</content-type> 
   </request>
  </distribute>
  <activity-results /> 
</workflow>

Word document to PDF conversion with advanced security

The following XML is an example of an actual job ticket:

<?xml version="1.0" encoding="utf-8" ?> 
- <workflow job-name="{95CFF940-F59B-404C-81AA-F7DEC795CFB5}" product="P8Publishing(PDF)"  submitter="suser@server1" job-id="{9eaadaba-a9f0-4228-90f5-08687049f959}">
 - <retrieve work-step="1">
  - <request name="retrieve-embedded" tag="request1">
    <preserve-filename type="bool">1</preserve-filename> 
    <primary-filename type="string">WordTestDoc_With_Several_Images</primary-filename> 
    <content-type type="string">doc</content-type> 
    <embedded-document type="string"></embedded-document> 
   </request>
  </retrieve>
+ <render work-step="2">
 - <request name="render-xml" tag="request1">
    <local-path from="retrieve/request[@tag='request1']/local-path" type="string" /> 
    <content-type type="string">doc</content-type> 
    <force-rendition type="bool">1</force-rendition> 
   </request>
  </render>
- <convert work-step="3">
 - <request name="pdf" tag="request1">
    <local-path from="render/request[@tag='request1']/local-rendition-path" type="string" /> 
   </request>
  </convert>
- <pdffile work-step="4">
 - <request name="set-security" tag="request1">
    <local-path from="convert/request[@tag='request1']/output-path" type="string" /> 
    <output-path from="convert/request[@tag='request1']/output-path" type="string" /> 
    <new-owner-password type="string">changedoc</new-owner-password> 
    <new-user-password type="string">opendoc</new-user-password> 
    <allow-print type="bool">0</allow-print> 
    <allow-edit type="bool">0</allow-edit> 
    <allow-copy type="bool">0</allow-copy> 
    <allow-edit-notes type="bool">0</allow-edit-notes> 
   </request>
  </pdffile>
- <zip work-step="5">
 - <request name="zip-file" tag="request1">
    <source-file from="convert/request[@tag='request1']/output-path" type="string" /> 
    <preserve-paths type="bool">1</preserve-paths> 
    <zip-file-name type="string">WordTestDoc_With_Several_Images</zip-file-name> 
   </request>
  </zip>
- <distribute work-step="6">
  - <request name="distribute-base64" tag="request1">
     <local-path from="zip/request[@tag='request1']/zip-file-path" type="string" /> 
     <content-type type="string">zip</content-type> 
    </request>
   </distribute>
   <activity-results /> 
</workflow>

Word document to HTML conversion

The following XML is an example of an actual job ticket:

<?xml version="1.0" encoding="utf-8" ?>
- <workflow job-name="{774F4175-A435-4A97-BFD5-DCF1A3A87B4A}" product="P8Publishing(HTML)" submitter="suser@server1">
- <retrieve>
 - <request name="retrieve-embedded" tag="request1">
     <preserve-filename type="bool">1</preserve-filename> 
     <primary-filename type="string">WordTestDoc_With_Several_Images</primary-filename> 
     <content-type type="string">doc</content-type> 
     <embedded-document type="string"></embedded-document> 
   </request>
  </retrieve>
- <render>
 - <request name="render-html" tag="request1">
     <local-path from="retrieve/request[@tag='request1']/local-path" type="string" /> 
     <content-type type="string">doc</content-type> 
     <force-rendition type="bool">1</force-rendition> 
     <output-name type="string">Pub(774F4175-A435-4A97-BFD5-DCF1A3A87B4)</output-name> 
     <organize-in-folder type="bool">1</organize-in-folder> 
   </request>
  </render>
- <zip>
 - <request name="zip-folder" tag="request1">
     <source-file-folder from="render/request[@tag='request1']/output-folder" type="string" />
     <preserve-paths type="bool">1</preserve-paths> 
     <include-sub-folders type="bool">1</include-sub-folders> 
     <zip-file-name type="string">WordTestDoc_With_Several_Images</zip-file-name> 
   </request>
  </zip>
- <distribute>
 - <request name="distribute-base64" tag="request1">
     <local-path from="zip/request[@tag='request1']/zip-file-path" type="string" /> 
     <content-type type="string">zip</content-type> 
   </request>
  </distribute>
</workflow>


Last updated: October 2015
pub_job_tickets.htm

© Copyright IBM Corporation 2015.