Webform Setup
Selecting a Webform for integration with Sherpa can be found in the Webform's Build menu under the "Sherpa Configuration" tab. Selecting "Send this form to Sherpa" will convert the form data to their mapped values and send a JSON POST to Sherpa using cURL (default) or RESTful Web Services module (if available and selected in the Configure Sherpa Webform page). Please note: If you do not have cURL installed or the RESTful Web Services module enabled and selected, then no information will be sent to Sherpa.
Once the Webform has been selected for integration, there are a number of options as well as a form field mappings that need to be configured.
Webform Configuration
Use Quickset
Selecting "Use Quickset" acts just like the setting in the Configure Sherpa Webform page, and will pre-fill the JSON sent to Sherpa with common required fields set to default values, except the scope will be limited to this form only. This way, you can globally use Quick Set, with the exception of one or more forms where you wish to configure custom values (as hidden fields) to send to Sherpa (or vice versa). This setting will always over-write the global setting for this form only.
Custom Community ID
Selecting "Custom Community ID" will allow you to save a custom Community ID to the Webform. If this is unselected, the Community ID will revert to the default entered in the main configuration page.
Field Mappings
Below these settings is a list of supported fields from the Webform. You must map all required fields found in your Sherpa API documentation. If necessary you may need to create hidden fields and then map them to meet these requirements. Please refer to your Sherpa documentation for more information.
Please note that if you are using the "Quick Set" option for this form that some of your mappings may be overwritten, as Quick Set values are set after the fields have been mapped from the Webform submission. If you wish to customize these fields, you will need to disable "Quick Set" and manually enter all required values as hidden fields.
Supported Webform Fields
Only a limited number of webform fields are supported and will display in the field mapping screen. This is done to ensure that data conforms with Sherpa requirements and to keep any issues with JSON file creation to a minimum. Below is a list of tested and supported fields.
- checkbox
- date
- datelist
- datetime
- hidden
- number
- radios
- range
- select
- textarea
- tel
- tableselect
- textfield
- url
- value
- webform_autocomplete
- webform_codemirror
- webform_radios_other
- webform_rating
- webform_select_other
- webform_terms_of_service
- webform_time
Additionally, fields that are set to allow more than one value are not supported and are filtered from field mapping.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion