Migrating Channel from DSS Version 5 to DSS Version 6 - DSS 6 | Data Source Solutions Documentation

Documentation: Migrating Channel from DSS Version 5 to DSS Version 6 - DSS 6 | Data Source Solutions Documentation

Migrating Channel from DSS Version 5

This section describes the steps to migrate channel definitions from DSS 5 to DSS 6 using the dssconvert5to6 script. This script is suitable for migrating channel definitions only. It does not manage the capture status (e.g., transaction log position) in the DSS 5 channel. Therefore, it is not suited for situations that require replication to resume in DSS 6 from where it was stopped in the DSS 5. For such cases, see section Upgrading From DSS 5.

You can find the script in the DSS_HOME/script/ directory of the DSS 6 distribution. It exports one or more DSS 5 channels to an DSS 6 compatible import file (JSON) from either an DSS 5 catalog export file (XML) or DSS 5 hub database. The resulting JSON file is then used to import the channels to the DSS 6 Hub.

The exported channel definition includes:

Locations
Location group membership
Tables
Actions, including configuration actions

DSS version 5.3 or above is required to run the dssconvert5to6 script.
The dssconvert5to6 script must be executed on the DSS 5 system because the DSS 5 command dss is used to run the script.

For differences between DSS 5 and DSS 6, see section Important Notes When Upgrading from DSS 5.

Prerequisites

Ensure the following requirements are met before migrating from DSS 5 to DSS 6:

DSS 6 is already installed and configured.

DSS 6 must be installed as a separate system, to a directory other than the DSS 5 DSS_HOME and DSS_CONFIG directories.

Do not disable/uninstall DSS 5 before ensuring DSS 6 works properly.
Before disabling DSS 5, it is recommended to take a full backup of the following DSS 5 objects:
- the DSS_HOME and DSS_CONFIG directories.
- the Hub database using the DBMS native backup option.
Perform the migration during scheduled downtime, as all DSS running services (DSS Agent Listener) must be stopped during the migration.

dssconvert5to6

NAME

dssconvert5to6 - DSS 5 to DSS 6 channel migration

USAGE

dss dssconvert5to6 -f xmlfile [-c chn]... hub output.json dss dssconvert5to6 [-c chn]... [-h class] [-u user[/pass]] hub output.json

DESCRIPTION

Exports one or more DSS 5 channels to an DSS 6 compatible import file, from either an DSS 5 catalog export file or an DSS 5 hub database.

OPTIONS

Parameter	Description
`-cchn`	Channel name
`-fxmlfile`	DSS 5 catalog export output file
`-hclass`	DSS 5 hub class
`-uuser[/pass]`	Database username and password for relevant hubs

Migration Steps

Follow these steps to migrate DSS 5 channels to the DSS 6 Hub:

If the DSS 5 and DSS 6 systems are installed on separate machines, copy the dssconvert5to6 script (available in DSS_CONFIG/script directory) from DSS 6 to DSS 5 machine.
Export DSS 5 channels to an DSS 6 compatible import file (JSON). There are two ways to do this:

The dssconvert5to6 script must be run in the DSS 5 system.

- **Method 1:** Generate DSS 5 channel export file (XML) and convert it to DSS 6 compatible import file (JSON).
    1.  Use the DSS 5 command [**dsscatalogexport**](/docs/dss5-commands-dsscatalogcreate-dsscatalogdrop) or the **Export Catalogs** option in DSS 5 graphical user interface to generate the DSS 5 channel export file (XML).  

    2.  Run the **dssconvert5to6** script to convert the DSS 5 channel export file (XML) to DSS 6 compatible import file (JSON):  
        ```shell
        dss <em>dssconvert5to6_script_path</em>/dssconvert5to6 -f <em>dss5_export</em>.xml <em>dss5_hub output</em>.json
        ```

        To migrate a specific channel (e.g. **mychannel**) only, use option `<b>-c</b>`:
        ```shell
        dss <em>dssconvert5to6_script_path</em>/dssconvert5to6 -c mychannel -f <em>dss5_export</em>.xml <em>dss5_hub output</em>.json
        ```

- **Method 2:** Connect directly to DSS 5 hub database and generate the DSS 6 compatible import file (JSON) using the **dssconvert5to6** script:  
        
     ```shell
     dss <em>dssconvert5to6_script_path</em>/script/dssconvert5to6 -h oracle -u <em>dssuser</em>/<em>password </em><em>dss5_hub output</em>.json
     ```
       
       <div class="callout callout-note">

For more information about using option -h for other location types (class), see Calling DSS on the Command Line (DSS 5).

In the DSS 6 system, use the dssdefinitionimport command to import the contents of the JSON file to the DSS 6 Hub.
```
dssdefinitionimport dss6_hub output.json
```
Alternatively, use the Import Channel Definition option in the DSS 6 User Interface.