ITPOLSSessionSetModelParams
Parameters
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 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 ITPOLSSessionSetModelParams the parameters defining a model run may be set. Most of these parameters match the parameters described in section Runmodel.

Parameter

Description

User

The user on behalf of which the model will be run. The value for this parameter will e.g. be passed to the ListModels and the CheckModelAccess exit point scripts.

Model

The model to be run.

Label

The label of the model run. The value will be shown on the HTML forms of the model run.

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, 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.