Basic Configuration

Last updated on
29 October 2019

Basic Setup

Basic administration of the module is set at the Configure Sherpa Webform found at Administration/Configuration/Web Services. You will need the production URL for the Web Service, along with the Company ID and Community ID.

The default values provided by the module's installation under Configure Sherpa Webform screen can be used in the sandbox environment provided by Sherpa "out of the box".

Enable Debugging

Selecting "Enable Debugging" will set verbose logging to the Drupal log. Each step in the process will be noted, along with a number of data values. Very useful for debugging your field mappings.

Integration Options

There are two methods for sending data to Sherpa; cURL and the RESTful Web Services module (part of Drupal core). The module detects which methods are available, and provides this information on the configuration screen. If you have it enabled, you may chose to use the RESTful Web Services module by selecting the "Use RESTful Web Services" checkbox. If you do not select this option, the module will attempt to use cURL.

You must have cURL installed on your server OR an enabled RESTful Web Services module to send data to Sherpa.

If you do not have cURL installed on your server, you must enable the RESTful Web Services module and select the "Use RESTful Web Services" checkbox.

Quick Set

Selecting "Use Quickset" will pre-fill the JSON sent to Sherpa with common required fields set to default values, so they do not need to be included in the form (for example as a hidden field). The values are as follows:

  • VendorName = "Company Website"
  • SourceName = "Internet"
  • ReferralType = 1
  • AdvisorFirstName = ""
  • AdvisorLastName = ""
  • AdvisorEmail = ""
  • ResidentContactFirstName = ""
  • ResidentContactLastName = ""
  • PrimaryContactResidentRelationship = "self"

This can keep your Webforms free of unwanted and messy hidden fields, as well as reduce the time needed to update and map your Webform fields. Please note, this value will always be overwritten by the local Webform configuration settings.

Sherpa Date & Time Fields

You can set the date format sent to Sherpa using the Sherpa ReferralDate and Sherpa ReferralDateTime dropdown lists. Both ReferralDate and ReferralDateTime are pre-set to Sherp's preferred values ('Y-m-d' for ReferralDate & 'Y-m-d\zH:i:s' for ReferralDateTime), but you can set this value to any of Drupal's available Date Time types, including custom values. Keep in mind that data set to Sherpa will be in JSON format, which will escape some characters in the POST string.

Help improve this page

Page status: No known problems

You can: