Calls

The Listmodels and Runmodel functionalities are considered as "Calls", because they both have a number of parameters.

The behavior of each call in KCM ComposerUI depends on a large set of parameters. Overall, there are three types of parameters:

  1. Call parameters are call-specific parameters that vary at run time. They can only be passed as a parameter of the Call.
  2. Configuration parameters are installation-specific parameters that are not vary at run time. They can only be configured through the configuration pages.
  3. Properties are parameters that may or may not vary at run time. For properties, defaults may be configured on the application specific configuration page. If a property is not passed as a parameter on the Call, the configured default is used.

The following parameter types are supported:

  • String
  • Number (string that may be interpreted as a number)
  • Boolean (string that may be interpreted as a boolean value, both 'Y'/'N' and 'true/false' are accepted, either in upper or in lower case)

All parameter names are case insensitive.

Call parameters

Parameters can be passed in a call in two ways:

  1. Get method, as part of the query string
  2. Post method, as form parameters

Both methods may be mixed in a single call. The call functionality does not depend on the method used to pass the parameter. If a parameter is passed both as part of the query string and as a form parameter, the latter will prevail.

When Secure Mode is enabled for an application, the form parameters are ignored. The parameter sessionid of the Runmodel call can only be passed through the query string.

Configuration parameters

Configuration parameters can only be configured through the main configuration page or the application-specific configuration pages.

Main configuration page:

http://[ machine ]:[ port ]/itp/configure.aspx

Application-specific configuration page:

http://[ machine ]:[ port ]/itp/app/[ application ]/configure.aspx

Properties

To limit the amount of parameters that need to be passed in a call to KCM ComposerUI, the concept of a "Property" is introduced. A Property is a Call parameter with the possibility of default configuration.