The RED Migration Tooling allows you to migrate metadata repositories from WhereScape RED 8.6 and 9.0 to WhereScape RED 10.4+. The following sections provide information on how to install and use the RED Migration Tooling. 

Prerequisites

License

The RED Migration Tooling requires a 'Custom Target' enabled license. This is because the tooling will use the Custom Target database type for loading into the destination PostgreSQL RED metadata database. For customers on a traditional SQL Server, Oracle or Teradata target your license may need to be temporarily upgraded to support the migration by adding a Custom Target.

Source Metadata

Source Metadata: 

• A RED Metadata Repository on SQL Server, Oracle or Teradata which has a RED version of 8.6 or higher
• ODBC DSN and user with at least select permissions to the source metadata database.

Data Warehouse:

• Any data warehouse platform where the RED 10 version of the WhereScape Target Enablement Pack is available.

Destination Metadata

Destination Metadata: 

• An empty PostgreSQL database to become your migrated metadata repository.
• An ODBC DSN and user with full permissions on the database (see setting up database and users in PostgreSQL for RED).
• Compatible PostgreSQL command line tools.

Data Warehouse:

• A downloaded and unzipped RED 10 WhereScape Target Enablement Pack for your data warehouse platform.
• All prerequisites as outlined in your WhereScape Target Enablement Pack's install guide.   
• All Data Warehouse Source ODBC Drivers, DSN's and and any required platform specific native tooling are installed and configured (if you are running RED 10 side by side with your Source RED 8.6+ repository then these Drivers, DSN's and tooling should already exist).

Migration Tooling

Migration Tooling Metadata: 

• An empty PostgreSQL database to house your Migration Tooling, this database can be removed once migration is complete.
• An ODBC DSN and user with full permissions on the database (see setting up database and users in PostgreSQL for RED).
• Compatible PostgreSQL command line tools.

Tooling:

• Downloaded and unzipped Migration Tooling Enablement Pack.
• RED 10.4.0.2 or higher installed.
• Valid RED license installed with a Custom Target enabled.

How the Migration Tooling Works

The RED Migration Tooling is provided as an Enablement Pack which is installed, using the RED Setup Wizard, to a dedicated PostgreSQL database. Once installed you will have a RED metadata repository + the Migration Tooling Enablement Pack which provides a set of scripts and jobs to transfer RED Metadata from a Source of SQL, Oracle or Teradata to a Destination of PostgreSQL and then reconfigure the Destination to suit RED 10 and the Azkaban Scheduler.

The Migration Tooling requires the following named connections in RED:

Installing the Migration Tool

Check Prerequisites

Check that you have met the prerequisites to begin, here is a quick checklist:

• Destination database created on PostgreSQL with a working ODBC DSN configured for it.
• Migration Tooling database created on PostgreSQL with a working ODBC DSN configured for it.

Run the RED Setup Wizard

1. Launch the RED Setup Wizard (RedSetupWizard.exe) from the RED installation directory
2. Select Create a new repository.
3. Configure the metadata database - this will be your Migration Tooling metadata.
   
4. Select the directory that contains the unzipped RED Migration Tooling. Click Next.
   
5. Review the components that will be installed. Click Next.
   
   

Create Target Connections

You must create two PostgreSQL connections with the following characteristics:

Adding the 'Target' Destination Metadata Connection

The connection named 'Target' will be your PostgreSQL connection to your database to house the migrated RED metadata repository. 

1. On the Connection Name field, ensure to enter 'Target' as a name. On the Target Storage Locations field, ensure to enter 'red'.
2. Complete the other fields with the appropriate data, then click Validate to check your configurations.
   
3. Once you validate your configurations click Add.  
4. On the Add Targets screen you will see the connection you just added. Click Add another target to add the Reports connection.
   

Adding the 'Reports' Migration Tooling Metadata Connection

The connection named 'Reports' will be your PostgreSQL connection to your Migration Tooling metadata repository, which allows us to add targets to the tooling metadata database for reporting.

1. On the Connection Name field, ensure you enter 'Reports' as the connection name. On the Target Storage Locations field, enter 'red' as the storage location.
2. Complete the other fields with the appropriate data, then click Validate to check your configurations.
   
3. Once you validate your configurations click Add.  
4. On the Add Targets screen you will see the two connections you just added. Click Next continue and add the source connection.
   

Create the Source Metadata Connection

1. On the Add ODBC Sources screen, configure a connection with 'Source' as the connection name, select the DSN relating to your existing RED 8.6 or 9.0 metadata repository. Click Validate to check your connection and then click Add.
   
   
2.  The Add ODBC Sources screen will show the connection you just added. Click Next to continue or click Add another source to add more sources.
3. On the Summary screen review your configurations are correct, you can click Previous to make changes or click Install to continue. 
   

Once the installation finishes, click Finish to close the installer and launch RED.

Enter your login settings and click Connect.

Migration Preparation

Migration Preparation Script

When WhereScape RED starts for the first time, after the installation steps described in the previous section, the script that prepares the Migration Tooling executes automatically.

If you get failures in the Reports pane after opening WhereScape RED, then one or more of the preparation steps in the host script named '1_prepare_migration' did not succeed.

Take note of the failure message and see if you can correct the issue, then rerun the script. On subsequent script runs you may get additional failures due to the earlier run having already applied a change but in general rerunning this script will not cause issues and some failures when re-run may be dismissed.

If you have not set up the required connections, the Results pane will display a failure message similar to the image shown below. Please expand the Connections node in the left tree and add or amend connections as required before rerunning the script.

If you do add or adjust connections at this point, then ensure you 'Save your Connection Profile' and restart RED so that the in-memory profile of connections credentials is up to date.

The Migration Preparation Script will prompt for two items:

1. Source Repository Database Type - either SQL Server, Oracle or Teradata
2. Target Database Enablement Pack - this is the location of the unpacked RED 10 compatible Target Enablement Pack for your licensed target

Manual Steps and checks after RED Migration Tooling starts

Check Connections

For each connection Target, Source and Reports:

1. Open the connection and click the 'Derive' button to ensure the server and port fields are up to date.
2. Browse the connection to ensure the credentials are working (note that the Target connection will not have any objects to display yet).

Check Parameters

Check the Parameters which the start-up script added make sense for your environment, here is an example below:

Setup the Migration Tooling Azkaban Scheduler on Windows

Windows Scheduler Installation

We'll need a Windows Scheduler installed to perform the migration tasks. Follow the Windows Scheduler Installation instructions to install a WhereScape RED Scheduler for the RED Migration Tooling metadata.

Configure the Scheduler Credentials in RED

After installing the Scheduler ensure to enter your scheduler credentials into the Configuration page of the Scheduler tab in RED, then Save your Profile again to ensure your credentials are preserved between RED sessions.

Configure the Scheduler Profile

Before running any jobs, you must first setup the Scheduler Profile which adds the encrypted connection credentials rows for the connections in RED. This makes those credentials available to scheduled jobs. To do this run the script 'wsl_scheduler_profile_maintenance' found under 'Host Scripts' in the object tree in RED.

Run the Migration Jobs

todo: add details of the jobs and what they do

Run the Destination Configuration Scripts

todo: add details of the scripts

Troubleshooting