itpserver_setting

The function itpserver_setting can be used to retrieve information on the ITP/Server context in which the model is run. The function has one parameter type TEXT which contains the setting that the function retrieves. The function result is type TEXT and holds the retrieved value.

Supported settings are:

• _JobID; retrieves the ITP/Server Job Identifier of the current request.
• _User; retrieves the user who submitted the request:
  • For ITP/Server requests, this returns the user profile of the user who submitted the request.
  • For ITP/OnLine requests, this returns the user credentials used to authenticate with ITP/OnLine.
• _ApplicationID; retrieves the application id of the ITP/OnLine IIS application or the application name of the ITP/OnLine J2EE application.
• _Server; retrieves the Microsoft Windows Service name of the ITP/Document Processor running the script that is accessing this constant.
• _Service; retrieves the text "Load Balancer Interface:" followed by the name of the ITP/Server service accessing this constant.
• _ServerName; retrieves the name of the ITP/Server installation.
• TempDir; retrieves the temp location created of the ITP/Document Processor.
• ITPWorkDir; retrieves the folder ITPWORK of an ITP/Server setup.
• ITP/Server Constants; can be used to retrieve the value of ITP/Server constants. ITP/Server constants are defined on the Constants tab of the Services. Their value can be retrieved by calling the itpserver_setting function passing the name of the constant as parameter.

Example

TEXT server := itpserver_setting("_Server")

TEXT temp := itpserver_setting("TempDir")

Note that this function will work when running an ITP Model with ITP/Workstation but the result will always be an empty string.