DIDComposeDocxV1
The DIDComposeDocxV1 call composes a DOCX document from a Document Template.
The request requires the following fields next to the standard fields.
| Field | Type | Description |
| project | repositoryobjectname | The Designer project that contains the Document Template that you want to use. |
| documenttemplate | repositoryobjectname | The Document Template that you want to use. |
| 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. |
| 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 |
|
document |
base64Binary |
A base-64 encoded DOCX document. |
In case of an error, the response contains a SOAP Fault structure.