Installing Screener for the first time

This section guides you through the steps for installing the Spectrum™ Technology Platform and running the script to set up the Screener module for the first time.
  1. Install the Spectrum™ Technology Platform. For steps on installing the server, see Installing a New Server section of the Installation Guide.
    Note: When prompted to select modules, ensure that you select all these:
    • Business Steward Module
    • Data Integration Module
    • Data Hub Module
    • Spectrum Screener
    • Universal Addressing Module
    • Universal Name, Data Normalization, and Advanced Matching Modules
  2. Stop the Spectrum server and 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. Repeat this step by selecting Open Parser and Table Lookup.
    Note: For information on database utility, see Installing the Advanced Matching Module Database section of the Installation Guide.
    Note: 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.
  3. Configure these properties in the fcc.properties file here: <SpectrumLocation>\server\modules\fcc\fcc.properties
    1. The base path where the List Import/Export files are created: fcc.spectrum.list.job.base.path
    2. FCC Repo base path: fcc.spectrum.base.path
    3. The polling directory for list ingestion: fcc.spectrum.list.job.poll.dir
    4. Upload path for Attachments: fcc.spectrum.attachments.upload.path
  4. Start the Spectrum server and import the Spectrum™ Technology Platform license key. For more information, see Installing a License Key in the Installation Guide.
  5. Deploy the SPD files for Spectrum data sets (UAM-US, UAM-CAN, Loqate) to the server here : <SpectrumLocation>\server\import.
    Note: If you do not deploy the SPDs to import directory, that is, if you do not have SPD files, you will be prompted to provide the base paths for respective data bases while running the setup script. See step 8 below.
  6. Ensure these pre-requisites are met before you run the set-up script.
    • JDK 8+ is installed and JAVA_HOME environment variable is set accordingly.
    • jar command is running fine from command line.
      Note: To verify, open the Command Prompt and enter jar. If you see Command not recognized message, add the JDK/bin path to Path environment variable. Verify the jar command again in a new Command Prompt.
    • For Windows system, powershell and other commands, such as xcopy and findstr, which are contained in C:/Windows/System32, are working fine.
      Note: Type these commands in the Windows command prompt, and in case you get the error: Not recognized as an internal or external command, append the paths for powershell (C:\Windows\System32\WindowsPowerShell\<versionNo>) and System32 (C:\Windows\System32) to the Path environment variable.
  7. Set up these configurable properties in the screener_setup_win.txt file for Windows and screener_setup.txt file for Unix systems at: <SpectrumLocation>/server/modules/fcc/FCC_Repo/setup/cli.
    1. host: Machine where the Spectrum™ Technology Platform Server needs to be setup is running.
    2. port: Port on which Spectrum™ Technology Platform is running
    3. user: Spectrum™ Technology Platform User, should be an administrative user
    4. password: Spectrum™ Technology Platform Password
  8. Run the set-up script (ScreenerSetup.bat for Windows systems and ScreenerSetup.sh for Unix systems.
    Note: For Solaris and AIX platforms, automated scripts are not supported. In these cases you can only manually install the Sreener setup.
    • For Windows systems:
      1. Run Command Prompt as Administrator
      2. Change directory to location of the script (<SpectrumLocation>\server\modules\fcc)
      3. Run the script
    • For Unix systems:
      1. Go to the folder where the script is placed: <SpectrumLocation>\server\modules\fcc
      2. Execute the script.

    The script performs these tasks:

    1. Installs your custom tables and open parser domains
    2. Imports match rules and flows
    3. Creates database resources
    4. Creates Hub metadata model
    5. Creates list and party search indexes
    6. Runs the flow to load hub FCC_METADATA model with basic data which is required to run the Screener
      Note: To run the Unix script, you need to have appropriate permissions.
  9. If you have not already deployed the Spectrum dataset SPDs, the script prompts you for the same. In case you do not have SPDs enter the base DB path instead. For example, 
    "LOQATE folder not found."
No Vintage found for LOQATE. 
Enter base DB path for LOQATE or deploy the SPD and copy the exact vintage name here:
  10. If multiple vintages are installed for any of the dataset types, the script lists the vintage names with count, and prompts you to provide the exact vintage to be used. 
    "C:\Program Files \Pitney Bowes\Spectrum\Server\ref-data\Universal_Addressing_Module
\c1p\UAM-US_JAN2019\UAM-US\metadata.json"
"VINTAGE NAMES" - JAN2019 JUN2018
VINTAGE COUNT 2
2 VINTAGE for UAM US - JAN2019 JUN2018
  11. Invoke the Screener Secured Entity Manager and List Ingestion Utility Manager:
    1. To synchronize secured entities such as ListType, List, and Party Group, invoke the Screener Secured Entity Manager through JMX Console using 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, and click this ScreenerSecuredEntityManager link: com.pb.spectrum.fcc.security.ws: manager=ScreenerSecuredEntityManager. The Screener Secured Entity Manager page is displayed.
      4. Of all the operations displayed, invoke refreshSecuredEntities operation.
      5. Close the page when you receive the Invocation successful message.
    2. Invoke the List Injestion Utility Manager through JMX Console using these steps:
      1. Go back to All MBeans (upper right hand corner). Search for List Injestion Utility Manager, and click this ListInjestionUtilityManager link: com.pb.spectrum.fcc.job:manager=ListInjestionUtilityManager. The List Injestion Utility Manager page is displayed.
      2. Of all the operations displayed, invoke autoRestartPoller operation.
  12. Configuring a Mail Server using the Management Console: This is mandatory for enabling Screener to send out mail alerts to you. For steps on configuring, see Configuring a Mail Server section in the Administration Guide.
    Note: To map users who will be notified of list ingestion through file, go to the fcc.properties file at this path: <Spectrum_Installation_Location>\server\modules\fcc, and map the users in the fcc.spectrum.list.ingestion.email.roles.configurable property.