DIDComposePdfInteractiveStartV1
The DIDComposePdfInteractiveStartV1 call starts an interactive run that composes a PDF document from a Document Template or a Letter Book.
The request requires the following fields next to the standard fields.
| Field | Type | Description |
| project | repositoryobjectname | The Designer project that contains the Document Template or the Letter Book that you want to start an interactive run for. |
| documenttemplate | repositoryobjectname | Optional. If specified, the Document Template that you want to start an interactive run for. Either a documenttemplate or letterbook must be specified, but not both. Only the following Document Template formats are supported: DOC, DOCX, and PDF. The DOC format has been deprecated in KCM 5.7.0. |
| lettterbook | repositoryobjectname | Optional. If specified, the Letter Book that you want to start an interactive run for. Either a documenttemplate or letterbook must be specified, but not both. |
| status | message | Optional. The status of the Document Template that you want to use. The available statuses are Current, Accepted, or Published. If omitted, Published is used. |
| previewformat | message | Optional. If specified, the format of the document previews that you want to have during the interactive run. If omitted, no preview is shown. This can be either PDF or HTML. |
| keys | message | Optional. A semicolon separated list of keys. If a key should refer to the uploaded xmlfile, the special value *XMLFILE should be used. In this case the xmlfile parameter is required. Note that *XMLFILE is interpreted case-sensitively. |
| extras | message | Optional. An extra parameter is a single string that contains items separated by semilcolons and has a limitation of 1024 characters. This parameter is not meant to pass big amounts of data to a template, for this purpose, use the Data Backbone. |
| xmlfile | base64Binary | Optional. A base-64 encoded data xml file, which matches the DID on which the template is based. If a file is passed for the xmlfile parameter, the keys will be required to contain at least one occurrence of *XMLFILE. |
| environment | name | Optional. Specifies the data environment that will be used. If no environment parameter is passed, the default environment will be used. If you pass an environment that does not exist, an error occurs. |
If you want to supply a key or extra value with a semicolon, use a slash as an escape character.
Example:
-
Extra1;Extra2. These are two extra parameters separated by a semicolon: Extra1 and Extra2.
-
Extra1/;Extra2. This is only one extra parameter value: Extra1;Extra2.
For more information, see Kofax Communications Manager Template Scripting Language Guide.
Keys and Extras are only supported by the CCMCompatibility contract type. See the corresponding topic for more information on document pack template restrictions related to data retrieval.
The response contains the following fields in addition to the standard fields.
| Field | Type | Description |
| ccmsessionid | sessionId | KCM Contract Manage session identifier. |
| url | url |
A URL that is relative to the base URL of Kofax Communications Manager. Example: https://<kcm server>:443/ccm/ All relative URLs that are returned are relative to this base URL. This URL refers to JSON data that serves as input to your interactive ComposerUI web application. |
In case of an error, the response contains a SOAP Fault structure.