Menu

ClickDimensions Integration How-To

Our ClickDimensions integration supports the following services:

  • PredictiveAddress
  • Email Validation
  • Phone Validation
  • Name Validation

Step 1: Open Code Editor

To integrate Data8 Validation or PredictiveAddress into your ClickDimensions form, select the form record, click "Design" in the ribbon and then click "Code Editor" in the form designer.

Step 2: Generate your configuration code using the form below

Simply fill out the form and click generate to get your custom code.

Each validation service requires the necessary credits to function.

An API key is required to use any of the validation or PredictiveAddress services. You can generate one from the Dashboard, under the Validation tab or by clicking here (please note, you need to register to access the Dashboard). Your API key must be enabled for use on the domain name entered as the "Web content CNAME" in your ClickDimensions configuration (usually web.yourdomain.com)

Client API Key
Use PredictiveAddress
Street 1 Field
The "Form Field Id" of the field that holds the first line of the address
Street 2 Field
The "Form Field Id" of the field that holds the second line of the address
Street 3 Field
The "Form Field Id" of the field that holds the third line of the address
City Field
The "Form Field Id" of the field that holds the city name
State/Province Field
The "Form Field Id" of the field that holds the state/province name
Postcode Field
The "Form Field Id" of the field that holds the postcode
Country Field
The "Form Field Id" of the field that holds the country name
Include Multiple Residency Properties (Requires additional licensing)
Include addresses from the UK Multiple Residency database, e.g. multiple flats behind a single letter box, university halls of residence
Include Not Yet Built Properties (Requires additional licensing)
Include addresses from the UK Not Yet Built database, e.g. houses currently being developed
Use Geocoding (Retrieve latitude and longitude information)
Include location information (latitude/longitude, easting/northing and/or grid reference, depending on country) where possible
Use what3words to get Geolocation (Requires additional licensing)
Indicate if the coordinates of the what3words searched for by the user should be included in the response instead of the standard coordinates available for the address. This option consumes a what3words credit in addition to the standard PredictiveAddress credit.
Allowed Countries
An array of ISO2 country codes that the user is allowed to select from, e.g. [ "GB", "US" ] to limit the user to UK and US addresses. Leave this set to null to allow the user to select from all the supported countries
Barred Countries
An array of ISO2 country codes that the user is not allowed to select from, e.g. [ "RU", "CN" ] to allow the user to select any country other than Russia or China. Leave this set to null to not block any countries
Use Name Validation
First Name Field
The "Form Field Id" of the field that holds the first name
Last Name Field
The "Form Field Id" of the field that holds the last name
Use Email Validation
Email Address Field
The "Form Field Id" of the field that holds the email address
Email Validation Level
In addition to the Server level checks, validates that the mail server accepts mail for the full email address.
Use Phone Validation
Phone Number Field
The "Form Field Id" of the field that holds the phone number
Default Country Code
Specify the ISO 2-character country code or international dialling code of the country to validate the telephone number in, unless that number contains an explicit country code prefix. i.e. 'GB' or '44'

Step 3: Paste code in Javascript section

Having generated your code above, you can now copy and paste this into the Javascript section of the ClickDimensions Code Editor window.

Should you ever wish to remove the Data8 Validation or PredictiveAddress from your ClickDimensions form, simply remove this code from the code editor again.

That's it! Data8 Validation and Address Capture has been applied to your form, depending on the options you selected.

Additional Configuration

To configure the validation to suit your needs, open the Code Editor and change the value of the variables to suit your needs. An API key is required to use any of the validation or PredictiveAddress services. Each validation service requires the necessary credits to function.

PredictiveAddress Options

When the PredictiveAddress service is enabled, the PredictiveAddress options will be encoded at the top of the generated script according to the options selected on this form. However, should you wish to customise your integration, you can do so by entering any combination of the options available for the PredictiveAddress service.

For example, add the following into the PredictiveAddress options box to detect the initial country in the PredictiveAddress search, from the users IP address:

initialCountry: "auto"

Validating Additional Fields

To attach the PredictiveAddress service to more than one address field, add more entries to the generated fields array. For example:

fields: [
  { 
      street1: "address1_line1",
      street2: "address1_line2",
      street3: "address1_line3",
      city: "address1_city",
      stateorprovince: "address1_stateorprovince",
      postalcode: "address1_postalcode",
      country: "address1_country"
  },
  { 
      street1: "address2_line1",
      street2: "address2_line2",
      street3: "address2_line3",
      city: "address2_city",
      stateorprovince: "address2_stateorprovince",
      postalcode: "address2_postalcode",
      country: "address2_country"
  }
],
...

You do not need to specify each of the field mappings above for an address. The only required lines are "line1" and "postcode". The rest can be removed if necessary.

Email and Phone Validation can be applied to multiple fields by adding the field names to the fields array in the corresponding section of the generated script configuration, e.g.:

email: {
  level: "Address",
  fields: [
    "emailaddress1",
    "emailaddress2"
  ]
}

Salacious Names validation can also be added to multiple sets of name fields:

name: {
  fields: [
    { firstname: "firstname", lastname: "lastname" },
    { firstname: "new_customfirstname", lastname: "new_customlastname" }
  ]
}

Usage

When PredictiveAddress is enabled, you will start seeing autocomplete suggestions displayed as you type in the Street 1 field. Select an address from the autocomplete list to automatically fill out the remaining fields.

If you have configured one of the other validation services, the data will be validated automatically as the form is submitted. Any errors will be highlighted using the standard ClickDimensions error display and will need to be corrected before the form can be submitted.

ClickDimensions Validation Errors