ITPOLSSessionSetModelParams
Parameter Text User
Parameter Text Model
Parameter Text Label = ""
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 Text DBB_XMLInput = ""
Parameter Text DBB_XMLOutput = ""
Parameter Text RedirectUrl = ""
The parameters defining a Master Template run may be set through ITPOLSSessionSetModelParams. Most of these parameters match the parameters described in section Runmodel.
| Parameter | Description |
|---|---|
| User | The user on whose behalf the Master Template is run. For example, the value for this parameter is passed to the ListModels and the CheckModelAccess exit point scripts. |
| Master Template | The Master Template to be run. |
| Label | The label of the Master Template run. The value is shown on the HTML forms of the Master Template run. |
| Keys | A semicolon separated list of keys to be 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 to be 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 exitpoint scripts. |
| Environment | The environment under which the Master Template run takes place. |
| ResultFileFormat | The format of the result document, either "PDF" or "native". |
| Preview | The HTML forms of the Master Template run are 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 model completes. Either "Y" or "N". |
| ConfirmFileFormat | The format of the confirm document. Either "PDF", "native" or "HTML". |
| DatabaseUID | User Id to be passed to the DataManager on KCM Core. |
| DatabasePWD | Password to be 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). |
| DBB_XMLInput |
The location of a data XML file that 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 is 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 | An URL that can be retrieved with the ITPOLSSessionGetRedirectURL service using an exchange data. Typically used to redirect the user's browser after completing the Master Template. |
For certain parameters it is possible to indicate that the value is determined by the configuration of KCM ComposerUI, instead of by the value passed to the service ITPOLSSessionSetModelParams. This can be indicated by passing the special value "*DEFAULT". This special value is supported for the following parameters:
-
User
-
Environment
-
ResultFileFormat
-
Preview
-
DatabaseUID
-
DatabasePWD
-
OnSuccessCommand
-
OnFailureCommand
-
PreCommand
-
PostCommand