CCH® SureAddress™ for D365 Finance & Operations User Guide

Updated: June 18, 2024

Installing CCH SureAddress

Overview

CCH SureAddress for Microsoft Dynamics 365 for Finance and Operations is a plug-in that integrates CCH SureAddress solution with Microsoft Dynamics 365 for Finance and Operations. With CCH SureAddress for Microsoft Dynamics 365 for Finance and Operations, you can validate addresses in the following ways:

  • Explicit Address Validation. You can explicitly request address validation for a given address record by clicking the Validate Address button.
  • Automatic Address Validation. When automatic address validation is enabled, addresses will be automatically validated whenever an address record is saved.
  • Batch Address Validation. The batch address validation form allows you to validate multiple addresses at the same time.

How It Works

When address validation is requested in Dynamics 365 for Finance and Operations, the plug-in sends the address information from Dynamics 365 for Finance and Operations to SureAddress API Web Service. The SureAddress API Web Service is used to validate the address. The validated address is sent back to the plug-in through the SureAddress API Web Service, and the plug-in presents the updated address in the Dynamics 365 for Finance and Operations user interface.

There are four steps to installing and setting up CCH SureAddress for Dynamics 365 for Finance and Operations:

  1. Import the Model Files
  2. Importing Licenses
  3. Building Models and Synchronizing the Database
  4. Create a Deployment Package
  5. Deploy and Apply the Package

Importing the Model File

To import the CCHSureAddress for Dynamics 365 for Finance and Operations model file, do the following:

  1. Get the CCH SureAddress for Dynamics365 ZIP file from CCH.
  2. On the VM/machine, open the folder where the latest CCH SureAddress for Dynamics365 zip package exists.
  3. Unzip the model file on your machine.
  4. Open Command Prompt in Administrator mode and execute the following commands (in this order):
    • Note: If you install a model on a development environment that contains customization to that model (in a higher layer), you may need to resolve code or metadata conflicts using Visual Studio. 
      cd "[path of the metadata store where model should be imported]\Bin"

ModelUtil.exe -import -metadatastorepath="[path of the metadata store where model should be imported]" -file="[path where model files are unzipped]\CCH\_SureAddress-CCH Inc..axmodel"

Importing Licenses

  1. Get the license file from CCH based on the serial number of AX installed in your development environment. Create a Licenses directory at a location where you want to copy the license files (for example, C:\License). Copy the licenses to the Licenses directory.
  2. Run the following command to turn on maintenance mode. You should turn on maintenance mode before you import the license files and turn it off after the import is complete.
    • Microsoft.Dynamics.AX.Deployment.Setup.exe --metadatadir " [path of the metadata store]" --bindir "[path of the metadata store]" --sqlserver . --sqldatabase [databasename] --sqluser [User with sysadmin privileges] --sqlpwd [userpwd] --setupmode maintenancemode --isinmaintenancemode true
  3. Restart the AOS.
  4. For Address Validation license execute the following on command prompt.
    • cd "[path of the metadata store]\bin"
    • Microsoft.Dynamics.AX.Deployment.Setup.exe --setupmode importlicensefile --metadatadir "[path of the metadata store]" --bindir "[path of the metadata store]" --sqlserver . --sqldatabase [databasename] --sqluser [User with sysadmin privileges] --sqlpwd [userpwd] --licensefilename "[location of License directory][Companyname]_ [SureAddressAVlicense].txt"
  5. After the license are imported, log in to Microsoft Dynamics and go to System administration > Setup > License configuration.
  6. Verify all CCH licenses are present and checked.
  7. Run the following command to turn off maintenance mode once the license files are imported.
    • Microsoft.Dynamics.AX.Deployment.Setup.exe --metadatadir " [path of the metadata store]" --bindir "[path of the metadata store]" --sqlserver . --sqldatabase [databasename] --sqluser [User with sysadmin privileges] --sqlpwd [userpwd] -- setupmode maintenancemode --isinmaintenancemode false
  8. Restart the AOS.

Building Models and Synchronizing the Database

  1. Open Visual Studio.
  2. Click Dynamics AX > Model Management > Refresh models.
  3. Click Dynamics AX > Build Models. The Full Build dialog displays.
  4. Select the first check box (Select all) on the packages tab.
  5. Select the Options tab and select following:
    • Build Pre-Compiled Form
    • Build Reports
    • Synchronize Database
    • Build cross reference data
  6. Click Build and synchronize the database. This can take more than an hour to complete.
  7. Once the build is complete, restart IIS and SQL server.

Creating the Deployment Package Using Visual Studio

  1. In Visual Studio, select Dynamics AX > Deploy > Create Deployment Package.
  2. Select the following packages:
    • CCHSureAddress
    • Directory
  3. Provide the package file location in the dialog box.
  4. Click Create to generate the package. Get the license file from CCH based on the serial number of AX installed in your production environment. Unzip the package. Add license files to unzipped package under the AOSService\Scripts\License folder.
  5. Zip the package again, now with the license files.

Deploying and Applying the Package to Lifecycle Services

  1. Log in to lcs.dynamics.com.
  2. Select the Shared Asset library and do the following:
    • Select the Software deployable package asset type.
    • Click the plus sign (+) to upload the package.
    • Enter the name and description of the package you are uploading.
    • Select the uploaded package.
    • Click Publish.
  3. Click the project in Life Cycle Service where the package needs to be installed.
  4. Click Asset Library. You may need to scroll to the right for this option to be visible.
  5. In the Asset library, click Import to import the package.
  6. Return to the project's home screen and select the virtual machine environment.
  7. Verify the virtual machine is running.
  8. Click Maintain, and then click Apply updates. A window displays, showing the eleven steps of deployment.

Configuring SureAddress

To configure your CCH SureAddress for Dynamics 365 for Finance and Operations settings, do the following:

  1. Do one of the following:
    • Go to Workspaces > CCH SureAddress Workspace, and then click CCH SureAddress Address Validation Setup.
    • Go to Modules > Common > CCH SureAddress tab > CCH SureAddress Address Validation Setup.
  2. Select General on the left side of the dialog.
  3. Enter the CCH SureAddress Validation URL, Client Number, and Validation Key.
  4. Select Address validation settings on the left side of the dialog.
  5. Set Enable automatic address validation to Yes if you want addresses to be validated any time an address record is saved.
  6. Set Automatically Accept Address to Yes if you want addresses to be saved immediately after OK is clicked.
  7. Select the Select country/region to validate tab, and then specify the country or region for which CCH SureAddress should validate addresses. To add a new line for adding another country, click Alt+N
  8. Select the Address keywords to skip tab, and then specify keywords in street address lines that should be ignored during address validation. Example: Ordinarily, a line that starts with "ATTN:" or "C/O" will cause address validation to fail. If you enter these keywords in the Address keywords to skip tab, those lines will be ignored during validation.
  9. Click Save.
  10. Click Import Address Types Description menu to display the address type description in the address form.

Access Levels

CCH SureAddress provides two levels of access: one for Basic Users and one for Power Users.

Power Users have full access to all address validation functionality and plug-in forms, including the following forms:

  • Address Validation Settings
  • Batch Address Validation
  • Individual Address Validation

Basic users have the following access:

  • View Only access to the Address Validation Settings form
  • Full access to the following address validation functionality and plug-in forms:
    • Batch Address Validation
    • Individual Address Validation

Validating Addresses

Validating Individual Addresses

To validate an individual address in Dynamics 365 for Finance and Operations, do the following:

  1. Enter an address on the Microsoft Dynamics 365 for Finance and Operations address form.
  2. Click Validate Address.
  3. Select the correct address and click OK.
  4. Click Save. The validated address is saved.

Batch Validating Addresses

To batch validate multiple addresses, do the following:

  1. Do one of the following:
    • Go to Workspaces > CCH SureAddress Workspace, and then click CCH SureAddress Batch address validation.
    • Go to Modules > Common > CCH SureAddress tab > CCH SureAddress Batch Address Validation.
  2. Click CCH SureAddress Batch address validation.
  3. Select the addresses you want to validate. You can also select the General tab at the top of the form and click Select All.
  4. Select Validate.
  5. Select the General tab and click Validate all modules. The selected addresses are validated for all modules.