Configuring Custom Site Preferences for DQE Licence Code (API Key)
To integrate DQE services into your Salesforce Commerce Cloud (SFCC) environment, you need to configure the DQE Licence Code (API key) in your site preferences. This step is required, while other configurations are optional.
Steps to Configure the DQE Licence Code (API Key):
-
Navigate to Site Preferences:
- Go to Site > (select desired SFCC Site) > Site Preferences > Custom Preferences > DQE in the Business Manager.
-
Select the DQE Instance:
- Choose the appropriate instance from the dropdown (e.g., Sandbox/Development, Staging, or Production).
-
Set the DQE Licence Code:
- Enter the DQE Licence Code (API key) provided by your DQE representative in the DQE Licence Code field.
-
Click Apply:
- After entering the Licence Code, click Apply to save the configuration.
Optional Custom Site Preferences Configurations:
Apart from the Licence Code, there are other optional settings that can be configured under DQE preferences:
- Navigate to Site > (select desired SFCC Site) > Site Preferences > Custom Preferences > DQE to access and configure additional preferences.
DQE Site Preferences:
| id | name | description |
| dqeLicenceCode | DQE Licence Code | DQE Licence Code (API Key). It is required for DQE API authentication and must be provided be DQE team |
| dqeAddressSuggestionsEnabled | DQE Address Suggestions Enabled | Enable/Disable address suggestion functionality on site |
| dqeAddressCompleteEnabled | DQE Address Suggestions Complete Enabled | Enable/Disable complete address API call for address suggestion functionality on site |
| dqeAddressValidationEnabled | DQE Address Validation Enabled | Enable/Disable address validation functionality on site |
| dqeAddressValidationMode | DQE Address Validation Mode |
Address validation mode indicates in what cases submitted address will be validated with DQE. Possible values: “validate_always”, “validate_on_manual_input”, “validate_on_manual_change”.
Difference between “validate_on_manual_input” and “validate_on_manual_change” that: In case of “validate_on_manual_input” address will be validated only if it is fully entered manually without address suggestion selection. And if address suggestion was selected validation will not happen even if user made manual change after suggestion selection.
In case of “validate_on_manual_change” validation would happen if user made manual change after address suggestion selection. |
| dqeAddressValidationPropositionEnabled | DQE Address Validation Proposition Enabled | Set Proposition parameter to "O" for RNVP call. Allows you to have suggestions for addresses in case of a bad address |
| dqeAddressValidationModificationEnabled | DQE Address Validation Modification Enabled | Set Modification parameter to "O" for RNVP call. Allows you to have the indication of what has been modified by the RNVP engine to make a postal address valid. |
| dqePhoneEnabled | DQE Phone Enabled | Enable/Disable phone validation functionality on site |
| dqePhoneResponsePhoneFormat | DQE Response Phone Format | DQE response phone format. Check DQE API doc for more details |
| dqeEmailEnabled | DQE Email Enabled | Enable/Disable email validation functionality on site |
| dqeEmailRectifyEnabled | DQE Email Rectify Enabled | domain correction should be proposed when domain entered is unknown |
| dqeEmailCheckuserEnabled | DQE Email Checkuser Enabled | to check the left part of an email. If set to “No” validation API call works faster but left part of the email is not validated |
| dqeCustomMappingUsageIsEnabled | DQE Custom Mapping Usage Is Enabled | Enable usage of validation mapping rules configured in business manager. If set to 'NO' validation works based on rules setup on code level |
Configuring Services in SFCC
After importing the services.xml file from the metadata folder, you will see the DQE services available in the Salesforce Commerce Cloud (SFCC) Business Manager. Here's how to access and configure them:
Steps to View and Configure Services:
-
Navigate to Services:
- Go to Administration > Operations > Services in the SFCC Business Manager.
-
View the Services:
- In the Services section, you will see the services with the name prefix
dqe.http.
- In the Services section, you will see the services with the name prefix
-
View Linked Service Profiles:
- You will also see the linked service profiles with the name prefix
dqe.http. These profiles are used to define how the system interacts with the DQE services.
- You will also see the linked service profiles with the name prefix
-
View Linked Service Credentials:
- Additionally, the linked service credentials with the name prefix
dqe.httpwill be listed. These credentials are required for authenticating and authorizing requests between SFCC and DQE.
- Additionally, the linked service credentials with the name prefix
Service’s profile used for configuration of general connection properties.
Go to: Administration → Operation → Services → Profiles tab
Configuring Service Credentials for DQE Services in SFCC
Service credentials are used to add or change the URL, if needed.
-
Navigate to Service Credentials:
- Go to Administration > Operations > Services > Credentials tab.
-
View the Credentials:
- In the Credentials list, you should see credentials with the prefix
dqe.http.
- In the Credentials list, you should see credentials with the prefix
-
Modify DQE Service Credentials:
- Open the required DQE service credentials and configure the URL fields as provided by DQE (for example, you can add additional query parameters to the URL if necessary).
Business Manager Modules for DQE in SFCC
The bm_dqe cartridge includes extensions and additional modules for the 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 the Business Manager.
Steps to Access DQE Modules in Business Manager:
-
Navigate to DQE Modules:
- Go to BM > Merchant Tools > DQE in the Business Manager.
-
Select the Correct Site:
- Ensure you select the appropriate site, as DQE modules and configurations are site-specific.
The DQE Links module provides users with two important buttons for easy access to DQE services:
- A button that redirects users to https://new.mydqe.com to track their consumption.
- A button that redirects users to the help center at https://helpcenter.dqe.tech/hc/en-gb.
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 that will be displayed.
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
By selecting the appropriate option, the corresponding mapping will be rendered.
Actions available for managing the codes:
- Create new codes.
- Edit existing codes.
- Remove codes as necessary.
Each DQE code configuration includes next fields:
- DQE Code
- Validation Status
- Display Message (localizable)
Display message is locale specific value so first make sure to select the correct locale in the “Locale” field above it.
Important Note:
DQE Validation mapping is cacheable so after making any changes make sure to invalidate the DQE custom cache. Otherwise, the changes might not be applied immediately on the storefront.
Custom cache can be found in BM > Administration > Operations > Custom Caches
DQE Site Preferences Module
The DQE Site Preferences module offers an alternative method for configuring DQE-related site preferences. This module can be particularly useful if your 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 for configuration of custom DQE site preferences, as described in the relevant sections above.
- It provides a way to manage these preferences without needing to access the broader Site Preferences module, making it ideal for situations where access restrictions are in place for certain users.
This gives you control over how DQE preferences are configured on your site, even when limited access to Site Preferences is granted. Let me know if you need further guidance!
Related to