DIDComposePackInteractiveStartV1
DIDComposePackInteractiveStartV1 prepares a session from which a document pack can be composed from an interactive Document Template or Document Pack Template. Returns a sessionid and a URL, based on which the interaction can be started. After the interaction has been completed, you can retrieve the resulting document pack using DIDComposePackGetV1. For more information see "DIDComposePackGetV1".
The request requires the following fields next to the standard fields.
Field | Type | Description |
---|---|---|
project | repositoryobjectname | Name of the KCM Repository project. |
templatetype | name | Either documentpacktemplate or documenttemplate. |
templatename | repositoryobjectname | Name of the template to compose the document pack from. |
importdocuments | base64Binary | Optional. A base-64 encoded XML structure binary representation of an import documents data structure. For more information on the format for this XML see "Format for the definitions". |
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. Extra parameters are specified as a string of values separated by semicolons with the maximum length 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. |
status | name | Optional. The status of the template to use. The available statuses are Current, Accepted, or Published. If omitted, Published is used. |
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. With this URL the interactive session can be started. |