Properties
The Model class has the following properties. All properties have getter and setter methods.
Connection settings.
Both properties below must be specified when constructing a model.
| Property | Type | Description |
|---|---|---|
| Host | String | Required. A string that contains the name of the server running KCM ComposerUI. The name can be specified either in (IPv4) Internet Protocol dotted address notation (a.b.c.d) or as a resolvable host name. |
| Port | String | Required. A string that contains the port to connect to KCM ComposerUI. The port can be specified either in numerical format or as a resolvable port name (TCP/IP service name). |
Identification
| Property | Type | Description |
|---|---|---|
| JobId | String | Required. A string that contains the Job Identifier for this job. |
| UserId | String | Required. The user that is doing this request. |
| ApplicationId | String | Optional. Additional accounting information. |
| SessionId | String | This identifier is initialized by KCM ComposerUI during a "Start" call. If a single Model instance is used to manage a complete Master Template run, this will automatically ensure that Continue/Cancel/Finish calls pass the right session id. We recommend that the user of this API remembers this value, and sets it before issuing one of these subsequent calls. |
Database info
| Property | Type | Description |
|---|---|---|
| Environment | String | Optional. The environment that the Master Template runs in. If not set, the default environment will be used (if configured). |
| DBUserId | String | Optional. Database User ID. |
| DBPassword | String | Optional. Database password for the given DBUser. If set, these credentials are initially passed
to the Start and the Continue call. They override any credentials that have been set in the Connection Configuration file.
The password is not encrypted. |
Processing modes
| Property | Type | Description |
|---|---|---|
| History | boolean | Optional. If set to True, return a list of all interact answers (in XML format) together with the final document. False by default. |
Input and Output files
| Property | Type | Description |
|---|---|---|
| Info | String | Required. This property contains the path to the file in which all XML data will be returned. The content of the XML file depends on the call, and on the return value of the call. |
| Result | String |
The UNC path where the final document is stored. It contains the value that is passed as a Result argument to the Start method. API retrieves the document from KCM Core and stores it at the UNC path location that is accessible from the machine, and on which the Java API is installed. We recommend that the user ensures that the API is able to write to this location. Also see the property DocumentOnServer for alternative use. |
| Preview | String | Optional. The UNC path where the previews are stored. A preview is an intermediate result document, as it is at the moment of an interact. Also see Result. If no preview filename is specified, no previews are generated. It is allowed to use the same UNC path for both the preview and the final document. |
| Data | String |
Optional. The UNC path to an XML data file. Also see Result. This XML data can be passed as an input file to KCM Core. Only used with the KCM XML File Connection. If the Data property is not set and the KCM Template needs an XML data file, an XML Form is sent out with an INTERACT. In this INTERACT the user is asked to select the XML data file. |
| DocumentOverwrite | boolean | Optional. Specifies whether existing result documents may be overwritten. True by default. |
| ResultFormat | String | Optional. The format of the final document. Can be either "NATIVE" or case insensitive "PDF". Default is "NATIVE", which means that the word processor format of the model itself gets generated. |
| PreviewFormat | String | Optional. The format of the previews. Can be either "NATIVE" (the default) or "PDF" (case insensitive). |
| ResultOnServer | boolean | If True, the Result is relative to the KCM Core machine, such as a local path on the KCM Core machine. In that case, KCM Core is responsible for storing the result document at that location. The final document is not transferred to the Java API then. If this value is False, the final document is transferred and stored on the machine where the API is installed. False by default. |
| PreviewOnServer | boolean | Optional. See DocumentOnServer. False by default. |
| DataOnServer | boolean | Optional. See DocumentOnServer. If True, the API does not transmit any XML data file. False by default. |
| FileExtension | String | Read only. Contains the extension of the result document. Possible values are:
unknown: Unable to determine the type of the file. doc: Microsoft Word document. docx: Microsoft Word Open XML document. ps: PostScript file. pdf: PDF document. sxw: OpenOffice.org/StarOffice document. odt: OpenOffice.org 2.2 document. lwp: WordPro document. wpd: WordPerfect document. |
| ProcessPreviewParams | String | Optional. A string that is passed to the ProcessPreview exit point. This can be used freely to pass information to the exit point. For example, to specify which action it should take. |
| ProcessResultParams | String | Optional. A string that is passed to the ProcessResult exit point. This can be used freely to pass information to the exit point, such as to specify which action it should take. |
| FormVersion | String | Optional. The maximum feature level that is supported by the client of the API. Clients can protect themselves against new features in the INTERACT XMLs returned by KCM Core. Instead of sending back an XML with these features, KCM Core returns an error. |