itp_parameter (k)

This function is deprecated. Use the document_metadata function instead. For more information, see document_metadata (k).

The itp_parameter (k) function retrieves the value that has been set by the last template for the key k. The template sets this value by calling the function itpserver_parameter ("k"; "value").

If no template has previously been run by the job or if the last template did not set a value for the key k, the itp_parameter (k) function returns an empty string.

Use the itp_parameter(...) function in combination with the itpserver_parameter(…) function to pass data from a template to the calling KCM Core script.

The itp_parameter data is part of the session data and persists over jobs until the next template is run. You can use this function to retrieve information from the template. The template can use runmodel_setting, itpserver_setting, and environment_setting to retrieve information from its context. See the sections runmodel_setting, itpserver_setting, and environment_setting in the Kofax Communications Manager Template Scripting Language Developer's Guide.