Professional Configuration and Setup

This section will provide step-by-step instructions for creating Display Configurations and configuring batch jobs for Professional Edition. Display Configurations allow an Administrator to configure List View and Related List for displaying and validating phone numbers. Batch jobs allow periodic scheduled jobs to be run to validate phone numbers.

These instructions apply to the Professional Edition of this product. Professional displays validation data in custom Related List and List View Lightning Web Components. To display validation data on standard Salesforce record pages and list views utilize the Enterprise Edition.

Be sure you have completed the Installation And Setup guide before continuing.

NOTE: this solution utilizes Lighting Components, which requires a My Domain to be setup and deployed in your Salesforce instance. To learn more about My Domain, refer to the Salesforce help documentation

Contents

• Create a Display Configuration
• Add Related List to Record Page
• Add List View to an App Page
• Schedule Batch to Update Phone Numbers Via Filters
• Schedule Batch to Update All Phone Numbers
• Schedule Retry Batch Job

Create a Display Configuration

A Display Configuration is used to select the realphonevalidation.com API, the phone numbers to validate, the validation fields that will be displayed, and if the configuration is for a Related List or a List View.

1. Click the app launcher icon
2. Select the Tigerface Systems application
3. Click the Professional tab
4. Click New
5. Enter a value in the Configuration Name text box
6. Select Page Type: Related List or List View
7. Select Account, Contact, or Lead from the Configuration Object picklist
8. Select the Fields to Validate then click Next

8. Select the API Product from the picklist.
   NOTE: you must have access to the API from your realphonevalidation.com account
9. Use the arrow buttons to configure the Select Fields To Display then click Next

10. If this is a List View configuration, you can add a filter. Click Add Filter, then select Field, Operator, and Value, then click Done. Repeat to add additional filters

Note: filters are not supported for Releated List Display Configurations

11. Click Save
12. Repeat steps 3-11 to create additional Display Configurations

Add Related List to Record Page

A Lightning Web Component can be added to the record page in order to view the validation data for that records phone numbers.

1. Click the app launcher icon
2. Select the Sales application
   
3. Click on the tab for the object (Account, Contact, or Lead) which you configured for the Display Configuration in Create Display Configurations. In this example we will click the Contacts tab
   
4. Select the All list view and click a row to open the record's detail page
   
5. Click the gear icon in the upper right of the record page and then click Edit Page
   
6. Drag the Phone Validation Related List component from the components pane onto the page layout. In this example I added a Phone Validation tab to the page layout and dragged the component to it. However, you can drag the component to any area of the page layout
   
7. Select the Display Configuration in the property pane on the right side of the screen
   

Note: if no display configurations appear in the drop down then you will have to create a Display Configuration for a Related List of the correct object type. In this example the object type is Contact

8. Click Save, click Activate, click Assign as Org Default, click Next, click Save, and then click Save in the upper right of the page
9. Click the back button in the upper left to return to the record page
10. You can now select records in the related list and click the Validate button to retrieve validation data associated with the phone numbers
    

Add List View to an App Page

A Lightning Web Component can be added to a page to provide a List View of phone validation data. These steps will provide instructions for applying the List View to a Home page, but it can be added to any Lightning page.

1. Click the app launcher icon
2. Select the Sales application
   
3. Click on the Home tab
   
4. Click the gear icon in the upper right of the record page and then click Edit Page
   
5. Drag the Phone Validation List View component from the components pane onto the page layout
   
6. Select the Display Configuration in the property pane on the right side of the screen

Note: if no display configurations appear in the drop down then you will have to create a Display Configuration for a List View

7. Set the Number of Records property. This defaults to 10
8. Click Save, click Activate, click Assign as Org Default, click Next, click Save, and then in the upper right of the page click Save
9. Click the back button in the upper left to return to the page
10. You can now select records in the list view and click the Validate button to retrieve validation data associated with the phone numbers
    

Schedule Batch to Update Phone Numbers Via Filters

We highly recommended you configure these jobs in a test environment with limited number of records prior to running in production. Misconfiguration with large numbers of records can lead to excessive API calls which will be charged to your realphonevalidation.com account.

This batch job will update all the phone validation data specified by List View Display Configurations which have filters.

At least one List View configuration with a filter should be configured prior to running this batch. List View configurations without filters will not be processed.

1. Go to Apex Classes in setup (you can search for it in the quick find box)
   
2. Click the Schedule Apex button
   
3. In the Apex Class text box, enter PhoneValListViewFilteredBatch
4. Configure the Frequency, Start, End, and Preferring Start Time fields
   
5. Click the Save button
6. Go to Scheduled Jobs in setup (you can search for it in the quick find box) to view or delete the job
   
7. Go to Apex Jobs in setup (you can search for it in the quick find box) to view in process and completed DisplayConfigBatch jobs. These jobs will appear after the PhoneValListViewFilteredBatch job is executed
   

Schedule Batch to Update All Phone Numbers

This batch job will update all phone validation data defined by all Display Configurations that have been configured.

We highly recommended you configure these jobs in a test environment with limited number of records prior to running in production. Misconfiguration with large numbers of records can lead to excessive API calls which will be charged to your realphonevalidation.com account.

Display Configuration filters will be ignored and all records in you Salesforce instance will have their phone numbers validated. This should be tested in a non-production environment with low record volumes to avoid excessive charges to your realphonevalidation.com account.

1. Go to Apex Classes in setup (you can search for it in the quick find box)
   
2. Click the Schedule Apex button
   
3. In the Apex Class text box, enter PhoneValidationBatch
4. Configure the Frequency, Start, End, and Preferring Start Time fields
   
5. Click the Save button
6. Go to Scheduled Jobs in setup (you can search for it in the quick find box) to view or delete the job
   
7. Go to Apex Jobs in setup (you can search for it in the quick find box) to view in process and completed DisplayConfigBatch jobs. These jobs will appear after the PhoneValidationBatch job is executed
   

Schedule Retry Batch Job

An Apex batch job can be configured to retry any phone number whose API called failed on a previous attempt. API call failures can occur due to network or service outages. These records are identified by the API_Call_Failed__c field on the Phone_Validation__c object.

1. Go to Apex Classes in setup (you can search for it in the quick find box)
   
2. Click the Schedule Apex button
   
3. In the Apex Class text box, enter PhoneValBatchRetry
4. Configure the Frequency, Start, End, and Preferring Start Time fields
   
5. Click the Save button
6. Go to Scheduled Jobs in setup (you can search for it in the quick find box) to view or delete the job
   
7. Go to Apex Jobs in setup (you can search for it in the quick find box) to view in process and completed RetryAPIFailedBatch jobs. These jobs will appear after the PhoneValBatchRetry job is executed