spectrum technologyplatform -...

Spectrum™ Technology PlatformVersion 11.0

Installation GuideWindows

1 - Planning Your Installation

Installation Scenarios 5System Requirements 9

2 - Standard Installation

Installing a New Server 20Upgrading a Server 21Installing a License Key 22Installing the Server with a Silent Installer 23Adding Modules 23Removing the Server 24

3 - Cluster

Clustered Architecture 27Requirements 31Installing a Cluster 31Installing a Cluster for the Data Hub Module 36Installing a Cluster for the Location Intelligence

Module 37Upgrading a Cluster 47Upgrading with Clustering for the Data Hub

Module 49Upgrading with Clustering for the Location

Intelligence Module 51Removing a Node from a Cluster 53Adding Modules to a Cluster 53Starting a Cluster 54Shutting Down a Cluster 55Using Enterprise Designer with a Cluster 55

4 - Cluster with SeparatedConfiguration Database

Installing a Cluster with a Separated ConfigurationDatabase 57

Upgrading a Cluster with a SeparatedDatabase 59

Converting to a Separated ConfigurationDatabase 62

Converting from a Separated ConfigurationDatabase to a Standard Installation 65

5 - Spectrum Databases

Installing the Address Now Module Database 67Installing the Advanced Matching Module

Database 67Installing Data Normalization Module

Databases 68Installing Enterprise Geocoding Module

Databases 70Installing Enterprise Routing Module Databases 73Installing Enterprise Tax Module Databases 73Installing Global Geocoding Module Databases 77Installing the Global Sentry Module Database 80Installing Location Intelligence Module

Databases 82Installing Universal Addressing Module

Databases 82Installing Universal Name Module Databases 84Using the Database Silent Installer 86

Table of Contents

6 - Client Tools

Installing the Client Tools 88Installing Enterprise Designer with a Silent

Installer 89Upgrading Enterprise Designer 90Removing Enterprise Designer 90

7 - Client API

Installing the Client API 92Removing the Client API 92

8 - SAP, Siebel, and MicrosoftDynamics

Configuring SAP 94Configuring Siebel 106Configuring Microsoft Dynamics CRM 151

9 - Support

Technical Support 156Documentation 156Digital Insights 156

3Spectrum™ Technology Platform 11.0 Installation Guide

1 - Planning YourInstallation

In this section

Installation Scenarios 5System Requirements 9

Installation Scenarios

Spectrum™ Technology Platform supports a variety of installation scenarios that scale to fit theneeds of your organization.

Standard

The standard scenario is the simplest installation scenario. You install Spectrum™ TechnologyPlatform on a single server. All activity is handled by this one server, including designing dataflows,storage of configuration information, running jobs, and handling service requests.

Remote Servers

Remote servers are useful if you have licensed many modules. To use remote servers, you installSpectrum™ Technology Platform on several different servers, installing different modules on eachserver. You then configure the individual services to execute on one of the remote servers. Thisapproach has the following advantages:

• Improved performance, especially for web service and API calls. For jobs, there may be someperformance improvement, but the time it takes to send data across the network to the remoteserver may offset any performance gains.

• Ability to perform database updates on individual modules without interrupting the availability ofother modules. For example, if you need to update a postal database for the Universal AddressingModule, you could install the update by stopping just the remote server handling the UniversalAddressing Module, allowing other modules to remain available on other remote servers.


Planning Your Installation

• Startup time can be reduced. With all modules on one server, it can take a long time for the serverto start up. With modules installed on separate servers, each server will start up more quickly.

Cluster

In a clustered environment, processing is shared among two or more instances of the server. Allcommunication with Spectrum™ Technology Platform goes through a load balancer. Instead ofusing the URL and port of the Spectrum™ Technology Platform server, you use the URL and portof the load balancer. Consider using this approach if you require failover redundancy and high-volume,high-performance processing.

The following diagram illustrates this architecture:



This approach has the following advantages:

• Processing is automatically distributed among the nodes in the cluster for optimal performance.• Configuration settings are automatically synchronized across nodes.• Uptime can be improved since if a node goes down the other nodes remain available to handleprocessing requests.

• Adding a new node is easy.

Cluster with Separate Configuration Database

When you install the Spectrum™ Technology Platform server you are installing two things: serversoftware and a configuration database. The server handles the execution of jobs and servicerequests, reporting, and logging. The configuration database stores data such as users and roles,data connections, dataflows, and the audit log.

For clusters consisting of only a few nodes, installing the server and configuration database togetheron the same server provides acceptable performance. However, a cluster that consists of a largenumber of nodes may have its performance negatively affected by having a copy of the configurationdatabase on each node. This is because an increasing number of nodes results in increased datareplication between nodes during synchronization. Performancemay also suffer if users are accessingthe configuration database frequently through activities such as editing dataflows or job schedules.These activities require processing power, resulting in less CPU capacity available for running jobsand responding to service requests.

If you have an implementation with four or more nodes, you should consider installing theconfiguration database to separate servers. This is the most scalable installation scenario becauseyou can add nodes without necessarily adding another instance of the configuration database. Forexample, say you have five nodes and three configuration database servers. You could add anotherfive nodes, bringing the total number of nodes to 10, while still using just the three configurationdatabases to support all 10 nodes.

Installing the configuration database to a separate server has the following advantages:



• More CPU is available to the server for running jobs, process flows, and service requests becausereading and writing to the configuration database is handled by a separate server.

• Reduced network traffic due to reduced configuration data replicated between nodes. For example,you could have five Spectrum™ Technology Platform servers for handling execution while havingonly three repositories. With just three repositories instead of five, data only needs to replicatebetween three servers rather than five.

• Most scalable installation scenario.



System Requirements

Server

Operating Systems

NotesOperating System

NoneWindows Server 2008 R2

The Enterprise Tax Module is not supported on R2.Windows Server 2012Windows Server 2012 R2

A 64-bit operating system is required. 32-bit operating systems are not supported.Note:

Disk Space

UpgradeNew Installation

• Free disk space equal to three times the size of yourcurrent installation. To determine the size of your current

• 3 GB to install all modules, less if installing fewer modules.• 7 GB to 8 GB of temp space for the installation to extractthe files it needs, but you may need more depending on installation, look at the size of the folder where you

installed Spectrum™ Technology Platform.the options you are installing. If necessary, modify yourTEMP environment variable (Windows) or IATEMPDIR • If you are adding modules as part of your upgrade, you

will need 3 GB to install all modules, less if installing fewermodules.

environment variable (Unix and Linux) to point to alocation with enough space.

• 7 GB to 8 GB of temp space for the installation to extractthe files it needs, but you may need more depending onthe options you are installing. If necessary, modify yourTEMP environment variable (Windows) or IATEMPDIRenvironment variable (Unix and Linux) to point to alocation with enough space.

If you are installing a module that uses a reference database, such as a postal database,geocoding database, or data normalization tables, you will need space for this data. The

Note:



total disk space varies, depending on what modules(s) and what database(s) you areinstalling.

Memory

• Basic memory requirement: 8 GB• The Enterprise Geocoding Module requires an additional 500 MB memory for the first non-U.S.geocoder, and 250 MB for each additional non-U.S. geocoder, with these exceptions:

• Germany, Australia, and the U.K. each require 1 GB additional memory• Japan requires 2 GB additional memory

You may distribute processing among multiple servers which may allow you to take advantage ofexisting hardware instead of adding memory to a single Spectrum™ Technology Platform server.This is referred to as remote server processing. For information on remote servers, see theSpectrum™ Technology Platform Installation Guide.

• The Location IntelligenceModule requires an additional 2 GBRAM to support its remote component.• The Data Normalization Module and Universal Name Module require additional memory if youuse the following name databases:

• Arabic Plus Pack: 5.5 GB• Asian Plus Pack - Chinese: 32 MB• Asian Plus Pack - Japanese: 1.6 GB• Asian Plus Pack - Korean: 8 MB• Core Names: 1.1 GB

Additional Requirements

• Windows administrator rights are required to install Spectrum™ Technology Platform• In order to use the enhanced system tray notification application the server must have .NETFramework 3.5 SP1 (also known as 3.5.1) or higher. Windows Server 2008 comes with a limitedversion of .NET Framework 3.5. You need install the full .NET Framework 3.5.1 on WindowsServer 2008. Windows Server 2012 and 2012 R2 come with the required version of .NETFramework.

Default Network Ports

The Spectrum™ Technology Platform server uses several network ports for communication. Networkport conflicts can result in module components failing to start up. One indication that a componenthas failed to start up is if it does not appear in the Management Console. To troubleshoot the problem,look in the Spectrum™ Technology Platform wrapper log. This log shows which port is causing theproblem. You can find the Spectrum™ Technology Platform wrapper log in:

server\app\repository\logs\wrapper.log

The following table lists the default network ports. You can change the ports by modifying theproperties in this file:



server\app\conf\spectrum-container.properties

If you want to change the networks ports used by a cluster, you must modify thespectrum-container.properties file on each node in the cluster.

Note:

DescriptionPropertyPort

This port is used by the Spectrum™ TechnologyPlatform configuration database.

spectrum.orientdb.binary.port2424-2430


spectrum.orientdb.hazelcast.port2434


spectrum.orientdb.http.port2480-2486

This port is used by Hazelcast for managingdistributed processing between Spectrum™

Technology Platform servers in a cluster.

spectrum.hazelcast.port5701

The port used for communication between theserver and Enterprise Designer and

spectrum.http.port8080

Management Console. This port is also usedby web services.

This port is used for API calls made to services.spectrum.socketgateway.port10119

Enterprise Designer

Enterprise Designer requires the following:

• Operating system requirements:

• Windows 7• Windows 10

• 86 MB of disk space to install Enterprise Designer without any modules. Each module you installrequires additional disk space.

• Microsoft .NET Framework 4.6 (available from the Spectrum™ Technology Platform WelcomePage, http://<SpectrumServerName>:8080)

• A monitor with at least 1024 x 768 resolution• Maximum Windows DPI setting: 150%• Adobe Reader 7 or later (for viewing and saving reports)



Web Browsers

• Internet Explorer 10 and 11• Google Chrome 48 or later• Firefox 44 or later• To use the Data Hub Relationship Analysis Client, a browser with Microsoft Silverlight 5 installed.See www.microsoft.com/getsilverlight. Because Google Chrome no longer supports MicrosoftSilverlight, you will need to access these client tools using Internet Explorer (we recommendversion 11) or Firefox.

Command Line Tools

Administration Utility

• Operating system requirements:

• Windows 7• Windows 10

• The Administration Utility requires Java 8 or later. If you are installing the Administration Utility onthe same computer where the Spectrum™ Technology Platform server is installed, Java 8 isalready installed since it is included with the server. If you want to install the Administration Utilityon another computer, make sure that the computer has Java 8 or later installed.

Job Executor and Process Flow Executor

The Job Executor and Process Flow Executor command line tools require Java 8 or later.

User Interface Languages

Spectrum™ Technology Platform user interfaces such asManagement Console, Enterprise Designer,and web-based applications are localized for the following languages:

• English• French• Japanese• Portuguese• Spanish



http://www.microsoft.com/getsilverlight

Client SDK

The Client SDK provides API access to Spectrum™ Technology Platform services. To use the ClientSDK your computer must meet the following requirements:

• 1.25 GB disk space• JDK 1.5 is required to install the Client SDK. Be sure that JDK 1.5 is in the PATH environmentvariable. Once installed, the Client SDK supports JDK 1.4 and greater.

Supported Compilers

The Spectrum™ Technology Platform Client SDK is supported with the following compiler andruntime minimum versions.

Java

Client SDK Package Directory: clientSDK/platforms/java

Client SDK requires the Java JDK, version 1.4 or higher. This is not installed with the Client SDK.

Windows 32-bit

• JDK: 1.4• C Compiler: MSVC 6.0 SP3, MSVC 2003, MSVC 2005, MSVC 2008• C++ Compiler: MSVC 6.0 SP3, MSVC 2003, MSVC 2005, MSVC 2008• C# .NET: Microsoft .NET Framework 1.1• Visual Basic: MS Visual Basic 6.0

Windows 64-bit

• JDK: 1.4• C Compiler: MSVC 2005, MSVC 2008• C++ Compiler: MSVC 2005, MSVC 2008

HP-UX RISC

• JDK: 1.4• C Compiler: cc: HP92453-01 A.11.01.21 HP C (Bundled) Compiler• C++ Compiler: aCC: HP aC++ B3910B A.03.30 HP aC++ B3910B A.03.27

The clientSDK 32-bit lib is linked to the following libraries:

• libpthread.1• librt.2• libnsl.1• libxti.2




• libpthread.1• libnsl.1• librt.2• libdl.1• libc.2• libxti.2• libdl.1

HP-UX Itanium

• JDK: 1.4• C Compiler: cc: HP aC++/ANSI C B3910B A.06.05• C++ Compiler: aCC: HP aC++/ANSI C B3910B A.06.05


• libpthread.so.1• libnsl.so.1• librt.so.1• libxti.so.1• libdl.so.1


• libpthread.so.1• libnsl.so.1• librt.so.1• libxti.so.1• libdl.so.1

Red Hat (32-bit)

• Operating System: Red Hat Linux 2.4.9-e.65smp• C Compiler: gcc version 2.96 (gcc 4.1 required for the Address Now Module)• C++ Compiler: g++ version 2.96

The clientSDK lib is linked to the following libraries:

• libstdc++-libc6.2-2.so.3• libm.so.6• libc.so.6• ld-linux.so.2

Red Hat (64-bit)

• Operating System: Red Hat Linux version 2.6.9-34.0.2.ELsmp



• C Compiler: gcc version 3.4.5• C++ Compiler: g++ version 3.4.5

The clientSDK lib is linked to the following libraries:

• libstdc++.so.6• libm.so.6• libgcc_s.so.1• libpthread.so.0• libc.so.6• ld-linux-x86-64.so.2

SuSE

• Operating System: SuSE SLES 8 (powered by UnitedLinux 1.0) (i586)\nKernel 2.4.21-295-smp(0).

• C Compiler: gcc version 3.2.2• C++ Compiler: g++ version 3.2.2

The clientSDK lib (32-bit) is linked to the following libraries:

• libstdc++.so.5• libm.so.6• libgcc_s.so.1• libc.so.6• ld-linux.so.2

Solaris

• Operating System: Solaris 5.8• C Compiler: cc: Forte Developer 7 C 5.4 2002/03/09• C++ Compiler: CC: Forte Developer 7 C++ 5.4 Patch 111715-16 2005/04/28


• libpthread.so.1• libsocket.so.1• libnsl.so.1• librt.so.1• libc.so.1• libdl.so.1• libmp.so.2• libaio.so.1• libc_psr.so.1


• libpthread.so.1



• libsocket.so.1• libnsl.so.1• librt.so.1• libc.so.1• libmp.so.2• libmd5.so.1• libscf.so.1• libaio.so.1• libdoor.so.1• libuutil.so.1• libm.so.2• libc_psr.so.1• libmd5_psr.so.1

AIX

• Operating System: AIX version 5.1.0.0• C Compiler: xlc 6.0 Visual Age C 6.0• C++ Compiler: xlC 6.0 Visual Age C++ 6.0

The clientSDK 32-bit and 64-bit lib are linked to the following libraries:

• libC.a• libc_r.a• libpthread.a• librtl.a

Location Intelligence Module Support

Database

The Location Intelligence Module supports the following spatial databases for use with the spatialservices, data, and resources:

• Oracle 11gR2, Oracle 12C• SQL Server 2008 R2, SQL Server 2012, SQL Server 2014• SAP HANA 9.3• PostgreSQL 8+ (PostGis 2.x)• GeoPackage (Windows and CentOS)

Data Format

The Location IntelligenceModule supports the following data formats for use with the spatial services:



• Generic JDBC (w/XY)• TAB (native, native extended, raster, grid, seamless, DBF)• ESRI ShapeFile

Raster Format

The following raster and grid formats (64-bit only) are supported in the Location Intelligence Module:

Raster formats:

File ExtensionFormat.genADRG

.genASRP

.bmp, .wbmpBMP

.genCADRG

variousCIB

.ecwECW (SDK v5)

.geotifGeoTiff

.gifGIF

.jpg/.jpegJPEG

.sidMrSID (SDK v9)

Supports MG4 (MrSID Generation 4). On CentOS 7.1,libpng12.so is required for reading MrSID rasters.

Note:

.ntfNITF

.pngPNG

.tifTIFF

TIFF files used by the Feature Service and MappingService cannot exceed 2GB.

Note:

Solaris or AIX machines, whether installed with 32- or 64- bit JVM, do not support ECW andMrSID raster formats.

Note:

Grid Formats

File ExtensionFormat.dt0, .dt1, .dt2, .dt3Defense Digital Terrain Elevation Data (DTED)

.migMapInfo Grid

.mrrMRR (Multi-Resolution Raster)



This support is provided on Windows 64-bit and the followingLinux environments:

Note:

• Oracle Linux 6.5 and 7.1• CentOS 6.4 and 7.1• Ubuntu 12.04

.grcVertical Mapper Classified Grid

.grdVertical Mapper Continuous Grid

In order to use rasters and grids as a map layer, there must be an associated .TAB file containinggeoreference information about the image, including the bounds, coordinate system and registrationpoints.

BrowserThe Location IntelligenceModule spatial client development, samples, and SpectrumSpatial Managersupport the following browsers:

• Microsoft Internet Explorer 10 and 11• Mozilla Firefox 35 and above• Google Chrome 40 and above• Safari (Mac OS X) and Safari 5.1.7 for Windows

Utilities

The Location Intelligence Module utilities (Tile Generator, Map Uploader, Geometry Validator) havethe follow requirements:

• These utilities require at a minimum Java 7. If you are installing these utilities on the same computerwhere the Spectrum™ Technology Platform server is installed, Java 8 will be installed since it isincluded with the server. If you want to install the utilities on another computer, make sure thatthe computer has Java 7 or later installed.

• The Map Uploader also requires Microsoft .NET Framework 4.0 (available from the Spectrum™

Technology Platform Welcome Page, http://<SpectrumServerName>:8080)

OGC Compliance

The Location Intelligence Module is OGC compliant for the following services:

• WFS version number 1.0.0• WMS version number 1.1.1 and 1.3.0

MapInfo Professional Compatibility

The Location Intelligence Module is compatible with MapInfo Professional up to version 15.x. SeeTools > MapInfo Pro in the Spectrum Spatial Getting Started Guide for more information about theinteroperability of the two products.



2 - StandardInstallation

In this section

Installing a New Server 20Upgrading a Server 21Installing a License Key 22Installing the Server with a Silent Installer 23Adding Modules 23Removing the Server 24

Installing a New Server

Prerequisites:

• Before installing Spectrum™ Technology Platform, be sure to read the release notes. The releasenotes contains important compatibility information as well as release-specific installation notes.

• Apply all the latest updates available for your operating system, especially those that resolveissues with Java.

• You may encounter installation problems on Windows if the data execution prevention (DEP)setting is not set correctly. The DEP setting must be set to Turn on DEP for essential Windowsprograms and services only. For instructions on how to change your DEP setting, see theWindows documentation.

To install a new server:

1. Download Spectrum™ Technology Platform using the download instructions contained in yourwelcome letter.

2. Extract the downloaded file to a temporary location on the server where you want to installSpectrum™ Technology Platform.

3. Double-click install.exe.4. The installer walks you through the installation process. Note the following:

• If you are setting up an environment where the configuration database is installed on a separateserver choose Server only. Otherwise choose Standard installation.

• When prompted, select the modules that you want to install.

• Make sure that Spectrum™ Technology Platform is selected.• If you are installing the SAP Module you must install these modules: Address Now Moduleand Advanced Matching Module. The Enterprise Tax Module is optional. The UniversalAddressing Module is only required if you will be using the SAP module serviceSAPValidateAddressWithCandidates.

• If you are installing the Siebel Module you must install these modules: Advanced MatchingModule,Data NormalizationModule, andUniversal NameModule Youmay need to installone or more of these modules depending on the features you have licensed: Address NowModule, Enterprise Geocoding Module, and Universal Addressing Module.

• When prompted, enter the HTTP port that you want to use and then press Enter. The defaultis 8080. For a complete listing of ports used by Spectrum™ Technology Platform see DefaultNetwork Ports on page 10.

5. After the installation completes, the Spectrum™ Technology Platform server starts automatically.Wait for the server to start up.


Standard Installation

You can see when the server has stared up by opening the log file <Spectrum InstallationLocation>\server\app\repository\logs\wrapper.log and looking for this message:

INFO [Server] Pitney Bowes Spectrum(TM) Technology Platform (Versionversion build) Started

Do not attempt to stop the server until after it has fully started for the first time.Stopping the server before it performs an initial startup can cause your installationto become unusable.

Important:

6. Install your license key. For instructions, see Installing a License Key on page 22.

Upgrading a Server

Prerequisites:

• Before upgrading, be sure to read the release notes for the new version. The release notes containimportant compatibility information, supported upgrade paths, and module-specific data backuprecommendations.


To upgrade a server:

1. Download the updated version of Spectrum™ Technology Platform using the download instructionscontained in the release announcement email.

2. Unzip the downloaded installer to a temporary folder on the server you want to upgrade.3. Follow the information provided in the release notes for recommendations about backing up

module-specific data. For example, for the Location Intelligence Module, you need to back upyour named resources, data, and configuration files. For the Data Hub Module, you need to followthe instructions in "Backing up Data Hub Models" from the Master Data Management Guide.

4. Stop the Spectrum™ Technology Platform server. To stop the server, right-click the Spectrum™

Technology Platform icon in theWindows system tray and select Stop Spectrum™. Alternatively,you can use the Windows Services control panel and stop the Pitney Bowes Spectrum™

Technology Platform service.5. If you have the Address Now Module installed, shut down the Address Now server by going to

the Windows services control panel and stopping the Address Now Server service.6. If you have the Global Sentry Module installed, shut down the Global Sentry database server by

going to the Windows services control panel and stopping the Global Sentry Database Serverservice.



7. Any changes you made to files in the folder <SpectrumPlatformLocation>\server will belost. Before upgrading, review the files and folders in this location and back up any files you havemodified.

You may have modified files in this folder in the following situations:

• You have the Siebel or SAPmodules installed. Be sure to back up existing dataflows, especiallyany that are customized.

• You are using LDAP for authentication. Be sure to back up this file and restore it after upgrading:server\app\conf\spring\security\spectrum-config-ldap.properties.

8. Run the Spectrum™ Technology Platform installer to upgrade your system.9. If you backed up any files under the <SpectrumPlatformLocation>\server folder, restore

them to the upgraded server.

Any job or subflow stored in the system during a server upgrade is marked as exposed toprovide the same behavior for those jobs and subflows as before the upgrade. Any job or

Note:

subflow that is exported prior to the upgrade will not be exposed. Therefore, when importingthese jobs or subflows back into the system, you must manually expose the imported job orsubflow.

Installing a License Key

The license key provides access to software pursuant to the terms of your license. It is an encryptedXML file with a file name ending in .key.

When you upgrade an existing Spectrum™ Technology Platform installation, youmay continueto use your existing license key. You do not need to get a new one.

Note:

To install a license key:

1. Locate the email containing your license key that you received from Pitney Bowes.

You must install the license key within 45 days of receiving it. If you do not you willneed to contact Pitney Bowes for another license key.

Important:

2. Copy the .key file to the following directory:

<SpectrumPlatformLocation>\server\app\import

The license key is applied to your system. There is no need to restart your server.

If there was a problem installing the license key, check the log file in:

<SpectrumPlatformLocation>\server\app\repository\logs



Depending on whether the key was processed successfully or there was an error processing thekey, the processed key goes into one of these folders:

• <SpectrumPlatformLocation>\server\app\import\archive\license-keys• <SpectrumPlatformLocation>\server\app\import\error\license-keys

Installing the Server with a Silent Installer

The silent install process for the server allows you to pre-configure the server installation processso that it runs without user intervention. Instead of responding to prompts for information such asthe installation location and which modules to install, you specify these responses in a propertiesfile which the installer uses instead of user prompts.

1. In the Spectrum™ Technology Platform installer, browse to the SilentInstaller folder.2. Open the file installer.properties in a text editor.3. Edit installer.properties as necessary to specify the installation settings you want to use.

See the comments in installer.properties for additional information.4. To run the installer in silent mode, place installer.properties in the same directory as

install.exe. When the installer executes it will detect installer.properties and automaticallyrun in silent mode.

Alternatively, you can place installer.properties in different directory and give the absolutepath to the property in the command prompt using the -f argument, as follows:

install.exe -f PathOfPropertyFile\installer.properties

Adding Modules

Spectrum™ Technology Platform is designed so that modules can be added as you grow yoursystem over time. For example, you may have one Spectrum™ Technology Platform module andthen license another module a fewmonths later. The second product may be built on a newer versionof Spectrum™ Technology Platform. This will require you to upgrade your version of Spectrum™

Technology Platform. In another case, the second product is compatible with the installed version.In both cases, the install program recognizes if it needs to upgrade Spectrum™ Technology Platformand will do so without prompting. If an upgrade is not required, the installer will skip the Spectrum™

Technology Platform install steps and install the new module.

The process for adding a module is similar to that of a new installation. In both cases you start theinstallation process by running the Spectrum™ Technology Platform installer. Note that Spectrum™



Technology Platform modules do not have their own installer. Instead, you use the Spectrum™

Technology Platform installer to add modules.

1. If the Spectrum™ Technology Platform server is running, stop the server. To stop the server,right-click the Spectrum™ Technology Platform icon in the Windows system tray (shown below)and select Stop Spectrum™.

2. Launch the Spectrum™ Technology Platform installer by double-clicking Install.exe. Theinstaller walks you through the installation process. When prompted, select the modules that youwant to install. Your currently installed modules are selected.

3. Install any necessary databases for the new product. For more information on installing databases,see Spectrum Databases on page 66.

4. After you install the necessary databases (if any), start Spectrum™ Technology Platform byright-clicking the Spectrum™ Technology Platform icon in theWindows system tray and selectingStart Spectrum™.

5. Install the license key for the module. For instructions, see Installing a License Key on page22.

Removing the Server

Before uninstalling any product, back up any files youmay need in the future. Uninstalling Spectrum™

Technology Platform will remove all jobs and settings.

1. If the Spectrum™ Technology Platform server is running, stop the server. To stop the server,right-click the Spectrum™ Technology Platform icon in the Windows system tray (shown below)and select Stop Spectrum™.



2. Go to Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Server andselect Uninstall Pitney Bowes Spectrum™ Technology Platform.

Some Java files will not be removed because the uninstall process itself uses them.Note:

3. If there are any client tools that you want to uninstall, see Removing Enterprise Designer onpage 90.



3 - Cluster

In this section

Clustered Architecture 27Requirements 31Installing a Cluster 31Installing a Cluster for the Data Hub Module 36Installing a Cluster for the Location Intelligence Module 37Upgrading a Cluster 47Upgrading with Clustering for the Data Hub Module 49Upgrading with Clustering for the Location Intelligence Module 51Removing a Node from a Cluster 53Adding Modules to a Cluster 53Starting a Cluster 54Shutting Down a Cluster 55Using Enterprise Designer with a Cluster 55

Clustered Architecture

In a clustered environment, processing is shared among two or more instances of the server. Allcommunication with Spectrum™ Technology Platform goes through a load balancer. Instead ofusing the URL and port of the Spectrum™ Technology Platform server, you use the URL and portof the load balancer. Consider using this approach if you require failover redundancy and high-volume,high-performance processing.

The following diagram illustrates this architecture:

Load Balancer

As requests come into the cluster, the load balancer identifies the best available Spectrum™

Technology Platform node to handle the request. The request is then passed to a Spectrum™

Technology Platform node.

From the user's perspective, the distributed architecture is handled automatically behind the scenes.The user sends a request to the load balancer's URL and port for Spectrum™ Technology Platform(typically port 80 for a distributed environment) as if it were a single Spectrum™ Technology Platformserver.

Nodes

A node is a Spectrum™ Technology Platform server installation. Each node has a copy of theconfiguration database. Each copy is continuously synchronized. This enables each node to sharethe same settings. License information, dataflows, database resources, and so on can be centrallymanaged for the cluster because of the shared configuration database.

To configure the cluster, simply point Management Console or Enterprise Designer to the loadbalancer's URL and port for Spectrum™ Technology Platform (typically port 80 for a distributedenvironment).


Cluster

External Resources

The definitions for external resources such as database resources (postal databases, geocodingdatabases, and so on), JDBC connections, and file servers, reside in the configuration database.The resources themselves (databases, files, web services) can reside anywhere you choose.

Because the database resources themselves reside outside the cluster, multiple clusters can sharethe same database resources. You must create the resource definitions in each cluster usingManagement Console. For example if you want multiple clusters to share the same geocodingdatabase, you can install the geocoding database on a server accessible from each cluster, thenin Management Console point each cluster to the geocoding database.

Installing a Cluster

For instructions on installing a cluster, see the Spectrum™ Technology Platform Installation Guide.

Clustered Architecture for the Data Hub Module

In a clustered environment, processing is shared among two or more instances of the server. TheData Hub Module maintains a separate graph database for each model that is configured; eachgraph database is replicated to each Spectrum™ Technology Platform server. When a model isloaded, one server is chosen as the master and all other servers will maintain a replicated mirror ofthat master. All writes to the database will be synchronized with the master, while any server canprocess read requests.

The server that receives the first request to open the model will be chosen as the master. If differentservers receive the request to open different models, the masters for these models will be runningon different servers. Though it is not normally required to know which server is serving the masterrole for a given model, this information is available in the JMX Console:http://servername:8080/jmx-console/HttpAdaptor/list. Scroll down to the neo4j.org domain andthere will be a set of objects for each model, numbered, starting at 0. The Role attribute in theHighAvailability object will indicate whether this server is the master for this model. The Kernel objectwill indicate the model name in the StoreDirectory attribute.

Clustered Architecture for the Global Geocoding Module

In a clustered environment, processing is shared among two or more instances of the server. Thediagram below illustrates the deployment architecture of such a configuration. Load balancing canbe used to support high availability and scaling. The deployment architecture includes a load balancer,Spectrum™ Technology Platform nodes with Global Geocoding Modules and Geocoding databases.


Cluster

http://servername:8080/jmx-console/HttpAdaptor/list

Each Geocoding database MUST be installed in the same location on all of the nodes forthe cluster to work properly. For example, if the Geocoding database for “Spectrum Node

Note:

1” is installed on C:\data\, then the other Spectrum nodes' Geocoding database must alsoreside on C:\data\.

Clustered Architecture for the Location Intelligence Module

In a clustered environment, processing is shared among two or more instances of the server. Thediagram below illustrates the deployment architecture of such a configuration. Load balancing canbe used to support high availability and scaling. The deployment architecture includes a load balancer,a Spectrum Spatial cluster, a database, and a file share. With this approach it is possible to scaleboth horizontally and vertically. You can cluster the Location Intelligence Module with or withoutplatform clustering, starting from version 8.0.


Cluster

Load Balancer

The load balancer spreads requests between the Spectrum Spatial instances. Any load balancerthat supports load balancing HTTP/HTTPs requests can be used.

Spectrum Spatial Cluster

The cluster is a collection of Spectrum instances with LIM sharing administration, named resources,geographical metadata content and configuration settings. Additional nodes can be added to thecluster for resilience or to deliver support for greater loads. Each node can be scaled verticallythrough additional hardware resources and/or additional instances should this be required forhardware with massive resources. Spectrum can be configured to use restricted numbers of CPUs.

Database

Spectrum stores named resources (maps, layers, tables and styles), geographic metadata andconfiguration in a repository. In the default single server installation an embedded database is usedto store these resources on the local server. To create a resilient scalable solution this embeddeddatabase should be replaced with a resilient independent database. Oracle, PostGreSQL/PostGISand Microsoft SQL Server are the supported repository databases.


Cluster

In the load balanced configuration, Spectrum nodes cache these resources in a local cache andsearch index in each node in the cluster. When a Spectrum node receives a request it uses thelocal cache and index to find resources. Named resources can be added through any node in thecluster. Each node keeps its cache current by checking for differences between its local cache andthe central database. This check occurs every 2 seconds by default. Time frequency can beconfigured. This architecture ensures the server delivers high performance transactions and theload on the repository database is kept to a minimum. If a new Spectrum node is added to the clusterthe cache and index are created automatically. Such a scenario can occur to remedy a node failureor grow the capability of the deployment.

File Share

The file share provides a folder to hold map images generated by Spectrum. When maps arerendered using the web services the server supports the map images being returned through URLsor returned as a base 64 encoded image. When a URL is returned the map image is stored as afile and served on request of the URL. To ensure any Spectrum node can return the map image afile share is used to store the images.

Requirements

• All servers that host a node must have their system clocks synchronized in order for the clusterto function. Verify that all systems point to the same time service to synchronize their clocks.

• All nodes in a cluster must be the same version of Spectrum™ Technology Platform so be surethat the version you install is the same as the existing nodes.

• All nodes in a cluster must have the same modules installed, so be sure to install all the necessarymodules on the new node.

Installing a Cluster

If you are setting up a cluster for the Location Intelligence Module only, follow the instructionsin Installing a Cluster for the Location Intelligence Module on page 37.

Note:

If you are setting up a cluster for the Data Hub Module, also see Installing a Cluster forthe Data Hub Module on page 36.

Note:

Installing a cluster involves setting up one Spectrum™ Technology Platform server at a time. Eachtime you add a server you need to point it to an existing server which will act as a seed node. Aseed node is a server that has a copy of the Spectrum configuration data that it can copy to a new


Cluster

node so that the new node's configuration is synchronized with the other nodes in the cluster. Thefollowing diagrams illustrate this process.

After installing the first node you will in effect have a cluster with only one node:

When you install the second node it must point to the first node as a seed node. This will enablethe second node to receive a copy of the first node's configuration database, resulting in a clusterwith two nodes with synchronized configuration information.

As you add additional nodes, the new nodes can point to any of the existing nodes as a seed node.You must also configure the first node to point to at least one other node in the cluster so that if itis ever brought down it can rejoin the cluster.


Cluster

To install a cluster, follow these steps:

1. Install a load balancer. You can choose for yourself an appropriate load balancer. Follow theprocedures described in the load balancer's documentation when installing.

The load balancer must be configured to allow encoded forward slashes. If the loadbalancer does not allow encoded forward slashes you may get HTTP 404 errors while

Note:

using the cluster. For example, if you are using an Apache load balancer, you can configureit to allow encoded forward slashes by opening the httpd.conf file and specifying thisproperty: AllowEncodedSlashes On. For other types of load balancers, refer to theload balancer's documentation.

2. Install Spectrum™ Technology Platform on a server where you want to host a node. Forinstructions, see Installing a New Server on page 20.

3. If the Spectrum™ Technology Platform server is running, stop it. To stop the server, right-clickthe Spectrum™ Technology Platform icon in theWindows system tray and selectStop Spectrum™.

4. Edit the file server/app/conf/spectrum-container.properties as follows:spectrum.cluster.enabled

Set this to true.

spectrum.cluster.name

Set this to any name you want to give to the cluster. If you have multiple clusters,give each cluster a unique name.

spectrum.cluster.address


Cluster

Set this to the network interface to which you want this node to bind. Specify 0.0.0.0if you want the node to bind to all network interfaces.

spectrum.cluster.seeds

Set this to the IP address of the Spectrum™ Technology Platform server whoseconfiguration will be reproduced on new nodes added to the cluster. The new serverwill be configured with the same settings as the seed server whenever it starts up sothat it is synchronized with the cluster.

If this is the first node in the cluster you need to specify a seed node that is not yetrunning. If you know the IP address of the node you want to use as a seed node,enter it now. Otherwise, you will need to return to this properties file once you havethe IP address of the seed node.

You can specify multiple IP addresses by separating each with a comma. Werecommend that you specify multiple seed nodes so that if one is down others canbe used to allow the node to join the cluster. The node will attempt to access eachseed node in the order listed. If none of the seed nodes can be reached, the nodewill not join the cluster.

spectrum.cluster.nodename

Optional. This property allows you to define a specific node name to associate withthe configuration database on this node. You should set this option if you plan onmanually copying the configuration database from one server to another, such ascopying the configuration database from a staging server to a production server. Ifyou do not specify this property, an internally-used node name will be automaticallygenerated by the system.

5. Uncomment the following lines:

spectrum.runtime.hostname=spectrum.runtime.port=

Modify these to point to the load balancer host name and the port on which you have configuredthe load balancer to listen.

6. Save and close the spectrum-container.properties file.7. Start the server. To start the server, right-click the Spectrum™ Technology Platform icon in the

Windows task bar and select Start Server.

Add additional nodes to the cluster. For instructions on adding a node, see Adding a Node to aCluster on page 35.


Cluster

Adding a Node to a Cluster

Follow this procedure if you have already set up a cluster with a load balancer and at least oneSpectrum™ Technology Platform node, and you want to add a new Spectrum™ Technology Platformnode.

1. Install Spectrum™ Technology Platform on a server where you want to host a node. Forinstructions, see the Spectrum™ Technology Platform Installation Guide.



Set this to true.


Set this to the name of the cluster that you want this node to join.




Set this to the IP address of the Spectrum™ Technology Platform server whoseconfiguration will be replicated on the new node.





5. Save and close the spectrum-container.properties file.6. Start the server.

• On Unix or Linux, change the working directory to the Spectrum™ Technology Platform server'sbin directory, source the setup file, then type the following command: ./server.start .


Cluster

• On Windows, right-click the Spectrum™ Technology Platform icon in the Windows system trayand select Start Spectrum™.

Installing a Cluster for the Data Hub Module

1. Follow the directions in Installing a Cluster on page 31.2. Stop all the Spectrum™ Technology Platform servers in the cluster. To stop the servers, right-click

the Spectrum™ Technology Platform icon in theWindows system tray and selectStop Spectrum™.Alternatively, you can use the Windows Services control panel and stop the Pitney BowesSpectrum™ Technology Platform service.

3. Source the SpectrumDirectory/server/bin/setup script.4. Execute the SpectrumDirectory/server/bin/server.stop script to shut down the

Spectrum™ Technology Platform server.5. Configure the property files.6. Start the Spectrum™ Technology Platform server. To start the server, right-click the Spectrum™

Technology Platform icon in theWindows system tray and select Start Spectrum™. Alternatively,you can use theWindows Services control panel to start the Pitney Bowes Spectrum™ TechnologyPlatform service.

7. Execute the SpectrumDirectory/server/bin/server.start script to start the Spectrum™

Technology Platform server.

Configuring Property Files

Two files are used to configure the Data Hub Module:

• SpectrumFolder\server\modules\hub\hub.properties-Controls Spectrum™TechnologyPlatform settings, including whether to join a cluster and whether to enable history tracking andauditing.

• SpectrumFolder\server\modules\hub\db\neo4j.properties-Controls how the graphdatabases are configured, using Neo4j Enterprise. This file is used as a template for each model.If needed, each model can be configured separately by placing a copy of this property file into thestore directory for that model.

By default, each model is placed in a subdirectory under theSpectrumFolder\server\modules\hub\db directory. The name of each model contains a"model." prefix followed by the name of the model (e.g., "model.CustomerRetention"). The locationof this top-level directory may be overridden using the hub.models.path.base property in thehub.properties file.


Cluster

To configure the system to run in a cluster you must set the following properties in the hub.propertiesfile:

#hub.neo4j.database.type=embeddedhub.neo4j.database.type=ha

#For ha mode, MUST be set to the number of servers in the cluster (ormodels will not replicate reliably)hub.servers.per.cluster=3

Note that the hub.servers.per.cluster property must match the number of servers expected in acluster. If fewer than this number of servers are running at the time the Data Hub attempts to openor create a model, it will wait for these servers to join and then fail after a timeout. Once the modelis running, the system will continue running as long a quorum of servers (more than half the expectednumber of servers) are in communication. For a cluster of six servers, four must stay incommunication, for three servers, two must stay in contact, and for a two-server cluster, all serversmust be in contact at all times. For this reason, it is recommended that clusters have a minimum ofthree servers in order to achieve a level of fault tolerance. Also, an odd number of servers providebetter resiliency per server than an even-numbered cluster (e.g., both a three-server cluster and afour-server cluster can tolerate a maximum of one lost server).

Installing a Cluster for the Location Intelligence Module

To set up a cluster for the Location Intelligence Module, you must first configure a common repository(depending on the type of database you have) then configure your system to prepare it for clustering.

Configuring a Common Repository

You must configure Spectrum to use a common repository database for the cluster. This ensuresthat named resources, geographic metadata and configuration settings are managed across thecluster.

The repository is installed with a set of named resources, geographic metadata and configurationfiles. To migrate these resources to the common database repository the resources need to beexported from the default internal repository database and reimported into the new shared repositorydatabase.

For bulk export/import of repository content, you can use WebDAV or the limrepo import andlimrepo import commands in the Administration Utility, which give you the option of preservingpermissions (see the Administration section of the Spectrum Spatial Guide for instructions.)

Follow the steps outlined for your common repository database, either PostgreSQL, Oracle, orMicrosoft SQL Server.


Cluster

Set Up a PostgreSQL Repository

These steps describe how to set up your repository on a PostgreSQL database:

1. Copy all repository resources to a local folder usingWebDAV or the limrepo export commandin the Administration Utility (see the Administration section of the Spectrum Spatial Guide forinstructions).

The contents of the installed repository must be exported. This step only needs to be performedonce, as the contents of the repository should be the same at this point for all instances ofSpectrum™ Technology Platform.

2. Back up the folder /<spectrum root>/server/modules/spatial/jackrabbit to a local directory or disk.3. Stop Spectrum.4. On all instances of Spectrum™ Technology Platform, add the database JDBC driver to the

Spectrum common lib directory to allow it to use the selected database. Copy thepostgresql-x.x-x-jdbcx.jar file from /<spectrum root>/server/modules/spatial/libto /<spectrum root>/server/app/lib.

5. On all instances of Spectrum™ Technology Platform, edit the /<spectrumroot>/server/modules/spatial/jackrabbit/repository.xml file to point the repository to a databaseand add clustering. There are four separate changes you need to make:a) Modify the two FileSystem sections within the Repository and Workspace sections of the file:

<FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem"><param name="driver" value="org.postgresql.Driver"/><param name="url"

value="jdbc:postgresql://<hostname>:<port>/<databasename>"/><param name="schema" value="postgresql"/><param name="user" value="<user>"/><param name="password" value="<pwd>"/><param name="schemaObjectPrefix" value="rep_"/></FileSystem>

b) Modify the Persistence Manager section within the Workspace section:

<PersistenceManagerclass="org.apache.jackrabbit.core.persistence.pool.PostgreSQLPersistenceManager">

<param name="url"value="jdbc:postgresql://<hostname>:<port>/<databasename>"/>

<param name="schema" value="postgresql"/><param name="user" value="<user>"/><param name="password" value="<pwd>"/><param name="schemaObjectPrefix" value="${wsp.name}_"/><param name="externalBLOBs" value="false"/></PersistenceManager>


Cluster

c) Enable Clustering at the end of the file, right above the </Repository> tag. Each instance ofSpectrum will need to have a distinct Cluster id to enable synchronization of clustering to work.The delay defines the time delay for synchronization in milliseconds.

<Cluster id="node1" syncDelay="2000"><Journal

class="org.apache.jackrabbit.core.journal.DatabaseJournal"><param name="revision" value="${rep.home}/revision.log" /><param name="driver" value="org.postgresql.Driver" /><param name="url"

value="jdbc:postgresql://<hostname>:<port>/<databasename>" /><param name="schema" value="postgresql"/><param name="schemaObjectPrefix" value="rep_"/><param name="user" value="<user>"/><param name="password" value="<pwd>"/><param name="databaseType" value="postgresql"/></Journal></Cluster>

d) Comment out the DataStore section:

<DataStore class="org.apache.jackrabbit.core.data.FileDataStore"/>

6. On all instances of Spectrum™ Technology Platform, remove the following folders from the/server/modules/spatial/jackrabbit directory: repository, version, workspaces.

7. If your PostgreSQL database has previously had repository content added, you must removetables from your database so a clean repository can be created. If you are starting with a newdatabase, make sure the tables do not exist. The following tables need to be removed from thedatabase:

public.default_names_id_seqpublic.default_binvalpublic.default_bundlepublic.default_namespublic.default_refspublic rep_fsentrypublic.rep_global_revisionpublic.rep_journalpublic.rep_local_revisionspublic.security_binvalpublic.security_bundlepublic.security_namespublic.security_refs

8. Start Spectrum.9. Restore the resources by copying them from the local folder into the Repository using WebDAV

or the limrepo import command in the Administration Utility (see the Administration sectionof the Spectrum Spatial Guide for instructions).


Cluster

Import the content of the repository you previously exported back into the repository. This steponly needs to be performed on one of the Spectrum™ Technology Platform instances.

Set Up an Oracle Repository

These steps describe how to set up your repository on an Oracle database:



2. Back up the folder /<spectrum root>/server/modules/spatial/jackrabbit to a local directory or disk.3. Stop Spectrum.4. On all instances of Spectrum™ Technology Platform, add the database JDBC driver to the

Spectrum common lib directory to allow it to use the selected database. Copy the ojdbc6-x.x.x.x.jarfile from /<spectrum root>/server/modules/spatial/lib to /<spectrumroot>/server/app/lib.


<FileSystem class="org.apache.jackrabbit.core.fs.db.OracleFileSystem">

<param name="driver" value="oracle.jdbc.OracleDriver"/>

<param name="url"value="jdbc:oracle:thin:@//<hostname>:<port>/<databasename>" />

<param name="user" value="<user>" /><param name="password" value="<pwd>" /><param name="schema" value="oracle"/><param name="schemaObjectPrefix" value="rep_"/>

</FileSystem>


<PersistenceManagerclass="org.apache.jackrabbit.core.persistence.pool.OraclePersistenceManager">

<param name="driver" value="oracle.jdbc.OracleDriver"/>

<param name="url"value="jdbc:oracle:thin:@//<hostname>:<port>/<databasename>" />

<param name="user" value="<user>" />


Cluster

<param name="password" value="<pwd>" /><param name="schema" value="oracle"/><param name="schemaObjectPrefix" value="${wsp.name}_"/>

<param name="externalBLOBs" value="false"/></PersistenceManager>

c) Enable clustering at the end of the file, right above the </Repository> tag. Each instance ofSpectrum will need to have a distinct id to enable synchronization of clustering to work. Thedelay defines the time delay for synchronization in milliseconds.


class="org.apache.jackrabbit.core.journal.OracleDatabaseJournal"><param name="driver" value="oracle.jdbc.OracleDriver"

/><param name="url"

value="jdbc:oracle:thin:@//<hostname>:<port>/<databasename>" /><param name="schema" value="oracle"/><param name="schemaObjectPrefix" value="rep_"/>

<param name="user" value="<user>" /><param name="password" value="<pwd>" /><param name="databaseType" value="oracle"/><param name="revision" value="${rep.home}/revision.log"

/></Journal>

</Cluster>




7. If your Oracle database has previously had repository content added, you must remove tablesfrom your database so a clean repository can be created. If you are starting with a new database,make sure the tables do not exist. The following tables need to be removed from the database:

default_names_id_seqdefault_binvaldefault_bundledefault_namesdefault_refspublic rep_fsentryrep_global_revisionrep_journalrep_local_revisionssecurity_binvalsecurity_bundle


Cluster

security_namessecurity_refs

8. Start Spectrum.9. Restore the resources by copying them from the local folder into the Repository using WebDAV



Set Up an MS SQL Server Repository

These steps describe how to set up your repository on an MS SQL Server database:



2. Back up the folder /<spectrum root>/server/modules/spatial/jackrabbit to a local directory or disk.3. Stop Spectrum on all nodes.4. On all instances of Spectrum™ Technology Platform, add the database JDBC driver to the

Spectrum common lib directory to allow it to use the selected database. Copy the sqljdbcx-x.x.jarfile from /<spectrum root>/server/modules/spatial/lib to /<spectrumroot>/server/app/lib.


<FileSystem class="org.apache.jackrabbit.core.fs.db.MSSqlFileSystem">

<param name="driver"value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>

<param name="url"value="jdbc:sqlserver://<hostname>:<port>;databaseName=<databasename>;"/>

<param name="schema" value="mssql"/><param name="user" value="<user>"/><param name="password" value="<pwd>"/><param name="schemaObjectPrefix" value="rep_"/>

</FileSystem>


Cluster


<PersistenceManagerclass="org.apache.jackrabbit.core.persistence.pool.MSSqlPersistenceManager">

<param name="url"value="jdbc:sqlserver://<hostname>:<port>;databaseName=<databasename>;"/>

<param name="schema" value="mssql"/><param name="user" value="<user>"/><param name="password" value="<pwd>"/><param name="schemaObjectPrefix" value="${wsp.name}_"/><param name="externalBLOBs" value="false"/><param name="tableSpace" value=""/></PersistenceManager>

c) Enable clustering at the end of the file, right above the </Repository> tag. Each instance ofSpectrum will need to have a distinct id to enable synchronization of clustering to work. Thedelay defines the time delay for synchronization in milliseconds.


class="org.apache.jackrabbit.core.journal.MSSqlDatabaseJournal"><param name="revision" value="${rep.home}/revision.log" /><param name="driver"value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/><param name="url"value="jdbc:sqlserver://<hostname>:<port>;databaseName=<databasename>;"/>

<param name="user" value="<user>"/><param name="password" value="<pwd>"/><param name="schema" value="mssql"/><param name="schemaObjectPrefix" value="rep_"/><param name="databaseType" value="mssql"/>

</Journal></Cluster>




7. If your SQL Server database has previously had repository content added, you must removetables from your database so a clean repository can be created. If you are starting with a newdatabase, make sure the tables do not exist. The following tables need to be removed from thedatabase:

default_names_id_seqdefault_binval


Cluster

default_bundledefault_namesdefault_refspublic rep_fsentryrep_global_revisionrep_journalrep_local_revisionssecurity_binvalsecurity_bundlesecurity_namessecurity_refs

8. Start Spectrum on all nodes.9. Restore the resources by copying them from the local folder into the repository using WebDAV



Configuring Your System

Once the Spectrum™ Technology Platform is installed and you have configure a common repository,you need to configure your instance before you can replicate it to another virtual machine. If youare not using a virtual machine environment, you will need to perform these steps on each of yourSpectrum™ Technology Platform installations.

Configure the Map File Share

To configure the map file share (a shared image folder) to Spectrum™ Technology Platform youfirst need a shared map image directory. To create a map file share, see Creating a Map ImageFile Share on Unix/Linux on page 45 or Creating a Map Image File Share on Windows on page46.

Once a map image directory has been created, configure the map file share:

1. Modify the Mapping Service configuration by pointing to a shared image folder and load balanceserver. In the ImageCache change the Directory parameter to a common image directory, andchange the AccessBaseURL parameter to the load balancer machine image URL.

If you are using a virtual machine environment, remember this IP address, as you must set theload balancer VM to this IP address.


Cluster

For Unix/Linus installations:

<ImageCache><Directory>/<spatial serverroot>/server/modules/spatial/images</Directory><AccessBaseURL>http://<loadbalance_IP_address>/rest/Spatial/MappingService/internal/imageCache</AccessBaseURL>

<FileExpire>30</FileExpire><ScanInterval>30</ScanInterval></ImageCache>

For Windows installations:

<ImageCache><Directory>\\server\Share\images</Directory><AccessBaseURL>http://<loadbalance_IP_address>/rest/Spatial/MappingService/internal/imageCache</AccessBaseURL>

<FileExpire>30</FileExpire><ScanInterval>30</ScanInterval></ImageCache>

2. For Unix/Linux installations, you must set up a symbolic link to enable map images to go to theshared file system.

Create an images subfolder in the mounted share folder, e.g., /mnt/<linux mount>/images

cd /<spatial server root>/server/modules/spatialrm –Rf imagesln -s /mnt/<linux mount>/images ./images

Creating a Map Image File Share on Unix/Linux

The file share provides a folder to hold map images generated by Spectrum Spatial. Create a sharedfolder accessible to all Spectrum nodes. The file share is not required if maps are returned from theweb services as Base64-encoded images.

To create a map image file share on Unix/Linux:

1. Mount a shared folder on each operating system hosting Spectrum. The commands belowmounta drive on a Microsoft Windows Server or network drive supporting CIFS.

mkdir /mnt/<linux mount>mount -t cifs //<windows host>/<windows share> /mnt/<linux mount>-ousername=shareuser,password=sharepassword,domain=pbi

2. Set the image share to load at startup in /etc/fstab.

//<windows ip address for share>/share /path_to/mount cifsusername=server_user,password=secret,_netdev 0 0


Cluster

Creating a Map Image File Share on Windows

The file share provides a folder to hold map images generated by Spectrum Spatial. Create a sharedfolder accessible to all Spectrum nodes. The file share is not required if maps are returned from theweb services as Base64-encoded images.

To create a map image file share on Windows:

1. In Windows Explorer, select the image folder you want to share.2. Right-click, and then click Share or Share with.3. Select the users who will be writing to the image folder. These users must have read/write

privileges.

Modifying the Service Configurations

To modify the service configurations for load balancing:

In each service configuration file, change the <RepositoryURL> to point to localhost for theserver repository URL. By default your server hostname will be configured in the RepositoryURL.For example, the RepositoryURL should change to point to localhost from http://<SpectrumHostname>:<Port>/RepositoryService/rmi tohttp://localhost:<Port>/RepositoryService/rmi. Ensurelocalhost can be resolvedon the server.

Modifying the Java Properties Files in All Nodes

You must change the java property file in all nodes of the cluster. To modify the java properties forSpectrum™ Technology Platform:

1. Modify the java.properties file, located in<spectrum>/server/modules/spatial/java.properties, to point to the load balanceserver.

2. Change the images.webapp.url and all of the service host and port numbers to point to the loadbalance server.

Configuring Ports for Multiple Spectrum Instances

If you have multiple Spectrum™ Technology Platform instances on a single machine, you mustchange the port numbers.

To change the port numbers for each Spectrum™ Technology Platform instance:

1. Change all ports in <Spectrumroot>/server/app/conf/spectrum-container.properties to new port values that arenot in use. The http port reflects the port number entered in the installer.

2. Update the rmi port in bootstrap.properties in the /<spectrum root>/server/modules/spatial folder(for example, 11099). The default is 1099.


Cluster

Shared Spectrum Local Data

If you are using TAB file data on the file system, this data needs to be in a shared location accessibleby all instances of Spectrum in the load balanced environment. It is also important to note that allnamed resources in the repository accessing data on the file system should point to this sharedlocation.

Each VM or machine hosting Spectrum needs to have access to the mounted shared drive.

Using named resources that point to database tables do not require a shared drive, as thenamed resources in the repository do not access the data using a file path; rather they usea named connection to the data in the database.

Note:

Ensuring Security Entities Set On All Nodes

If you are adding or removing named resources in a LIM only cluster (multiple nodes), these entitieswill only be registered to the node where you are making changes. To ensure these security entitiesare persisted to all nodes in the cluster, you must restart each other Spectrum™ Technology PlatformLIM nodes. This will synchronize all security entities.

This is only required if you are setting security entity overrides for named resources.Note:

Upgrading a Cluster

Prerequisites:



If you are upgrading a cluster for the Location Intelligence Module only, follow the instructionsin Upgrading with Clustering for the Location Intelligence Module on page 51. If you

Note:

are upgrading both Spectrum and LIM clusters, before shutting down all nodes also seeUpgrading with Clustering for the Location Intelligence Module on page 51 for somerequired pre-upgrade steps.

If you are upgrading a cluster for the Data Hub Module, also seeUpgrading with Clusteringfor the Data Hub Module on page 49 for some required pre- and post-upgrade steps.

Note:

1. Shut down all the Spectrum™ Technology Platform nodes in the cluster.


Cluster

2. Choose which node you want to upgrade first, and upgrade that node. For instructions, seeUpgrading a Server on page 21.



Set this to true.


Set this to any name you want to give to the cluster. If you have multiple clusters,give each cluster a unique name.




Set this to the IP address of the Spectrum™ Technology Platform server whoseconfiguration will be reproduced on new nodes added to the cluster. The new serverwill be configured with the same settings as the seed server whenever it starts up sothat it is synchronized with the cluster.

If this is the first node in the cluster you need to specify a seed node that is not yetrunning. If you know the IP address of the node you want to use as a seed node,enter it now. Otherwise, you will need to return to this properties file once you havethe IP address of the seed node.


spectrum.cluster.nodename

Optional. This property allows you to define a specific node name to associate withthe configuration database on this node. You should set this option if you plan onmanually copying the configuration database from one server to another, such ascopying the configuration database from a staging server to a production server. Ifyou do not specify this property, an internally-used node name will be automaticallygenerated by the system.




Cluster


6. Save and close the spectrum-container.properties file.7. Start the server.8. Repeat this process to upgrade the other nodes in the cluster.

Upgrading with Clustering for the Data Hub Module

Additional steps are required for the Data Hub Module both before and after the upgrade process.

Prepare for Upgrading

1. Follow the instructions in Upgrading a Cluster on page 47, as these apply to both clustered andnon-clustered environments.

2. Follow the instructions in "Backing up Data Hub Models" from the Master Data ManagementGuide.

3. Shut down each server in the cluster. Shut the instances down one at a time rather than all atonce, and shut down the master server last. Because the choice of master depends upon whichserver first opened the model, you may want to restart the cluster and open each model from thefirst server that was started and then shut them down in reverse order.

4. To ensure that Spectrum™ Technology Platform is shut down cleanly and completely, examinethe SpectrumDirectory/server/app/repository/logs/wrapper.log file for errorsduring shutdown.

5. For Spectrum™ Technology Platform versions 10.0 and later, each model directory must containa version.data file(SpectrumDirectory/server/modules/hub/db/model.<modelname>/version.data).If after opening each model on the master server the model directory does not contain this file,it can be copied from one of the non-master nodes. This issue can occur when a non-masterservices the initial request to create a model.

Upgrade the Master ServerAfter following the instructions in Upgrading a Cluster on page 47 to install the new version ofSpectrum™ Technology Platform on the master server, the server will have been reset to anon-clustered configuration. The server can be started at this point; however, the Data Hub modelsmay still require a store upgrade and will fail to open if the server is started before the store upgradeis allowed.

1. Stop the Spectrum™ Technology Platform server. To stop the server, right-click the Spectrum™


Technology Platform service.2. Source the SpectrumDirectory/server/bin/setup script.


Cluster

3. Execute the SpectrumDirectory/server/bin/server.stop script to shut down theSpectrum™ Technology Platform server.

4. Confirm that master server is set to non-clustered (embedded) mode in theSpectrumFolder\server\modules\hub\hub.properties file:

hub.neo4j.database.type=embedded#hub.neo4j.database.type=ha

#For ha mode, MUST be set to the number of servers in the cluster (ormodels will not replicate reliably)#hub.servers.per.cluster=3

5. Enable store upgrade by setting the following line fromSpectrumFolder\server\modules\hub\db\neo4j.properties as shown below.

allow_store_upgrade=true

6. Start the Spectrum™ Technology Platform server. To start the server, right-click the Spectrum™

Technology Platform icon in theWindows system tray and select Start Spectrum™. Alternatively,you can use theWindows Services control panel to start the Pitney Bowes Spectrum™ TechnologyPlatform service.

7. Execute the SpectrumDirectory/server/bin/server.start script to start the Spectrum™

Technology Platform server.8. Open each model.9. Follow the instructions in "Backing up Data Hub Models" from the Master Data Management

Guide again.10. Stop the Spectrum™ Technology Platform server. To stop the server, right-click the Spectrum™


Technology Platform service.11. Source the SpectrumDirectory/server/bin/setup script.12. Execute the SpectrumDirectory/server/bin/server.stop script to shut down the

Spectrum™ Technology Platform server.13. Set the master server to clustered (high-availability) mode in the

SpectrumFolder\server\modules\hub\hub.properties file:



14. Compare any configuration files that you backed up to the installed files and make any necessarychanges. Do not overwrite new files with old files because new files may contain properties thatold files do not.


Cluster

Delete Models on Non-Master ServersBefore upgrading, delete the models in the SpectrumDirectory/server/modules/hub/dbdirectory for all non-master servers. Do not delete the models from the master server.

Upgrade Non-Master Servers

1. Follow the instructions in Upgrading a Server on page 21 for each non-master server. If theinstaller starts up the Spectrum™ Technology Platform server, shut the server down.

2. Set each non-master server to clustered (high-availability) mode in theSpectrumFolder\server\modules\hub\hub.properties file:



3. Compare any configuration files that you backed up to the installed files and make any necessarychanges. Do not overwrite new files with old files because new files may contain properties thatold files do not.

Copy Models

Copy the SpectrumFolder\server\modules\hub\db\model.* directories to each of thenon-master servers.

Start the Servers

1. Start up the master server, followed by non-master servers.2. Ensure that each server in the cluster is functioning. Check

SpectrumFolder\server\app\repository\wrapper.log for any errors.3. While directly connected to the master server (bypassing the load balancer), open each model,

one at a time, and inspect the wrapper.log file for errors.

Upgrading with Clustering for the Location IntelligenceModule

When a common repository database is used for clustering, these additional steps required beforeand after the Spectrum™ Technology Platform upgrade process. Before the upgrade, you mustmove to a local Derby database setup; after the upgrade, you then change back to the cluster setupby pointing repository.xml to the external database.


Cluster

To preserve access control settings, do not useWindowsWebDAV; instead, use a third-partyWebDAV tool such as WinSCP.

Note:

1. Before upgrading Spectrum™ Technology Platform, back up the repository by following thesesteps.a) Select a node from the cluster.b) Back up the repository content using a non-Windows WebDAV client.c) Back up repository.xml (under Spectrum\server\modules\spatial\jackrabbit).d) Back up the JDBC driver jar file used by the database for the repository (for example,

postgresql-9.1-901.jdbc4.jar under Spectrum\server\app\lib).e) Back up repository.xml from

Spectrum\server\app\tmp\RepositoryService.war-xxxxxxxx-contents\webapp\WEB-INF\classes\org\apache\jackrabbit\core. If you cannot find this file,you can extract it from RepositoryService.war under Spectrum\server\app\deploy.

2. Switch the common repository database to a local Derby database (temporarily, just for upgradepurposes). Apply the following steps to all nodes in the cluster.a) Shut down the Spectrum™ Technology Platform server.b) Rename the jackrabbit folder to "jackrabbit_cluster" (from

Spectrum\server\modules\spatial\jackrabbit toSpectrum\server\modules\spatial\jackrabbit_cluster).

c) Create another jackrabbit folder in the same location.d) Copy repository.xml (backed up in Step 1e) to the jackrabbit folder.e) Start the Spectrum™ Technology Platform serverf) Copy all the repository files and folders (backed up in Step 1b) into the repository using a

non-Windows WebDAV client.g) Shut down the Spectrum™ Technology Platform server

3. Follow normal procedures to upgrade Spectrum™ Technology Platform to the new version.4. After the Spectrum™ Technology Platform upgrade is complete, switch back to the common

repository database for all nodes in the cluster by following these steps.a) First node only: Start the Spectrum™ Technology Platform server (if required) and back up

the content from the repository using a non-Windows WebDAV client.b) Shut down the Spectrum™ Technology Platform server.c) Rename the jackrabbit folder to "jackrabbit_local" (from

Spectrum\server\modules\spatial\jackrabbit toSpectrum\server\modules\spatial\jackrabbit_local).

d) Create another folder named "jackrabbit" in the same location.e) Copy repository.xml (backed up in Step 1c) to the jackrabbit folder.f) Copy the JDBC driver jar (backed up in Step 1d) to Spectrum\server\app\lib.g) Start the Spectrum™ Technology Platform server.h) First node only: Copy the content that you backed up in Step 4a into the repository using a

non-Windows WebDAV client.


Cluster

i) Repeat Steps 4b-4g for each additional node.j) For each additional node, after copying repository.xml (backed up in Step 1c) to the jackrabbit

folder, verify that it has a distinct Cluster ID.

Removing a Node from a Cluster

To remove a node from a cluster, stop the Spectrum™ Technology Platform server.

• On Unix or Linux, change the working directory to the Spectrum™ Technology Platform server'sbin directory, source the setup file, then type the following command: ./server.stop .

• On Windows, right-click the Spectrum™ Technology Platform icon in the system tray and selectStop Spectrum™.

If you do not want the server to rejoin the cluster the next time it starts up, open the fileserver/app/conf/spectrum-container.properties in a text editor and setspectrum.cluster.enabled to false.

For Location Intelligence Module users: If you want to keep the node standalone and able to runoutside the cluster, copy back the original repository.xml file and remove the following folders fromthe /server/modules/spatial/jackrabbit directory for each instance of Spectrum™

Technology Platform: repository, version, workspaces. Restart the server and import the repositorycontent.

Adding Modules to a Cluster

After installing a cluster you may decide to add additional modules. This procedure describes howto add one or more modules to an existing cluster.

1. Shut down all the Spectrum™ Technology Platform nodes in the cluster.2. Choose a node where you will first install the module. On that node, open the following file in a

text editor: server/app/conf/spectrum-container.properties.3. Set spectrum.cluster.enabled to false.4. Save and close the file.5. Install the module or modules you want to add. For instructions, see the Spectrum™ Technology

Platform Installation Guide.6. Start up the server.

The server starts up in standalone (non-clustered) mode.

7. Wait for the server to fully start up, then stop the server.


Cluster

8. Open server/app/conf/spectrum-container.properties in a text editor and setspectrum.cluster.enabled to true.

9. Save and close the file.10. Start up the server.

You now have a cluster of one with the new module installed.

11. Start up each of the other nodes.

Starting a Cluster

If all the nodes in a cluster are stopped, you must follow this procedure to start up the cluster safelyand avoid data loss.

1. Start the node that was shut down last.

The first node that you start must be the last node that was shut down. Starting upanother node first may result in loss of data such as job history and configuration

Warning:

settings. If you do not know which node was shut down last, look in each node'swrapper log for the time stamp of the shutdown message. You can find the wrapperlog in: Spectrum Location\server\app\repository\logs\wrapper.log.

2. Wait for the Spectrum™ Technology Platform server to completely start up.

You can tell when the Spectrum™ Technology Platform server has completely started up bylooking in the wrapper log: SpectrumLocation\server\app\repository\logs\wrapper.log. The following message isdisplayed when the server is completely started:

Pitney Bowes Spectrum(TM) Technology Platform (Version Version Number)Started.

3. Start the other nodes in the cluster.

Be sure to wait for the first node to start up completely before starting additionalnodes. Starting up additional nodes before the first one is started may result in lossof data.

Warning:


Cluster

Shutting Down a Cluster

To shut down an entire cluster:

1. Identify which nodes are seed nodes. To do this, open the fileSpectrumFolder/server/app/conf/spectrum-container.properties and look atthe nodes listed in the spectrum.cluser.seeds property.

2. Shut down each Spectrum™ Technology Platform server in the cluster, making sure that the lastnode you shut down is a seed node.

• On Unix or Linux, change the working directory to the Spectrum™ Technology Platform server'sbin directory, source the setup file, then type the following command: ./server.stop .

• On Windows, right-click the Spectrum™ Technology Platform icon in the Windows system trayand select Stop Spectrum™.

To prevent loss of data the last node you shut down must be a seed node.Warning:

3. Make a note of which node was the last node you shut down. You will need this information whenstarting up the cluster.

To prevent loss of data when starting the cluster, the first node you start must be thelast node that was shut down, and that node must be a seed node.

Warning:

Using Enterprise Designer with a Cluster

1. Launch Enterprise Designer.2. In the Server name field, enter the server name of the load balancer.3. In the Port field, enter the port that you have configured the load balancer to listen on.

Input files, output files and database resources must be on a shared drive, or file server,or some commonly-accessible location. Otherwise, all files must be loaded on each server

Note:

that hosts a Spectrum™ Technology Platform server and must be located in the samepath.

Once you have logged in you can use Enterprise Designer as normal. The actions you take willapply to all Spectrum™ Technology Platform instances in the cluster where you are logged in.


Cluster

4 - Cluster withSeparatedConfigurationDatabase

In this section

Installing a Cluster with a Separated Configuration Database 57Upgrading a Cluster with a Separated Database 59Converting to a Separated Configuration Database 62Converting from a Separated Configuration Database to a Standard

Installation 65

Installing a Cluster with a Separated ConfigurationDatabase

This procedure creates two clusters: one for the server nodes and one for configuration databasenodes. The nodes in the server cluster point to the servers in the configuration database cluster fortheir configuration data. The nodes in the configuration database cluster replicate their data betweeneach other.

The following diagram illustrates this installation scenario:

To install a separate database repository, you first install the configuration database on servers ina cluster, then install the server on nodes in a separate cluster. At least one configuration databasemust be running before you can install the server.

1. Place the Spectrum™ Technology Platform installer on the server where you want to install theconfiguration database.

2. Double-click installdb.exe.3. Follow the prompts to install the configuration database.


Cluster with Separated Configuration Database

4. After the installation is complete, the configuration database starts up automatically. Verify thatthe configuration database is fully started before continuing by opening the log file <SpectrumInstallation Location>/server/app/repository/logs/wrapper.log and lookingfor this message:


Do not continue until the configuration database has fully started up. If it fails to startup, troubleshoot the issue before continuing. Also, do not attempt to stop the

Important:

configuration database until after it has fully started for the first time. Stopping theconfiguration database before it performs an initial startup can cause your installationto become unusable.

5. Stop the configuration database. To stop the configuration database, right-click the Spectrum™

Technology Platform icon in theWindows system tray and select Stop Spectrum™. Alternatively,you can use the Windows Services control panel to stop the configuration database by stoppingthe Spectrum Database service.

6. Edit the file server/app/conf/spectrum-container.properties as follows:spectrum.cluster.name

• If this is the first node in the cluster, set this to any name you want to give to thecluster. Be sure that the name is unique if you have multiple clusters.

• If you are adding a node to an existing cluster, set this to the name of the clusterthat you want this node to join.

spectrum.cluster.enabled

Set this to true.




Set this to the IP address of the configuration database server you want to be usedto set up new configuration database nodes added to the cluster. The configurationdatabase from the seed server is copied to the node whenever it starts up so that itis synchronized with the cluster.

If this is the first node in the cluster you may specify seed nodes that arenot yet running. If you know the IP addresses of the nodes you want to

Note:

use as seed nodes, you may enter those now. Otherwise, you will needto return to this properties file once you have the IP addresses of theseed nodes and enter them.

You can specify multiple comma-separated IP addresses. You should specify multipleseed nodes so that if one is down others can be used to allow the node to join the



cluster. The node will attempt to access each seed node in the order listed. If noneof the seed nodes can be reached, the node will not join the cluster.

7. Save and close the spectrum-container.properties file.8. Start the configuration database. To start the configuration database, right-click the Spectrum™

Technology Platform icon in theWindows system tray and select Start Spectrum™. Alternatively,you can use the Windows Services control panel to start the configuration database by startingthe Spectrum Database service.

9. Install the configuration database on additional servers as needed to complete the configurationdatabase cluster.

10. Install the server cluster. For instructions, see Installing a Cluster on page 31.

When installing each server select the Server only option in the installer and provide thehost and port of one or more of each of the configuration database server. You can find the

Important:

port in the fileInstallationLocation\server\app\conf\spectrum-container.properties.The port is specified in the spectrum.orientdb.binary.port property.

Upgrading a Cluster with a Separated Database

Prerequisites:



This procedure describes how to upgrade Spectrum™ Technology Platformwhen you have separatedthe configuration database from the server. To upgrade an environment that has a separatedconfiguration database, you first upgrade the configuration database cluster, then the server cluster.

1. Shut down all the nodes in the server cluster and then shut down all the nodes in the configurationdatabase cluster. Make a note of the last node that you shut down in the configuration databasecluster. You must start up this node first after upgrading.

2. On the last node that you shut down in the configuration database cluster, executeinstalldb.exe. The installer upgrades the configuration database.

The first node that you upgrade must be the last node that was shut down. This isbecause on some operating systems the configuration database will start automatically

Warning:

at the end of the upgrade process. If the first node that starts up is not the last nodethat was shut down, data such as job history and configuration settings may be lost.If you do not know which node was shut down last, look in each node's wrapper log



for the time stamp of the shutdown message. You can find the wrapper log in:Spectrum Location\server\app\repository\logs\wrapper.log.

3. After the upgrade process finishes, wait for the server to start up, then stop the server.

You can see when the server has started up by opening the log file <Spectrum InstallationLocation>\server\app\repository\logs\wrapper.log and looking for this message:

INFO [Server] Pitney Bowes Spectrum(TM) Technology Platform Database(Version version build) Started


Important:

4. Run the conversion utility.

You must run the conversion utility after upgrading the configuration database clusterand before upgrading the server cluster.

Note:

Before proceeding, note the following:

• In order to run this utility, the server must have adequate disk space. The amount of free diskspace needed is three times the size of the server/app/repository/store/databasesfolder. If necessary, add disk space before proceeding.

• The conversion process may take an hour or more if you have a large configuration database.• If no conversion is necessary, the utility will display a message saying that there is nothing todo.

a) Verify that all nodes in the configuration database cluster are shut down.b) On one of the nodes, back up the following folder:

server/app/repository/store/databases

c) On the last node that was shut down in the cluster, right-click the following file and select Runas administrator:SpectrumFolder\server\bin\convert.db.bat

5. Configure clustering for the database cluster.a) Edit the file server/app/conf/spectrum-container.properties as follows:





Set this to true.








Note:


You can specify multiple comma-separated IP addresses. You should specify multipleseed nodes so that if one is down others can be used to allow the node to join thecluster. The node will attempt to access each seed node in the order listed. If noneof the seed nodes can be reached, the node will not join the cluster.

b) Save and close the spectrum-container.properties file.c) Start the last node that was shut down in the configuration database. To start the configuration

database, right-click the Spectrum™ Technology Platform icon in the Windows system trayand select Start Spectrum™. Alternatively, you can use the Windows Services control panelto start the configuration database by starting the Spectrum Database service.

The first node that you start must be the last node that was shut down. Startingup another node first may result in loss of data such as job history and configuration

Warning:

settings. If you do not know which node was shut down last, look in each node'swrapper log for the time stamp of the shutdownmessage. You can find the wrapperlog in:Spectrum Location\server\app\repository\logs\wrapper.log.

d) After the upgraded configuration database is fully started up, repeat the previous steps toupgrade each of the remaining servers in the configuration database cluster and start up eachof them.

6. Upgrade each node in the server cluster. For instructions, see Upgrading a Cluster on page47.

When installing each server select the Server only option in the installer and provide thehost and port of one or more of each of the configuration database server. You can find the

Important:

port in the fileInstallationLocation\server\app\conf\spectrum-container.properties.The port is specified in the spectrum.orientdb.binary.port property.



Any job or subflow stored in the system during a server upgrade is marked as exposed toprovide the same behavior for those jobs and subflows as before the upgrade. Any job or

Note:

subflow that is exported prior to the upgrade will not be exposed. Therefore, when importingthese jobs or subflows back into the system, you must manually expose the imported job orsubflow.

Converting to a Separated Configuration Database

Converting an existing Spectrum™ Technology Platform installation to a separated configurationdatabase enables you to take advantage of the improved scalability of a separated configurationdatabase. When you convert to a separated configuration database, your existing installation isconverted from one where the configuration database is part of the server to one where theconfiguration database is in a separate cluster.

At a high level, this is the conversion process:

• Shut down your existing Spectrum™ Technology Platform installation.• Set up the new configuration database cluster:

• Install the separate configuration database software on a new server.• Copy your existing configuration database to the new server.• Configure clustering and start up the configuration database cluster.

• Install the server-only cluster and start it up.

This procedure applies both to converting a single server to a separated configurationdatabase, and converting a cluster to a separated configuration database.

Note:

To convert to a separated configuration database:

1. (Optional) If you are upgrading to a new version as part of converting from a standard installationto a separated configuration database, upgrade your existing server. For instructions, seeUpgrading a Server on page 21 (for upgrading a single serer) or Upgrading a Cluster on page47 (for upgrading a cluster).

2. Shut down the server. If you have a clustered installation, shut down the cluster.3. Install the configuration database to a new server.

a) Place the Spectrum™ Technology Platform installer on the machine where you want to installthe configuration database. This must be a different machine from the one where you haveyour existing Spectrum™ Technology Platform server installed.

b) Double-click installdb.exe.c) Follow the prompts to install the configuration database.d) After the installation is complete, the configuration database starts up automatically. Verify

that the configuration database is fully started before continuing by opening the log file



<Spectrum Installation Location>/server/app/repository/logs/wrapper.logand looking for this message:


Do not continue until the configuration database has fully started up. If it fails tostart up, troubleshoot the issue before continuing. Also, do not attempt to stop

Important:

the configuration database until after it has fully started for the first time. Stoppingthe configuration database before it performs an initial startup can cause yourinstallation to become unusable.

e) Stop the configuration database. To stop the configuration database, right-click the Spectrum™

Technology Platform icon in the Windows system tray and select Stop Spectrum™.Alternatively, you can use the Windows Services control panel to stop the configurationdatabase by stopping the Spectrum Database service.

f) Copy the server\app\repository\store folder from your existing server to the serverwhere you installed the separate configuration database. Replace the existingserver\app\repository\store folder.

g) Run the conversion utility on the configuration database on the new configuration databaseserver.

Before running the conversion utility note the following:

• In order to run this utility, the server must have adequate disk space. The amount of freedisk space needed is three times the size of theserver/app/repository/store/databases folder. If necessary, add disk space beforeproceeding.

• The conversion process may take an hour or more if you have a large configuration database.• If no conversion is necessary, the utility will display a message saying that there is nothingto do.

To run the conversion utility:

1. Back up the following folder: server/app/repository/store/databases2. Right-click the following file and select Run as administrator:

SpectrumFolder\server\bin\convert.db.bat

h) Configure the cluster properties for the database cluster by editing the fileserver/app/conf/spectrum-container.properties as follows:spectrum.cluster.name






Set this to true.






Note:


You can specify multiple comma-separated IP addresses. You should specify multipleseed nodes so that if one is down others can be used to allow the node to join thecluster. The node will attempt to access each seed node in the order listed. If noneof the seed nodes can be reached, the node will not join the cluster.

i) Save and close the spectrum-container.properties file.j) Start the configuration database. To start the configuration database, right-click the Spectrum™

Technology Platform icon in the Windows system tray and select Start Spectrum™.Alternatively, you can use the Windows Services control panel to start the configurationdatabase by starting the Spectrum Database service.

k) Install the configuration database on additional servers as needed to complete the configurationdatabase cluster.

4. Install the server.a) (Optional) If you are upgrading to a new version and you want to use the same machine to

host the upgraded server as hosted the existing server, uninstall the existing server ofSpectrum™ Technology Platform.

b) Install the server cluster. For instructions, see Installing a Cluster on page 31.

When installing each server select the Server only option in the installer and provide thehost and port of one or more of the configuration database servers. You can find the port in

Important:

the fileInstallationLocation\server\app\conf\spectrum-container.properties.The port is specified in the spectrum.orientdb.binary.port property.



Converting from a Separated Configuration Database toa Standard Installation

If you have a cluster that consists of separate clusters for the server and for the configurationdatabase, you can convert your installation to a standard installation where the server andconfiguration database are installed together on the same server.

1. Shut down all the nodes in the server cluster and then shut down all the nodes in the configurationdatabase cluster.

2. The configuration database must be of the same version of Spectrum™ Technology Platform asthe server you are converting to. If the configuration database is from an older version, upgradethe configuration database to the same version of Spectrum™ Technology Platform as the versionyou want to use for the standard server. On the last node that you shut down in the configurationdatabase cluster, execute installdb.exe. The installer upgrades the configuration database.

The node that you upgrade must be the last node that was shut down. This is so thatdata such as job history and configuration settings are not lost. If you do not know

Warning:

which node was shut down last, look in each node's wrapper log for the time stampof the shutdown message. You can find the wrapper log in: SpectrumLocation\server\app\repository\logs\wrapper.log.

3. After the upgrade process finishes, wait for the server to start up, then stop the server.

You can see when the server has stared up by opening the log file <Spectrum InstallationLocation>\server\app\repository\logs\wrapper.log and looking for this message:

INFO [Server] Pitney Bowes Spectrum(TM) Technology Platform Database(Version version build) Started


Important:

4. Install a new server. For instructions, see Installing a New Server on page 20.

When prompted, be sure to select Standard Installation, not Server only.Note:

5. Stop the server.6. Copy the SpectrumLocation/server/app/repository/store folder from the last

configuration database server you shut down to the new server, replacing the existingSpectrumLocation/server/app/repository/store folder.

7. Start the server.



5 - SpectrumDatabasesAfter you have installed the server you need to install the databases thatsupport themodule(s) you have installed. Databases provide the informationthat Spectrum™ Technology Platform modules use to process data, suchas postal address data, name data, or geospatial data. For example, if youhave installed the Enterprise Geocoding Module, you will need to installdatabases that contain geospatial data; if you have installed the UniversalAddressing Module, you will need to install databases that contain postaldata.

In this section

Installing the Address Now Module Database 67Installing the Advanced Matching Module Database 67Installing Data Normalization Module Databases 68Installing Enterprise Geocoding Module Databases 70Installing Enterprise Routing Module Databases 73Installing Enterprise Tax Module Databases 73Installing Global Geocoding Module Databases 77Installing the Global Sentry Module Database 80Installing Location Intelligence Module Databases 82Installing Universal Addressing Module Databases 82Installing Universal Name Module Databases 84Using the Database Silent Installer 86

Installing the Address Now Module Database

1. Copy the liclcs.sbi license file provided by Pitney Bowes into the following directory:<SpectrumPlatformLocation>\server\modules\anow\license.

2. Make sure no applications are running.3. Stop Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platform

icon in the Windows task bar and select Stop Server.4. Insert the database DVD containing the database(s) you want to install.

You must install the Postal databases if you want to use the Enhanced databases.Note:

5. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Address Now Module > Address Now Data Loader.

6. The installation wizard guides you through the rest of the process.

The installation location for the Address Now directory defaults to<SpectrumPlatformLocation>\server\modules\anow. Do not change this pathor the database will not install correctly.

Note:

When prompted for the location of the Installation Media Directory, be sure to select thedirectory on the database DVD that contains the kbase folder.

Note:

You may install databases on a mapped drive, but performance will be affected since youwill be accessing them on a network rather than accessing them locally.

Note:

7. When the Data Loader is finished, start the Address Now server by going to Control Panel >Administrative Tools > Services. Right-click the Address Now Server service and select Start.

8. After the database installed, start Spectrum™ Technology Platform. To do this, right-click theSpectrum™ Technology Platform icon in the Windows system tray and select Start Spectrum™.

Installing the Advanced Matching Module Database

The Advanced Matching Module provides a load utility to install databases. The database files thatyou install depend on the databases you have licensed.

To install the Advanced Matching Module databases on Windows Server 2008 you needadministrator privileges.

Note:

1. Make sure no applications are running.


Spectrum Databases

2. Stop Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platformicon in the Windows task bar and select Stop Server.

3. Insert the database DVD or download the database from the technical support web site,www.g1.com/support.

If you download the database from the web site, it will be downloaded as a zip file. Unzipthe database before proceeding with the installation.

Note:

4. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Universal Name and Advanced Matching Modules > Database Load Utility.

5. Follow the prompts during the rest of the installation process.


Note:

6. Open the file <SpectrumDirectory>\server\bin\wrapper\wrapper.conf in a texteditor.

7. Increase the Java settings for initial heap size (wrapper.java.initmemory) and maximumheap size (wrapper.java.maxmemory) to reflect the total amount of memory required for theArabic Plus Pack and Asian Plus Pack.


8. Save and close wrapper.conf.9. Start Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platform

icon in the Windows task bar and select Start Server.

Installing Data Normalization Module Databases

The Data Normalization Module provides a load utility to install databases for the AdvancedTransformer, Open Parser, and Table Lookup components. The database files that you installdepend on the databases you have licensed. Use this list of database tables to determine whichfiles you should download and install. For more information on the tables contained in each database,refer to the reference documentation for each component.


Spectrum Databases

http://www.g1.com/support

Available DatabasesStage

Data Normalization Module - Base TablesAdvanced Transformer

Open Parser• Data Normalization Module - Base Tables• Core Names Database• Company Names Database• Arabic Plus Pack• Asian Plus Pack

Table Lookup• Data Normalization Module - Base Tables• Core Names Database• Arabic Plus Pack• Asian Plus Pack• ZREPLACE (Used by the SAPModule for French addressvalidation)

To install the Data Normalization Module databases on Windows Server 2008 you needadministrator privileges.

Note:


icon in the Windows task bar and select Stop Server.3. Insert the database DVD or download the database from the technical support web site,

www.g1.com/support.


Note:

4. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Data Normalization Module > Database Load Utility.



Note:

6. Start Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platformicon in the Windows task bar and select Start Server.


Spectrum Databases


Installing Enterprise Geocoding Module Databases

This module has several databases. You may have one or more of these, depending on the featuresyou have licensed.

International Geocoding Databases

International geocoding databases contain the data necessary to perform geocoding and reversegeocoding for locations outside the U.S. Each country has its own database, and some countrieshave optional databases that provide enhanced geocoding.

If you install multiple databases, install each database to a separate folder.Note:

To install the Enterprise Geocoding Module databases on Windows Server 2008 you needadministrator privileges.

Note:

1. Download your licensed SPD files from the Pitney Bowes eStore using the link provided in therelease announcement or welcome email.

2. Unzip the file to a temporary location.3. Place the .spd files in:

SpectrumLocation/server/app/dataimport

The SPD file is automatically extracted to:

SpectrumLocation/server/app/repository/datastorage

Once the database has been extracted to the datastorage folder, it is installed and you can defineit as a database resource using Management Console or the Administration Utility.

You can modify the Spectrum database installation process if needed:

• You can change the location of the data import directory by altering the platform property in the<SpectrumLocation>/server/app/conf/dataimportdirectories.properties file.

• You can change the location of the data storage folder by altering thespectrum.data.manager.storage.directory property in the Data Manager settings section of the<SpectrumLocation>/server/app/conf/spectrum-container.properties file.

• By default, the SPD files are deleted after the files are extracted. However, you can archive SPDfiles by setting the spectrum.data.manager.archive.data property to "true" in the Data Managersettings section of the<SpectrumLocation>/server/app/conf/spectrum-container.properties file.

AUS-GNAF


Spectrum Databases

If you installed the Australia Geocoded National Address File (G-NAF), youmust specify the GNAF123and GNAF456 as separate paths but in the same database resource in the Management Console.

GNAF123 contains the point-level dictionary. This has the highest precision of geocoding(characterized by Reliability Level 1, 2, or 3.) GNAF456 contains the remainder of address informationin G-NAF that does not meet high precision geocoding criteria (characterized by Reliability Level 4,5, or 6.)

We recommend that you use both databases to validate the existence of addresses but only useGNAF123 for parcel-level geocoding. If you do not require parcel-level geocodes you can useGNAF456 for geocoding.

U.S. Geocoding Databases

The U.S. geocoding databases contain the spatial data necessary to perform address standardizationand geocoding. You must install at least one of these databases.

• Centrus Enhanced Geocoding—This database consists of TIGER data provided by the U.S.Geological Survey and address data provided by the U.S. Postal Service.

• TomTomGeocoding—This database provides more up-to-date data than the Centrus EnhancedGeocoding database. It requires an additional license. The data is provided by TomTom, athird-party provider of spatial data, and postal data from the U.S. Postal Service.

• NAVTEQGeocoding—This database provides more up-to-date data than the Centrus EnhancedGeocoding database. It requires an additional license. NAVTEQ data is provided by NAVTEQ, athird-party provider of spatial data. For more information about these databases, contact yoursales representative.

• ZIP + 4 Centroid—This database provides only address standardization and ZIP + 4 centroidmatching. It does not provide street-level matching.

These databases use proprietary files called GSD files. For ZIP Code centroid matching, the fileus.Z9 contains all the centroid info for all states and normally has a z9 extension.

Each geocoding database has an optional Statewide Intersections Index. The Statewide IntersectionIndex is designed to enable fast intersection identification on a statewide basis. For example, theStatewide Intersection Index will allow the database to search for "1st and Main St, CO" and returna list of possible matches in Colorado more quickly than searching the entire geocoding databasefor each instance of the intersection.


Note:

1. Make sure no applications are running.2. Download the database from the Pitney Bowes Software eStore using the link provided in the

release announcement or welcome email. You can also download the database from the technicalsupport web site, www.g1.com/support.


Spectrum Databases


3. The database is downloaded as a zip file. Unzip the database before proceeding with theinstallation.

4. Run DataSets.exe. The installation wizard guides you through the rest of the process.


Note:

5. After you install the database files, use the Database Resource tool in the Management Consoleto define the database as a resource. For more information, see the Administration Guide.

Points Databases (U.S. Only)

Points databases contain data for locating the center of a parcel. These databases provides enhancedgeocoding accuracy for internet mapping, property and casualty insurance, telecommunications,utilities, and others.

• Master Location Data —This database provides the best available address point location forevery mailable and deliverable address in the United States.

• Centrus Points—This database contains the data necessary to locate the center of a parcel orbuilding. It does not contain assessor's parcel number (APN) or elevation data.

• Centrus Elevation—This database contains the same data as Centrus Points, plus elevationdata.

• Centrus Enhanced Points—This database contains the same data as Centrus Points, plus APNdata.

• Centrus Premium Points—This database contains the same data as Centrus Points, plus bothAPN and elevation data.

• TomTom Points Database—The data in this database is provided by TomTom, a third-partyprovider of spatial data.

• NAVTEQ Points—This database is provided by NAVTEQ, a third-party data provider. It containsdata used to locate addresses at the center of the actual building footprint or parcel.


Note:

1. Make sure no applications are running.2. Insert the database DVD or download the database from the technical support web site,

www.g1.com/support.

If you download the database from the Pitney Bowes web site, it will be downloaded asa zip file. Unzip the database before proceeding with the installation.

Note:

3. Run Setup.exe. The installation wizard guides you through the rest of the process.


Note:


Spectrum Databases


4. After you install the database files, use the Database Resource tool in the Management Consoleto define the database as a resource. For more information, see Spectrum™ Technology PlatformAdministration Guide.

Early Warning System (U.S. Only)

The USPS provides free Early Warning System (EWS) data to prevent matching errors due to theage of the address information in the .gsd files. The USPS creates a new EWS data set each weekthat you can download from the USPS website (ribbs.usps.gov).

To install the Early Warning System (EWS) database rename the database file fromOUT to EWS.txtand place it in the same folder as the primary database.

Installing Enterprise Routing Module Databases


www.g1.com/support.

If you download the database from the technical support web site, it will be downloadedas a zip file. Unzip the database before proceeding with the installation.

Note:

3. Run dbloader.exe.4. Follow the prompts during the rest of the installation process.


Note:

Installing Enterprise Tax Module Databases

Depending on the features you have licensed, you need to install one or more of these databases.


Spectrum Databases

http://ribbs.usps.gov


Database Compatibility

The Enterprise Tax Module version 9.0 SP2 and later uses a different data format than previousreleases. You must download and install the GeoTAX/Enterprise Tax Premium database for usein this version. The GeoTAX/Enterprise Tax Premium database is not compatible with any releasesprior to version 9.0 SP2.

Downloading Database Files

Prior to downloading the data files: If you have previously installed database files, youshould back up those files and delete any copies of the .gdi, .gsd, gsi, .gsl,.gsu, .gsz, .gsx, .z9, .dir, .las and .los files in the data install directory.

Note:

Downloading from the eStore

Use the link in your welcome email to download the zip file. Extract the files and make note of thedirectory where you save the files.

Downloading from the Technical Support Web Site

Download the database from the technical support web site, www.g1.com/support. The data filewill be downloaded as a .zip file. Extract the files and make note of the directory where you savethe files.

Downloading Florida Format Files

You can obtain the Florida format files from the Florida Department of Revenue. The FloridaDepartment of Revenue compiles the database based on county.

1. Download the files from the Florida website at:https://pointmatch.state.fl.us/General/AddressFiles.aspx/.

2. Unzip the downloaded files and transfer them to the server.

Be sure to FTP your files in binary format.Note:

3. Combine the county files into a single file if you downloaded more than one county. If youdownloaded the entire state list, you have approximately 67 files. You must combine all the filesinto one file.Your file is ready for loading.


Spectrum Databases


https://pointmatch.state.fl.us/General/AddressFiles.aspx/

Downloading TS-158 Format Files

The Federation of Tax Administrators (FTA) maintains a website with links to all data sources thatuse the TS-158 format.

1. Download the files from the Florida website at:https://pointmatch.state.fl.us/General/AddressFiles.aspx.

2. Unzip the downloaded files and transfer them to the Spectrum™ Technology Platform server.3. State files are often broken up into individual county files. Combine all state and/or county files

into a single file.Your file is ready for loading.

Database Options

The following describes the database options presented in the Windows Database Load Utility.

GeoTAX master filesThe GeoTAX/Enterprise Tax Premium Database is a required dataset and is themaster file for the Enterprise Tax Module software. The master files identify allgeographic components associated with a street address, such as thelatitude/longitude, census tract, and block group.

Point Data filesPoint Data products include Master Location Data (MLD), Centrus Points, CentrusNAVTEQ Points, and Centrus TomTom Points. The point data provides point-levelgeocoding for the most accurate placement of addresses throughout the U.S. TheMaster Location Data database provides the best available address point locationfor every mailable and deliverable address in the United States.

User auxiliary fileThis is a user-defined file that the Enterprise Tax Module uses to override resultsfrom the master files in street-level matching. If you have data that is more currentthan that in the master files, you can enter the new data into the auxiliary file and useit for your address matching. The Enterprise Tax Module returns matches made witha code that signifies the answer came from the auxiliary file. You can also returnuser-defined data from the auxiliary file with the match. The install program createsthe file G1GTAUX in the specified destination.

GeoTAX auxiliary fileThis file contains new addresses that have not yet been added to the master files. Itprovides the most up-to-date address data possible. The install program creates theindexed sequential file G1GTAX2 in the specified destination.

Landmark auxiliary fileThis is a user-defined file that allows you to specify customized address informationin your input records. The recommended primary use of this file to match to your


Spectrum Databases

https://pointmatch.state.fl.us/General/AddressFiles.aspx/

company’s non-address locations such as well heads, transmission towers or anyother descriptive location. The latitude/longitude that is part of the input needed tobuild this file allows companies to automatically keep track of any jurisdictionalchanges that affect these unique locations. Matching to this file requires that the inputrecord information match exactly to the Landmark file contents. This also applies tostreet records if you choose to enter them in the Landmark file. For more information,refer to the Enterprise Tax Module Guide.

State-supplied Florida format fileThis is a state-supplied file in Florida-native format which is provided by individualstate governments. The Enterprise Tax Module first attempts to match to the statedatabase. If the Enterprise Tax Module cannot find a state match, it attempts a matchto the GeoTAX Auxiliary file, if loaded, then to the master files.

State-supplied TS-158 format fileThis is a state-supplied file in TS-158 (ANSI Transaction Set No. 158) format whichis provided by individual state governments. The Enterprise Tax Module first attemptsto match to the state database. If the Enterprise Tax Module cannot find a statematch, it attempts a match to the GeoTAX Auxiliary file, if loaded, then to the masterfiles.

Boundary fileBoundary files provide additional data about locations of special tax districts:

• Special Purpose Tax Districts (spd.txb)• Insurance Premium Tax Districts (ipd.txb)• Payroll Tax Districts (pay.txb)• Personal Property Tax Districts (ptd.txb)• User-defined Boundary file (usr.txb)

PB Software tax rate fileThe Pitney Bowes Software Sales and Use Tax Rate file allows you to use theEnterprise Tax Module to provide sales and use tax rates for each of the assignedtax jurisdictions as well as the total rate for the assigned locations. The install programcreates the indexed sequential file GTTAXRT.

Payroll tax correspondence filePayroll tax cross-reference file allow you to use third-party software to determine thepayroll tax rates. The cross-reference files combine the U.S. Government FederalInformation Processing Standards (FIPS) codes with the proprietary geocodes usedby tax software from third parties. The Payroll System Tax Code file is a customizedfile that you build to return the payroll tax codes used by your payroll system. Theinstall program produces database files called G1GTPTC and G1GTPTC.vix.

Taxware® cross reference fileThis sales tax cross-reference file enables you to use the Enterprise Tax Module todetermine tax jurisdictions for a given address, then use Taxware® software todetermine the sales tax rates for those jurisdictions.

Vertex® cross reference file


Spectrum Databases

This sales tax cross-reference files allows you to use the Enterprise Tax module todetermine tax jurisdictions for a given address, then use Vertex® software to determinethe sales tax rates for those jurisdictions.

PB Software Vertex® cross reference fileThis is a Vertex® cross-reference file supplied by Pitney Bowes. The install programproduces a database file GTMSTR2 in the specified destination.

Installing the Database Files

1. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Enterprise Tax Module > Database Load Utility.The Database Load Utility window launches.

2. Select the database you want to install.

For Point Data, select the GeoTAX master files option.Note:

3. Follow the instructions provided by the wizard.

When specifying the destination directory:Note:

• All Enterprise Tax Module databases and cross-reference files must be installed in thesame directory.

• You may install databases on a mapped drive, but performance will be affected sinceyou will be accessing them on a network rather than accessing them locally.

4. In Management Console, open the Enterprise Tax Module database resource tool and define adatabase resource that includes the database you just installed. Be sure to update Assign GeoTAXInfo and Reverse GeoTAX Info Lookup to use the new database resource.

Installing Global Geocoding Module Databases

This module supports databases for both US and non-US countries.

Non-US Geocoding Databases

Non-US geocoding databases contain the data necessary to perform geocoding and reversegeocoding for locations outside the U.S.

If you install multiple databases, install each database to a separate folder.Note:


Spectrum Databases

To install the Global Geocoding Module databases on Windows Server 2008 you needadministrator privileges.

Note:




4. Run dbloader.exe.5. Follow the prompts during the rest of the installation process.

Do not install geocoding databases on a network drive. Doing so can cause performanceproblems.

Note:

6. After you install the database files, use either the Database Resource tool in the ManagementConsole or the Global Geocode CLI database commands to define the database as a resource.For more information, see the Administration Guide.

U.S. Geocoding Databases

The U.S. geocoding databases contain the spatial data necessary to perform address standardizationand geocoding. You must install at least one of these databases.

• TomTom Geocoding—This database provides street segment data by TomTom, a third-partyprovider of spatial data, and postal data from the U.S. Postal Service.

• NAVTEQ Geocoding—This database provides street segment data by NAVTEQ, a third-partyprovider of spatial data.

These databases use proprietary files called GSD files. For ZIP Code centroid matching, the fileus.Z9 contains all the centroid info for all states and normally has a z9 extension.

Each geocoding database has an optional Statewide Intersections Index. The Statewide IntersectionIndex is designed to enable fast intersection identification on a statewide basis. For example, theStatewide Intersection Index will allow the database to search for "1st and Main St, CO" and returna list of possible matches in Colorado more quickly than searching the entire geocoding databasefor each instance of the intersection.


Note:




Spectrum Databases




4. Run DataSets.exe. The installation wizard guides you through the rest of the process.


Note:

5. After you install the database files, use either the Global Geocoding Database Resource tool inthe Management Console or the Global Geocoding CLI database commands to define thedatabase as a resource. For more information, see the Administration Guide.

Points Databases (U.S. Only)

Points databases contain data for locating the center of a parcel. These databases provides enhancedgeocoding accuracy for internet mapping, property and casualty insurance, telecommunications,utilities, and others.

To use a points database, you must also install a streets database. See U.S. GeocodingDatabases on page 78 for the list of available US streets databases.

Note:

• Master Location Data —This database provides the best available address point location forevery mailable and deliverable address in the United States.

• Centrus Points—This database contains the data necessary to locate the center of a parcel orbuilding. It does not contain assessor's parcel number (APN) or elevation data.

• Centrus Elevation—This database contains the same data as Centrus Points, plus elevationdata.

• Centrus Enhanced Points—This database contains the same data as Centrus Points, plus APNdata.

• Centrus Premium Points—This database contains the same data as Centrus Points, plus bothAPN and elevation data.

• TomTom Points—The data in this database is provided by TomTom, a third-party provider ofspatial data.

• NAVTEQ Points—This database is provided by NAVTEQ, a third-party data provider. It containsdata used to locate addresses at the center of the actual building footprint or parcel.


Note:


www.g1.com/support.


Note:


Spectrum Databases


3. Run Setup.exe. The installation wizard guides you through the rest of the process.


Note:

4. After you install the database files, use either the Global Geocoding Database Resource tool inthe Management Console or the Global Geocoding CLI database commands to define thedatabase as a resource. For more information, see the Administration Guide.

Installing the Global Sentry Module Database

The following databases are required to run Global Sentry in real-time mode:

• globalsentrydb.script• globalsentrydb.properties

The following databases are required to run Global Sentry in batch mode:

• globalsentrydb.script• globalsentrydb.properties• globalsentrydb.addresses.csv• globalsentrydb.fullnames.csv• globalsentrydb.ids.csv• globalsentrydb.names.csv

In addition, you must install the Data Normalization Module databases to use Global Sentry. Forinstructions, see Installing Data Normalization Module Databases on page 68.

1. Open the Windows services control panel and stop the service Global Sentry Database Server.2. Stop Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platform


www.g1.com/support.


Note:

4. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Global Sentry Module > Database Load Utility.



Note:


Spectrum Databases


6. Start Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platformicon in the Windows task bar and select Start Server.

7. Open the Windows services control panel and start the service Global Sentry Database Server.8. After installing the Global Sentry Module database, you must configure a JDBC connection in

the Spectrum™ Technology Platform Management Console. Go to Start > Settings > ControlPanel > Administrative Tools > Services to verify that the Global Sentry Database is running.

9. Open Management Console by clicking Start > Programs > Pitney Bowes > Spectrum™

Technology Platform > Client Tools > Management Console.10. Under Resources, select JDBC Drivers.11. Click Add.12. Type the JDBC properties in the applicable text box:

• JDBC driver configuration name: HSQLDB• JDBC driver class name: org.hsqldb.jdbcDriver• Connection string template: jdbc:hsqldb:hsql://${host}:${port}/${instance}

13. Add the following driver file:file:<SpectrumPlatformLocation>/GlobalSentryDatabase/lib/hsqldb.jar

14. Add the following Connection properties:a) Click Add. In the JDBC Connection property dialog box, type "Password" in both the Label

and the Property Token fields and click OK.b) Click Add. In the JDBC Connection property dialog box type "User" in the Label and the

Property Token fields and click OK.

15. Click OK.16. Under Resources, click Connections.17. Click Add.18. Define the following connection properties:

• Connection name: Global Sentry• Database driver: select the HSQLDB JDBC driver that you created in the previous steps.

19. Enter the following values in the Connection Properties dialog box:

• user: sa• password: <there is no password>• host: localhost or <your server name>• port: 9001• instance: globalsentrydb

20. Click Test to verify the connection works.21. Click OK, then click OK again.


Spectrum Databases

Installing Location Intelligence Module Databases

1. Place the data on the file system, or install the data into a database.2. Use Spatial Manager to define Location Intelligence Module database resources (named

connections and tables). For more information, see the "Configuring Database Resources" chapterof the Spectrum™ Technology Platform Administration Guide on support.pb.com.

Installing Universal Addressing Module Databases

This procedure describes how to install databases used by Get Candidate Addresses, Get CityState Province, Get Postal Codes, Validate Address, and Validate Address AUS. For instructionson installing databases used by Validate Address Global, see Installing Validate Address GlobalDatabases on page 83. For instructions on installing databases used by Validate Address Loqate,see Installing Validate Address Loqate Databases on page 83.

To install the Universal Addressing Module databases on Windows Server 2008 you needadministrator privileges.

Note:




4. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Universal Addressing Module > Database Load Utility.



Note:

6. If you choose to install Residential Delivery Indicator, an optional database that you licensedirectly from the U.S. Postal Service, you are prompted for the nine-digit RDI table and theeleven-digit RDI table. These are called rts.hs9 and rts.hs11, respectively, and they are providedby the U.S. Postal Service.


Spectrum Databases

http://support.pb.com/ekip/index?page=product_content&cat=SC_SPECTRUM_TECHNOLOGY_PLATFORM


Installing Validate Address Global Databases

This procedure describes how to install the databases used by the Validate Address Global stage.For instructions on installing databases used by other Universal Addressing Module stages, seethe Spectrum™ Technology Platform Administration Guide.

1. Download the database from the Pitney Bowes Software eStore using the link provided in therelease announcement or welcome email. You can also download the database from the technicalsupport web site, www.g1.com/support.


3. Unzip the database file to the location you want. The database zip files are:

• VAGlobal-EMEA.zip—Contains the data for Europe, Middle East, and Africa.• VAGlobal-APAC.zip—Contains the data for Asia-Pacific.• VAGlobal-Americas.zip—Contains the data for the Americas.

You may install databases on a network share, but performance will be affected sinceyou will be accessing them on a network rather than accessing them locally.

Note:

4. Stop Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platformicon in the system tray and select Stop Spectrum™.

5. Install the unlock code:a) Open the following file in a text editor:

<SpectrumLocation>\server\modules\addressglobal\conf\unlockcodes.txt

b) Enter your unlock codes, one per line.c) Save and close the file.

6. Start Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platformicon in the system tray and select Start Spectrum™.

Installing Validate Address Loqate Databases

This procedure describes how to install the databases used by the Validate Address Loqate stage.For instructions on installing databases used by other Universal Addressing Module stages, seethe Spectrum™ Technology Platform Administration Guide.

1. Download the database from the Pitney Bowes Software eStore using the link provided in therelease announcement or welcome email. You can also download the database from the technicalsupport web site, www.g1.com/support.



Spectrum Databases



3. Unzip the database file(s) to the location you want. If you are installing data from multiple zipfiles or discs, be sure to unzip them all to the same location. The database zip files are:

• LQ0/DB_Setup—Contains general database setup files.

Regardless of which set of data you use, the files in LQ0 must be installed.Note:

• LQ1/APAC_AFR_ME-I—Contains the data for Asia-Pacific, Africa, and Middle East.• LQ2/Americas-I—Contains the data for the Carribbean, Central America, and South America.• LQ3/Europe-I—Contains the data for Eastern and parts of Western Europe.• LQ4/Americas-II—Contains the data for parts of North America.• LQ5/Europe-II—Contains the data for parts of Western Europe.• LQ6/Americas-III—Contains the data for parts of North America.• LQ7/APAC_AFR_ME-II—Contains the data for parts of Asia-Pacific, Africa, and Middle East.• LQ8/Europe-III—Contains the data for parts of Western Europe.• LQ9/Australia—Contains the data for Australia.

4. From the location where you extracted the database files, right-click install.bat and select Runas administrator. This will launch the Loqate Installer.

Except general database setup files (LQ0), all the other data files are placed inside theDATA folder.

Note:

5. Follow the prompts during the rest of the installation process.6. From the location where you installed the Loqate database, click InstallData.bat. This will launch

the Installation manager that installs the data files.

Installing Universal Name Module Databases

The Universal Name Module provides a load utility to install databases. The database files that youload depend on the databases you have licensed.

To install the Universal Name Module databases on Windows Server 2008 you needadministrator privileges.

Note:



www.g1.com/support.


Note:


Spectrum Databases


4. Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform > Modules >Universal Name and Advanced Matching Modules > Database Load Utility.

5. Follow the prompts to complete the installation process. The database files are you can installare:

• Arabic Plus Pack: g1-cdq-cjki-arabic-<date>.jar• Asian Plus Pack - Chinese: g1-cdq-cjki-chinese-<date>.jar• Asian Plus Pack - Japanese: g1-cdq-cjki-japanese-<date>.jar• Asian Plus Pack - Korean: g1-cdq-cjki-korean-<date>.jar• Core Names Database: g1-cdq-nomino-base-<date>.jar


Note:

6. To load the complete Core Names Database, you must also install Open Parser and Table Lookupdata from the Data Normalization Module Database Load Utility.a) Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform >Modules >

Data Normalization Module > Database Load Utility > Open Parser.b) Follow the prompts to complete the installation process. The database file you need to install

is:

• cdq-OpenParser-EnhancedNames.tba

c) Select Start > Programs > Pitney Bowes > Spectrum™ Technology Platform >Modules >Data Normalization Module > Database Load Utility > Table Lookup.

d) Follow the prompts to complete the installation process. The database file you need to installis:

• cdq-TableLookup-EnhancedGenderCodes.tba

7. Open the file <SpectrumDirectory>\server\bin\wrapper\wrapper.conf in a texteditor.

8. Increase the Java settings for initial heap size (wrapper.java.initmemory) and maximumheap size (wrapper.java.maxmemory) to reflect the total amount of memory required for theArabic Plus Pack and Asian Plus Pack.


9. Save and close wrapper.conf.10. Start Spectrum™ Technology Platform. To do this, right-click the Spectrum™ Technology Platform

icon in the Windows task bar and select Start Server.


Spectrum Databases

Using the Database Silent Installer

The silent install process allows you to pre-configure the database installation process so that itruns without user intervention. Instead of responding to prompts from the installation process forinformation such as the installation location, you specify these responses in a properties file thatthe installer uses instead of user prompts.

Using the Loqate Database Silent Installer

1. In the Spectrum™ Technology Platform server installer (not the database installer), browse tothe SilentInstaller folder.

2. Using a text editor, open the uam_loqate.installer.properties file.3. Edit the properties file as necessary to specify the installation settings you want to use. See the

comments in the properties file for additional information.4. To run the installer in silent mode, place the properties file in any directory except the location

where you are going to install the Loqate data and give the absolute path to the property in thecommand prompt, as follows:

install.bat %PathOfPropertyFile%\uam_loqate.installer.properties


Spectrum Databases

6 - Client Tools

In this section

Installing the Client Tools 88Installing Enterprise Designer with a Silent Installer 89Upgrading Enterprise Designer 90Removing Enterprise Designer 90

Installing the Client Tools

The Spectrum™ Technology Platform client tools are applications that you use to administer yourserver and design and run dataflows and process flows. Youmust install your Spectrum™ TechnologyPlatform server before installing the client tools.

Before installing, be sure to read the release notes. The release notes contains important compatibilityinformation as well as release-specific installation notes.

This procedure describes how to install the following client tools:

• Enterprise Designer— Use Enterprise Designer to create, modify, and run dataflows.• Job Executor—Job Executor is a command line tool that allows you to run a job from a commandline or script. The job must have been previously created and saved on Spectrum™ TechnologyPlatform using Enterprise Designer.

• Process Flow Executor—Process Flow Executor is a command line tool that allows the executionof a process flow from a command line or script. The process flow must have been previouslycreated and saved on Spectrum™ Technology Platform using Enterprise Designer.

• Administration Utility—The Administration Utility provides command line access to severaladministrative functions. You can use it in a script, allowing you to automate certain administrativetasks. You can also use it interactively.

As of Spectrum version 11.0, Management Console is a web-based tool rather than installableclient as it was in previous releases.

Note:

To install the client tools:

1. Open a web browser and go to the Spectrum™ Technology Platform Welcome Page at:

http://<servername>:<port>

For example, if you installed Spectrum™ Technology Platform on a computer named"myspectrumplatform" and it is using the default HTTP port 8080, you would go to:

http://myspectrumplatform:8080

2. Click Platform Client Tools.3. Download the client tool you want to install.


Client Tools

Installing Enterprise Designer with a Silent Installer

The silent install process installs Enterprise Designer without user intervention. Instead of promptingthe user for information such as the installation location, the installer uses pre-configured selectionsthat you specify.

To use the silent installer you must first create an installer properties file by running the client installerand responding to the prompts. The resulting properties file can then be used to silently installEnterprise Designer on other computers.

1. Open a web browser and go to the Spectrum™ Technology Platform Welcome Page at:

http://<servername>:<port>

For example, if you installed Spectrum™ Technology Platform on a computer named"myspectrumplatform" and it is using the default HTTP port 8080, you would go to:

http://myspectrumplatform:8080

2. Click Platform Client Tools.3. Click Download Installer.4. Choose to save the file to a location on your computer.

Save the installer on aWindows computer that does not already have Enterprise Designerinstalled. You will need to run the installer in order to specify the options you want to usein the silent install process.

Note:

5. Open a Windows command prompt.6. In the command prompt, change directories to the directory where you saved the installer.7. Execute the following command:

Setup.exe -r installer.properties

8. Respond to the installer prompts by selecting the options that you want to use when the installerruns silently.

For example, if you want the silent installer to install Enterprise Designer toC:\Spectrum\EnterpriseDesigner, specify C:\Spectrum\EnterpriseDesignerwhenprompted for an installation folder.

When the installer finishes running, a properties file named installer.properties is createdin the same folder as the Setup.exe file.

9. Open the installer.properties file in a text editor.


Client Tools

10. Add the following on line 8 of the file:

INSTALLER_UI=silent

This is case sensitive to be sure to enter it exactly as shown above.Note:

11. Save and close the properties file.

You have now configured a properties file that will enable you to install Enterprise Designersilently.

12. To install Enterprise Designer silently, place installer.properties and Setup.exe in thesame folder on the computer where you want to install Enterprise Designer and run Setup.exe.When the installer executes it will detect installer.properties and automatically run insilent mode.

Alternatively, you can place installer.properties in different directory and give the absolutepath to the property in the command prompt using the -f argument, as follows:

Setup.exe -f PathOfPropertyFile\installer.properties

Upgrading Enterprise Designer

Due to security updates in Spectrum™ Technology Platform 11.0, you must remove prior versionsof Enterprise Designer and install the updated version of Enterprise Designer. You cannot upgradeyour existing Enterprise Designer installation. You must remove it and install the new version. Priorversions of Enterprise Designer cannot log in to the Spectrum™ Technology Platform 11.0 server.

Removing Enterprise Designer

1. Back up any files you may need in the future.2. Use the Windows Add/Remove Programs control panel to uninstall Enterprise Designer.


Client Tools

7 - Client API

In this section

Installing the Client API 92Removing the Client API 92

Installing the Client API

The Client API is used to integrate Spectrum™ Technology Platform functionality into yourapplications. If you will be creating your own program to call Spectrum™ Technology Platform, youneed to install the Spectrum™ Technology Platform Client API on the system where you will bedeveloping your application. The Client API allows access to Spectrum™ Technology Platformthrough several programming languages, including Java, C++, and web services.

1. Open the folder where you have downloaded the Spectrum™ Technology Platform Client APIinstaller.

2. Double-click the sdkinst.exe file.3. The installer guides you through the installation process.

Removing the Client API

Use the Windows Add/Remove Programs control panel to uninstall the Spectrum™ TechnologyPlatform Client API.


Client API

8 - SAP, Siebel, andMicrosoft Dynamics

In this section

Configuring SAP 94Configuring Siebel 106Configuring Microsoft Dynamics CRM 151

Configuring SAP

Integrating with SAP Web Dynpro

Before continuing verify the following:

• SAP Application, SAP NetWeaver 7.01 with Patch 3 and Spectrum™ Technology Platform isavailable

• PBS SCA files have been deployed.• System Landscape Directory (SLD) has been properly configured

To integrate Spectrum™ Technology Platform with SAP Web Dynpro, you need to install supportingdatabases and dataflows on the Spectrum™ Technology Platform server, and then configure yourSAP system to communicate with Spectrum™ Technology Platform. Once you do this, users of SAPWeb Dynpro will have access to address validation and geocoding functionality from within SAPWeb Dynpro.

1. On the Spectrum™ Technology Platform server, install the databases required to perform addressvalidation, geocoding, and tax jurisdiction assignment and define database resources for eachdatabase.

You must give the database resources the following names.

Required Name for Database ResourceDatabase

IGEO_CANEnterprise Geocoding Module - Canada Database

EGM_USEnterprise Geocoding Module - U.S. Database

ETMEnterprise Tax Module Database

CanadaUniversal Addressing Module - Canada Database

LoqateUniversal Addressing Module - Loqate Database

UAM_USUniversal Addressing Module - U.S. Database

2. When you install the SAPModule, several dataflow files are automatically installed. Other dataflowfiles must be manually copied into Spectrum™ Technology Platform.


SAP, Siebel, and Microsoft Dynamics

a) If you are adding the Address Now Module, Enterprise Tax Module, or Universal AddressingModule to an existing installation, open Spectrum™ Technology Platform Enterprise Designer,select View > Server Explorer, and delete this dataflow: SAPValidateAddressWithCandidates.

b) Go to: SpectrumFolder\server\modules\dataflows\sap.c) Review the following table then copy the applicable dataflow files to:

SpectrumFolder\server\app\import

Copy these dataflow files to the import folderIf you are installing this set ofmodules

SAPValidateAddressWithCandidates.ANOW.dfAddress Now Module

SAPGenerateCASSReport.dfSAPValidateAddressWithCandidates.ANOW.dfSAPValidateAddressWithCandidates.UAM.df

Address Now ModuleUniversal Addressing Module

SAPValidateAddressWithCandidates.ANOW_EGM.dfAddress Now ModuleEnterprise Geocoding Module

SAPValidateAddressWithCandidates.UAM_ANOW_EGM.dfAddress Now ModuleEnterprise Geocoding ModuleUniversal Addressing Module

SAPAssignGeoTAXInfo.dfSAPBatchAssignGeoTAXInfo.df

Address Now ModuleEnterprise Tax ModuleUniversal Addressing Module SAPGenerateCASSReport.df

SAPValidateAddressAndAssignGeoTAXInfo.dfSAPValidateAddressWithCandidates.UAM_ANOW_ETM.df

SAPValidateAddressWithCandidates.UAM_ANOW_ETM_EGM.dfAddress Now ModuleEnterprise Geocoding ModuleEnterprise Tax ModuleUniversal Addressing Module

SAPGenerateCASSReport.dfSAPValidateAddressWithCandidate_UAM.df

Universal Addressing Module withoutLoqate





Universal Addressing Module withoutLoqateEnterprise Tax Module SAPGenerateCASSReport.df

SAPValidateAddressAndAssignGeoTAXInfo.dfSAPValidateAddressWithCandidates.UAM_ETM.df

ValidateAddressWithCandidates_UAM_Loqate.dfUniversal Addressing Module withLoqate

ValidateAddressWithCandidates_UAM_Loqate_EGM.dfUniversal Addressing Module withLoqateEnterprise Geocoding Module

ValidateAddressWithCandidates_UAM_Loqate_ETM.dfUniversal Addressing Module withLoqateEnterprise Tax Module

ValidateAddressWithCandidates_UAM_Loqate_EGM_ETM.dfUniversal Addressing Module withLoqateEnterprise Geocoding ModuleEnterprise Tax Module

ValidateAddressWithCandidates_Loqate.dfUniversal Addressing Module, Loqateonly

ValidateAddressWithCandidates_Loqate_EGM.dfUniversal Addressing Module, LoqateonlyEnterprise Geocoding Module

GeocodeUSAddressWithCandidates.dfValidateAddressWithCandidates_EGM.df

Enterprise Geocoding Module

ValidateAssignGeoTAXInfo.dfValidateAddressWithCandidates_ETM.dfSAPBatchAssignGeoTAXInfo.df

Enterprise Tax Module



If errors occur in Management Console or Enterprise Designer, delete the contents of<WindowsTemporaryDirectory>\g1Assemblies, where

Note:

<WindowsTemporaryDirectory> is one of the following: %TMP%, %TEMP%,%USERPROFILE%, or the Windows directory. Typically, C:\Documents andSettings\<USERNAME>\Local Settings\Temp\g1Assemblies. After you delete thecontents of this folder log in again.

3. Import .SAR files.

A .SAR file is a file that contains a third-party add-on package for SAP, such as the Spectrum™

Technology Platform SAP Module. The .SAR file is located on the Spectrum™ TechnologyPlatform installer in the SAP Objects folder. For information on importing .SAR files into SAPapplications, see your SAP Basis administrator.

4. Activate the BC sets.a) Log-on to the client where the settings for the Spectrum™ Technology Platform SAP Module

is to be configured.b) Enter the transaction code SCPR20.

This activates Business Configuration (BC) sets. This will place the default entries on theSpectrum™ Technology Platform customizing tables.

c) In the BC Set field, enter /HSGRP1/BCSET_BC_BAS_PV.d) Activate it with the options Overwrite All Data and Default Mode.

e) Select and activate the remaining BC sets with the activation options set to Overwrite AllData and Expert Mode.

Active these BC sets in the order listed.Note:

/HSGRP1/BCSET_BC_BAS_GTX



/HSGRP1/MERGE_SETTINGS/HSGRP1/BCSET_BUPA_CUSTOM/HSGRP1/BCSET_BC_BAS_DES/HSGRP1/BCSET_VENDOR

5. Set up the RFC destination.a) Enter transaction code SM59.b) Click Create.c) In the RFC Destination field, enter a name of your choice.d) In the Connection Type field, enter G (HTTP connection to external server).e) In the Description 1 field, enter a meaningful description.f) Press the Enter key.g) Click the Technical Settings tab.h) In the Target Host field, enter the computer name or IP Address of the Spectrum™ Technology

Platform server.i) In the Service No field enter 8080.j) Click the Special Options tab.k) Select No Timeout.l) Select HTTP 1.1.m) After you save, click Connection Test.

If there is a pop-up window, check the Accept All Further Cookies box and selectYES.

Note:

n) When the test is successful, go to theResponse Body tab to view the Spectrum™ TechnologyPlatform page.

6. Set up the Spectrum™ Technology Platform Logging Objecta) Enter transaction code SLG0.b) Click New Entries.c) In the Object column, enter /HSGRP1/DQC.d) In the Object text column, enter DQC Logging.e) Save the change.

7. Set up JCO destinations:a) Go to the NetWeaver Portal Content Administrator URL and log in as J2EE_ADMIN or an

account that has an Administrator Privilege.b) Expand Deployed Content, then pb.com, then pb.com/dqc. On the Details window, select

the JCO Connections tab.c) SelectWD_DQC_MODELDATA_DEST and clickCreate. Complete all the required information

to be able to run and test the connection.d) Repeat the steps and complete the required information for WD_DQC_MODELDATA_DEST.



WD_DQC_MODELDATA_DEST is the Application Data andWD_DQC_RFC_METADATA_DEST is the Dictionary Metadata.

Note:

8. Configure the BuildGlobalAddress web service in the SAP Visual Admin:a) Go to <drive>:/usr./sap/<system id>/DVEBMGS01/ j2ee/admin and click go.bat and enter

J2EE_ADMIN password.b) Go to Cluster > Server > Services > JCo RFC Provider and select the Bundles tab.c) Enter all of the information needed by the application and click Set to save the changes.d) Go to Cluster > Server > Services > Web Services Security.e) Create a proxy in Web Services Client > sap.com > Dynamic WSProxies with the name

PBBIWebServiceConnectorBGA.f) For the URL, enter:

http://<spectrumservername>:<port>/soap/BuildGlobalAddress?wsdl

For example,

http://MySpectrumServer:8080/soap/BuildGlobalAddress?wsdl

g) Restart the application server.

9. If you will be using French address validation, you must install the Data Normalization Moduletable cdq-TableLookup-SAP.tba on the Spectrum™ Technology Platform server. For moreinformation, see the Spectrum™ Technology Platform Installation Guide.

Integrating with SAP Interaction Center WebClient

Before continuing verify the following:

• The Interaction Center WebClient user has the CRM_UI_PROFILE parameter ID with IC_AGENTas the Parameter Value

• The duplicate option is activated in SPRO under ICWC (SPRO > CRM > ICWC > Define AccountIdentification Profiles)

To integrate Spectrum™ Technology Platform with SAP Interaction Center WebClient, you need toinstall supporting databases and dataflows on the Spectrum™ Technology Platform server, andthen configure your SAP system to communicate with Spectrum™ Technology Platform. Once youdo this, users of SAP Interaction Center WebClient will have access to address validation andgeocoding functionality from within SAP Interaction Center WebClient.












2. When you install the SAPModule, several dataflow files are automatically installed. Other dataflowfiles must be manually copied into Spectrum™ Technology Platform.a) If you are adding the Address Now Module, Enterprise Tax Module, or Universal Addressing

Module to an existing installation, open Spectrum™ Technology Platform Enterprise Designer,select View > Server Explorer, and delete this dataflow: SAPValidateAddressWithCandidates.

b) Go to: SpectrumFolder\server\modules\dataflows\sap.c) Review the following table then copy the applicable dataflow files to:



SAPValidateAddressWithCandidates.ANOW.dfAddress Now Module

SAPGenerateCASSReport.dfSAPValidateAddressWithCandidates.ANOW.dfSAPValidateAddressWithCandidates.UAM.df


SAPValidateAddressWithCandidates.ANOW_EGM.dfAddress Now ModuleEnterprise Geocoding Module

SAPValidateAddressWithCandidates.UAM_ANOW_EGM.dfAddress Now ModuleEnterprise Geocoding ModuleUniversal Addressing Module





Address Now ModuleEnterprise Tax ModuleUniversal Addressing Module SAPGenerateCASSReport.df

SAPValidateAddressAndAssignGeoTAXInfo.dfSAPValidateAddressWithCandidates.UAM_ANOW_ETM.df

SAPValidateAddressWithCandidates.UAM_ANOW_ETM_EGM.dfAddress Now ModuleEnterprise Geocoding ModuleEnterprise Tax ModuleUniversal Addressing Module

SAPGenerateCASSReport.dfSAPValidateAddressWithCandidate_UAM.df

Universal Addressing Module withoutLoqate


Universal Addressing Module withoutLoqateEnterprise Tax Module SAPGenerateCASSReport.df

SAPValidateAddressAndAssignGeoTAXInfo.dfSAPValidateAddressWithCandidates.UAM_ETM.df


ValidateAddressWithCandidates_UAM_Loqate_EGM.dfUniversal Addressing Module withLoqateEnterprise Geocoding Module








GeocodeUSAddressWithCandidates.dfValidateAddressWithCandidates_EGM.df

Enterprise Geocoding Module

ValidateAssignGeoTAXInfo.dfValidateAddressWithCandidates_ETM.dfSAPBatchAssignGeoTAXInfo.df

Enterprise Tax Module

If errors occur in Management Console or Enterprise Designer, delete the contents of<WindowsTemporaryDirectory>\g1Assemblies, where

Note:

<WindowsTemporaryDirectory> is one of the following: %TMP%, %TEMP%,%USERPROFILE%, or the Windows directory. Typically, C:\Documents andSettings\<USERNAME>\Local Settings\Temp\g1Assemblies. After you delete thecontents of this folder log in again.

3. Import .SAR files.

A .SAR file is a file that contains a third-party add-on package for SAP, such as the Spectrum™

Technology Platform SAP Module. The .SAR file is located on the Spectrum™ TechnologyPlatform installer in the SAP Objects folder. For information on importing .SAR files into SAPapplications, see your SAP Basis administrator.

4. Activate the BC sets.a) Log-on to the client where the settings for the Spectrum™ Technology Platform SAP Module

is to be configured.b) Enter the transaction code SCPR20.

This activates Business Configuration (BC) sets. This will place the default entries on theSpectrum™ Technology Platform customizing tables.

c) In the BC Set field, enter /HSGRP1/BCSET_BC_BAS_PV.d) Activate it with the options Overwrite All Data and Default Mode.



e) Select and activate the remaining BC sets with the activation options set to Overwrite AllData and Expert Mode.

Active these BC sets in the order listed.Note:

/HSGRP1/BCSET_BC_BAS_GTX/HSGRP1/MERGE_SETTINGS/HSGRP1/BCSET_BUPA_CUSTOM/HSGRP1/BCSET_BC_BAS_DES/HSGRP1/BCSET_VENDOR

5. Activate the following BC set with activation options set toOverwrite All Data and Expert Mode.

/HSGRP1/BCSET_DQC_CUSTOM

6. Activate the BC set for IC WebClient. The BC set is /HSGRP1/ICWC_SETTINGS. Specify theactivation options Overwrite Data and Expert Mode.

7. Set up the RFC destination.a) Enter transaction code SM59.b) Click Create.c) In the RFC Destination field, enter a name of your choice.d) In the Connection Type field, enter G (HTTP connection to external server).e) In the Description 1 field, enter a meaningful description.f) Press the Enter key.g) Click the Technical Settings tab.h) In the Target Host field, enter the computer name or IP Address of the Spectrum™ Technology

Platform server.i) In the Service No field enter 8080.j) Click the Special Options tab.



k) Select No Timeout.l) Select HTTP 1.1.m) After you save, click Connection Test.

If there is a pop-up window, check the Accept All Further Cookies box and selectYES.

Note:

n) When the test is successful, go to theResponse Body tab to view the Spectrum™ TechnologyPlatform page.

8. Set up the Spectrum™ Technology Platform Logging Objecta) Enter transaction code SLG0.b) Click New Entries.c) In the Object column, enter /HSGRP1/DQC.d) In the Object text column, enter DQC Logging.e) Save the change.

9. Enable the Pitney Bowes IC WebClient Enhancement Set.a) Enter the transaction code SM30.b) In the Table/View field, enter BSPWDV_EHSET_ASG.c) Click Maintain.d) Click New Entriese) In the Client field, enter the client number where the enhancement set will take effect.f) In the Enhancement Set field, enter /HSGRP1/ENHANCEMENT_SET.

10. Add the IC WebClient Configurations.a) Enter the transaction code BSP_WD_CMPWB.b) In the Component field, enter ICCMP_DETAIL.c) Click the check icon.d) In the Enhancement Set field, enter /HSGRP1/ENHANCEMENT_SET.e) Click Display.f) Expand the Views folder and select

/HSGRP1/BUPA_CMP_VIEW/BuPaDetailSelectDuplCustomer.



g) Click the Configuration tab.h) On the edit screen select Full Name, Telephone, Street, City and Country context then click

the right arrow button and arrange them in this order:

Full NameTelephoneStreetCityCountry

i) Save the configuration.

11. If you will be using French address validation, you must install the Data Normalization Moduletable cdq-TableLookup-SAP.tba on the Spectrum™ Technology Platform server. For moreinformation, see the Spectrum™ Technology Platform Installation Guide.

Installing Support Files for Read from SAP

The Read from SAP stage reads data from an SAP database as input to a Spectrum™ TechnologyPlatform dataflow. In order for the Read from SAP stage to access data in your SAP system youmust make the following changes on your SAP system:

• Install the SAP Java Connector• Install the SAP Transport Requests that support Read from SAP

You will not be able to use the Read form SAP stage until you perform these steps.Note:

1. Install the SAP Java Connector (SAP JCo).a) Go to service.sap.com/connectors and log in with your SAP Marketplace credentials.b) Go to SAP JCo Connector > Tools & Services.c) Download SAP JCo to your system.d) Unzip the SAP JCo zip file to a temporary location.e) Stop the Spectrum™ Technology Platform server.f) Copy the .jar file to the following folder on the Spectrum™ Technology Platform server:

SpectrumFolder\server\app\lib

g) Copy the .dll file to the following folder on the Spectrum™ Technology Platform server:SpectrumFolder\server\bin\wrapper

h) Start the Spectrum™ Technology Platform server.

2. Install the SAP Transport Requests that support Read from SAP.

The following steps should be performed by your SAP Basis administrator.Note:



http://service.sap.com/connectors

a) In the Spectrum™ Technology Platform installer, go to the folder AP Data IntegrationObjects\Enterprise System Connectors.

b) Deploy the SAP Transport Requests contained in this folder. See your SAP documentationfor instructions on deploying SAP Transport Requests.

Configuring Siebel

Integrating with Siebel Data Quality

To integrate Spectrum™ Technology Platform with Siebel Data Quality, you need to install supportingdatabases and dataflows on the Spectrum™ Technology Platform server, and then configure yourSiebel system to communicate with Spectrum™ Technology Platform. Once you do this, users ofSiebel Data Quality will have access to address validation and geocoding functionality from withinSiebel Data Quality.










2. When you install the Siebel module, several dataflow files are automatically installed. Otherdataflow files must be manually copied into the Spectrum™ Technology Platform server.



a) Browse to one of the following folders on your Spectrum™ Technology Platform server:

• For Siebel Business Applications, go to:<SpectrumPlatformLocation>\server\modules\dataflows\siebel\sea

• For Siebel Industry Applications, go to:<SpectrumPlatformLocation>\server\modules\dataflows\siebel\sia

b) Review the following table then copy the applicable dataflow files to:

SpectrumLocation\server\app\import

Table 1: Dataflow Files To Import


SiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.ADN.df

Address Now Module only

SiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.UAM_ADN.df


GeocodeUSAddressWithCandidates.dfSiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.EGM_ADN.df

Address Now ModuleEnterprise Geocoding Module

GeocodeUSAddressWithCandidates.dfSiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.UAM_EGM_ADN.df

Address Now ModuleEnterprise Geocoding ModuleUniversal Addressing Module

GeocodeUSAddressWithCandidates.dfValidateAddressWithCandidates.UAM.df

Universal Addressing Module only

GeocodeUSAddressWithCandidates.dfValidateAddressWithCandidates.UAM_EGM.df

Universal Addressing ModuleEnterprise Geocoding Module

GeocodeUSAddressWithCandidates.dfValidateAssignGeoTAXInfo.dfValidateAddressWithCandidates_UAM_ETM.df

Universal Addressing ModuleEnterprise Tax Module




ValidateAddressWithCandidates_UAM_Loqate.dfUniversal Address Module with Loqate

ValidateAddressWithCandidates_Loqate_EGM.dfUniversal Addressing Module withLoqateEnterprise Geocoding Module





ValidateAddressWithCandidates.EGM.dfEnterprise Geocoding Module

ValidateAssignGeoTAXInfo.dfEnterprise Tax Module

If errors occur in Management Console or Enterprise Designer, delete the client cache.To delete the client cache, go to Tools >Options in Management Console or Enterprise

Note:

Designer, click the Advanced tab, then click Clear Cache. After you clear the cache,restart Management Console or Enterprise Designer.

3. Optional: If you are using the Enterprise Geocoding Module, configure the geocoding dataflowto use the geocoding database resource name you have configured on your system:



a) In Enterprise Designer, open the dataflow GeocodeUSAddressWithCandidates.b) In each dataflow, open the Geocode US Address stage.c) In the Database field, select the name of the geocoding database as defined in the

Management Console. The default name is KGDDatasource but if the geocoding databasehas a different name on your system, select the appropriate name.

For more information about database resources, see the Spectrum™ TechnologyPlatform Administration Guide.

Note:

d) Save and close each dataflow.

4. Copy Siebel objects to your system:a) Browse to the location where you downloaded the Spectrum™ Technology Platform installer.b) Browse to the appropriate folder for your version of Siebel as shown in the following table.

FolderSiebel Version

Siebel Objects\8.0\Business\SDQSiebel Business Applications 8.0 SDQ

Siebel Objects\8.1.1\Business\SDQSiebel Business Applications 8.1.1 SDQ

Siebel Objects\8.0\Industry\SDQSiebel Industry Applications 8.0 SDQ

Siebel Objects\8.1.1\Industry\SDQSiebel Industry Applications 8.1.1 SDQ

c) Copy the contents of the folder to a temporary directory.

This temporary folder will be the referred to as <Spectrum Package> in the followingsteps.

Note:

5. Create objects and allow object locking:a) Log in to Siebel Tools as the user SADMIN. In the Connect to field select Server.b) In the Object Explorer, click Project.c) Create three new records using the following values in the Name column. To create a new

record, right-click in the Projects area and select New Record.

Group 1 Data QualityGroup 1 EAI TestingGroup 1 Workflow

d) Open the file <Spectrum Package>\tools\CDQP_Queries.txt.e) Copy and paste the query contents to the Project list of your Object Manager. Cross-check

the query result with the table below and perform the action suggested. To toggle object



locking, go to Object Explorer and browse to the Project object. From the Project area, right-clickand select the project, and select Toggle Object Locking.

Table 2: Queries for Siebel SDQ

ActionProjectSiebel IndustryApplications

Siebel BusinessApplications

Toggle Object LockingAccountX

Toggle Object LockingAccount (SCW)X

Toggle Object LockingAccount (SSE)XX

Toggle Object LockingContactXX

Toggle Object LockingContact (SSE)

Toggle Object LockingCUT Account

Toggle Object LockingCUT SiebelCommunications

Toggle Object LockingCUT Usage

Toggle Object LockingDNB Data

Toggle Object LockingDeDuplication

Toggle Object LockingeAutomotive

Toggle Object LockingEmployeeXX

Toggle Object LockingFINS Contract

Toggle Object LockingFINS Contract Info

Toggle Object LockingFINS Deal Commercial

Toggle Object LockingFINS Financial Services

Toggle Object LockingFINS Opportunity



ActionProjectSiebel IndustryApplications


Create and Toggle ObjectLocking

Group 1 Data QualityXX


Group 1 EAI TestingXX


Group 1 WorkflowXX

Toggle Object LockingList Mgmt (Import)

Toggle Object LockingList Mgmt (UI)XX

Toggle Object LockingMvg

Toggle Object LockingOppty

Toggle Object LockingOppty (SSE)

Toggle Object LockingPersonal ContactX

Toggle Object LockingPicklistXX

Toggle Object LockingServer ComponentRequests

Toggle Object LockingSiebel Sales Enterprise

Toggle Object LockingSiebel Universal Agent

Toggle Object LockingVERT CUT AddressX

Toggle Object LockingVERT Cut Common

6. Check out the Siebel Projects:a) Log in to Siebel Tools as the user SADMIN. In the Connect to field select Local.b) Select Tools > Check Out.c) Select the projects indicated in the following table and click Checkout.



Table 3: Siebel Projects for SDQ

ProjectSiebel Industry ApplicationsSiebel Business Applications

AccountX

Account (SCW)XX

Account (SSE)XX

ContactXX

Contact (SSE)

CUT Account

CUT Siebel Communications

CUT Usage

DNB Data

DeDuplication

eAutomotive

EmployeeXX

FINS Contract

FINS Contract Info

FINS Deal Commercial

FINS Financial Services

FINS Opportunity

Group 1 Data Quality





Group 1 WorkflowXX

List Mgmt (Import)

List Mgmt (UI)XX

Mvg

Oppty

Oppty (SSE)

Personal ContactX

PicklistXX

Server Component Requests

Siebel Sales EnterpriseX

Siebel Universal Agent

VERT CUT AddressX

VERT Cut Common

7. Import the Spectrum™ Technology Platform Siebel Objects.a) Select Tools > Import from Archive.b) Browse to the Spectrum™ Technology Platform installation package. In the Siebel Objects

folder, browse to the subfolder for your version of Siebel and select the SIF files.c) Select Merge the object definition in the repository and click Next.

8. Check in all locked projects:a) Select Tools > Check In.b) Select all the Projects to check in and click Check in.

9. (Open UI Only) Import the Spectrum™ Technology Platform Siebel Objects for Open UI:a) Select Tools > Import from Archive.b) Browse to the Spectrum™ Technology Platform installation package. In the Siebel Objects

folder, browse to the OPEN_UI subfolder for your version of Siebel and select the SIF files.



c) Select Merge the object definition in the repository and click Next.

10. Compile all Projects:a) Select Tools > Compile Projects.b) Click All Projects.c) In the Siebel Repository File field, enter the path of your Siebel Web Client SRF file.d) Click Compile.

11. Deploy the Siebel objects in the client:

Keep a backup of the old SRF in case old binaries need to be re-implemented.Note:

a) Copy the generated SRF to your web client objects folder.

For example, on Windows the web client object folder may be C:\ProgramFiles\Siebel\8.0\web client\OBJECTS\ENU. On Unix or Linux the folder may be/disk2/sia78/webclient/OBJECTS/enu/.

b) Copy the contents of <Spectrum Package>\dll to your BIN folder.c) Copy the contents of <Spectrum Package>\cfg to your BIN/ENU folder.

12. Deploy the Siebel objects to the server:a) Stop the Siebel server.b) Copy the generated SRF file to your web client objects folder.

For example, the folder for Siebel Business on Windows may beC:\sea80\siebsrvr\OBJECTS\ENU. On Unix or Linux the folder may be/disk2/sea78/siebsrvr/OBJECTS/enu/.

c) Copy the libraries to your server.

• For Windows, copy the contents of <Spectrum Package>\lib\win to your BIN folder.• For Unix or Linux, copy the contents of <Spectrum Package>/lib/sol to your LIBfolder.

d) Copy the contents of <Spectrum Package>\cfg to your BIN\ENU folder.e) Start the Siebel server.

13. Install the options file.a) Click Site Map > Administration - Data > LOV Explorer.b) Click New.c) In the Type column, enter FILE_PATH.d) Click Query.e) In the Type column, enter FILE_PATH.f) Browse to the Values folder.g) In the Display Value column, enter the absolute path to the folder where you want to keep

the options file. You can specify any folder you want.h) Browse to the Spectrum™ Technology Platform installation package.



i) In the Siebel Objects folder, browse to the cfg subfolder for your version of Siebel andselect the Group1Connector.opt file.

j) Copy this file to the folder you specified for FILE_PATH.

14. Activate the Spectrum™ Technology Platform workflows in the Siebel web client:a) Log in to the Siebel Application, connecting to the server data source.b) Select Site Map > Administration - Business Process > Workflow Deployment.c) Query for all the GROUP 1* workflows.d) Click Activate for each workflow.e) Query for all the Promote* workflows.f) ClickActivate for the ff workflowsPromote Prospect (Single) andPromote Prospect (Many).

15. Verify the installation:a) Log in to Siebel Application.b) All applets should load properly without error.

16. Configure the Siebel instance configuration parameters:a) Select Site Map > Administration - Server Configuration > Enterprises.b) Verify/Change the ff Parameters:

• Data Cleansing Type—G1Cleansing• DeDuplication Data Type—G1DataMatching

c) Click Component Definitions and select the ff components. For each component, verifyparameters and values.

Table 4: Siebel Business

Value/Value on RestartParameterComponent Definitions

G1CleansingData Cleansing Type*Data Quality Manager *Sales ObjectManager (ENU) *List Import ServiceManager

TrueData Cleansing Enable Flag

G1DataMatchingDeDuplication Data Type

TrueDeDuplication Enable Flag



Table 5: Siebel Industry

Value/Value on RestartParameterComponent Definitions

G1CleansingData Cleansing Type*Data Quality Manager *eAutomotiveObject Manager (ENU) *List ImportService Manager

TrueData Cleansing Enable Flag

G1DataMatchingDeDuplication Data Type

TrueDeDuplication Enable Flag

d) Select Site Map > Server Configuration > Servers. Repeat steps b through c for serverconfiguration parameters.

e) Select Site Map > User Profile Preferences > Data Quality. Change the following settings:

ValueParameter

YesEnable DeDuplication

YesEnable Data Cleansing

f) Browse to <Siebel Installation>\bin\ENU and open the appropriate file:

• Siebel Business: siebel.cfg and uagent.cfg• Siebel Industry: auto.cfg

g) Under the area [DataCleansing] change the ff Parameters:

Enable = TRUEType = G1Cleansing

h) Under the area [DeDuplication] change the ff Parameters:

Enable = TRUEType = G1DataMatching

i) Select Site Map > Administration - Server Configuration. Click the Synchronize link andselect Synchronize after being redirected.

17. Configure data cleansing configuration parameters:a) Select Site Map > Administration > Data Quality > Third Party Administration. On the

Vendor Applet, include the ff value



DLL NameName

Group1ConnectorG1Cleansing

b) Add the ff BC Vendor Field Mapping:


OperationBusiness Component

Data CleansingAccount

Data CleansingBusiness Address

Data CleansingContact

Data CleansingList Mgmt Prospective Contact

Data CleansingPersonal Address



Data CleansingAccount

Data CleansingCUT Address

Data CleansingContact

Data CleansingList Mgmt Prospective Contact

Data CleansingPersonal Address

c) Under each BC operation, add the ff field mappings:




Mapped FieldBusiness Component Field

Account

FirmNameName

Business Address

CityCity

CountryNameCountry

USCountyNameCounty

DisableDataCleansingDisable DataCleansing

DPVG1 Delivery Point Validation Indicator

LatitudeG1 Latitude

LocationCodeG1 Location Code

LongitudeG1 Longitude

MatchCodeG1 Match Code

RDIG1 Residential Delivery Indicator

PostalCodePostal Code

StateProvinceState

AddressLine1Street Address

AddressLine2Street Address 2

Contact

FirstNameFirst Name




LastNameLast Name

TitleOfRespectM/M

MiddleNameMiddle Name

List Management Prospective Contact

CityCity

CountryNameCountry

USCountyNameCounty


FirstNameFirst Name


LatitudeG1 Latitude





LastNameLast Name



StateProvinceState






Personal Address

CityCity

CountryNameCountry

USCountyNameCounty



LatitudeG1 Latitude




StateProvinceState





Account

FirmNameName

CUT Address

CityCity




CountryNameCountry

USCountyNameCounty

DisableDataCleansingDisable Data Cleansing


LatitudeG1 Latitude






StateProvinceState



Contact

FirstNameFirst Name

LastNameLast Name


TitleOfRespectM/M


CityCity




CountryNameCountry

USCountyNameCounty


FirstNameFirst Name


LatitudeG1 Latitude





LastNameLast Name



StateProvinceState



Personal Address

CityCity

CountryNameCountry

USCountyNameCounty






LatitudeG1 Latitude




StateProvinceState



d) Add the ff Vendor Parameters.


ValueName

AccountAccount DataCleanse Record Type

Business AddressBusiness Address DataCleanse Record Type

ContactContact DataCleanse Record Type

List Mgmt Prospective ContactList Mgmt Prospective Contact DataCleanse RecordType

Personal AddressPersonal Address DataCleanse Record Type



Table 11: Siebel Industry:

ValueName

AccountAccount DataCleanse Record Type

CUT AddressCUT Address DataCleanse Record Type

ContactContact DataCleanse Record Type

List Mgmt Prospective ContactList Mgmt Prospective Contact DataCleanse RecordType

Personal AddressPersonal Address DataCleanse Record Type

e) Select Site Map > Administration - Data Quality > Third Party Administration > DataQuality Settings. Add the ff data for Data Quality Settings. These settings enable datacleansing for your Siebel Application

ValueName

YesEnable DataCleansing

18. Configure data matching configuration parameters:a) Select Site Map > Administration > Data Quality > Third Party Administration. On the

Vendor Applet, include the ff value

DLL NameName

Group1ConnectorG1DataMatching

b) Add the ff BC Vendor Field Mapping:

Table 12: Siebel Business Applications


DeDuplicationAccount

DeDuplicationBusiness Address




DeDuplicationContact

DeDuplicationList Mgmt Prospective Contact

Table 13: Siebel Industry Applications


DeDuplicationAccount

DeDuplicationCUT Address

DeDuplicationContact

DeDuplicationList Mgmt Prospective Contact

c) Under each BC Operation, add the ff Field Mappings.

Table 14: Siebel Business Applications


Account

DedupTokenDedup Token

IdId

LocationLocation

NameName

CityPrimary Account City

CountryNamePrimary Account Country

PostalCodePrimary Account Postal Code




StateProvincePrimary Account State

AddressLine1Primary Account Street Address

Business Address

CityCity

CountryNameCountry

IdId


StateProvinceState



Contact

FirstNameFirst Name

IdId

LastNameLast Name


AccountNamePrimary Account Name

CityPrimary City

CountryNamePrimary Country

PostalCodePrimary Postal Code

StateProvincePrimary State





AccountAccount

CityCity

CountryNameCountry

FirstNameFirst Name

IdId

LastNameLast Name



StateProvinceState



Table 15: Siebel Industry Applications


Account

DedupTokenDedup Token

IdId

LocationLocation

NameName

CityPrimary Account City




CountryPrimary Account Country

PostalCodePrimary Account Postal Code

StatePrimary Account State

AddressLine1Primary Account Street Address

CUT Address

CityCity

CountryCountry

IdId


StateState



Contact

FirstNameFirst Name

IdId

LastNameLast Name


NamePrimary Account Name

CityPrimary City

CountryPrimary Country




CodePrimary Postal Code

StatePrimary State


AccountAccount

CityCity

CountryNameCountry

FirstNameFirst Name

IdId

LastNameLast Name



StateProvinceState



d) Add the ff Vendor Parameters:

Token Expression and Query Expression are custom fields in their respective BusinessComponents.

Note:

Table 16: Vendor Parameters

ValueName

AccountAccount DeDup Record Type



ValueName

"|" + [Query Expression 1] + [Query Expression 2] +[Query Expression 3]

Account Query Expression

"|" + [Token Expression 1] + [Token Expression 2] +[Token Expression 3]

Account Token Expression

200Batch Max Num of Records

Business Address(Siebel Business Only)

Business Address DeDup Record Type

CUT Address(Siebel Industry Only)

CUT Address DeDup Record Type

ContactContact DeDup Record Type


Contact Query Expression


Contact Token Expression

List Mgmt Prospective ContactList Mgmt Prospective Contact DeDup Record Type


List Mgmt Prospective Contact Query Expression


List Mgmt Prospective Contact Token Expression

200Realtime Max Num of Records

e) Select Site Map > Administration - Data Quality > Third Party Administration > DataQuality Settings. Add the ff data for Data Quality Settings. These settings enable datamatchingfor your Siebel Application.

ValueName

YesEnable DeDuplication



ValueName

YesForce User DeDupe - Account

YesForce User DeDupe - Contact

YesForce User DeDupe - List Mgmt

19. (Open UI Only) Grant the EAI File Transport business service access to the file system by followingthese steps.a) Click Navigate > Site map.b) Click Administration - Server Configuration.c) In theAdministration - Server Configuration section, under Enterprises, click Parameters.d) Click Query.e) In the Name column, enter EAI File Transport Folder List.f) Click Go.g) In the Value column, enter the root of the drive where you have Siebel installed. For example,

C:\.h) Click the Servers link:

i) Click the Parameters tab:



j) Click Query.k) In the Name column, enter EAI File Transport Folder List.l) Click Go.m) In the Value column, enter the root of the drive where you have Siebel installed. For example,

C:\.n) Add the following values to the the .cfg file appropriate for your system (for example, auto.cfg,

tools.cfg, and so on).

[EAIFileTransportConfigSubsys]EAIFileTransportFolders=C:\

o) Restart the Siebel server and gateway.

20. Set the EditProfileAttr parameter:a) Click Navigate > Site Mapb) Click Administration - Server Configuration.c) In the Administration - Server Configuration section, under Servers, click Components.d) On the Components tab, click Query.e) In the Component column, enter the name of the Object Manager component. For example,

"eAutomotive Object Manager".f) Click Go.g) Click the Parameters tab at the bottom of the window.



h) Scroll to the parameter EditProfileAttr.i) Enter True in the Value, Value on Restart, and Default Value columns.

You have now configured Siebel SDQ to use Spectrum™ Technology Platform for data qualityprocessing.



Integrating with Siebel Non-SDQ

To integrate Spectrum™ Technology Platform with Siebel Non-SDQ, you need to install supportingdatabases and dataflows on the Spectrum™ Technology Platform server, and then configure yourSiebel system to communicate with Spectrum™ Technology Platform. Once you do this, users ofSiebel Non-SDQ will have access to address validation and geocoding functionality from withinSiebel Non-SDQ.










2. When you install the Siebel module, several dataflow files are automatically installed. Otherdataflow files must be manually copied into the Spectrum™ Technology Platform server.a) Browse to one of the following folders on your Spectrum™ Technology Platform server:

• For Siebel Business Applications, go to:<SpectrumPlatformLocation>\server\modules\dataflows\siebel\sea

• For Siebel Industry Applications, go to:<SpectrumPlatformLocation>\server\modules\dataflows\siebel\sia


SpectrumLocation\server\app\import



Table 17: Dataflow Files To Import


SiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.ADN.df

Address Now Module only

SiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.UAM_ADN.df


GeocodeUSAddressWithCandidates.dfSiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.EGM_ADN.df

Address Now ModuleEnterprise Geocoding Module

GeocodeUSAddressWithCandidates.dfSiebelGetGlobalCandidateAddresses.dfValidateAddressWithCandidates.UAM_EGM_ADN.df

Address Now ModuleEnterprise Geocoding ModuleUniversal Addressing Module

GeocodeUSAddressWithCandidates.dfValidateAddressWithCandidates.UAM.df

Universal Addressing Module only

GeocodeUSAddressWithCandidates.dfValidateAddressWithCandidates.UAM_EGM.df

Universal Addressing ModuleEnterprise Geocoding Module

GeocodeUSAddressWithCandidates.dfValidateAssignGeoTAXInfo.dfValidateAddressWithCandidates_UAM_ETM.df

Universal Addressing ModuleEnterprise Tax Module

ValidateAddressWithCandidates_UAM_Loqate.dfUniversal Address Module with Loqate

ValidateAddressWithCandidates_Loqate_EGM.dfUniversal Addressing Module withLoqateEnterprise Geocoding Module








ValidateAddressWithCandidates.EGM.dfEnterprise Geocoding Module

ValidateAssignGeoTAXInfo.dfEnterprise Tax Module

If errors occur in Management Console or Enterprise Designer, delete the client cache.To delete the client cache, go to Tools >Options in Management Console or Enterprise

Note:

Designer, click the Advanced tab, then click Clear Cache. After you clear the cache,restart Management Console or Enterprise Designer.

3. Optional: If you are using the Enterprise Geocoding Module, configure the geocoding dataflowto use the geocoding database resource name you have configured on your system:a) In Enterprise Designer, open the dataflow GeocodeUSAddressWithCandidates.b) In each dataflow, open the Geocode US Address stage.c) In the Database field, select the name of the geocoding database as defined in the

Management Console. The default name is KGDDatasource but if the geocoding databasehas a different name on your system, select the appropriate name.

For more information about database resources, see the Spectrum™ TechnologyPlatform Administration Guide.

Note:



d) Save and close each dataflow.

4. Copy Siebel objects to your system:a) Browse to the location where you downloaded the Spectrum™ Technology Platform installer.b) Browse to the appropriate folder for your version of Siebel as shown in the following table.

FolderSiebel Version

Siebel Objects\8.0\Business\nonSDQ

Siebel Business Applications 8.0 Non-SDQ

Siebel Objects\8.1.1\Business\nonSDQ

Siebel Business Applications 8.1.1 Non-SDQ

Siebel Objects\8.0\Industry\nonSDQ

Siebel Industry Applications 8.0 Non-SDQ

Siebel Objects\8.1.1\Industry\nonSDQ

Siebel Industry Applications 8.1.1 Non-SDQ

c) Copy the contents of the folder to a temporary directory.

This temporary folder will be the referred to as <Spectrum Package> in the followingsteps.

Note:

5. Create objects and allow object locking:a) Log in to Siebel Tools as the user SADMIN, with the connection pointing to the server data

source.b) Go to Object Explorer, drill down to the Project object. From the Project area, right-click and

select New Record. Create the following projects:

• Group 1 Data Quality• Group 1 EAI Testing• Group 1 Workflow

c) Open the file <Spectrum Package>\tools\CDQP_Queries.txt.d) Copy and paste the query contents to the Project list of your Object Manager. Cross-check

the query result with the table below and perform the action suggested. To toggle objectlocking, go to Object Explorer and browse to the Project object. From the Project area, right-clickand select the project, and select Toggle Object Locking.



Table 18: Queries for Siebel non-SDQ

ActionProjectOpen UISiebel IndustryApplications


Toggle ObjectLocking

AccountXXX


Account (SCW)XXX


Account (SSE)XXX


ContactXXX


Contact (SSE)XXX


CUT AccountXX


CUT SiebelCommunications

XX


CUT UsageXX


DNB DataXXX


DeDuplicationXXX


eAutomotiveXX


EmployeeXXX


FINS ContractXX






FINS Contract InfoXX


FINS DealCommercial

XX


FINS FinancialServices

XX


FINS OpportunityXX

Create and ToggleObject Locking

Group 1 Data QualityXXX


Group 1 EAI TestingXXX


Group 1 WorkflowXX


List Mgmt (Import)X


List Mgmt (UI)XXX


MvgX


OpptyXXX


Oppty (SSE)XXX


Personal ContactXXX


PicklistXXX






Server ComponentRequests

XXX


Siebel SalesEnterprise

XX


Siebel UniversalAgent

X


VERT CUT AddressXX


VERT Cut CommonXX

6. Check out the Siebel Projects:a) Log in to Siebel Tools on Local Datasource.b) Select Tools > Checkout.c) Select the projects indicated in the following table and click Checkout.

Table 19: Siebel Projects for non-SDQ


AccountXX

Account (SCW)XX

Account (SSE)XX

ContactXX

Contact (SSE)XX

CUT AccountX

CUT Siebel CommunicationsX

CUT UsageX




DNB DataXX

DeDuplicationXX

eAutomotiveX

EmployeeXX

FINS ContractX

FINS Contract InfoX

FINS Deal CommercialX

FINS Financial ServicesX

FINS OpportunityX

Group 1 Data QualityXX


Group 1 WorkflowX

List Mgmt (Import)X

List Mgmt (UI)XX

MvgX

OpptyXX

Oppty (SSE)XX

Personal ContactXX

PicklistXX

Server Component RequestsXX




Siebel Sales EnterpriseX

Siebel Universal AgentX

VERT CUT AddressX

VERT Cut CommonX

7. Import the Spectrum™ Technology Platform Siebel objects:a) Select Tools > Import from Archive.b) Import the Siebel SIF files located in <Spectrum Package>\sif. Select Overwrite the

object definition in the repository and click Next to proceed until the import process hasbeen completed.

• G1_NEW.sif• G1_APPLET.sif• G1_BO.sif• G1_LINK.sif• G1_BC.sif• G1_BC_SCRIPTS.sif• G1_EAI_TESTING.sif• G1_APPLICATION.sif• G1_PICKLIST.sif• G1_VIEW.sif• G1_WORKFLOW.sif• (8.1.1 only) Rebranding.sif

c) (Open UI Only) Import the Siebel SIF files located in <Spectrum Package>\OPEN_UI.Select Overwrite the object definition in the repository and click Next to proceed until theimport process has been completed.

• FINS Personal Address List Applet.sif• G1 Common Browser Scripts Service.sif• Siebel Sales Enterprise.sif

8. Check in all locked projects:a) Select Tools > Check In.b) Select all the Projects to check in and click Check in.

9. Compile all Projects:a) Select Tools > Compile Projects.



b) Click All Projects.c) In the Siebel Repository File field, enter the path of your Siebel Web Client SRF file.d) Click Compile.

10. Update the application .CFG flie:a) Open the appropriate .cfg file in an editor:

For example, for Siebel Business:

• Siebel Call Center—uagent.cfg

• Siebel Sales—siebel.cfg

For example, for Siebel Industry:

• eAutomotive—auto.cfg

• Financial—fins.cfg

• eCommunication—ecomm.cfg

Siebel .cfg files are usually found in the following locations:

• Siebel thick client—Siebel\<version>\web client\bin\enu

• Siebel thin client—<Siebel Server>\bin\enu

b) Add the following lines under the [SWE] section:

ClientBusinessService0 = G1 Async ServiceClientBusinessService1 = G1 Business Name Standardization ServiceClientBusinessService2 = G1 Common Browser Scripts ServiceClientBusinessService3 = G1 Common Server Scripts ServiceClientBusinessService4 = G1 DNB VBC ServiceClientBusinessService5 = G1 Data Cleansing ServiceClientBusinessService6 = G1 DeDuplication ServiceClientBusinessService7 = G1 Generate HashKey ServiceClientBusinessService8 = G1 GeoCoding ServiceClientBusinessService9 = G1 Interactive ServiceClientBusinessService10 = G1 Merge Records ServiceClientBusinessService11 = G1 Name Casing ServiceClientBusinessService12 = G1WebService

11. Deploy the Siebel objects in the client:

Keep a backup of the old SRF in case old binaries need to be re-implemented.Note:

a) Copy the generated SRF to your web client objects folder.

For example, on Windows this folder may be C:\Program Files\Siebel\8.0\webclient\OBJECTS\ENU. On Unix or Linux this folder may be/disk2/sia78/webclient/OBJECTS/enu/.

b) Open a command prompt and go to the BIN folder of the web client.



For example, on Windows this folder may be C:\Program Files\Siebel\8.0\webclient\BIN. On Unix or Linux, this folder may be /disk2/sia80/webclient/BIN.

c) Generate browser scripts by issuing the command:

On Windows:

genbscript "ENU\siebel.cfg" "[public\enu folder]"

On Unix or Linux:

genbscript [location of .cfg] [public/enu folder]

For example, on Windows:

C:\Program Files\Siebel\8.0\web client\BIN>genbscript "enu\siebel.cfg""C:\Program Files\Siebel\8.0\web client\PUBLIC\enu"

On Unix or Linux:

genbscript /disk2/sia80/webclient/BIN/enu/siebel.cfgsia80/webclient/PUBLIC/enu

d) Copy g1_check.gif and g1_x.gif from the temporary folder to public\enu\images inthe Siebel web client.

e) Copy the contents of <Spectrum Package>\dll to your BIN folder.f) Copy the contents of <Spectrum Package>\cfg to your BIN/ENU folder.

12. Deploy the Siebel objects to the server:a) Stop the Siebel server.b) Copy the generated SRF file to your web client objects folder.

For example, for Siebel Business on Windows the folder may beC:\sea80\siebsrvr\OBJECTS\ENU. On Unix or Linux the folder may be/disk2/sea80/siebsrvr/OBJECTS/enu/.

c) Open a command prompt and go to the BIN drive of the web client.

For example, on Windows this folder may be C:\sia80\siebsrvr\BIN. On Unix or Linuxthis folder may be /disk2/sea80/siebsrvr/BIN.

d) Generate browser scripts by issuing this command:

On Windows:

genbscript "ENU\siebel.cfg" "[webmaster folder]"

On Unix or Linux:

genbscript [location of Siebel.cfg] [webmaster folder]

For example, on Windows:

C:\sia80\siebsrvr\BIN>genbscript "enu\siebel.cfg""C:\sia80\siebsrvr\WEBMASTER"



For example, on Unix or Linux:

genbscript /disk2/sea80/siebsrvr/BIN/enu/siebel.cfg/disk2/sea80/siebsrvr/WEBMASTER/

e) Copy g1_check.gif and g1_x.gif from the temporary folder to the following folder on theSiebel sever.

On Windows:

public\enu\images

On Unix or Linux:

WEBMASTER/images/enu

For Siebel Thin Client, copy g1_check.gif and g1_x.gif from the temporarydirectory to SWEApp/PUBLIC/enu/images.

Note:

f) Copy the generated browser scripts from /WEBMASTER to <SWEAppLocation>/public/ENU.

g) Start the Siebel server.

13. Activate the Spectrum™ Technology Platform workflows in the Siebel web client:a) Log in to the Siebel Application, connecting to the server data source.b) Select Site Map > Administration - Business Process > Workflow Deployment.c) Query for all the GROUP 1* workflows.d) Click Activate for each workflow.e) Query for all the Promote* workflows.f) ClickActivate for the ff workflowsPromote Prospect (Single) andPromote Prospect (Many).

14. Load the Group 1 configuration.a) Log in to the Siebel application connecting to the server data source.b) Go to Site Map > Administration - Business Service > Simulator.c) In the top applet, create a new record and set the following fields:

Workflow Process ManagerService Name

Run ProcessMethod Name

1Iterations

d) In the Input Arguments applet, load:

<Spectrum Package>\tools\OptionsManagerLoadData.xml

Delete the entry if previous GROUP 1 options already exist in the database. Run thefollowing SQL Script: DELETE SIEBEL.S_LST_OF_VAL WHERE CODE = 'G1'

Note:



e) Click Run in the top applet of the Simulator view. Delete the record.f) Repeat steps c. and d. for the ff files:

• ViewAccessLoadData.xml• AdminAccessLoadData.xml

g) Go to Site Map > Administration - Application > Responsibilities:h) Query for the responsibility Group 1 Responsibility.i) In the Users tab, add SADMIN or any Siebel administrator. This associates the Group 1

Administration Screen to the user.

In order to see the changes you must log-in again.Note:

j) Go to Site Map > Administration - Group 1 Data Quality > Options Manager > GeneralBehavior.

k) Change the server and port number where the Spectrum™ Technology Platform server islocated.

15. Verify the installation:a) Log in to Siebel Application.b) All applets should load properly without error.

16. Modify and apply web services.a) Go to Site Map > Administration - Web Services > Outbound Web Services.b) Click Import on the Outbound Web Services area and then specify the file <Spectrum

Package>\tools\G1WebService.xml.c) Query on the Name field ValidateAddress, and modify its settings as follows:

On the Service Port applet, change the following fields:

• Transport: Local Business Service• Address: G1 WebService Filter Service

On the Operations applet, change the following fields:

• Response Filter Service Display: G1 WebService Filter Service• Response Filter Method Display: filter Response

17. Encrypt and apply Spectrum™ Technology Platform user name and password.a) Run the following command on the command prompt:

java -version

Java Runtime Environment (JRE) 1.4.x is required. If none is installed, you can downloadfrom java.sun.com/j2se/1.4.2/download.html. Download the JRE of your target platform.

b) Acquire the file <Spectrum Package>\tools\Base64.class.c) On the command prompt, type the following command:

java Base64 -encode -s "<username>:<password>"



http://java.sun.com/j2se/1.4.2/download.html

where <username> and <password> is to the login information of Spectrum™ TechnologyPlatform server. Copy the generated value.

The default Spectrum™ Technology Platform password can be found in <SpectrumPackage>\tools\Default Password.txt.

Note:

d) Go to Site Map > Administration - Group 1 Data Quality > Password Manager. Paste thevalue generated in step c. and click Save Changes.

18. Configure Siebel server configuration events.

The Siebel server must be configured so that the records created in the local database can besynchronized to the server.

a) Navigate to View > Administration - Server Configuration > Servers > Components >Event.

b) Locate the Workflow Process Manager Server components.c) Set the following Component Event Configuration for Workflow Process Manager:

4Task Configuration

3Component Tracing

4SQL Parse and Execute

4Workflow Definition Loading

4Workflow Engine Invoked

4Workflow Step Execution

4Workflow Process Execution

4Object Manager Business Service Operation andSetErrorMsg Log

4Object Manager Business Component Operation andSetErrorMsg Log

4Object Manager SQL Log

d) Locate the Transaction Merger server components.e) Set the following Component Event Configuration for Transaction Merger:



4General Events

3Components Tracing

4SQL Parse and Execute

19. Enable marketing server components.

The Marketing Server Components must be enabled to import a list from the List Managementbusiness object.

a) Navigate to Administration - Server Configuration > Enterprises > Component Groups.b) In the Spectrum™ Technology Platform Server list, select the appropriate server.c) In the Enterprise Component Groups list, locate each of the required component groups using

the following table. If the Enable State field does not contain the value Enabled, select thecomponent groups, click the menu button, and choose Enable Component Group.

DescriptionComponentsGroup Name

Marketing Object Manager. Supportsthe user interface and businessobjects for the Marketing application.

MktgOM• Marketing Obj Mgr• eMarketing Obj Mgr• eEvents Obj Mjr

Marketing Server. Used for listmanagement list import.

List Import Service ManagerMktg Srv

d) Click the Synchronize view tab and click Synchronize.e) Restart the Siebel server. The Siebel server must be restarted each time synchronization

occurs.

20. (Open UI Only) Grant the EAI File Transport business service access to the file system by followingthese steps.a) Click Navigate > Site map.b) Click Administration - Server Configuration.c) In theAdministration - Server Configuration section, under Enterprises, click Parameters.d) Click Query.e) In the Name column, enter EAI File Transport Folder List.f) Click Go.g) In the Value column, enter the root of the drive where you have Siebel installed. For example,

C:\.h) Click the Servers link:



i) Click the Parameters tab:

j) Click Query.k) In the Name column, enter EAI File Transport Folder List.l) Click Go.m) In the Value column, enter the root of the drive where you have Siebel installed. For example,

C:\.n) Add the following values to the the .cfg file appropriate for your system (for example, auto.cfg,

tools.cfg, and so on).

[EAIFileTransportConfigSubsys]EAIFileTransportFolders=C:\

o) Restart the Siebel server and gateway.

21. Set the EditProfileAttr parameter:a) Click Navigate > Site Mapb) Click Administration - Server Configuration.c) In the Administration - Server Configuration section, under Servers, click Components.d) On the Components tab, click Query.e) In the Component column, enter the name of the Object Manager component. For example,

"eAutomotive Object Manager".f) Click Go.



g) Click the Parameters tab at the bottom of the window.

h) Scroll to the parameter EditProfileAttr.i) Enter True in the Value, Value on Restart, and Default Value columns.

You have now configured Siebel non-SDQ to use Spectrum™ Technology Platform for data qualityprocessing.



Configuring Microsoft Dynamics CRM

Integrating with

To integrate Spectrum™ Technology Platform with , you must install the supporting databases anddataflows on the Spectrum™ Technology Platform server, and deploy the Spectrum™ TechnologyPlatform solution on your . Once you do this, users of will have access to address validation,geocoding, and duplicate detection functionality from within .

End users who use Internet Explorer must use Internet Explorer 10 or 11. Older versions ofInternet Explorer are not supported. All versions of Chrome and Firefox are supported.

Note:

Before you begin, confirm that you are using a compatible version of Microsoft Dynamics. Thefollowing versions are supported:

Microsoft Dynamics CRM 2013Microsoft Dynamics CRM 2013 SP1Microsoft Dynamics 2015

1. If you are using Spectrum™ Technology Platform for address validation or geocoding, install thedatabases required to perform address validation and geocoding and define database resourcesfor each database.

If you are using Spectrum™ Technology Platform for duplicate detection only, you canskip this step.

Note:










You must install the Delivery Point Validation (DPV) data and the Residential DeliveryIndicator (RDI) data in order to perform DPV and RDI processing on U.S. addresses.

Note:

2. Import the Module dataflows into your Spectrum™ Technology Platform server.a) On the Spectrum™ Technology Platform server, open this folder:

SpectrumFolder\server\modules\dataflows\mscrm

This folder is only available if you have installed the Module.Note:



Copy these dataflow files to the import folderIf you have installed this set ofmodules

GenerateMatchKey.dfGenerateMatchScore.df

Advanced Matching Module

GenerateSearchKey.Consonant.dfGenerateSearchKey.dfGenerateSearchKey.Metaphone.dfGenerateSearchKey.Substring.df

ValidateAddresswithCandidates_UAM.dfUniversal Addressing Module withoutLoqate

ValidateAddressWithCandidates_UAM_EGM.dfUniversal Addressing Module withoutLoqateEnterprise Geocoding Module


BatchAddressValidate.dfValidateAddressAndGenerateMatchKey.dfValidateAddressWithCandidates_UAM_Loqate_EGM.df

Universal Addressing Module withLoqateEnterprise Geocoding Module




Copy these dataflow files to the import folderIf you have installed this set ofmodules


GeocodeUSAddressWithCandidates.dfEnterprise Geocoding Module

3. Import the Microsoft Dynamics CRM Module into your Microsoft Dynamics CRM system.a) In the Spectrum™ Technology Platform installation package, browse to this folder:

MS CRM Objects\Proxy

b) Copy the file netProxy.aspx to the following folder on your Microsoft Dynamics CRM server:

MicrosoftDynamicsCRMInstallation\CRMWeb

c) Copy the file netProxy.dll to the following folder on your Microsoft Dynamics CRM server:

MicrosoftDynamicsCRMInstallation\CRMWeb\Bin

d) Log in to Microsoft Dynamics CRM as an administrator.e) Click Microsoft Dynamics CRM then click Settings.f) Click Solutions.g) Click Import.h) Browse to the Spectrum™ Technology Platform installation package and select the following

file:

MS CRM Objects\mscrm\PBMSDynamicsCRMConnector_4_0_0_managed.zip

i) Click Next then Publish All Customizations.j) Restart the Microsoft Dynamics CRM server.

4. Define the connection betweenMicrosoft Dynamics CRMand the Spectrum™ Technology Platformserver.a) Log in to Microsoft Dynamics CRM as an administrator.b) Click Microsoft Dynamics CRM > Settings.c) Click Settings > Pitney Bowes. You will have to scroll to the right to find the Pitney Bowes

link.d) Click Administration.e) Click New.f) In the Name field, enter PB.



g) In the Server Name field, enter the server name or IP address of the Spectrum™ TechnologyPlatform server.

h) In the Port field, enter the port used by the Spectrum™ Technology Platform server for HTTPcommunication. By default the port is 8080.

i) In the Account ID field, enter the Spectrum™ Technology Platform user name.j) In the Password field, enter the password for the Spectrum™ Technology Platform user.k) Click Save

The Microsoft Dynamics CRM system now has access to address validation and, optionally,geocoding services on the Spectrum™ Technology Platform server.



9 - Support

In this section

Technical Support 156Documentation 156Digital Insights 156

Technical Support

If you run into an issue, Pitney Bowes Technical Support can help guide you to a solution. Whenyou contact Pitney Bowes Technical Support, please provide the following information:

• A description of the task you were performing• The level or version of your operating system• The patch level or service pack• The log file located in your install directory at:<SpectrumInstallationLocation>\server\app\repository\logs\wrapper.log

Contact information for Technical Support can be found at:

support.pb.com/spectrum

If you purchased Spectrum™ Technology Platform through a third-party partner, pleasecontact the partner for technical support.

Note:

Documentation

Product documentation can be found at:

support.pb.com/spectrum

Digital Insights

Digital Insights is an online resource for Pitney Bowes leadership to share innovations, goals, andproduct news, as well as exchange ideas with visitors. You can access Digital Insights at:

blogs.pb.com/digital-insights/


Support

http://support.pb.com/spectrum

http://support.pb.com/spectrum

http://blogs.pb.com/digital-insights/

Notices

© 2016 Pitney Bowes Software Inc. All rights reserved. MapInfo and Group 1 Software are trademarksof Pitney Bowes Software Inc. All other marks and trademarks are property of their respectiveholders.

USPS® Notices

Pitney Bowes Inc. holds a non-exclusive license to publish and sell ZIP + 4® databases on opticaland magnetic media. The following trademarks are owned by the United States Postal Service:CASS, CASS Certified, DPV, eLOT, FASTforward, First-Class Mail, Intelligent Mail, LACSLink,NCOALink, PAVE, PLANET Code, Postal Service, POSTNET, Post Office, RDI, SuiteLink , UnitedStates Postal Service, Standard Mail, United States Post Office, USPS, ZIP Code, and ZIP + 4.This list is not exhaustive of the trademarks belonging to the Postal Service.

Pitney Bowes Inc. is a non-exclusive licensee of USPS® for NCOALink® processing.

Prices for Pitney Bowes Software's products, options, and services are not established, controlled,or approved by USPS® or United States Government. When utilizing RDI™ data to determineparcel-shipping costs, the business decision on which parcel delivery company to use is not madeby the USPS® or United States Government.

Data Provider and Related Notices

Data Products contained on this media and used within Pitney Bowes Software applications areprotected by various trademarks and by one or more of the following copyrights:© Copyright United States Postal Service. All rights reserved.© 2014 TomTom. All rights reserved. TomTom and the TomTom logo are registered trademarks ofTomTom N.V.© 2016 HERE

Fuente: INEGI (Instituto Nacional de Estadística y Geografía)

Based upon electronic data © National Land Survey Sweden.© Copyright United States Census Bureau© Copyright Nova Marketing Group, Inc.

Portions of this program are © Copyright 1993-2007 by Nova Marketing Group Inc. All RightsReserved© Copyright Second Decimal, LLC© Copyright Canada Post Corporation

This CD-ROM contains data from a compilation in which Canada Post Corporation is the copyrightowner.© 2007 Claritas, Inc.

The Geocode Address World data set contains data licensed from the GeoNames Project(www.geonames.org) provided under the Creative Commons Attribution License ("Attribution


Copyright

http://www.geonames.org

License") located at http://creativecommons.org/licenses/by/3.0/legalcode. Your use of theGeoNames data (described in the Spectrum™ Technology Platform User Manual) is governed bythe terms of the Attribution License, and any conflict between your agreement with Pitney BowesSoftware, Inc. and the Attribution License will be resolved in favor of the Attribution License solelyas it relates to your use of the GeoNames data.

ICU Notices

Copyright © 1995-2011 International Business Machines Corporation and others.

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software andassociated documentation files (the "Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of theSoftware, and to permit persons to whom the Software is furnished to do so, provided that the abovecopyright notice(s) and this permission notice appear in all copies of the Software and that both theabove copyright notice(s) and this permission notice appear in supporting documentation.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESSFORAPARTICULARPURPOSEANDNONINFRINGEMENTOFTHIRDPARTYRIGHTS.IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICEBE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES,OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THISSOFTWARE.

Except as contained in this notice, the name of a copyright holder shall not be used in advertisingor otherwise to promote the sale, use or other dealings in this Software without prior writtenauthorization of the copyright holder.


Copyright

http://creativecommons.org/licenses/by/3.0/legalcode