ITPOLSSessionPrepareLetterbook
Parameters
Parameter Text User
Parameter Text Letterbook = ""
Parameter Text Keys = ""
Parameter Text Extras = ""
Parameter Text ResultFileName = "Result"
Parameter Text ProcessPreviewParams = ""
Parameter Text ProcessResultParams = ""
Parameter Text ProcessConfirmParams = ""
Parameter Text Environment = ""
Parameter Text ResultFileFormat = ""
Parameter Text Preview = ""
Parameter Text PreviewFileFormat = ""
Parameter Text Confirm = ""
Parameter Text ConfirmFileFormat = ""
Parameter Text DatabaseUID = ""
Parameter Text DatabasePWD = ""
Parameter Text OnSuccessCommand = ""
Parameter Text OnFailureCommand = ""
Parameter Text PreCommand = ""
Parameter Text PostCommand = ""
Parameter Boolean UploadDataFile = False
Parameter Boolean UploadDBB_XML = False
Parameter Text DBB_XMLInput = ""
Parameter Text DBB_XMLOutput = ""
Parameter Text RedirectUrl = ""
The parameters defining a Master Template list and the parameters for a subsequent Master Template run may be set through ITPOLSSessionSetListParams. Most of these parameters match the parameters described in the section Runmodel.
| Parameter | Description |
|---|---|
| User | The user on whose behalf the Master Template list and the subsequent Master Template are run. For example, the value for this parameter is passed to the ListModels and the CheckModelAccess exit point scripts. |
| Letterbook |
The entry point of a Letterbook. This selects the folders and Templates that are available for the browsing user. This is the name of an interactive Letterbook, optionally followed by sub folders separated by slashes (/). Starting with KCM Core and KCM Repository version 4.2.3y when a rep:/ uri is provided for the Letterbook, the Letterbook is retrieved from the KCM Repository. See also RetrieveRepositoryObject. |
| Keys | A semicolon separated list of keys is used by the Master Template run. It is possible to refer to files in the session by prefixing their name with "session." For example, key1;session:data;key3;key4. |
| Extras | A semicolon separated list of extras is used by the Master Template run. |
| ResultFileName | The file name of the result document. The result document is always stored as a session file. |
| ProcessPreviewParams | The value of this parameter is passed to the ProcessPreview exit point script. |
| ProcessResultParams | The value of this parameter is passed to the ProcessResult exit point script. |
| ProcessConfirmParams | The value of this parameter is passed to the ProcessParams parameter of the exit point scripts. |
| Environment | The environment under which the Master Template run will take place. |
| ResultFileFormat | The format of the result document, either "PDF" or "native". |
| Preview | Whether or not the HTML forms of the model run should be accompanied with previews of the document as it is at that moment. Either "Y" or "N". |
| PreviewFileFormat | The format of the preview document, either "PDF", "native" or "HTML". |
| Confirm | A confirmation page is presented after the Master Template completes. Either "Y" or "N". |
| ConfirmFileFormat | The format of the confirm document, either "PDF", "native" or "HTML". |
| DatabaseUID | User Id is passed to the DataManager on KCM Core. |
| DatabasePWD | Password is passed to the DataManager on KCM Core. |
| OnSuccessCommand | OnSuccess command, executed when the model succeeds (AS/400 only). |
| OnFailureCommand | OnFailure command, executed when the model fails (AS/400 only). |
| PreCommand | Pre command, executed at the start of the run (AS/400 only). |
| PostCommand | Post command, executed at the end of the run (AS/400 only). |
| UploadDataFile | Either True or False. If UploadDataFile is set to True, a ReceiveFile is performed with the value "datafile" for the parameter Src. In this case the location of the received data file is used as Keys, replacing the value passed to this service. The UploadDataFile feature is designed for use by Master Templates that use an XML File connection (DID). The uploaded file is automatically used as the XML data file by the Master Template run. |
| UploadDBB_XML | Either True or False. If UploadDBB_XML is set to True, a ReceiveFile is performed with the value "xml-input" for the parameter Src. The received data file is stored in the session and a reference to that file ("session:xml-input.xml") is used as DBB_XMLInput value, replacing the value passed to this service. The UploadDBB_XML feature is designed for use by Master Templates that have a Data Backbone which are filled by a data XML that matches the xsd of the Data Backbone. |
| DBB_XMLInput | The location of a data XML file is used to fill the Data Backbone of the Master Template. That data XML file must match the xsd of the Data Backbone. It is possible to refer to files in the session by prefixing their name with "session." For example, "session:xml-input.xml". Uploading a file to the session can be done with the ITPOLSSessionUploadFile service. |
| DBB_XMLOutput | The location where the XML file with the data of the Data Backbone of the Master Template should be stored after the Master Template run completed. It is possible to refer to files in the session by prefixing their name with "session." For example, "session:xml-output.xml". Downloading the file from the session can be done with the ITPOLSSessionDownloadFile service. |
| RedirectUrl | A URL that can be retrieved with the ITPOLSSessionGetRedirectURL service using an exchange data. Typically used to redirect the user's browser after completing the model. |
For certain parameters it is possible to indicate that the value should be determined by the configuration of KCM ComposerUI, instead of by the value passed to the service ITPOLSSessionPrepareLetterbook. This can be indicated by passing the special value "*DEFAULT". This special value is supported by the following parameters:
-
User
-
Letterbook
-
Environment
-
ResultFileFormat
-
Preview
-
DatabaseUID
-
DatabasePWD
-
OnSuccessCommand
-
OnFailureCommand
-
PreCommand
-
PostCommand