itpserver_setting

The itpserver_setting function can be used to retrieve information on the KCM Core context in which the Master Template is run.

The function has one parameter of type TEXT that contains the setting that the function retrieves. The function result is of type TEXT and holds the retrieved value.

Supported settings are the following:

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

An example is provided here.

 TEXT server :=
itpserver_setting("_Server")
 TEXT temp :=
itpserver_setting("TempDir")