First Installation Scenario

This section guides you through the steps required for installation of Screener for the first installation scenario.
Follow the subsequent steps to install Spectrum Screener:
Note: If you have already installed Spectrum™ Technology Platform 2018.2, verify that all the modules mentioned below are installed; if any of the module is missing, reinstall with all the mentioned modules.

Spectrum™ Technology Platform Installation

Install Spectrum™ Technology Platform with these modules:

  • Spectrum Technology Platform Server (64-bit)
  • Business Steward Module
  • Data Hub Module
  • Data Integration Module
  • Information Extraction Module
  • Global Sentry Module
  • Spectrum Screener
  • Universal Addressing Module
  • Universal Name, Data Normalization, and Advanced Matching Modules

    For more information about installing , see Installing a New Server section of the Installation Guide, do not import the Spectrum™ Technology Platform license key here, perform the subsequent steps first.

After successful installation, follow these steps to download and apply the windows specific product update 2018.2 S12:
Note: In this procedure, SpectrumLocation refers to the folder where you have installed the Spectrum™ Technology Platform server.
  1. Stop the Spectrum™ Technology Platform server. To stop the server, 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 and stop the Pitney Bowes Spectrum™ Technology Platform service.
  2. Back up these files to a different location:
    • <SpectrumLocation>\server\app\deploy\fcc-18.2.car
    • <SpectrumLocation>\server\app\deploy\fcc.war
    • <SpectrumLocation>\server\modules\fcc
  3. Delete this folder:

    <SpectrumLocation>\server\modules\fcc

  4. Download the zip file containing the patch.
  5. Extract the contents of the zip file to a temporary location.
  6. Extract the resulting zip file (cdq20182S12.zip) to the folder where you installed Spectrum. For example, C:\Program Files\Pitney Bowes\Spectrum.

    Choose to overwrite the existing files.

Now, run the Data Normalization Module database utility, select Advanced Transformer and enter this path for the source folder: <SpectrumLocation>/server/modules/fcc/FCC_Repo/setup/baseTables. This utility works only when the Spectrum Server is stopped.

Note: Repeat this step by selecting Open Parser and Table Lookup.

For information on database utility, see the Installing the Advanced Matching Module Database section of the Installation Guide. For Unix, you must stop the server prior to importing base tables. For more information, see the Installing Data Normalization Module databases section of the Unix and Linux Install Guide.

On completion of this process, start the server and import the Spectrum™ Technology Platform license key.

Running the Screener Setup Script for Windows Systems

This script installs your custom tables and open parser domains, imports match rules and flows, creates database resources and hub metadata model. This script also creates list and party search indexes, and runs the flow to load hub FCC_METADATA model with basic data which is required to run the Screener.

Note: If your databases are imported using SPD, specify the path of the datastorage folder where you have deployed the SPD files. For example, the path for UAM US for JUNE 2017 Vintage is: <SpectrumLocation>\\server\\app\\repository\\datastorage\\ Universal_Addressing_Module\\c1p\\UAM-US_JUNE2017/UAM-US

For loqate, give the path to the /data folder such as C:/loqate, do not give the full path to the data like C:/loqate/data as you did for UAM.

This step must be performed prior to running the script as you need to provide these paths as input while running the script.

For more information, see Installing Universal Addressing Module Databases section of the Installation Guide.

Follow these steps to run the Screener Setup Script and install Screener:

  1. Copy the FCC_REPO folder residing at <SpectrumLocation>/server/modules/fcc/FCC_Repo to a different location. For example, C:/FCC_REPO/... If you are placing it at some other location, make changes in base directory placed at <SpectrumLocation>/modules/fcc/fcc.properties in these properties:
    • fcc.spectrum.list.job.base.path=C:/FCC_Repo/lists

    • fcc.spectrum.base.path=C:/FCC_REPO

  2. Run the Spectrum- CLI: copy spectrum-cli-<spectrumversion> placed at <SpectrumLocation>/server/app/exports and unzip it outside the Program Files folder in the same drive or you can download Administration Utility placed under the Command Line at server:port/dcg.

    Where server is the server name or IP address of your Spectrum™ Technology Platform server and port is the HTTP port. By default, the HTTP port is 8080.

  3. Go to <SpectrumLocation>/server/modules/fcc/FCC_Repo/setup/cli, you will see these files - cli_screener_setup.cmd, cli_screener_setup.cli, and screener_setup.txt. Copy these files to the folder where you unzipped the spectrum-cli-<spectrumversion>.zip file.
    The screener_setup.txt file contains configurable properties, you need to set these prior to running the setup script:
    • host: Machine where the Spectrum™ Technology Platform Server needs to be setup is running.
    • port: Port on which Spectrum™ Technology Platform is running
    • user: Spectrum™ Technology Platform User, should be an administrative user
    • password: Spectrum™ Technology Platform Password
  4. For executing the screener files, open the command prompt with Admin privileges. Then go to the CLI folder and run the cli_screener_setup.cmd file.
  5. Enter these details in the command prompt:
    • Path for the FCC_Repo folder; this will be same as specified in the first step.
    • Path for the Spectrum UAM US, UAM CAN, UAM INT, and LOQATE databases.
      Note: For LOQATE, enter the Loqate database extracted folder path.

Running the Screener Setup Script for Unix Systems

This script installs your custom tables and open parser domains, imports match rules and flows, creates database resources and hub metadata model. This script also creates list and party search indexes, and runs the flow to load hub FCC_METADATA model with basic data which is required to run the Screener.

Note: If your databases are imported using SPD, specify the path of the datastorage folder where you have deployed the SPD files. For example, the path for UAM US for JUNE 2017 Vintage is: <SpectrumLocation>\\server\\app\\repository\\datastorage\\ Universal_Addressing_Module\\c1p\\UAM-US_JUNE2017/UAM-US

This step must be performed prior to running the script as you need to provide these paths as input while running the script.

For more information, see Installing Universal Addressing Module Databases section of the Installation Guide.

Follow these steps to run the Screener Setup Script and install Screener:

  1. Copy the FCC_REPO folder residing at <SpectrumLocation>/server/modules/fcc/FCC_Repo to a different location. For example, C:/FCC_REPO/... If you are placing it at some other location, make changes in base directory placed at <SpectrumLocation>/modules/fcc/fcc.properties in these properties:
    • fcc.spectrum.list.job.base.path=C:/FCC_Repo/lists

    • fcc.spectrum.base.path=C:/FCC_REPO

  2. Run the Spectrum- CLI: copy spectrum-cli-<spectrumversion> placed at <SpectrumLocation>/server/app/exports and unzip it outside the Program Files folder in the same drive or you can download Administration Utility placed under the Command Line at server:port/dcg.

    Where server is the server name or IP address of your Spectrum™ Technology Platform server and port is the HTTP port. By default, the HTTP port is 8080.

  3. Go to <SpectrumLocation>/server/modules/fcc/FCC_Repo/setup/cli, you will see these files - cli_screener_setup.sh , cli_screener_setup.cli, and screener_setup.txt. Copy these files to the folder where you unzipped the spectrum-cli-<spectrumversion>.zip file.
    The screener_setup.txt file contains configurable properties, you need to set these prior to running the setup script:
    • host: Machine where the Spectrum™ Technology Platform Server needs to be setup is running.
    • port: Port on which Spectrum™ Technology Platform is running
    • user: Spectrum™ Technology Platform User, should be an administrative user
    • password: Spectrum™ Technology Platform Password
  4. For executing the screener files, open the command prompt with Admin privileges. Then go to the CLI folder and run the cli_screener_setup.sh file.
  5. Enter these details in the command prompt:
    • Path for the FCC_Repo folder; this will be same as specified in the first step.
    • Path for the Spectrum UAM US, UAM CAN, UAM INT, and LOQATE databases.
      Note: For LOQATE, enter the Loqate database extracted folder path.

Invoking the Screener Secured Entity Manager

To synchronize secured entities such as ListType, List, and Party Group, invoke the Screener Secured Entity Manager through JMX Console and follow these steps:

  1. Go to http://server:port/jmx-console

    Where server is the server name or IP address of your Spectrum™ Technology Platform server and port is the HTTP port. By default, the HTTP port is 8080.

  2. Log in using your credentials.
  3. Search for Screener Secured Entity Manager
  4. Click com.pb.spectrum.fcc.security.ws: manager=ScreenerSecuredEntityManager, a page showing the Attributes and Operations is displayed.
  5. Click the Invoke button, Invocation Successful message is displayed.

Running the List Ingestion Utility

To setup this utility, Go to this path:

<SpectrumLocation> \server\modules\fcc\ListIngestionUtiltity and copy the ListIngestionUtility to a different location which should be outside and at the same level as Program Files.

Now, you can run the list ingestion utility in two ways:
  1. Go to the ListIngestionUtility folder, open the command prompt as admin and run this script in the command line: java -cp fcc.jar com.pb.spectrum.fcc.job.Main -u <Spectrum Username> -p <Spectrum Password> -h <Spectrum Server> -s <Port> -x <Path of List Polling Directory>.

    A sample command- java -cp fcc.jar com.pb.spectrum.fcc.job.Main -u xyz -p abc -h myServer -s 8080 -x "C:/FCC_Repo/CreateListIndex/poll"

    Note: <Path of List Polling Directory> must match the fcc.spectrum.list.job.poll.dir property file placed at modules/fcc/fcc.properties, this path should also exist on the server.
  2. The second method to run this utility:

    A command file StartListIngestion.cmd at <SpectrumLocation>server\modules\fcc\FCC_Repo\setup\cli is provided. You must copy this command file to the ListIngestionUtility folder and run as an administrator. The default parameters of this file are: polling directory- C:/FCC_Repo/CreateListIndex/Poll host- localhost, port - 8080, user-admin, and password-admin. If you wish to change the default options, those can be edited here.

    For AWS ec2 instance, no admin permissions are required.

The Log file for this utility fcc.log will be generated at <SpectrumLocation> \server\modules\fcc\ListIngestionUtiltity. This utility will be polling at the base directory for any changes made by uploading List files or by directly copying these to Import folder.

Any List file uploaded through the pre-process flow will be placed in the polling directory with this hierarchy:

PollingDirectory > ListType > Vendor > ListID > Import > InputFile

Note: This execution can also be triggered directly by placing the input file in Import directory.
After the completion of this utility, List_in.csv file placed in the Import directory will be moved to NewListVersion/archive Listversion directory. The import status field on the Lists page changes to Succeeded.

List Import utility – Upload and Polling

To import any List files from the Screener or to directly upload these to the polling or base directory, you need to configure and start ListIngestion utility.

Configuring a Pre Process Flow

For ingesting a list to screener, it should be in standard canonical format. A sample of the same resides at <SpectrumLocation> \server\modules\fcc\FCC_Repo\CreateListIndex\Input\List_in.csv. If not, create a pre-config flow for every unique combination of ListType and Vendor.
Multiple files can be provided as input and the output should be a standard output file in fixed canonical format
Note: Number and order of columns of the output file must match the input file of the list ingestion process flow.

All the fields such as ListType, Vendor, Mappings, and FlowName of the Inspection Input tab are mandatory.

The Mappings section displays a list of files and their Mode, Info and Stage. The Label field gets generated in the flow.
  • The Mapping Mode can be IN or OUT, specify IN or OUT depending on whether you want to Read from File or Write to File.
  • The Info field specifies the information about the file such as address, email, and name. This is helpful during uploading a file.