Parameter Text User
Parameter Text Pattern = ""
Parameter Text Root = ""
Parameter Text Keys = ""
Parameter Text Extras = ""
Parameter Text ResultFileName = "Result"
Parameter Text ProcessPreviewParams = ""
Parameter Text ProcessResultParams = ""
Parameter Text Environment = ""
Parameter Text ResultFileFormat = ""
Parameter Text Preview = ""
Parameter Text DatabaseUID = ""
Parameter Text DatabasePWD = ""
Parameter Text OnSuccessCommand = ""
Parameter Text OnFailureCommand = ""
Parameter Text PreCommand = ""
Parameter Text PostCommand = ""
Through ITPOLSSessionSetListParams the parameters defining a model list may be set and the parameters for a subsequent model run. Most of these parameters match the parameters described in section Runmodel.
Parameter |
Description |
|---|---|
User |
The user on behalf of which the model list and the subsequent model will be run. The value for this parameter will e.g. be passed to the ListModels and the CheckModelAccess exit point scripts. |
Pattern |
A (file system) pattern identifying a subset of the models that are available for the browsing user. A script on the server will interpret this pattern. The default implementation of this script will interpret the pattern as a path relative to the models directory of the ITP/Server installation. See ITP/Server: OnLine exit points for more information on the way the list of models is retrieved from ITP/Server. |
Root |
A path relative to the models directory of the ITP/Server installation, identifying a subset of the folders and models to be shown. This path point to the top level folder of the folders to be shown. |
Keys |
A semi-colon separated list of keys to be used by the model run. It is possible to refer to files in the session by prefixing their name with "session:" e.g., key1;session:data;key3;key4. |
Extras |
A semi-colon separated list of extras to be used by the model run. |
ResultFileName |
The file name of the result document. The result document will always be stored as a session file. |
ProcessPreviewParams |
The value of this parameter will be passed to the ProcessPreview exit point script. |
ProcessResultParams |
The value of this parameter will be passed to the ProcessResult exit point script. |
Environment |
The environment under which the model 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". |
DatabaseUID |
User Id to be passed to the DataManager on ITP/Server. |
DatabasePWD |
Password to be passed to the DataManager on ITP/Server. |
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). |
For certain parameters it is possible to indicate that the value should be determined by the configuration of ITP/OnLine, 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, Pattern, Root, Environment, ResultFileFormat, Preview, DatabaseUID, DatabasePWD, OnSuccessCommand, OnFailureCommand, PreCommand, and PostCommand. For the remaining parameters, the model run will always use the exact values specified as parameters to this service.