Call parameters

Parameter

Type

 

Description

model

string

required

Identification of the model to be run. This is a path relative to the models directory of the ITP/OnLine Server installation. This path must include the model's name.

Absolute paths can be used here but this is not recommended because some functionality, such as ListModels, assumes all models to be placed in the Models directory.

Refer to the Script Manual of ITP/Server, chapter ITPRun, Usage for details on using absolute paths.

label

string

optional

User readable model identification.

keys

string

optional

Semicolon-separated list of keys to be used in the model run.

extras

string

optional

Semicolon-separated list of extras to be used in the model run.

res_uri

string

optional

The location of the result document as a local path relative to either the web server (res_srv=N) or the ITP server (res_srv=Y). See below for a description of the res_srv property.

The default is an empty string in which case ITP/OnLine will store the documents on the Web Server and make it available for display in the browser. In that case the document will be deleted when the session expires.

pvw_proc_params

string

optional

A string that will be 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.
See ITP/Server: OnLine exit points for more information.

res_proc_params

string

optional

A string that will be passes to the ProcessResult exit point. This can be used freely to pass information to the exit point, for example to specify which action it should take.
See ITP/Server: OnLine exit points for more information