Easy Form Settings - Handlers – Stacks for Libraries

Handlers are typically used to trigger an action related to form submissions, updates, or deletions.

Accessing Handlers

From the Dashboard, click the Easy Forms tile
Find the form to add or edit the handler(s) for by:
1. Browse the list
2. Search the form by title
Once found, under the Operations column, click the drop-down arrow, then click Settings
Click the Emails/Handlers sub-tab near the top of the screen
Click the + Add Handler button, then select the handler to configure by clicking the Add Handler button under the operations column for the handler type:
1. Action, triggers an action on a submission
2. Debug, debug a webform submission
3. Remote Post, Posts webform submissions to a URL
4. Settings, Allows webform settings to be overridden based on submission data, source entity fields, and conditions

Action Handlers

General tab

General settings
1. Title, name the handler
2. Administrative notes, add any relevant administrative notes if applicable
Trigger
1. Execute, select the trigger type from:
  1. ...when draft is created
  2. ...when draft is updated
  3. ...when anonymous submission is converted to authenticated
  4. ...when submission is completed
  5. ... when submission is updated
Actions
1. Change status, select from
  1. Flag/Star
  2. Unflag/Unstar
2. Change lock, select from
  1. Lock
  2. Unlock
    1. Submissions can only be unlocked programmatically
3. Append the below text to notes (plain text)
4. Display message
  1. Enter a message to display
5. Display message type, select from
  1. Status
  2. Error
  3. Warning
  4. Info
6. Update the below submission data (YAML)
7. Available element keys, expand the section to view the available element keys
Click Save when finished

Conditions tab

Click the Conditions tab to configure settings that allow you to control the appearance, state, or validation of pages or elements. For more information on adding conditions, see the article Advanced Features for Easy Forms.

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler.

Advanced settings
1. Enable the Action handler, when checked, will enable the action handler
Development settings
1. Enable debugging, when checked, trigger actions will be displayed on screen for all users
Click Save when finished

Debug Handlers

General tab

General settings
1. Title, name the handler
2. Administrative notes, add any relevant administrative notes if applicable
Debug settings
1. Data format, select from
  1. YAML
  2. JSON
2. Include submission properties, when checked, all submission properties and values will be included in the displayed debug information
Click Save when finished

Conditions tab

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler.

Advanced settings
1. Enable the Debug handler, when checked, will enable the debug handler
2. Click Save when finished

Remote Post Handlers

General tab

General settings
1. Title, name the handler
2. Administrative notes, add any relevant administrative notes if applicable
Completed, data will be posted when a submission is completed
1. Completed URL, enter the full URL to POST to when the submission is completed
Updated, data will be posted when a submission is updated
1. Updated URL, enter the full URL to POST to when the submission is updated
Deleted, data will be posted when a submission is deleted
1. Deleted URL, enter the full URL to POST to when the submission is deleted
Submission data, data will be posted when a submission is completed
1. Check the box beside the data to post
Click Save when finished

Conditions tab

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler.

Advanced settings
1. Enable the Remote post handler, when checked, will enable the remote post handler
Additional settings
1. Method, select POST to request the web server accept the data enclosed when a completed form is submitted
2. Post type, select from
  1. x-www-form-urlencoded
    1. Use this option when unsure, as it is the default format for HTML webforms
  2. JSON
3. Cast posted element value and custom data, when checked posted element values will be cast to integers, floats, and booleans as needed
  1. Custom data can be cast by placing the desired type in parentheses before the value or token
4. Custom data, enter the custom data that will be included in all remote post requests
5. Custom options, enter custom request options that will be used by the Guzzle HTTP client
6. Custom error response message, enter a message to be displayed when the response status code is not 2xx
7. Add, select a numerical value and click the button to add more settings as needed
8. Custom error response redirect URL, enter the URL or path to redirect when a remote fails
Development settings
1. Enable debugging, when checked, posted submissions will be displayed on screen for all users
Click Save when finished

Settings Handlers

General tab

General settings
1. Title, name the handler
2. Administrative notes, add any relevant administrative notes if applicable
Confirmation settings
1. Confirmation title, enter a title display at the top of the page upon a successful submission
2. Confirmation message, enter a message to be displayed upon a successful submission
Custom settings
1. Custom settings (YAML), enter the setting name and value as YAML
Available custom settings, expand the section to see the available settings
Click Save when finished

Conditions tab

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler.

Advanced settings
1. Enable the Settings handler, when checked, will enable the settings handler
Developer settings
1. Enable debugging, when checked, settings will be displayed on screen for all users
Click Save when finished