Introduction

Sample Template is a set of pre-configured templates using which you can demonstrate Spectrum migration capabilities. It eliminitates the need to create data flows from scratch. You need to create a couple of connections and import these flows into your system to demonstrate the migration capabilities. This section describes the end-to-end process of data migration using sample flows.

Locating the Sample Template

The sample template is shipped with the Spectrum Technology Platform installer zip. Depending on your installation directory, you can find the sample template at the following path:
Program Files\Pitney Bowes\Spectrum\server\modules\metadata-insights\connectors\samples
The folder contains all the required files to configure the data flow.

Creating Connections

You need to create two connections to import and deploy required files to configure the data flow. Follow these steps to create connections:

  1. Install the latest Spectrum platform Server
  2. Open the Spectrum Server home page
  3. Click Platform Client Tools and then click Web
  4. Open the Management Console view
  5. Click Resources menu and then click Data Sources and create two connections.

Importing and Deploying Files to the Server

With connection in place, now you need a command line utility to import and deploy the files to the server.

  1. Open the Spectrum platform home page, click Platform Client Tools followed by Command Line and download the following files:
    1. Job Executor, which is an individual .jar file
    2. Administration Utility, which is a zipped file (spectrum-cli)
  2. Unzip the spectrum-cli file
  3. Copy all the files from the Sample Template folder to the spectrum-cli folder. This saves you from entering full path of every file with each command
  4. Run cli.cmd utility located in the spectrum-cli-12.1 folder. The command line interface of the Spectrum Platform is launched
  5. Connect to the Spectrum Server using following commands: connect <server name>:<port> --u <username> --p <password>. Successful connection is confirmed by message: Connected to server<server name> :< port>
  6. Type and execute the following commands in the given order to import and deploy the sample data flows:
    1. Import modelstore using command: spectrum> modelstore bulkImport --importDependency true This command imports the modelstore with all the dependencies.
    2. Deploy modelstore using command:modelstore deploy --n <name>
    3. Import dbconnection using command: dbconnection import --f <name.json>
    4. Import data flows using command: dataflow import --f <name.df>
Note:

Remove any extra spaces around commands of filenames

Replace the placeholder <name> with the exact name of the file

Viewing Imported Files

After successful import, you can use these data flows to demonstrate the Spectrum capabilities. Files are stored at following locations:

  1. Modelstore: In the Physical Model and Model Store tabs in Metadata Insights
  2. Dataflow: In the Server Explorer of Enterprise Designer application
  3. Json: In the Model Store in Management Console

Imported flows can be used to migrate data from one system to other using Enterprise Designer. Detailed steps for each of the flows is mentioned in their respetive following secitons.

Note: These sample templates are part of the Spectrum installer file and do not work standalone. There is no further support available for these samples.