Clean Suite for CRM: Salesforce Quickstart

Introduction

Clean Suite for CRM: Salesforce connects your Salesforce org to Melissa Data web services. The package cleans, verifies, and enriches contact and company data in real time or through scheduled batch jobs.

What Clean Suite Does

Clean Suite processes records from standard objects like Contact, Lead, and Account. It also processes custom objects.

The package provides eight core data quality services:

• Global Address Verification: Validates and standardizes addresses in more than 240 countries and territories.

• Global Email Verification: Validates an email address and checks whether it can receive mail.

• Global Phone Verification: Validates a phone number with a live check. It returns line type and phone status data.

• Personator Consumer: Validates a domestic address, phone, name, and email. It also appends demographic data.

• SmartMover (NCOA & CCOA): Applies official NCOA and CCOA change-of-address data for the United States and Canada.

• Global Express Entry: Suggests validated addresses while a user types.

• BusinessCoder US: Validates a domestic business, its address, email, and phone. It also appends firmographic data.

• Property: Validates a United States property and appends property and mortgage data.

Application Architecture

Clean Suite runs as an installed managed package under the MDPERSONATOR namespace.

The package operates through three primary mechanisms:

1. Lightning Components & Quick Actions: Users trigger single-record validation directly from record detail pages.

2. Batch Processing Framework: Admins process thousands of records asynchronously through Batch Apex jobs.

3. Custom Field Mappings: JSON mappings dictate which Salesforce fields map to Melissa API inputs and outputs.

Package Flow

This flow shows how the package processes Salesforce records.

Diagram flow

1. Salesforce records → Clean Suite managed package

2. Clean Suite managed package → Custom Field Mappings

3. Custom Field Mappings → Lightning Components and Quick Actions

4. Custom Field Mappings → Batch Processing Framework

5. Lightning Components and Quick Actions → Melissa Data web services

6. Batch Processing Framework → Melissa Data web services

System Requirements

To use Clean Suite, your Salesforce org must meet these requirements:

• Salesforce Edition: Enterprise, Unlimited, Performance, or Developer Edition.

• User Permissions: System Administrator access for initial setup, or assigned Clean Suite Permission Sets for standard users.

• Melissa Customer ID: Active Melissa license key with entitled services.

• Remote Site Settings: Authorized callout URLs for https://address.melissadata.net and https://expressentry.melissadata.net.

Installation

Follow these steps to install and set up Clean Suite in your Salesforce org.

Installation Sequence

This sequence shows the setup order.

Diagram flow

1. Install the managed package → Verify callout configuration

2. Verify callout configuration → Assign permission sets

3. Assign permission sets → Enter the Melissa license key

4. Enter the Melissa license key → Create result fields and relationships

5. Create result fields and relationships → Configure an advanced mapping

6. Configure an advanced mapping → Verify the installation

Step 1 — Install the Managed Package

1. Log in to Salesforce as a System Administrator.

2. Open the AppExchange listing for Clean Suite for CRM: Salesforce.

3. Click Get It Now.

4. Wait for the Where do you want to install this package window.

5. Select the destination for your org.

   

   Select the button that matches your installation destination.

6. Confirm the values in Confirm Install Details.

7. Select the terms and conditions checkbox.

   

   Confirm the package details before you continue.

8. Log in to the destination account.

   

   For a sandbox, append the sandbox name to the username.

9. Select Install for All Users.

   

   Select the users who need access to Clean Suite.

10. Click Install.

11. Wait for Salesforce to complete the installation.

Step 2 — Verify Callout Configuration

Clean Suite calls a Named Credential. Salesforce resolves it to the Melissa host.

The managed package installs its own callout configuration. It supplies Named Credentials for each service. It also supplies Remote Site Settings for each Melissa host.

Do not create these entries by hand. Verify them after installation.

1. Go to Setup → Security → Named Credentials.

2. Confirm that these Named Credential names are present:

Named Credential name
MelissaData_API
MelissaData_BusinessCoder_API
MelissaData_ExpressEntryDEV_API
MelissaData_ExpressEntry_API
MelissaData_GlobalAddress_API
MelissaData_GlobalEmail_API
MelissaData_GlobalPhone_API
MelissaData_Personator_API
MelissaData_Property_API
MelissaData_SmartMover_API
MelissaData_SmartMoverCanada_API
MelissaData_Token_API
MelissaData_TokenService_API

3. Go to Setup → Security → Remote Site Settings.

4. Confirm that the Melissa entries are present and active.

The package includes Remote Site Settings for these hosts:

Host	Service
address.melissadata.net	Global Address Validation
globalemail.melissadata.net	Global Email
globalphone.melissadata.net	Global Phone
globalname.melissadata.net	Name parsing
personator.melissadata.net	Personator Consumer
property.melissadata.net	Property
businesscoder.melissadata.net	BusinessCoder US
smartmover.melissadata.net	SmartMover US
smartmovercanada.melissadata.net	SmartMover Canada
expressentry.melissadata.net	Global Express Entry
token.melissadata.net	Token service
tokenservice.melissadata.net	Token service
creditservice.melissadata.net	Credit balance

If a callout fails after installation, confirm that the entry for that host is present and active.

Step 3 — Assign Permission Sets

Clean Suite provides three standard permission sets:

• Melissa_Global_Intelligence_Permission_Set: Grants access to execute single-record lookups and batch jobs.

• SmartMoverAccess: Grants specific permissions required to configure and run SmartMover NCOA batch jobs.

• Melissa_Global_Intelligence_Permission_Set_NonAdmin: Grants basic access to standard users who run component lookups without admin setup rights.

Follow these steps to assign a permission set:

1. Go to Setup → Administration → Users → Permission Sets.

2. Click Melissa_Global_Intelligence_Permission_Set.

3. Click Manage Assignments.

4. Click Add Assignments.

5. Select the users who need access.

6. Click Assign.

Step 4 — Enter Your Melissa License Key

1. Search for Clean Suite in the App Launcher.

   

   Open the Clean Suite app from the App Launcher.

2. Open the Listware/Clean Suite Administration tab.

3. Open the Account/License tab.

4. Enter the license string that Melissa supplied.

5. Click Save Settings.

6. Open each service tab that you use.

7. Configure the service options for your business need.

Step 5 — Create Result Fields and Relationships

Clean Suite writes each service response to a Clean Suite Result Record. Create a lookup field so that the source record can reference that result record.

Create a text field for the result codes that your mapping stores.

1. Open Setup.

2. Open Object Manager.

3. Select the target object.

4. Open Fields & Relationships.

5. Click New.

6. Select Lookup Relationship.

7. Click Next.

8. Select the Clean Suite result object in the Related To list.

   

   The example selects Clean Suite Personator Result.

9. Click Next.

10. Enter a Field Label.

11. Enter a Field Name.

Use a name that identifies the service.

12. Set the security settings that your org requires.

13. Click Next.

Grant access to the profiles that run Clean Suite.

14. Set the page layouts.

15. Click Next.

Select the layouts that must show the lookup field.

16. Set the related lists.

17. Click Save.

18. Click New in Fields & Relationships.

19. Select Text.

20. Click Next.

21. Set the field length to 255.

A 255-character text field holds a comma-delimited result-code string.

For the full lookup-relationship procedure, see Lightning Lookups.

Step 6 — Configure an Advanced Mapping

A mapping identifies the fields that Clean Suite sends to a service. It also identifies the fields that receive the service response.

The input column sends data to the service. The output column receives the response.

Follow these steps to create a mapping.

1. Open the Clean Suite Advanced Mappings tab.

2. Enter the object name under SELECT OBJECT TYPE.

3. Select the object.

   

   Standard objects and custom objects are supported.

4. Select the Clean Suite service under ADD NEW MAPPING.

5. Enter a mapping name.

   

   For example, use Mailing Address Verification.

6. Select the input fields.

   

   Select only the fields that match the service input.

7. Select the output fields.

8. Select the lookup field.

9. Select the result-code field.

   

   The lookup field stores a link to the complete service response.

10. Click Save All.

For the full mapping reference, see Clean Suite Advanced Mappings.

Step 7 — Configure Mappings for Components

Every Clean Suite component reads a saved mapping. Configure the mapping for the object before you add a component.

1. Open the Clean Suite Advanced Mappings tab.

2. Enter the object name under Object Type.

3. Select the object.

   

   The Object Type search lists the standard and custom objects that match.

4. Click the button for the service that you need.

5. Enter a mapping name.

6. Click Save.

   

   The New Mapping dialog accepts a name, such as Personator - Other Address.

7. Select the input fields.

8. Select the output fields.

   

   The output column includes Personator Lookup Field and Personator Result Codes.

Step 8 — Lightning Quick Actions

Quick Actions allow users to run single-record verification with one click from record pages.

Creating Quick Actions

Complete the service setup, license setup, and Custom Mapping setup before you add an action.

1. In Setup, open Object Manager and select the target object.

2. Open Buttons, Links, and Actions, then select New Action.

   

   The action list header shows the New Action button.

3. Set the action type to Lightning Component. Select the required Clean Suite Lightning Component. For a reference of all available components and their names, see Lightning Quick Actions.

4. Enter an action label that identifies the service, then save the action.

5. Open Page Layouts. Select each layout that must show the action.

   

   The page layout list shows each layout that is defined for the object.

6. In the layout, open Mobile & Lightning Actions. Drag the new action into Salesforce Mobile and Lightning Experience Actions.

   

   The layout editor shows the new action in the Salesforce Mobile and Lightning Experience Actions section.

7. Save the page layout.

8. Open a record of that object and confirm that the action is available.

9. Test the action with a user who has the required permissions and a record that has mapped input data.

Repeat these steps for each record type and page layout that needs the service.

Step 9 — Global Express Entry Components

Express Entry provides real-time address autocomplete while users type.

LWC Component: globalEEFreeForm

Use globalEEFreeForm in Screen Flows. The component metadata exposes the lightning__FlowScreen target only. You cannot add this component to a Lightning App Builder page.

• Supports single-field address search.

• Populates street address, city, state, postal code, country, and Melissa Address Key (MAK).

• Includes field locking and modification change flags.

Aura Component: LX_ExpressEntry_Flow

Use LX_ExpressEntry_Flow for legacy Flow implementations.

Accepts input field defaults for street, city, state, postalCode, and country. Returns selected address outputs back to Flow variables.

Step 10 — Visualforce Page Overrides

Clean Suite includes Visualforce pages to override standard Edit pages for Account, Contact, and Lead.

• MD_expressAccountEdit: Overrides Account detail edit view.

• MD_expressContactEdit: Overrides Contact detail edit view. This page is not available for mobile.

• MD_expressContactMobileView: Overrides the Contact view for the mobile form factor.

• MD_expressEntryLead: Overrides Lead New and Edit views. Use this page for a new Lead override.

• MD_expressLeadEdit: Legacy Lead edit page. Keep this page only when an existing override requires it.

Configure the mobile form factor separately. See Visualforce Pages for the full override matrix.

Setting Up a Page Override

1. Open Setup.

2. Open Object Manager.

3. Select Account.

4. Open Buttons, Links, and Actions.

5. Click Edit next to the Edit or New action.

6. Select Visualforce Page.

7. Select MD_expressAccountEdit.

8. Click Save.

Step 11 — Result Code Status Indicator

The Result Code Status Indicator component shows one configurable message panel on a record page. It reads one field and compares the value with up to three regular expressions.

Each panel shows a title, a message, and the color for the matched expression.

The component does not interpret result codes by itself. The shipped default expressions are address-oriented examples only.

For the configuration procedure, see Result Code Status Indicator.

Step 12 — Verify Installation

1. Open the object where the mapping was created.

2. Open the Setup menu.

3. Click Edit Page.

4. Drag the quick action that you created in the previous step onto the page layout.

5. Click Save.

6. Click Activate.

7. Return to the record.

8. Click the quick action that you added in the object.

9. Confirm that the fields mapped in the output populate the fields that they were mapped to.