StarQuest Technical Documents

Quick Start Guide to Using SQDR Plus on Windows (Part 2)

Last Update: 6 February 2015
Product: SQDR Plus
Version: 4.50 or later
Article ID: SQV00PU008-WC

Untitled Document

Abstract

This Quick Start Guide describes how to install and configure all of the software you need to perform incremental replication operations using SQDR and SQDR Plus.

This document assumes that you have already performed the steps to prepare the Tier 1 source database system and install and configure the Tier 2 SQDR Plus server. If not, refer to the Part 1 section appropriate for your environment; see Quick Start Guide to Using SQDR Plus. You will need certain information gathered in Part 1; we recommend using the SQDR Plus Configuration Worksheet.

This document assumes that you are installing both SQDR Plus and SQDR on the same Windows computer. This configuration (known as a combined tier 2/3 implementation) is the most common deployment of the StarQuest Data Replicator solution. If you are using a split tier 2/3 implementation, return to the master index for the Quick Start Guide to Using SQDR Plus and select the appropriate Part 2 document.

General considerations

The same individual or a combination of individuals must be capable of performing in the following three roles in order to successfully complete the evaluation.

  • Tier 1 Database Administrator (DB2 Administrator) is someone with administrative authority on the Tier 1 source system.
  • Tier 3 Administrator is someone with administrative authority to install SQDR on a Windows computer. This person must also have a set of DB2 user credentials that provide adequate authority to work with the libraries and tables you want to replicate.

The Windows client platform that will run SQDR must have:

  • TCP/IP access to the source database host and the destination database.
  • A supported web browser for managing the SQDR Plus server.

     

SQL Server considerations

  • The collation of the SQL Server database to where data will be replicated should be case-sensitive. Verify the collation for the database by viewing the database properties in the SQL Server Management Studio. A case-sensitive collation will have the characters “CS” appended to the Collation Designator. For example, the collation SQL_Latin1_General_CP1_CS_AS is a case-sensitive collation for U.S. English systems. Refer to the SQL Server Books Online for more information on collation values.

Summary of tasks

Perform the tasks in the order described, noting that some provide information used in subsequent steps. The detailed instructions for each task follow this summary.

  1. DB2 Administrator: Using StarAdmin (typically installed with SQDR Plus), bind packages to the database. This requires knowledge of the database host and sufficient user privilege. Provide database connectivity information to the Client-Platform Administrator to be used when configuring a source.
  2. Client-Platform Administrator:
    1. Download SQDR using the download link from step 2 in Part 1 and install the software. This installation includes the StarSQL ODBC driver.
    2. Install ODBC drivers for source and destination databases if necessary, and determine connection strings for the source and destination databases.
    3. License the software using the Registration Key from step 2 in Part 1.
    4. Run the SQDR configuration, connecting to the DB2 for LUW instance installed with SQDR Plus.
    5. Configure an SQDR incremental replication group and replication subscription.
    6. Review the subscription status.

Step 1: (DB2 Administrator task) Download and Install StarAdmin (if necessary)

Estimated Time: 10 minutes

The Windows installer for SQDR Plus includes StarAdmin, which will be used in the next step to bind StarSQL host packages.

 

Step 2: (DB2 Administrator task) Bind Host Packages Using StarAdmin

Estimated Time: 15 minutes

The database connectivity information collected in this section should be provided later to the SQDR Client-Platform Administrator for use in creating ODBC connection strings or data sources.

  1. Collect the DB2 host information and fill in the values for your environment in the space provided in the table below.
    Connection Parameter Description Your Value
    Host The network Host Name or IP address of the DB2 server.  
    Port

    The port number on which DB2 listens for connection requests, as determined during the pre-installation tasks.

     
    Database Name

    The name of the source DB2 database.

     
    Package Collection

    Set this value to SQDR.

    SQDR
    Username/Password A DB2 user account that has authority to create and bind packages in the SQDR collection.  
  2. Start the StarAdmin application from the Tools/StarAdmin subgroup of the SQDR Plus program group.
  3. Enter the database connectivity values in the Connection Settings dialog and click OK.
  4. Upon connecting successfully, StarAdmin will immediately bind one package, which will be displayed in the package list. The status bar at the bottom of the dialog will display the Database Name, Package Collection, DB2 Type, and Version. If StarAdmin fails to connect to the database, review the suggested resolutions in the Common Error Messages section of the StarQuest technical document Binding StarSQL Packages Using StarAdmin and make any necessary corrections to the values in the connection dialog.
  5. Leave the default values for the Package Settings and Grant Options.
  6. From the Command menu, select Bind to create and bind the remaining packages.
  7. Once the bind package operation has completed, review the summary dialog. If the packages are created and bound successfully, the summary output will look similar to the following:

Package binding starting: Wed Jul 29 14:44:03 PDT 2009
UID=SUPERUSER
HostName=DB2HOST.DOMAIN.COM
Port=446
Server=DB2PROD
PkgColID=SQDR
AutoTypDefOvr=
BindRules=RUN
CustomizePrdid=No
UseJumboPackages=No
UseEncryption=Any

jdbc:StarSQL_JDBC://DB2HOST.DOMAIN.COM:446/DB2PROD;collection=SQDR

SQL package SWNC0000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWNC0000 to PUBLIC
SQL package SWRU0000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWRU0000 to PUBLIC
SQL package SWRC0000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWRC0000 to PUBLIC
SQL package SWRR0000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWRR0000 to PUBLIC
SQL package SWTS0000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWTS0000 to PUBLIC
SQL package SWNC1000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWNC1000 to PUBLIC
SQL package SWRU1000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWRU1000 to PUBLIC
SQL package SWRC1000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWRC1000 to PUBLIC
SQL package SWRR1000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWRR1000 to PUBLIC
SQL package SWTS1000 in collection SQDR has been created.
Granted execute privileges on SQDR.SWTS1000 to PUBLIC
SQL package QSYS2 in collection SQDR has been created.
Granted execute privileges on SQDR.QSYS2 to PUBLIC

Package binding completed: Wed Jul 29 14:44:55 PDT 2009

If any errors are reported, review the suggested resolutions in the Common Error Messages section of the StarQuest technical document Binding StarSQL Packages Using StarAdmin, correct the problem and execute the bind operation again. If you are unable to resolve the error condition, copy the entire Summary text and send it to StarQuest Customer Support at contact@starquest.com.

  1. Copy the connection information at the top of the Summary text to the clipboard, as this information will be used in step 4c.
  2. Click the Finished button to return to the main dialog.
  3. From the File menu, choose Close Database and then Exit.

 

Step 3: Use DB2 for LUW for the SQDR Control Database

SQDR will use the DB2 for LUW instance installed with SQDR Plus; continue to the next step.

Step 4a: (Tier 3 Administrator task) Install the StarQuest Data Replicator Software

SQDR was installed as part of the SQDR Plus installation; continue to the next step.

Step 4b: (Tier 3 Administrator task) License the StarQuest Products

Estimated Time: 5 minutes

StarQuest products require a valid set of licenses for evaluation purposes. You can request license keys for multiple products at once, as described below. If the computer running the StarQuest software has access to the Internet, follow the Online Licensing Instructions below. Otherwise, follow the Alternate Licensing Instructions.

Online Licensing Instructions

  1. If the License Configuration utility is not already running already running, open the StarLicense Configuration utility from Start --> Programs --> StarQuest Data Replicator --> License Configuration.
  2. Click on the License Online tab. Select a License Lock Type, enter in the Registration Key provided in the download confirmation email from step 2 in Part 1 , and click Get License.

When the request successfully completes, the license(s) for the software you are registered to use appear in the License Keys list of the Licenses tab. The Registration Key may produce several License Keys, depending on the products you are registered to use. Subsequent attempts to use the same Registration Key will result in the identical License Key(s) being retrieved.

Alternate Licensing Instructions

  1. Open the License Configuration utility from Start --> Programs --> StarQuest Data Replicator --> License Configuration.
  2. Record the Host ID displayed on the License Online tab.
  3. From a computer that has access to the Internet, click on or browse to the following URL:

    http://starcust.starquest.com/Registration/index.html#license

  4. On the StarQuest Online Licensing Form web page, enter in the email address used for the original download request and the Registration Key you received in the download confirmation email.
  5. Enter the Host ID value recorded previously and select the "Node-locked" license option. Click Next.
  6. Review the information provided. If any changes are required, click Previous and modify the values as needed. Otherwise, click the Accept button.
  7. Copy the license key(s) displayed on the web page. You will also receive an e-mail with the license key(s).
  8. On the computer running the StarQuest software, open the License Configuration utility.
  9. Under the Licenses tab, click the Add button and enter in the license key. Repeat until all of the license keys have been entered.

Step 4c: (Tier 3 Administrator task) Install ODBC drivers for source and destination

Estimated Time: 5 minutes

You must have ODBC drivers for each source and destination type. In our example below, we will be using StarSQL to access an IBM DB2 for i source; StarSQL is already installed as part of the SQDR installation. For a SQL Server destination, we recommend installing the latest version of SQL Server Native Client (e.g. Native Client 11).

Step 4d: (Tier 3 Administrator) Configure the StarQuest Data Replicator Service

Estimated Time: 10 minutes

You must configure the Data Replicator service to create the control database tables.

  1. If the SQDR Configuration Wizard is not already running, launch it from the SQDR program group: Start—>Programs—>StarQuest Data Replicator—>Data Replicator Configuration.
  2. On the Control Database Logon panel, you can specify whether to use a connection string or an ODBC data source to connect to the SQDR control database. We will be using a connection string.
  3. Accept the default values to connect to the DB2 for LUW database "SQDRC" that was created during installation of SQDR Plus. Enter the credentials for the local Windows user sqdr that was created in Part I. Click Next to proceed.
  4. On the next panel, select the option Create new control tables and click Next.
  5. On the next panel, leave the Authorization ID at its default of SQDR and click Next.
  6. Continue clicking Next, accepting defaults for the remaining panels. Select Automatic as the Service Startup Type and choose the Local System Account as the Log On As user. If you would like to change the Data Replicator service properties, we recommend doing this in Windows Services once the SQDR configuration has been completed. Click Next.
  7. Review the configuration summary, choose to start the Data Replicator Service and Manager and click Finish to save the Data Replicator configuration.

 

Step 4e: (Tier 3 Administrator) Start the Data Replicator Manager and Create a Subscription

Estimated Time: 10 minutes

You use the Data Replicator Manager to set up and administer replication operations.

Define a Source

To define the source data that you want to replicate:

  1. In the main Data Replicator Manager window, right-click the Sources folder and select the Insert Source command.
  2. Create a source using connection strings:

    1. Select the ODBC Driver radio button.
    2. Select StarSQL (64-bit) from the list of ODBC drivers.
    3. The ODBC driver name will appear in the Source Name field. Be sure to modify this name to clearly identify the database; the name cannot be changed after it is saved. In our example, we are naming it DB2.
    4. Enter a valid connection string (maximum 254 characters). For StarSQL, the connection string will look like Server=MYRDB;HostName=myhostip;Port=446;IsolationLevel=2;PkgColID=SQDR
    5. Enter a user ID and password that has permission to access that database.

source 

  1. Click on the Advanced tab.
  2. On the Advanced dialog, set the default values for Database and/or Object Schema, as appropriate for your database. These values are necessary for the Copy Member operations.
  3. SQDR will automatically detect any available Capture Agent schemas and enable incremental replication. If multiple Capture Agent schemas are detected on the host system, select the desired schema from the drop-down menu.
  4. We recommend that you supply a Notification Address (host name or IP address) of the computer that you want to receive a UDP notification when changes are committed to this source. Configuring a notification address will reduce the time it takes for the SQDR client to detect and retrieve source table changes. The drop-down menu lists the IP addresses of all active network connections for the local machine. Select 127.0.0.1 from the drop-down menu.

source advanced

  1. Click OK to create the source.

Define a Destination

Now define the destination that will receive the replicated data.

  1. Right-click the Destinations folder and select the Insert Destination command.
  2. Create a SQL Server destination using connection strings:
  3. Select the ODBC Driver radio button.
  4. Select SQL Server Native Client 11 from the list of ODBC drivers.
  5. The ODBC driver name will appear in the Destination name field. Be sure to modify this name to clearly identify the database; the name cannot be changed after it is saved. In our example, we are naming it SQL Server.
  6. Enter a valid connection string (maximum 254 characters). For SQL Server, the connection string will look like Server=MYHOST\MYINSTANCE.
  7. Enter a user ID and password that has permission to access that database.

destination

  1. Click the Advanced tab.
  2. On the Advanced dialog, set the default value for the Database and/or Object Schema, as appropriate for your database. These values will be used by the SQDR subscription wizard to populate configuration fields and during Copy Member operations.

destination advanced

  1. Click OK to create the destination.

Create an Incremental Group

In this section you create a group in which to place one or more subscriptions that perform incremental replication operations between the specified source and destination.

  1. Right-click the Groups folder and select Insert Incremental Group. In the Group properties dialog, enter a name for the Group and an optional description in the Comment field. The default values for the remaining options are typically suitable for first-time users. To learn more about a particular option, click the Help button in this dialog to launch the SQDR online help topic for this tab.

sqdrplus

  1. On the Advanced tab, select the Source and Destination that will be used for each incremental replication subscription in this group. Ensure that the Receive Change Data Notifications from Capture Agent option is selected (i.e., checked). Leave the Apply options and Subscription Defaults as their default values and click OK to create the group.

Advanced Group Options

Create a Subscription

The Replicator Manager provides a Subscription Wizard to help you define the specific source data and how you want to replicate it.

  1. Right-click the Subscriptions folder beneath the source that you added and select the Insert Subscription command. The Add Subscription Wizard appears.
  2. In the Select the Source pane, select Incremental as the Replication Type and enter a schema or object name if you want to filter the source objects list. Click the Refresh button to display the available source objects in the right pane and select the source object you want to replicate. Click Next to proceed.

sqdrplus

  1. In the Select a Destination pane, select the destination you added to the Replicator Manager. Review the Destination Options and Replication Options, and click Next to proceed.
  2. Destination

  3. In the Select Group pane select the incremental replication group that you created earlier. Click Next to continue.

sqdrplus

  1. The Define Criteria pane allows you to specify a SQL WHERE clause in order to horizontally partition the data to be replicated. Enter a valid WHERE clause or leave the field blank. Click the Verify Criteria button to verify access to the table and that the number of rows to be returned are in the expected range. Click Next to continue.
  2. The Define Destination Columns pane allows you to review and change the data type mappings for the source and destination objects. If desired, modify the data types of the destination table by selecting one or more columns (use shift-click or control-click to select multiple columns), select Modify Column, make the desired change, and click OK. Click Next.

sqdrplus

  1. Click Next in the Create Statement pane. The CREATE TABLE statement will not appear until the subscription has been saved.
  2. On the Define Processing pane, enter optional host commands to be executed before and/or after the data is replicated. Click Next to continue.
  3. On the Indexes/Constraints pane, click Refresh to display any indexes or constraints defined for the source. Select any that you want to replicate to the destination and click Next.
  4. Review the default subscription name provided and, if desired, modify. Click Finish to save the subscription.

The subscription is added beneath the Subscriptions folder of the defined source and to the corresponding group.

Step 4f: Review the Subscription Status

Estimated Time: less than 5 minutes

After you define an incremental replication subscription, the Data Replicator runs a baseline snapshot replication that forms the base against which incremental changes are tracked. After the baseline snapshot replication succeeds, the source table is actively monitored by SQDR Plus for changes. This step shows you how to monitor the status of a subscription and a group of incremental subscriptions.

  1. Review the status of the subscription by highlighting the subscription in the left pane of the Replicator Manager.

sqdrplus

  1. Double-click the replication event, indicated by the sqdrplus icon, to view the statistics of the baseline snapshot. If the data did not replicate successfully, review the error(s) and correct the subscription properties as necessary.

sqdrplus

  1. Locate the member subscription under Groups, and double-click on the Replication Event to view the status of the subscription.

sqdrplus

After the baseline snapshot operation completes successfully the incremental subscription is automatically enabled and actively monitoring for changes at the source.

Continuing Your Software Evaluation

This Quick Start Guide was intended to help you install the StarQuest software and perform a data replication operation as quickly as possible.  Please continue to experiment with the software by adding additional subscriptions, scheduling replication operations, and performing SQL operations on data before and/or after it is replicated. As you experiment with the SQDR software, refer to the product documentation for more information.

  • The SQDR Plus Control Center (SQDR Manager) provides an online help system that provides more information about configuring and managing the SQDR Plus Staging Agent.
  • The Data Replicator Manager provides an online help system that provides more information about defining and running replication operations. Press F1 or click a Help button from the Data Replicator Manager to display the online help system.

If you encounter any problems while using the evaluation software, please open a support ticket at http://support.starquest.com or call +1 415.669.9619 for assistance.


DISCLAIMER

The information in technical documents comes without any warranty or applicability for a specific purpose. The author(s) or distributor(s) will not accept responsibility for any damage incurred directly or indirectly through use of the information contained in these documents. The instructions may need to be modified to be appropriate for the hardware and software that has been installed and configured within a particular organization.  The information in technical documents should be considered only as an example and may include information from various sources, including IBM, Microsoft, and other organizations.