Runmodel

A call to this page initiates a model run based on a number of passed parameters. The model that is run may contain FORM statements, possibly referring to dynamic Forms. If it does, this will result in a sequence of HTML pages containing forms being presented to the user.

Parameters (prepared model run)

If a model run is already prepared by the integrating application a single sessionid parameter is sufficient to start the model run. Other parameters ignored. See Integration chapter.

Call parameters

Parameter	Type	Status	Description
sessionid	string	required	The session identifier corresponding to the prepared model run. This session identifier can only be passed through the query string, not as form data.

Parameters

If the sessionid parameter is omitted, the following parameters are used:

Call parameters

Parameter	Type	Status	Description
model	string	required	Identification of the model to be run given as a rep:/ URI or Letterbook URI. See also Rep:/URIs.
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 KCM server (res_srv=Y). See the Properties table below for a description of the res_srv property. The default is an empty string in which case KCM ComposerUI stores the documents on the Web Server and makes it available for display in the browser. In that case the document is deleted when the session expires.
pvw_proc_params	string	optional	A string that passes 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. For more information, see CM Core: Online exit points.
res_proc_params	string	optional	A string that 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. For more information, see CM Core: OnLine exit points.

Properties

Parameter	Type	Description
dat_srv	Boolean	The XML data (if applicable) can be accessed from the server on which KCM Core is running. If this is not the case, the file identified by dat_uri (if any) is uploaded from the web server to the KCM server. In this case the value "*DataURI" should be passed for the keys parameter, thus indicating the file that was uploaded to the KCM server.
dat_uri	String	Location of the XML data to be used (if any), as a local path relative to either the web server (dat_srv=N) or the KCM server (dat_srv=Y).
db_pwd	String	Password to be used by the DataManager on KCM Core.
db_uid	String	User Id to be used by the DataManager on KCM Core.
env	String	Identification of the Environment under which the model is run on KCM Core. This corresponds to the connection configuration on the server.
history	Boolean	An outline of the provided answers to all interacts should be returned by KCM Core at the end of the model run.
ofcmd (AS/400 only)	String	OnFailure command, executed when the model fails.
oscmd (AS/400 only)	String	OnSuccess command, executed when the model succeeds.
postcmd (AS/400 only)	String	Post command, executed at the end of the run (after ofcmd or oscmd)
precmd (AS/400 only)	String	Pre command, executed at the start of the run.
pvw	Boolean	KCM ComposerUI HTML Forms should be accompanied with a preview of the document as it is at that moment.
pvw_fmt	String	Required format of the preview document (if any - either native or PDF).
res_fmt	String	Required format of the result document (either native or PDF).
res_owt	Boolean	The file identified by res_uri may be overwritten.
res_srv	Boolean	KCM Core should write the document to the location identified by res_uri. If a res_uri is provided, res_srv=Y makes sense in most cases. If a res_uri is not provided, res_srv is ignored, the document is stored in local storage on the web server and be made available through a URL.