Display Properties - Add New Command
This page is accessed as part of the form policy creation process. For details on how to access this page, see Define Step Map - Advanced Options for workflow policies or Document Policy - Advanced Options for document policies.
Use this page to edit existing commands or to enter details to create a new command that you can assign to toolbar buttons when you create a form policy. Enter the options you want to add or edit and click Continue.
HTTP Request command options
NOTE An asterisk (*) indicates a mandatory field.
Command Detail | Value |
---|---|
* Name | Name of the Command |
* Method | Get or Post as the method of data transfer. |
* URL | Enter the URL and relevant query string macros (see string macro table below for acceptable values). |
Validation Cell Name | Select a Validation Cell Name from the drop-down list. Published cells are available to assign. |
Validate as Action Type | Select an action type from the drop-down list. This defines the type of command you are creating. |
Include Form Data cell values as separate individual request parameters | To include Form Data cell values as separate, individual request parameters, activate this option. |
Include Template ID as a parameter. Request parameter name: template | To include Template ID as a parameter (Request parameter name: template), activate this option. |
Include Form Data cell values in XML format as a single parameter. Request parameter name: data | To include Form Data cell values in XML format as a single parameter (Request parameter name: data), activate this option. |
Valid URL query string macros
Macro | Description |
---|---|
{QUEUE_NAME} | The queue name that the current Workflow Step is running under. |
{WOB_NUM} | The Work Object number for the current Workflow Step. |
{WINDOW_ID} | The Workplace window ID Used for referencing the Workplace infrastructure for cached data. |
{DATA_ID} | The Content Engine object ID (GUID) of the Form Data instance currently being operated on. |
{DATA_OBJECTSTORE} | The Content Engine object store name of the Form Data instance. |
{RETURN_URL} | Places the return URL string passed to the processors on the URL to be passed to the invoked command. |
{USER_SHORT_NAME} | Places the user "short" name on the URL. Typically, this is the login name string. |
{USER_DIST_NAME} | Places the user "distinguished" name on the URL. |
NOTE The form processors recognize these macros at runtime and perform the value substitution. All the query string values are label-encoded with Workplace's utility class "WcmEncodingUtil." This utility must be used for the web integration commands. This requirement causes a dependency on the target URL to decode the values with this same utility. The utility is packaged as part of the p8toolkit.jar file.
Browser Window Features
Select Open in Popup Browser Window or Open Command in Current Browser.
Open in Popup Browser Window Settings
If you select this option, the command opens in a new browser window and use the settings you enter. See the table below for setting options.
Settings | Description |
---|---|
Target Window Name | Title of the browser window. |
Show Address Bar | To enable the address bar, activate this option. |
Show Browser Toolbar | To display the browser toolbar, activate this option. |
Allow Scrolling | To allow scrolling, activate this option. |
Allow Window Resizing | To allow window resizing, activate this option. |
Height | Specified window height. |
Width | Specified window width. |
Return JavaScript to be executed by form
Select this option to allow return script that updates form values or executes available commands such as Close or Launch.
JavaScript Command Options
Command Detail | Value |
---|---|
* Name | Name of the command. |
* Script | JavaScript command code. |
Validation Cell Name | Select a Validation Cell Name from the drop-down list. Published cells are available to assign. |
Validate as Action Type | Select an action type from the drop-down list. This defines the type of command you are creating. |
Feedback