Set Form Data Plug-in Properties

The Set Form Data plug-in allows you to set a value in a field in the form at a particular point in the process.

Note: If the Plug-in Action Node property SYNC / Continue without Waiting is set to TRUE, the plug-in will update form fields when a process ends with either "completed" or "approved" status.

On this page

• Set Form Data plug-in usage example
• How to configure the Set Form Data plug-in
• Set Form Data plug-in tips and best practices
• Set Form Data plug-in parameters table

Set Form Data Plug-in - Usage Example

When user chooses an option (such as rejecting a submitted file, for example), a field in the form is automatically filled in with data, such as an email address for another approver in the workflow.

How to configure the Set Form Data plug-in

1. Click the Workflow tab, and then click Plug-in Action.
2. In the workflow, add (i.e. click and drag to 'draw') a Plug-in Action node to the Workflow.
3. Click the newly created node. In the Properties pane, below Action, locate the Plug-in name field.
4. Select the Set Form Data plug-in.
   
5. Click the Plug-in Options button.
   
6. Set xpath and value fields with the form field and the value you require (respectively). In the example, the xpath is set to ApproverEmail, and the value is set to [$CurrentUser.Email].
7. (Optional) Click Add to add more fields and field values.

Notes: The xpath value list will be populated in the dropdown automatically with the fields available in the form.

If you add the Date Picker control, use the default format (YYYY-MM-DD) or place a text box at the location of the Date type field.

8. Click Validate. (You should see the message "Validation Complete. No Errors found.")

Set Form Data Plug-in - Tips and Best Practices

The value field can be the result: of a workflow property (for example, ApproverEmail) or a more complex logic using function operators such as RejectionDate AND ApproverEmail.

Set Form Data plug-in parameters table

Value Pair	Description	Mandatory
value [index]	The value to which to set the form field.	Yes
xpath [index]	The XPath to the form field.	Yes

Parameters example

• value0 – [New Division]
• Value1 – [New Name]
• xpath0 – //my:Division
• xpath1 – //my:Name

This example sets the field named my:Division to the value in the New Division field, and the field named my:Name to the New Name field.