Setup & Usage

Support DQE
Support DQE
  • Updated

Configuring Custom Site Preferences for the DQE License Code (API Key)

To integrate DQE services into your Salesforce Commerce Cloud (SFCC) environment, configure the DQE License Code (API key) in your site preferences. This step is required. Other configurations are optional.

Configure the DQE License Code

  1. Go to Site > select the desired SFCC site > Site Preferences > Custom Preferences > DQE in Business Manager.
  2. Select the appropriate DQE instance from the dropdown, such as Sandbox/Development, Staging, or Production.
  3. Enter the DQE License Code (API key) provided by your DQE representative in the DQE License Code field.
  4. Click Apply to save the configuration.

Optional Custom Site Preferences

In addition to the License Code, other optional settings can be configured under DQE preferences.

Go to Site > select the desired SFCC site > Site Preferences > Custom Preferences > DQE to access and configure these preferences.

SFCC Business Manager custom preferences menu for DQE site configuration

SFCC Business Manager DQE site preferences screen with license code and validation options

DQE Site Preferences

ID Name Description
dqeLicenceCode DQE License Code DQE License Code (API key). It is required for DQE API authentication and must be provided by the DQE team.
dqeAddressSuggestionsEnabled DQE Address Suggestions Enabled Enables or disables address suggestion functionality on the site.
dqeAddressCompleteEnabled DQE Address Suggestions Complete Enabled Enables or disables the complete address API call for address suggestion functionality on the site.
dqeAddressValidationEnabled DQE Address Validation Enabled Enables or disables address validation functionality on the site.
dqeAddressValidationMode DQE Address Validation Mode

Defines when submitted addresses are validated with DQE.

Possible values: validate_always, validate_on_manual_input, and validate_on_manual_change.

With validate_on_manual_input, the address is validated only if it is fully entered manually without selecting an address suggestion. If an address suggestion was selected, validation does not occur even if the user later modifies the address manually.

With validate_on_manual_change, validation occurs if the user manually changes the address after selecting an address suggestion.
dqeAddressValidationPropositionEnabled DQE Address Validation Proposition Enabled Sets the Proposition parameter to O for the RNVP call. This allows suggestions to be returned when the address is incorrect.
dqeAddressValidationModificationEnabled DQE Address Validation Modification Enabled Sets the Modification parameter to O for the RNVP call. This indicates what has been modified by the RNVP engine to make a postal address valid.
dqePhoneEnabled DQE Phone Enabled Enables or disables phone validation functionality on the site.
dqePhoneResponsePhoneFormat DQE Response Phone Format Defines the DQE response phone format. Check the DQE API documentation for more details.
dqeEmailEnabled DQE Email Enabled Enables or disables email validation functionality on the site.
dqeEmailRectifyEnabled DQE Email Rectify Enabled Proposes domain correction when the entered domain is unknown.
dqeEmailCheckuserEnabled DQE Email Checkuser Enabled Checks the left part of an email address. If set to No, the validation API call is faster, but the left part of the email address is not validated.
dqeCustomMappingUsageIsEnabled DQE Custom Mapping Usage Is Enabled Enables the use of validation mapping rules configured in Business Manager. If set to No, validation uses the rules configured at code level.

Configuring Services in SFCC

After importing the services.xml file from the metadata folder, the DQE services are available in Salesforce Commerce Cloud (SFCC) Business Manager.

View and Configure Services

  1. Go to Administration > Operations > Services in SFCC Business Manager.
  2. In the Services section, services with the dqe.http prefix are listed.
  3. The linked service profiles with the dqe.http prefix are also listed. These profiles define how the system interacts with DQE services.
  4. The linked service credentials with the dqe.http prefix are also listed. These credentials are required to authenticate and authorize requests between SFCC and DQE.

SFCC Business Manager services list showing DQE HTTP services

SFCC Business Manager DQE service profiles and credentials list

Service Profiles

Service profiles are used to configure general connection properties.

Go to Administration > Operations > Services > Profiles.

SFCC Business Manager DQE service profile configuration screen

Configuring Service Credentials for DQE Services in SFCC

Service credentials are used to add or change the URL when needed.

  1. Go to Administration > Operations > Services > Credentials.
  2. In the Credentials list, credentials with the dqe.http prefix should be visible.
  3. Open the required DQE service credentials and configure the URL fields as provided by DQE. You can also add additional query parameters to the URL if necessary.
SFCC Business Manager DQE service credential URL configuration

Business Manager Modules for DQE in SFCC

The bm_dqe cartridge includes extensions and additional modules for Salesforce Commerce Cloud (SFCC) Business Manager. Once the cartridge is set up globally and BM user access is granted, the DQE modules can be accessed and configured through Business Manager.

Access DQE Modules in Business Manager

  1. Go to BM > Merchant Tools > DQE in Business Manager.
  2. Select the appropriate site, as DQE modules and configurations are site-specific.

SFCC Business Manager Merchant Tools menu showing DQE modules

SFCC Business Manager DQE module landing page for a selected site

DQE Links

The DQE Links module provides users with two buttons for easy access to DQE services:

DQE Codes Mappings

The DQE Codes Mapping module allows admin users to set up and manage the mapping of DQE validation response codes to validation results and the corresponding messages displayed to users.

There are three options available at the top of the page for mapping different types of responses:

  • Email DQE Code Mapping
  • Phone DQE Code Mapping
  • Address DQE Code Mapping

Select the appropriate option to display the corresponding mapping.

Available actions:

  • Create new codes.
  • Edit existing codes.
  • Remove codes as needed.

SFCC Business Manager DQE code mapping module with email phone and address mapping options

SFCC Business Manager DQE validation code mapping list

SFCC Business Manager form for creating or editing a DQE validation code mapping

Each DQE code configuration includes the following fields:

  • DQE Code
  • Validation Status
  • Display Message (localizable)

The display message is locale-specific, so make sure to select the correct locale in the Locale field before editing it.

SFCC Business Manager localized display message field for a DQE code mapping

Important note: DQE validation mapping is cacheable. After making changes, invalidate the DQE custom cache. Otherwise, the changes may not be applied immediately on the storefront.

The custom cache is available in BM > Administration > Operations > Custom Caches.

DQE Site Preferences Module

The DQE Site Preferences module provides an alternative method for configuring DQE-related site preferences. This module is useful when a Business Manager (BM) user role does not have access to, or should not have access to, all Site Preferences modules on the site.

Key points:

  • The DQE Site Preferences module allows configuration of custom DQE site preferences as described in the sections above.
  • It provides a way to manage these preferences without accessing the broader Site Preferences module, which is useful when access restrictions are in place for certain users.

This gives users control over how DQE preferences are configured on the site, even when limited access to Site Preferences is granted.

SFCC Business Manager DQE Site Preferences module screen

Related to

Was this article helpful?

0 out of 0 found this helpful