Remote Approval action parameters

Process Design
1

Remote Approval requires additional parameters to be added to an EFORMASPX action. These parameters are to define the questions for remote approver and map the approver’s response to the action.

See the Remote Approval section in the WorkflowGen Administration Guide for information on how to define Remote Approval questions, email customization, Remote Approval web form design, and possible errors.

Default parameters

Parameter Type Direction Description
FORM_DATA (required) FILE IN/OUT IN/OUT parameter that holds the WorkflowGen request form data file. This is a default parameter for EFORMASPX actions.
FORM_ARCHIVE FILE OUT Remote Approval requires passing the FORM_ARCHIVE process data as a WorkflowGen parameter in order to capture all the field updates that occur during Remote Approval. The parameter direction must be OUT in order to return the updated archive content back to WorkflowGen.
Notes:
  • No update will be made to the archived web form if FORM_ARCHIVE is not defined in the Remote Approval action.
  • FORM_ARCHIVE is needed for EFORMASPX actions only.
Qx_KEYWORDS_n TEXT IN See the Email customization section for details on this parameter.
Qx_RESULT_n TEXT IN See the Email customization section for details on this parameter.
Qx_RETURN_FIELDNAME TEXT IN The normalized result from Qx_RESULT_n will be passed to the field name specified in this parameter.
Note: No other parameter should be defined in a Remote Approval that has the suffix _RETURN_FIELDNAME .

Optional parameters

Parameter Type Direction Description
KEYWORDS_BRACKETS TEXT IN To answer a Remote Approval question in regular approval mode, you must follow a pre-defined syntax: Q1: [answer]
The square brackets ( [ and ] ) are the default value if this parameter is not used. You can customize it by assigning different characters to enclose the answer. For example, you can set KEYWORDS_BRACKETS to ## for an answer format: Q1: #answer#
Note: This consists of two characters only, for the opening and closing characters.
USER_NAME_FORMAT TEXT IN The full name of the approver who replies will be retrieved from the WorkflowGen database. The approver’s full name will be returned to the field control in the web form if USER_NAME_FIELDNAME is defined. By default, the user’s full name will be in Firstname Lastname format. You can customize the format by using the control characters L and F , for last name and first name, respectively.
USER_NAME_FIELDNAME TEXT IN Regular web forms can use WorkflowGen macros to obtain the assignee’s full name. In Remote Approval, the approver is defined based on the receipt of the approval reply, a specific parameter is required to return the actual approver’s name back to WorkflowGen. Create this parameter to specify the field control ID that receives the returned approver name. Only TextBox type field control IDs are supported.
USER_FIRSTNAME_FIELDNAME TEXT IN Create this parameter by assigning the field control ID in your form to display the approver’s first name in the WorkflowGen user profile on the form archive page.
USER_LASTNAME_FIELDNAME TEXT IN Create this parameter by assigning the field control ID in your form to display the approver’s last name in the WorkflowGen user profile on the form archive page.
USER_TITLE_FIELDNAME TEXT IN Create this parameter by assigning the field control ID in your form to display the approver’s job title in the WorkflowGen user profile on the form archive page. Only TextBox, RadioButtonList, and DropDownList type field control IDs are supported.
COMMENT_FIELDNAME TEXT IN Create this parameter by assigning the field control ID in your form to display the approver’s comment on the form archive page. Only TextBox type field control IDs are supported.
Note: You can specify the control ID by entering the text string or by passing a process data only if the process data contains the ID of the control. If no control ID is found, or the control ID is invalid, no name will be displayed and this parameter will be ignored.
COMMENT_REQUIRED_RESULTS TEXT IN Create this parameter by specifying which approver results will require a mandatory comment. Approver results refer to Qx_RESULT_n parameters. You can enter a comma-separated text string for this parameter to specify more than one result requiring a comment.
Example: Q1_RESULT_2,Q2_RESULT_2,Q3_RESULT_1
Here, the second answers of questions 1 and 2 ( Q1 and Q2 ) and the first answer of question 3 ( Q3 ) will require comments.
Notes:
  • Mandatory comments require the COMMENT parameter in the action.
  • All required results share the same COMMENT parameter.
  • The approver will receive an email for re-approval if a mandatory comment is missing.
QUICKAPPROVALMODE TEXT IN Quick mode can be enabled or disabled globally for all Remote Approval actions in the Configuration Panel as a default setting. Defining the QUICKAPPROVALMODE parameter for an individual Remote Approval action in a process will override the global default setting.
Note: The only text string allowed for this parameter is Y or N .