-
Table of Contents
- Overview
- Install psaAddress
- Configure psaAddress
-
User Guide
- Purpose
- Getting Started
- General Address Construct
- Address Summary
- Address Review
- Suggested Address
- Address Result Errors
- Address Result Warning
- Address Result Approve
- Configuration - Result Code
- Service Modules - Melissa Data - Batch Summary
- Service Modules - Melissa Data - Parameters
- Service Modules - Melissa Data - Response Mapping
- Troubleshooting
- NOTE: Syniti’s Professional Service Accelerators (psa) have been developed and are supported by
- a team of senior consultants. The psas are designed to supplement the Stewardship Tier delivered features with content and automation that accelerate the progress of the project. If you have any questions or encounter any issues while using a psa, please submit a support ticket and be sure to select the psa on the form.
The attached PDF file contains the contents of this article.
Professional Service Accelerators (PSAs) are licensed separately from the SST. For more information, please email NASMT@syniti.com. To download or install a PSA, submit a request to Syniti support.
Overview
psaAddress is designed to assist users in address cleansing. It contains generic tables that can be adapted to any address cleansing solution. It also contains a user interface allowing users to view the changes to the address, approve or unapprove them and make additional changes.
Key Features:
- Relevancy solution included
- Configured for Data Services or Melissa Data
- Generic Tables that can easily adapt to the address cleansing solution of your choice
- Simple user interface for address review, approval and modification
- Final address data exported to be used by downstream waves
Prerequisites
Install PsaPerformanceBench prior to psaAddress installation. Refer to psaPerformanceBench Application Guide for install details.
Install psaAddress
Install the application on Syniti Solutions SST versions 7.0.1 and above.
Download the Application & License
The psaAddress application and/or license are obtained by opening a support ticket at support.syniti.com
Perform the following steps to retrieve the necessary information for a license request:
- On the SST application server, locate the Hardware Identifier program (called “HardwareIdentifier.exe") included in a zip file along with the SST installation software and documentation previously downloaded from Syniti.
- Open the program.
- Click Generate.
- Copy the automatically generated ID and collect the following additional information. All information below pertains to the application server running SST; no information is needed regarding the database server:
- Hardware ID (as mentioned above)
- Windows computer name
- Number of processor cores (as shown in the Task Manager CPU tab)
- Usage of the SST instance, as in, DEV, TEST (or QA) or PROD
Install the License
Perform the following steps to install the license:
- Log in to the SST site as an Administrator.
- Select Admin > Configuration > Product Licenses in the Navigation pane.
- Click the Upload a file icon in the FILE NAME column next to the Upload a New Product License link.
- Locate the license file that was provided by Syniti Licensing.
- Click Open.
- Verify the license is uploaded.
- NOTE: If the Navigation pane does not display all the licensed components as expected,
- use the browser refresh button or the F5 key to refresh the screen. At this point the full vertical menu will appear.
Install the Application
Perform the following steps to install the application:
- Right click on psaAddresss.zip and go to Properties. Ensure to unblock the file if it is blocked.
- Unzip the file.
- Navigate to the SST Installation folder. (e.g. D:\BOA\DSP or C:\Program Files (x86)\BOA\DSP)
- Back up the SST Install\BOA\DSP folder to a compressed zip file.
- Back up all Syniti-supplied SQL Server databases or verify that a complete recent backup already exists.
- NOTE: Supplied databases: AutoGen, cMap, cMap_Data, cMass, cMass_Data, Console, CranPort,
- CranSoft, DataConstructionServer, DataDialysis, DataGarage, DBMoto_Client, DGE, DGE_Data, dgReports, dgSAP, dspAddOn, DSPCommon, dspMonitor_AccPak, dspMonitorConfig, DSW, IGC, Integrate, IntegrateStaging, InterfaceServer, MC, & RADToolkit
- Stop IIS.
This process disconnects all active SST users, so it is highly recommended to perform the install when no users are on the system. This process stops IIS on the web server.
- Open Windows Start Menu.
- Open the Command Prompt (run as an administrator).
- Type: IISReset –stop.
- Press the Enter key.
- Leave the Command Prompt window open for later use.
- Stop all services that start with “Cransoft Service …”
This process stops all SST background jobs, so it is highly recommended to perform the install when no scheduled operations are running on the system.
- Open Windows Start Menu.
- Select Administrative Tools.
- Run Services.
- Right-click the SST service.
- Select Stop.
- Repeat the previous two steps for any additional SST services.
- Copy the Web folder from the zip file to existing SST install\Web folder. If prompted, replace the files in the destination.
- Copy the Databases folder from the zip file to existing SST install\Databases folder. If prompted, replace the files in the destination.
- Note: When copying the Databases\Apps folder do not replace files in that folder.
- Navigate to SST install\Databases and execute file psaAddress_Install.bat (run as an administrator)
- Start all services that start with “Cransoft Service …”
- Open Windows Start Menu.
- Select Administrative Tools.
- Run Services.
- Locate the SST service.
- Right-click the SST service.
- Select Start.
- Repeat the previous two steps for any additional SST services.
- Start IIS.
- Open Windows Start Menu.
- Open the Command Prompt. (run as an administrator).
- Type: IISReset –start.
- Press the Enter key.
Configure psaAddress
psaAddress is pre-configured with default values in the configuration tables, but they will require modification per specific client needs.
If the Navigation pane in SST does not display psaAddress, try these steps:
- Log in to the SST site as an Administrator.
- Select Admin > Configuration > Product License in the Navigation pane.
NOTE: Ensure that psaAddress displays.
- Select Admin > Configuration > Site Menu in the Navigation pane.
NOTE: Ensure that psaAddress displays. If not, then:
- Click Add.
- Enter a priority in the PRIORITY field.
- Enter psaAddress as the label for the site menu option in the LABEL field.
- Select the psaAddress : psaAddress page from the LINK TO PAGE ID list box.
- Select Admin > Configuration > Parameters in the Navigation pane.
- Click Clear Cache.
- Reload the browser tab.
If the psaAddress application still cannot be accessed, review the "Define Security Roles" article in the SST Online Help to ensure the SST user has access to psaAddress. The SST Online Help is accessible from the question mark icon in the top-right corner of all SST pages. Also, open a ticket at support.syniti.com for assistance.
Security Configuration
Prior to users being able to log in and view data in psaHarmonize, security must be configured. psaHarmonize uses the ObjectID to control user access. In order to provision a user access to an ObjectID the following steps must be completed.
- Select Admin > Security > Security Management > Security Roles in the Navigation pane..
- Click the Keys icon for the Security Role group to provision access. (e.g., Migration Developer)
- Click the Keys icon for the ‘psaHarmonize Object Roles’ security definition.
- Add the Objects relevant for that grouping. (e.g., Customer/Vendor/Business Partner)
Transform
Navigate to Transform > Central Wave and map the data to the valid source table (e.g., ttCustomerGeneral). Validate relevancy rules.
- Process Central Wave - Validate that ttBusinessPartner_Relevant is populated.
- Process Address Cleanse Wave - Validate ttGenericAddressInput table is populated.
User Guide
Purpose
The primary goal of psaAddress it to create a single cohesive application that can provide all necessary address cleansing and approval activities.
Getting Started
Request Access to the SST system with access to the psaAddress WebApp.
Log into the SST and navigate to the psaAddress WebApp (Using the site menu).
General Address Construct
Access this page using pathway: Construct Page > General Address Construct
The General Address Construct page allows for manual creation of addresses that do not exist in a legacy system. Users can manually enter new address records and include them in address verification.
Address Summary
Access this page using pathway: Portal > Summary
The Address summary screen displays a summary of all Address data split out by Source. This gives a good overall status of the progress of the address cleansing initiative.
Address Review
Access this page using pathway: Portal > Address Review
The Address Review screen allows a user to view addresses added for cleansing and review the returned information from the address cleansing solution.
Actions Users can take on this page include the following:
Approval – Users can use this checkbox to approve or unapprove an address which will determine if it is included in the output
Include In Next Verification – Users can use this flag to determine if the address will be sent for cleansing in the next process of Addresses. Usually this is only done on an initial run or if Source Data has been changed.
Overwrite Address – Users can choose to overwrite an address and change the address data directly within psaAddress. Change the legacy address data if possible as a recommendation.
Suggested Address
Access this page using pathway: Portal > Suggested Address
The Suggested Address page shows the user the data returned from the Address Cleansing solution for review. Users can review the Verification Results (Codes to determine what was changed, validated or contained an error). Also, there are flags to show address record Errors or Warnings.
Address Result Errors
Access this page using pathway: Portal> Address Result Errors
The Address Result Errors page shows only address records that returned with an error. These need to be reviewed by the business and corrected in order to get a correct result from the Address Cleansing solution.
Address Result Warning
Access this page using pathway: Portal > Address Result Warning
The Address Result Warning page shows only address records that returned with a warning. The business needs review and determine if a correction needs to be made.
-
Address Result Approve
Access this page using pathway: Portal > Address Result Approve
The Address Result Approve page shows only address records that returned without an Error or Warning flag. These records go into an approval state that is automatically set. These addresses should still be reviewed for accuracy.
Result Code
Access this page using pathway: Configuration > Result Code
The Result Code page determines the code returned from the Address Cleansing solution that makes an Error or Warning for an Address by checking off the checkbox. This determines how the Address will be handled within psaAddress.
Melissa Address Batch
Access this page using pathway: Service Modules > Melissa Address > Batch
The Melissa Address Batch page displays the records that you have sent to Melissa Data for Address cleansing. Batches are sent in 100 record batches. There is a Resend button available on this screen in case of a failure. This will re-send the addresses to Melissa Data for cleansing.
-
Melissa Address Parameter
Access this page using pathway: Service Modules > Melissa Address > Parameter
The Melissa Data Parameter page allows for configuration of the Melissa Data plugin parameters.
URL – Specifies the URL that the plugin uses to call Melissa Data to fetch results.
CustomerID – The Melissa Data License Key that needs to be provided with each call.
Options – Determine how the results are returned (Defaulted to LineSeparator: TAB)
Address Source – The Source file from which the data will be sent to Melissa Data.
Melissa Address Response Mapping
-
Access this page using pathway: Service Modules > Melissa Address > Response Mapping
The Melissa Data Response Mapping page allows for configuring which fields the Responses are mapped to. Also, it allows for Manual SQL expressions to manipulate the data prior to mapping.
Troubleshooting
Troubleshooting Guide for troubleshooting the psaHarmonization WebApp.
Site Menu missing psaAddress link
If the psaAddress application is not visible in the site menu, request access to the psaHarmonization WebApp to be able to view the application. Access can be granted at a user level, configurator or administration level.
License is expired
Open a ticket with BackOffice Associates to request a new license key. Once the new license key is applied the application will be available again.
Updated on September 1st, 2021