|
The Generate Interactive Document operation accepts a number
of mandatory and optional parameters. Only the package definition
is required. However if you do not specify the data as input to
the service, you must specify it in the package definition.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Input properties
Properties for specifying the package definition; the PDF
Portfolio, the data to merge with the document, and the output document.
Package definition (Mandatory)
A
document
value that specifies the
number, location, and layout of advertising content that direct
marketing will replace. The package definition is XML-based. It
includes references to other resources and attachments that will
be placed in the document. You create the package definition using
the Asset Placement Plug-in for Flash Builder 4 and then add the
asset data.
This value is mandatory.
Document template
A
document
value that represents the
template PDF Portfolio (.PDF) or Flex navigator (.NAV) that will
be used to provide the interactive portion of the output document.
The service distinguishes between the two variations and creates
the output accordingly. Alternatively, you can set this value to
NULL and specify it in the package definition.
Print template
A
document
value that points to a non-interactive
printable PDF form. If provided, the PDF document is rendered and
placed inside the document, and updated with current data. The value
could also be an xfa template stored within a .XDP file with no
external references. (A PDF would be passed for efficiency.)
Alternatively,
you can set this value to NULL and specify it in the package definition.
When defined in the package definition file, the attachment must
use the reserved ID "printDocument" so that it is recognized as
the printable statement, and merged with statement data.
This
value is not mandatory.
XML data
A
document
value that specifies the
XML data that must be merged into the document. The data is reflected
in the navigator user interface through the flex components, as
well as merged into the Print Template if it has been provided.
You
must either pass the data to the operation as a parameter, or define
it within the package definition file (package.xml). When defined
in the package definition file, the resource must use the reserved
ID "data" so that it is recognized as the interactive document's
global data source.
Caching properties
Properties for specifying caching.
Caching ID
A
string
value that the service uses
to create a unique cache to hold any resources. This value is a
unique identifier for a particular batch run. The intended usage
is for operation in batches where many invocations may occur for
the same generation of documents. These resources would be shared
for the duration. When empty no caching is performed. The Batch
Processor service automatically passes this value.
Clear cache
Forces the service to clear
any cache found with the provided caching ID. This property is useful
when an invocation is restarted and you don’t want to keep resources.
For
efficiency, the service does not clear its cache based on timestamp
comparisons between the assets' original location and those it holds
in its cache. Rather, by default it holds items while they are being
used and expires items as they become idle.
Output
Property for specifying the output result.
Interactive Document result
A
document
value that represents the
output.
Exceptions
This operation can throw an AssetPlacementException.
|
|
|
