Welcome to the Salesforce plugin user guide. This guide will help you get started with using our Salesforce plugin.
If you have not yet installed the plugin or configured any of the components, see our installation guide first and return to this page once you've completed those steps.
Contents of this guide:
- Real-time validation and PredictiveAddress (creating and editing records)
- Lightning Components
- Business Insights
- Salesforce Classic
Real-Time Validation and PredictiveAddress
Data8 validation and address capture services can be applied to your record forms, to ensure any data entered into your system is correct and accurate. Having followed our Record Form Override how-to guide, you should now have these services configured.
To use the validation and address capture, simply create a new record, or edit an existing record for any object that you performed the setup (specified in the record form override guide) on. You should notice that the standard pop-out modal is replaced with a full width page, containing the form fields from your selected form layout. In plugin version 1.49 or above, one or more PredictiveAddress interfaces will be included in this form, according to the mappings set up in the plugin settings page.
Upon submitting the form, email and telephone validation will be applied to any email or telephone fields, and TPS and bank validation will be applied according to mappings configured in the settings.
PredictiveAddress is an international address capture service which speeds up address entry time and reduces mistakes through autocompletion.
To use PredictiveAddress in Salesforce, simply click inside the search box and start typing an address. This could be a partial address such as the house name or street, or a postcode. As you type, we will narrow down our search results from all of our data sources and display the suggestions. Clicking a suggestion will either narrow down your search further if the suggestion contains multiple addresses (such as if the suggestion was a street name), or will retrieve the full details of the final address selected.
The initial country to search will be chosen based on the settings of your salesforce environment. If you wish to change the country in which you are searching, click the 'Change Country' button below the search box and either start typing a country or ISO2 code, or select a country from the list. You can limit the countries shown in this list from the plugin settings page.
Telephone, email, name and bank validation will be applied first when a form is submitted. If invalid information is entered, an error message will be displayed at the top specifying which fields are incorrect. If the entered email address is incorrect and we have a suggested correction, you will see this at the top of the form along with the error message. If the entered information passes all of the enabled validation checks, then TPS checking and telephone formatting will be performed on the entered numbers where necessary (if enabled).
Data8 Lightning Components can be implemented onto Lightning Record Pages to add an interface for performing PredictiveAddress, Bank Validation, TPS checks, Email Validation, Telephone Validation or Business Insights lookups, without having to open and edit the record.
Having added the components to your record page, and set up mappings for them in the plugin settings page, you should now see the mapped field's data displayed within the Lightning Components. In order for the fields values to be displayed in the lightning components, you will need to add the fields to the objects page layout.
As mentioned in the real-time validation and address capture section above, PredictiveAddress is an international address capture service which speeds up address entry time and reduces mistakes through autocompletion.
To use PredictiveAddress in Salesforce, simply click inside the search box and start typing an address. This could be a partial address such as the house name or street, a 3 word address from what3words (word.word.word) or a postcode. As you type, we will narrow down our search results from all of our data sources and display the suggestions. Clicking a suggestion will either narrow down your search further if the suggestion contains multiple addresses (such as if the suggestion was a street name), or will retrieve the full details of the final address selected. When entering an address with the PredictiveAddress lightning component, the record will automatically be updated once a final address has been chosen.
The TPS Lightning Component will display any mapped telephone numbers, along with their last TPS check result and the date that the last TPS check was performed on the record. If multiple telephone fields are configured for a record, they will all be shown here. Clicking the "Check Now" button will trigger a TPS check on the telephone number(s) and once finished, will update the results and last TPS check field accordingly.
The bank validation Lightning Component will display the mapped bank account details including any additional information retrieved about the bank account.
To retrieve additional information about the bank account (other than a validation result), set up custom fields to store the data and configure mappings in the plugin settings page for the additional fields. If you wish to retrieve the address of the bank that the bank account is associated with, make sure the appropriate option is enabled on the settings page.
Clicking the "Validate" button will perform a bank validation check on the account number and sort code, and if configured, attempt to retrieve any additional information about the bank account. You will need to configure at the very least, an account number, sort code and validation result field to use the bank validation Lightning Component.
If you have set up field mappings correctly, and added the fields to the objects page layout but the data is still not being updated in the lightning component, you may have to refresh the page or close Salesforce and reopen it - this can occur during initial setup of lightning components.
Our Business Insights service can be used to retrieve information about a company such as credit ratings, recommended credit limits, addresses, shareholders, group structure and much more.
The above image shows the Business Insights (company information) Visualforce display which has been added to the page layout of the account entity. It shows the latest credit rating, and recommended credit limit and gives quick access to the company entity containing all retrieved information. Alternatively, this can also be implemented through a Lightning Component as seen below.
To use the Business Insights service within Salesforce, expand the dropdown in the action buttons in the top right corner of the screen and click the "Get Company Information" custom button or click the "Find Business" button on the Lightning Component. This will load the company search page, which can be seen below.
Enter the company name and/or postcode in the search boxes and retrieve a list of matching companies. Select the company you wish to retrieve more information about and click "Select". You will then be redirected to the new Company entity that has been created. A link will automatically have been created to the account you were on when initially clicking the "Get Company Information" button. This link can be removed by clicking the "Remove" button on the Company Information Visualforce page display.
If you have yet to make the move to Lightning, then you may be looking for a solution that will work for you. Although Lightning Components may not be supported, our Visualforce integrations can still be used in the Salesforce classic interface. This includes Business Insights, PredictiveAddress (Custom button) and the real-time validation and address capture integration (record form override).