StarQuest Technical Documents

Quick Start Guide to Using SQDR Plus for iSeries with the StarSQL ODBC Driver

Updated: 17 August 2012
Product: StarQuest Data Replicator Plus for iSeries
Version: 3.69 or later
Article ID: SQV00PL001

Abstract

This Quick Start Guide describes how to install and configure all of the software you need, including the StarSQL ODBC driver and StarAdmin, to perform incremental replication operations using SQDR and SQDR Plus for iSeries.

This document is intended for first-time users of SQDR and SQDR Plus for iSeries. Users who are upgrading an existing installation should refer to the SQDR Release Notes or SQDR Plus Release Notes and the SQDR Plus for iSeries User's Guide for upgrade instructions.

The estimated time to complete all tasks is approximately 2 hours.

SQDR Plus for iSeries Quick Start Guide Outline

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.

  • iSeries Administrator is someone with an OS/400 user ID with Security Officer (SECOFR) authority.
  • SQL Server Administrator is someone with system administrator ("sa") authority or is a member of the sysadmin fixed server role on the SQL Server database, or has Windows administrative authority to install a version of SQL Server.
  • Client-Platform Administrator is someone with administrative authority to install StarAdmin, StarSQL, and 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.

General considerations

  1. The Windows platform that will run StarAdmin, StarSQL, and SQDR must have:
    • TCP-IP access to the database host.
    • .NET Framework 2.0 or later (3.5sp1 or later recommended)
    • A version of Microsoft SQL Server installed. This is because SQDR uses a SQL Server database to store replication subscription information. If you do not already have a SQL Server installation, you can obtain the Microsoft SQL Server 2000 Desktop Engine (MSDE 2000) or the SQL Server 2005/2008/2012 Express Edition free of charge from Microsoft to use as a control database for the Data Replicator. The StarQuest Technical Document Installing SQL Server for a Control Database provides details for using MSDE 2000 or 2005/2008/2012 Express with SQDR.
  2. The client computer from which you will run the SQDR Plus installer must have:
    • TCP-IP connectivity to the target iSeries computer. 
    • A Java Virtual Machine (JVM) or Java Runtime Environment (JRE) installed and specified in the system PATH. You can obtain the Java Runtime Environment free of charge from Oracle at http://www.java.com/en/download/. From a command prompt, run the java -version command to verify that Java is installed and can be located, as shown in the following example.

    C:\>java -version

    java version "1.6.0_03"
    Java(TM) SE Runtime Environment(build 1.6.0_03-b05)
    Java HotSpot(TM) Client VM (build 1.6.0_03-b05, mixed mode)

    • A 5250 emulation application or the ability to use "telnet" to verify some values during setup.

SQL Server considerations

  1. 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 Enterprise Manager (SQL Server 2000) or the SQL Server Management Studio (SQL Server 2005/2008). 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.
  2. Depending on the type of authentication that is configured for the SQL Server, you must have a SQL Server user ID (if using SQL Server and Windows authentication) or a Windows user ID (if using Windows-only authentication) that is a member of the System Administrators (sysadmin) server role.

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. Request to download SQDR Plus for iSeries.
  2. Receive the e-mail with a Registration Key and download links for StarAdmin, StarSQL, SQDR, and SQDR Plus.
  3. iSeries Administrator: Download StarAdmin using the download link from step 2 and install the software.
  4. iSeries Administrator: Download SQDR Plus using the download link from step 2, complete the pre-installation tasks, and install the software.
  5. iSeries Administrator: Using StarAdmin, 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 in step 7c.
  6. iSeries Administrator: Install and configure SQDR Plus Remote Admin (CAMAINT), and verify SQDR Plus installation using CAMAINT.
  7. Client-Platform Administrator:
    1. Download StarSQL using the download link from step 2 and install the software.
    2. License the software using the Registration Key from step 2.
    3. Create ODBC DBMS Data Sources for the source and destination databases.
  8. SQL Server Administrator: Start the SQL Server service and configure ODBC DSN for the control database.
  9. Client-Platform Administrator:
    1. Download SQDR using the download link from step 2 and install the software.
    2. Run the SQDR configuration, connecting to the local SQL Server using the DSN created in step 8.
    3. Configure an SQDR incremental replication group and replication subscription.
    4. Review the subscription status.

Step 1: Request SQDR Plus for iSeries Software

Estimated Time: 5 minutes

All software packages are distributed as compressed files that you download from the StarQuest Ventures Web site. From a web browser enter the address http://www.starquest.com/ and click on Download for Trial under the Products menu. Request to download SQDR Plus for iSeries. When the request is fulfilled, you will also receive StarSQL and StarAdmin.

Step 2: Receive the Download Confirmation E-mail from StarQuest

Estimated Time: 5 minutes

After submitting a request to download SQDR Plus for iSeries, you will receive an e-mail containing a Registration Key and download links for the SQDR Plus, StarAdmin, StarSQL, and SQDR software. The registration key will be used in step 7b to obtain temporary license keys valid for 15 days and the download links will be used in steps 3-9 below.

Step 3: (iSeries Administrator task) Download and Install StarAdmin

Estimated Time: 10 minutes

The user who installs StarAdmin must be an administrator on the Windows platform. Download StarAdmin to a temporary directory using the download link from step 2 and install the software using the instructions below.

  1. Log on as an administrative user.
  2. Execute setup.exe to launch the installer.
  3. If prompted to install the Microsoft Visual C++ 2008 SP1 Redistributable package, click the Install button.
  4. On the Welcome dialog, click Next.
  5. Accept the License Agreement and click Next.
  6. Accept to install StarAdmin in the default directory of C:\Program Files\StarQuest\StarAdmin or browse to select an alternate directory. Click Next to continue.
  7. Click Install to begin the installation or click the Back button to make any changes.
  8. After the installation is complete, click Finish.

StarAdmin will be used in step 5 to bind StarSQL host packages.

Step 4: (iSeries Administrator task) Download and Install SQDR Plus

Estimated Time: 35 minutes

Before you begin, complete the following pre-installation tasks to ensure that the iSeries meets the minimum requirements. You cannot successfully complete the installation until these requirements are fulfilled.

Pre-installation Tasks

Estimated Time: 15 minutes

  1. Start a 5250 session, using either emulation software or the telnet command, and sign on to the iSeries with a SECOFR user profile.
  2. Ensure that the installed version of Operating System/400 (OS/400) is release v5r3 or later.
    Run the OS/400 command GO LICPGM at the command line. Select option 10, "Display installed licensed programs" and press F11. The Installed Release column displays the version of the Operating System/400 software.
  3. Confirm that Qshell is installed.
    Run the command GO LICPGM and select option 10, "Display installed licensed programs," and look for Licensed Program 5722SS1 (or 5761SS1 for V6R1 or 5770SS1 for V7R1) with an Installed Status of *COMPATIBLE and a Description of “Qshell, Program Option 30.”
  4. Confirm that the Java Developer Kit is installed.
    Run the command GO LICPGM. Select option 10, "Display installed licensed programs," and look for Licensed Program 5722JV1 or 5761JV1 with an Installed Status of *COMPATIBLE and a Description of “Java Developer Kit 1.4, Program Option 6” or a higher version (e.g. J2SE 5.0, Java SE 6, or Java SE 7).
  5. Verify that the SYSIBM library is complete.
    Run the command CALL QSYS/QSQIBMCHK to invoke the SYSIBM object verification tool. If any objects are missing, run the command CALL QSYS/QSQSYSIBM to create any objects missing from the SYSIBM library. Contact IBM Customer Support if assistance is needed or if you need to obtain the QSQIBMCHK and QSQSYSIBM programs.
  6. Verify that the following cumulative PTF, DB2 Group PTF, and Java Group PTF packages, and the appropriate individual PTFs have been installed on the OS/400 system. The OS/400 system should have the following fixes or their superseding fixes applied.

OS Version

CUM PTF

DB2 Group

Java Group

Individual PTFs

V5R3

C6101530 (March 2006)

SF99503-9 (March 2006)

SF99269-10 (March 2006)

5722SS1-SI18139

V5R4

C6115540 (April 2006)

SF99504-3 (March 2006)

SF99291-2 (March 2006)

5722SS1-SI36059

5722SS1-SI36406

V6R1

C0047610 (Feb 2010)

   

5761SS1-SI39331 †

V7R1

C0229710 (Aug 2010)

 

 

 

†  Install this PTF if you are working with LOB data.

 

To verify that an individual PTF has been installed, use the DSPPTF command, entering the License Program (Product) number and the PTF number to select, as in the following example.

DSPPTF LICPGM(5722SS1) SELECT(SI18139)

View the General Information for the PTF and verify that the PTF status is either Superseded, Temporarily applied, or Permanently applied.

To review the DB2 Group or Java Group PTF packages that are installed, run the WRKPTFGRP command and browse the list of installed PTF Groups and cum PTF level.

  1. This Quick Start Guide assumes that the default configuration values are used during the installation as they are generally appropriate in most environments. Make a note of the optional email notification values for your environment if you want to specify these values during installation. You can leave these fields blank during the installation and configure the email notification feature at a later time. Refer to the SQDR Plus for iSeries User's Guide for more information about these parameters.

Configuration Parameter

Sample Value

Your Value

SMTP Server:

mail.mydomain.com

 

From:

sqdr@mydomain.com

 

To:

sqdradmin@mydomain.com

 

Notification Level:

SEVERE

 

Download and Install the SQDR Plus Software

Estimated Time: 20 minutes

The SQDR Plus installer requires a GUI environment, so it is typically run on a remote system, such as on a computer that is running Windows, MaxOS X, or UNIX with X Windows. The computer from which you run the installer must have TCP-IP connectivity to the target iSeries computer. The instructions and illustrations that follow reflect using a Windows computer.

  1. Download SQDR Plus for iSeries to a temporary directory using the download link from step 2.
  2. Run setup.exe from the SQDR Plus installer image. In the Signon to the Server dialog, enter the system name, a powerful (SECOFR) user ID, and password for accessing the iSeries computer and click OK.
  3. Accept all of the default values in the installer dialogs, except for those values gathered in step f of the pre-installation tasks above if you want to configure the email notification feature.

Note that the Capture Agent Maintenance utility allows you to specify which tables in the database are available for replication. During the installation, only enable the checkbox for the Restrict Subscriptions to Published Tables option if the security policy for your AS/400 requires this. This option can be changed at any time after the software is installed.

Step 5: (iSeries 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 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 iSeries.  
    Port

    Use the WRKSRVTBLE command and look for the DRDA entry with the port number.

     
    Database Name

    Run the AS/400 command WRKRDBDIRE and locate the entry with a Remote Location value of *LOCAL. If such an entry does not exist, create it with the 1=ADD option.

     
    Package Collection

    Set this value to SQDR.

    SQDR
    Username/Password An iSeries user account that has authority to create and bind packages in the SQDR collection.  
  2. From the StarAdmin program group, start the StarAdmin application.
  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 7c.
  2. Click the Finished button to return to the main dialog.
  3. From the File menu, choose Close Database and then Exit.

Step 6: (iSeries Administrator task) Install and Configure SQDR Plus Remote Admin

Estimated Time: 10 minutes

Install and Configure SQDR Plus Remote Admin

The SQDR Plus installer image includes the SQDR Plus Remote Admin (CAMAINT) software, which can be used to remotely administer and monitor the SQDR Plus software on the iSeries. Install SQDR Plus Remote Admin on the Windows computer that will run SQDR.

  1. In the SQDR Plus installer files, open the SQDRPlusAdmin folder and run setup.exe. Respond to the installer wizard prompts to install the software.
  2. From the SQDR Plus Remote Admin program group, run the Edit camaint.bat task to open the camaint.bat file in Notepad.
  3. Edit the file to set appropriate values for RDB, HOST, PORT and USER, as shown in the following example, and save the file.

    set RDB=DB2PROD
    set HOST=DB2HOST.DOMAIN.COM
    set PORT=446
    set USER=SUPERUSER
    set COLLECTION=SQDR

Verify the SQDR Plus Capture Agent is Running and Test Support Functions (Client-Platform Administrator task)

  1. From the Start menu of the Windows computer where SQDR Plus Remote Admin is installed, run CAMAINT.
  2. In the CAMAINT command window, type the password for the iSeries user specified in the camaint.bat configuration and press Enter to start the Capture Agent Maintenance Utility.
  3. In the Capture Agent Management Main Menu, choose Option 3, “Display current status” and verify that the Capture Agent component has a status of Running. Note: it may take a few minutes to display the status of the Capture Agent, depending upon the availability of resources on the iSeries.
  4. Press Enter to return to the main menu.
  5. In order to verify that the iSeries can send SQDR Plus support logs to StarQuest Customer Support, select Option 9, "Support" to enter the Support menu.
  6. Select Option 1, "Send SQDRPlus Support Logs", which will collect and ftp support files directly to StarQuest. If the iSeries is not able to reach external ftp sites, use Option 5 to create and store the support files on the local Windows computer. Send these files to StarQuest Customer Support if requested to do so.

Step 7a: (Client-Platform Administrator task) Install the StarSQL ODBC Driver

Estimated Time: 5 minutes

For best results with SQDR, StarQuest recommends using the StarSQL ODBC driver for access to DB2. The StarSQL software is distributed as a compressed file that you download from the StarQuest Ventures Web site.

  1. Log on as an Administrator.
  2. Download StarSQL using the download link provided in step 2 and uncompress the file into a temporary directory.
  3. Run the setup.exe program from the StarSQL installer image.
  4. Select the option to perform a Typical installation and respond to the prompts accordingly.

At the end of the installation, a License Configuration dialog prompts you to enter your license key for using StarSQL. You can enter the license keys for all the StarQuest products you want to use, as described in the next step.

Step 7b: (Client-Platform 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 StarSQL License Configuration utility is not already running already running, open the StarLicense Configuration utility from Start --> Programs --> StarSQL --> 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, 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. On the computer where the StarSQL software is installed, open the License Configuration utility from Start --> Programs --> StarSQL --> License Configuration. Record the Host ID displayed on the License Online tab.
  2. 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

  3. 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.
  4. Enter the Host ID value recorded previously and select the "Node-locked" license option. Click Next.
  5. Review the information provided. If any changes are required, click Previous and modify the values as needed. Otherwise, click the Accept button.
  6. Copy the license key(s) displayed on the web page. You will also receive an e-mail with the license key(s).
  7. On the computer running the StarQuest software, open the License Configuration utility from Start --> Programs --> StarSQL --> License Configuration.
  8. 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 7c: (Client-Platform Administrator task) Create ODBC DBMS Data Sources

Estimated Time: 5 minutes

An ODBC data source name (DSN) defines the information that a driver needs to access a specific instance of data in a DBMS. You must define an ODBC System DSN for each host DBMS that you want to replicate to and from.

Create ODBC DSN for the DB2 source database

The following steps describe how to create a StarSQL ODBC data source to connect to the iSeries source database.

  1. Launch the ODBC Administrator from the Windows Control Panel. For most versions of Windows the ODBC Administrator is typically found in the menu path Settings—>Control Panel —>Administrative Tools—>Data Sources (ODBC).
  2. Click the System DSN tab of the ODBC Data Source Administrator window. Click Add and, in the next dialog, select StarSQL 32 for the driver and click Finish.
  3. In the first dialog of the StarSQL Data Source Wizard, enter a name for the data source and, optionally, a description. Click Next to step through the Wizard panes, specifying the database connectivity parameter values obtained by the iSeries Administrator in step 5.
  4. From the Network pane of the StarSQL Data Source Wizard, click the Test Connection button to ensure you can connect to the host database. On the next pane, enter a valid AS/400 user ID and password so that the data source can connect to the database and set default values, and click Summary.  If the connection fails, modify the data source configuration until the ODBC DSN can successfully connect to the host.
  5. Click the Expert Page item in the left pane of the StarSQL Data Source Wizard. Select IsolationLevel in the Data Source Entry list box, and select Read Committed in the Values list box. Click Next to display the summary page and click OK to save the DSN.

Create ODBC DSN for the destination database

The following steps describe how to create a SQL Server ODBC data source that connects to the SQL Server destination database. If your destination database is not SQL Server, refer to the documentation for the ODBC driver specific for your database for instructions on creating ODBC DSNs.

  1. Launch the ODBC Administrator from the Windows Control Panel. For most versions of Windows this is located in the menu path Control Panel—>Administrative Tools—>Data Sources (ODBC). If using a Windows 64-bit operating system, create a 32-bit DSN using the 32-bit ODBC Data Source Administrator (odbcad32.exe) found in the \WINDOWS\SysWOW64 directory.
  2. Click the System DSN tab of the ODBC Data Source Administrator window.
  3. To create a new data source for the SQL Server database, click Add. In the next dialog, select SQL Server for the driver and click Finish. (If you are using SQL Server 2005/2008, be sure to select the SQL Server driver instead of the SQL Server Native Client driver.) 
  4. Specify a name and select which SQL Server you want the data source to connect to, and click Next to proceed.
  5. Continue through the remainder of the wizard and click Test Data Source to ensure the DSN can connect to the specified SQL Server. If you do not see TESTS COMPLETED SUCCESSFULLY, modify the data source configuration until it can successfully connect to the server.

Additional References

StarSQL Quick Start Guide
StarSQL User’s Guide
StarSQL Online Help

Step 8: (SQL Server Administrator task) Start the SQL Server Service and Configure ODBC DSN

Estimated Time: 10 minutes

The client computer on which you will install SQDR must have a supported version of Microsoft SQL Server installed. If you do not already have a SQL Server installation, you can obtain the Microsoft SQL Server 2000 Desktop Engine (MSDE 2000) or the SQL Server 2005/2008 Express Edition free of charge from Microsoft to use as a control database for the Data Replicator. Review the SQL Server considerations above for more information.

SQL Server 2008 users should verify that they have already installed the SQL Distributed Management Objects (SQL-DMO), which are included in the Microsoft SQL Server 2005 Backward Compatibility Components available at the Microsoft Download Center.

Start SQL Server Service

The SQL Server service must be running for the Data Replicator Service to access its control database. If you intend to configure replication subscriptions to run according to a schedule, also start the SQL Server Agent service. Start the SQL Server and SQL Server Agent services from Windows Services, typically found under Control Panel—> Administrative Tools—> Services.

Create a SQL Server ODBC DSN for the Control Database

Define the ODBC DSN for the SQL Server database that the Data Replicator Service will use as a control database. If the destination database is also SQL Server, create a new DSN instead of using the one created in step 7c.

  1. Launch the ODBC Administrator from the Windows Control Panel. For most versions of Windows this is located in the menu path Control Panel—>Administrative Tools—>Data Sources (ODBC).

NOTE

If using a 64-bit SQL Server, you will need to create a 32-bit ODBC DSN for the SQL Server database using the 32-bit ODBC Data Source Administrator (odbcad32.exe), typically located in \WINDOWS\SysWOW64 directory.

  1. Click the System DSN tab of the ODBC Data Source Administrator window.
  2. To create a new data source for the SQL Server database, click Add. In the next dialog, select SQL Server for the driver and click Finish. (If you are using SQL Server 2005/2008 Express, be sure to select the SQL Server driver instead of the SQL Server Native Client driver.)  If you already have a data source defined for the SQL Server database you want to use for the Data Replicator control tables, select it and click Configure to verify the properties.
  3. Specify a name and select which SQL Server you want the data source to connect to, and click Next to proceed.
  4. Continue through the remainder of the wizard and click Test Data Source to ensure the DSN can connect to the specified SQL Server. If you do not see TESTS COMPLETED SUCCESSFULLY, modify the data source configuration until it can successfully connect to the server.

Step 9a: (Client-Platform Administrator) Install the StarQuest Data Replicator Software

Estimated Time: 10 minutes

The StarQuest Data Replicator software is distributed as a compressed file that you download from the StarQuest Ventures Web site.

  1. Log on as an Administrator.
  2. Download SQDR using the download link provided in step 2 and uncompress the file into a temporary directory.
  3. Run the setup.exe program from the SQDR installer image.
  4. Respond to the prompts accordingly to complete the installation.

At the end of the installation, the installer prompts you to start the ODBC Administrator and/or the SQDR Configuration. You do not need to launch the ODBC Administrator, as ODBC DSNs were created in steps 7c and 8 above. Select the option to launch the Configuration after the installation completes and proceed to the next step.

Step 9b: (Client-Platform Administrator) Configure the StarQuest Data Replicator Service

Estimated Time: 10 minutes

You must configure the Data Replicator service to specify which SQL Server data source to use for the control tables and how the Data Replicator service should log in to the SQL Server.

  1. In the first pane of the Configuration Wizard, select the SQL Server data source that you configured (in step 8) to access SQDR's control database and enter the SQL Server credentials for a user who is a member of the sysadmin server role.
    Click Next to proceed.
NOTE If you receive an error that the data source cannot be found, launch the ODBC Data Source Administrator from Control Panel--> Administrative Tools-->Data Sources (ODBC), double-click the SQL Server System DSN, and review the configuration. At the configuration summary verify that the Test Connection succeeds. Exit the ODBC Administrator and return to the SQDR Configuration Wizard.
  1. Select the default option Create a new control database and click Next.
  2. Leave the default database name of ControlDB or enter an alternative name. Leave the schema name field blank, as it will default to "dbo". Click Next.
  3. Select Automatic as the Service Startup Type and choose the 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. Choose the correct Service Locale for the local Windows system and click Next.
  4. Review the configuration summary, choose to start the Data Replicator Service and Manager and click Finish to save the Data Replicator configuration.

When the Data Replicator Manager launches for the first time, a License Configuration dialog prompts you to enter your license keys. Since the license keys have already been requested, click OK to close this dialog.

Step 9c: (Client-Platform 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.

  1. Select Data Replicator Manager from the StarQuest Data Replicator program group if it is not already running.
  2. In the License Configuration dialog, verify that you have the three license keys entered (with PROD IDs "SQ", "DR", and "A+) and click OK. See step 7b if you have not entered license keys for using the evaluation software.
  3. Stop and restart the SQDR service in order for the license keys to take effect. In the left pane, right-click the Service node for your computer and Stop the service. Right-click again and choose Start.

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. Select the DSN that connects to the source database that contains the data you want to replicate, and enter a user ID and password that has permission to access that database.

  1. 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. 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. Select the DSN that connects to the database to which you want to replicate the data, and enter a user ID and password that has permission to access that database.

destination

  1. 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. Click OK to create the destination.

destination advanced

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.

.

  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.

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.

  1. In the Select the Destination pane, select the DSN that connects to the destination you added to the Replicator Manager. The default Destination Options and Replication Options should be suitable. Do not enable the I/R Options unless instructed to by StarQuest Customer Support. Click Next to proceed.
  2. In the Select Group pane, select the incremental replication group that you created in the previous section. Click Next to continue.

  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 and click the Verify Criteria button, or leave the field blank. 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. Modify the destination columns if desired and click Next.

  1. Click Next in the Create Table 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 9d: 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.

  1. Double-click the replication event, indicated by the  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.

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

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 is intended to help you install the StarQuest software and perform a data replication operation as quickly as possible. Please continue to explore the capabilities of SQDR Plus by adding additional subscriptions, scheduling replication operations, and performing SQL operations on data before and/or after it is replicated. The product documentation provides detailed information about performing these and many other tasks. Refer to the following documentation as you become familiar with using the SQDR software in your environment.

  • The SQDR Plus for iSeries User's Guide manual Acrobat PDF is available as a PDF file in the SQDR Plus installation image. It provides more detail about configuring and managing the SQDR Plus Capture 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.
  • The SQDR Plus Documentation Addendum and the SQDR Documentation Addendum contain information on new features and supplement the SQDR Plus User's Guide and SQDR online help.

Please especially be aware of the following operational requirements and suggestions, which are covered more thoroughly in the product documentation, as you proceed with your evaluation:

  • SQDR Plus uses TCP for inter process communications and requires TCP services to shut down properly. Shut down the SQDR subsystem before you end TCP services or shut down the OS/400 system. If there is a delay of 30 minutes or more between IPL of the OS/400 and restart of the SQDR subsystem, you also may want to lengthen the time interval for sending notifications that the SQDR journal receivers are unavailable to avoid flooding the operator's QSYSOPR message queue.
  • The Capture Agent spawns jobs in other subsystems, such as QSQSRVR in the QSYSWRK subsystem, QRWTSRVR in the QUSRWRK subsystem, QZDASOINIT in the QUSRWRK subsystem, and QZRCSRVS which can run in different subsystems. Do not manually stop any of these jobs.
  • You may want to modify the system startup routine to automatically start the SQDR subsystem when an IPL of the iSeries server is performed.

If you encounter any problems while using the evaluation software, please send an email to StarQuest Customer Support at contact@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.