Liquent InSight Rendering Business Service Reference Guide

local-path

Contained By

Business Service Element Business Service Request
Distribute

<request name="distribute-rendition">

<request name="distribute-version">

<request name="distribute-new">

<request name="distribute-new-or-version">

IPLinkSetter

<request name="resolve-links">

<request name="create-bookmarks">

MSWord

<request name="generate-toc">

PDFFile

<request name="set-security">

<request name="set-docinfo">

<request name="get-docinfo">

<request name="set-version">

<request name="append-tab-file">

<request name="set-initial-links">

<request name="make-pdfa-compliant">

Printer

<request name="generate-printer-output">

Render

<request name="render-pdf">

Retrieve

<request name="retrieve-document">

<request name="retrieve-properties">

<request name="retrieve-queued-document">

<request name="retrieve-next-queued-job">

Contains

Business Service XML Element
N/A

Business Service Parameter

Business Service Element Name Description Parameter Type Req (Y/N) Valid Value(s) Default Value Direction
Distribute local-path Specifies the:
  • rendition file path
  • file path of new version
  • file path of new document
  • path of the file to be used as new document or new version of existing document
  • path of the local file to be distributed
string Y user defined in
IPLinkSetter local-path Specifies the:
  • file being copied
  • pdf document to which bookmarks will be added
string Y user defined in
MSWord local-path Specifies the output file path. If not specified will be randomly generated. string N user defined in/out
PDFFile local-path Specifies the PDF file path. string N user defined in
Printer local-path Specifies the local path of the PDF file. string Y user defined in
Render local-path Specifies path of the source document to be rendered. string Y user defined in
Retrieve local-path Specifies path of the source document to be copied. If not supplied, a temporary folder location and file name will be generated. The local-path parameter will be set in the job ticket with the temporary file location and name upon completion of the request, if not provided in the original request.
Note: If this request is contained within a “workflow”, and you do not specify a ‘local-path’ parameter in this request, the output file created by the local-path parameter will be deleted upon completion of the workflow. To keep the output file beyond the workflow completion, you must “distribute” the retrieved document within the same Workflow process with the Business Service Distribute.
string Y user defined in/out

Example

<local-path type="string">c:\temp\rd5.tmp.xml</local-path>