CCH® SureAddress™ for SalesForce Commerce Cloud SFRA User Guide
Updated: August 13, 2024
Summary
The CCH® SureAddress™ cartridge for Salesforce Commerce Cloud provides a quick integration for real-time address verification for USA and CAN addresses.
This guide is for Storefront Reference Architecture (SFRA). You must follow all directions in CCH SureAddress Integration Guide documentation before following steps in this guide (note: skip SiteGenesis specific steps).
Component Overview
Functional Overview
Refer to CCH SureAddress Integration Guide
Use Cases
Refer to CCH SureAddress Integration Guide
Compatibility
Refer to CCH SureAddress Integration Guide
Privacy
Refer to CCH SureAddress Integration Guide
Setup and Implementation
Setup
Refer to CCH SureAddress Integration Guide
Important: Follow all steps in above guide, as int_sureaddress and metadata are pre-requisites for SFRA
- Import the "int_sureaddress_sfra" cartridge into the Salesforce Commerce Cloud UX Studio Workspace (Eclipse):
- Open UX Studio (Eclipse).
- If not already connected, create a Digital Connection to your Sandbox (or the environment you want to upload code to).
- Click File > Import > General > Existing Projects Into Workspace.
- Browse to the directory where you saved the "int_sureaddress_sfra" cartridge.
- Click Finish.
- Click OK when prompted to link the cartridge to the sandbox and upload.
- (Skip for SiteGenesis) Repeat the above process for the RefArch project (you can import from its root directory), which will be customized later in the custom code section. This will add app_storefront_base.
Configuration
Refer to CCH SureAddress Integration Guide
Important: Follow all steps in above guide, as int_sureaddress and metadata are pre-requisites for SFRA
- Add "int_sureaddress_sfra" to the effective cartridge path:
- Log in to the Salesforce Commerce Cloud Business Manager.
- Select Administration > Sites > Manage Sites.
- Select the desired site.
- Select the Settings tab.
- Add int_sureaddress_sfra: to the start of the Cartridges field (left of app_storefront_base).
- Click Apply.
Custom Code for SFRA
This cartridge (int_sureaddress_sfra) uses int_sureaddress, and override their corresponding templates in SFRA’s app_storefront_base. You can use this cartridge ‘as-is’, but if you need to integrate into your custom cartridge, please see the below.
The following 2 files are updated versions of their respective files in app_storefront_base:
- int_sureaddress_sfra/cartridge/templates/default/account/addressForm.xml
- int_sureaddress_sfra/cartridge/templates/default/checkout/checkout.xml
Custom code (see lines for “isif condition…”) for addressForm.isml added below submit button (see bolded code below):
** Start Code **
<div class="col-6">
<a href="${URLUtils.url('Address-List')}" class="btn btn-block btn-outline-primary">${Resource.msg('button.cancel','account',null)}
<div class="col-6">
<button type="submit" name="save" class="btn btn-save btn-block btn-primary">${Resource.msg('button.save','account',null)}
<isif condition="${dw.system.Site.current.getCustomPreferenceValue('SAEnable')}">
<isinclude template="sureaddress/saValidateAddress" />
** End Code **
Custom code (see lines for “isif condition…”) for checkout.isml added below the
** Start Code **
<div class="col-12 next-step-button">
<button class="btn btn-primary btn-block submit-shipping" type="submit" name="submit" value="submit-shipping"
<isif condition="${pdict.order.usingMultiShipping && !pdict.order.shippable}">disabled>
${Resource.msg('button.next.payment', 'checkout', null)}
<button class="btn btn-primary btn-block submit-payment" type="submit" name="submit" value="submit-payment">
${Resource.msg('button.next.place.order', 'checkout', null)}
<button class="btn btn-primary btn-block place-order" data-action="${URLUtils.url('CheckoutServices-PlaceOrder')}"
type="submit" name="submit" value="place-order">${Resource.msg('button.place.order', 'checkout', null)}
<isif condition="${dw.system.Site.current.getCustomPreferenceValue('SAEnable')}">
<isinclude template="sureaddress/saValidateAddress" />
** End Code **
External Interfaces
Refer to CCH SureAddress Integration Guide
Operations and Maintenance
Data Storage
Refer to CCH SureAddress Integration Guide
Availability
Refer to CCH SureAddress Integration Guide
User Guide
Business Manager
Refer to CCH SureAddress Integration Guide
CCH SureAddress Site Preferences
Refer to CCH SureAddress Integration Guide
Known Issues and Limitations
Refer to CCH SureAddress Integration Guide
Release History
Refer to CCH SureAddress Integration Guide
Version support and tested against
- SFRA version 6.0.0
- Compatibility Mode version 21.5