Creating the Replication Agent instance

A single installation of the Replication Agent can support replication from multiple databases, however, one Replication Agent instance is needed for each Oracle database that is to be replicated.This section describes how to prepare for the creation of an instance.

StepsTo prepare the Replication Agent instance

  1. Obtain the Oracle JDBC driver from Oracle and update the CLASSPATH environment variable.

    To find the JDBC connection that communicates with the primary Oracle instance, locate the JDBC driver that was available when the Oracle release was originally created, usually found at

    $ORACLE_HOME/jdbc/lib/ojdbc14.jar
    

    Replication Agent may require a newer version of the JDBC driver, which you can obtain fromhttp://technet.oracle.com/software/tech/java/sqlj_jdbc/content.html.

  2. Add the JDBC driver to the CLASSPATH environment variable. For example, you can append the existing CLASSPATH to the new JDBC driver and add the following command to the .login script of a UNIX and Linux user:

    setenv CLASSPATH /path_name/ojdbc14.jar:$CLASSPATH
    

    For a Windows user, add the following to the CLASSPATH environment variable:

    set CLASSPATH=path_name\jdbc\lib\ojdbc14.jar;
    %CLASSPATH%
    
  3. Record the location of the tnsnames.ora file and record the connection name from that file for the Replication Agent to use to connect to the Oracle primary database. You can find these values from any machine where an Oracle SQLPLUS session can be used to connect to the desired Oracle instance. The ORACLE_SID is from the environment variable, $ORACLE_SID.

    Obtain host and port information from the file called tnsnames.ora, available at $ORACLE_HOME/network/admin.

    Record the following:

  4. (Optional) If your operating system has a Java 5.0.x-compatible JRE or JDK installed, you can use Oracle’s iSQL (the browser-based interface to SQL*PLUS) demo items to connect to Oracle using the JDBC driver and to verify the connection information.

    To perform this validation, see “Verifying a JDBC Client Installation” in the Oracle JDBC Developer's Guide and Reference Guide.

  5. Obtain a local copy of the Oracle timezone file, so Replication Agent can correctly process the Oracle timestamp with timezone datatype.

    NoteThis step is required only if the Replication Agent is on a machine (host) other than the Oracle host and does not have access to the Oracle timezone file.

    There are two timezone files under the Oracle installation directory:

    The Oracle instance uses the timezone file from the ORA_TZFILE environment variable. If ORA_TZFILE is not set, use the default timezone file.

    Determine which timezone file is used by the primary Oracle instance and make a copy of that file available on the machine hosting the Replication Agent.

    NoteThese files are Oracle version- and platform-dependent. You cannot use a timezone file from a little endian platform on a big endian platform, nor can you use a timezone file from a version of Oracle that is different than the version of the primary Oracle.

  6. Locate the Replication Agent for Oracle resource file template.

    The majority of configuration values required to create and initialize a Replication Agent can be recorded and stored in a resource file. Using it provides a means to record or retain the configuration information for a Replication Agent instance, allowing an instance to be removed and re-created.The resource file template (oracle.rs) can be found in the Replication Agent directory $SYBASE/RAX-15_1/init.

  7. Create an instance resource file.

    Copy the resource file template $SYBASE/RAX-15_1/init/oracle.rs to another file that contains the configuration information for a new instance, for example:

    cp oracle.rs myra.rs
    

    Using a text editor, change the values assigned to properties in the resource file so they match the values required for your environment. The majority of these values are tnsname location, user, and password information for the Oracle, Replication Server, and RSSD connections.The resource file is self-documenting, with each parameter described. For more information, refer to the Replication Agent Administration Guide, in Chapter 2, “Setup and Configuration,” the section titled, “Creating a Replication Agent instance using resource files.”

    Table 2-4: Resource file parameters

    Parameter

    Description

    Example values

    instance name

    Any valid name

    myra

    admin_port

    Port number that Replication Agent uses.

    9030 (if in use, select a different port number)

    pds_host_name

    Machine (host) where Oracle is installed.

    NoteTo be used with pds_port_number, only if you have not set pds_tns_connection and pds_tns_filename.

    jdoe_host1

    pds_port_number

    Port number for Oracle.

    NoteTo be used with pds_host_name, only if you have not set pds_tns_connection and pds_tns_filename.

    1521

    pds_database_name

    $ORACLE_SID

    NYora92

    pds_tns_connection

    Connection name found in the tnsnames.ora file which identifies the connection information for the primary database.

    NoteTo be used with pds_tns_filename, only if you have not set pds_host_name and pds_port_number.

    ORA102.JDOE_HOST.COM

    pds_tns_filename

    File name identifying the Oracle tnsnames.ora file to be used to identify the connection information for the primary database.

    NoteTo be used with pds_tns_connection, only if you have not set pds_host_name and pds_port_number.

    A valid Oracle tnsnames.ora file. For example:

    /opt/oracle/network/admin/ tnsnames.ora

    pds_username

    User ID that Replication Agent uses to access primary data server.

    RA_USER

    pds_password

    Password for pds_username.

    sybase

    rs_host_name

    Machine where Replication Server is installed.

    jdoe_host1

    rs_port_number

    Port where Replication Server is installed.

    11752

    rs_username

    Replication Server user with CONNECT SOURCE and CREATE OBJECT capabilities.

    SAMPLE_RS_ra

    rs_password

    Password for rs_username.

    SAMPLE_RS_ra_ps

    rs_charset

    Character set that Replication Server is using.

    NoteThe value defined for the rs_charset configuration parameter MUST match the RS_charset value in Replication Server’s configuration file, $SYBASE/REP-15_0 /install /<server>.cfg.

    • Windows: cp850

    • UNIX: iso_1

    rs_source_ds

    Valid name representing data server of Oracle primary database.

    NY

    rs_source_db

    Valid name representing Oracle primary database.

    NYora92

    rssd_host_name

    Machine where RSSD resides.

    jdoe_host1

    rssd_port_number

    Port number where RSSD resides.

    11751

    rssd_database_name

    Database name for RSSD.

    SAMPLE_RS_ERSSD

    rssd_username

    Valid user for RSSD.

    SAMPLE_RS_RSSD_maint

    rssd_password

    Password for rssd_username.

    SAMPLE_RS_RSSD_maint_ps

    pdb_timezone_file

    Path to the pdb_timezone_file directory that contains the archive redo log files.

    /software/oracle/Ora10g /oracore/zoneinfo /timezone.dat

    start_instance

    Start the instance that was created.

    yes

    initialize_instance

    Initialize the Replication Agent instance.

    yes

    pdb_include_archives

    Enables or disables the use of Oracle archive log files.

    USE_DEFAULT

    pdb_archive_path

    Identifies directory path where Replication Agent expects to find archived Oracle redo log files.

    A valid directory path on the machine hosting Replication Agent that points to a location where Oracle puts the archived redo log files

    pdb_archive_remove

    Enables or disables the removal of archived Oracle redo log files from the path specified by pdb_archive_path.

    USE_DEFAULT

    asm_tns_connection

    Identifies the Oracle ASM connection name found in the tnsnames.ora file.

    A valid Oracle tnsnames.ora connection name

    NoteTo be used only if your Oracle environment uses ASM to manage the redo logs.

    asm_tns_filename

    Identifies the Oracle ASM tnsnames.ora filename where the connection information is located.

    A valid Oracle tnsnames.ora file.

    NoteTo be used only if your Oracle environment uses ASM to manage the redo logs.

    asm_username

    Identifies the Oracle user name to be used when connecting to an ASM server.

    User name used for ASM access

    NoteTo be used only if your Oracle environment uses ASM to manage the redo logs.

    asm_password

    Password for Oracle automatic Storage Management (ASM) access for the user specified in the asm_username.

    Password used for the ASM user name

    NoteTo be used only if your Oracle environment uses ASM to manage the redo logs.

  8. Create and execute the new instance resource file:

    NoteBe sure your CLASSPATH environment variable points to the correct Oracle JDBC driver before proceeding.

    1. Using the Replication Agent ra_admin utility, validate the settings in the resource file using the –vr parameter, for example:

      $SYBASE/RAX-15_1/bin/ra_admin.sh -vr myra.rs
      

      Here, myra.rs is the path name of the resource file. Validation results are returned as one of the following:

      • Response-file processing completed

      • Response-file processing completed with errors

      If any validation fails, the ra_admin utility returns an error message and information about the failure. You can repeat the validation process as many times as necessary until it executes without error. No entities are changed or created because of this process.

    2. After the resource file has been validated, allow the ra_admin utility to create and configure the Replication Agent instance, using the –r parameter, for example:

      $SYBASE/RAX-15_1/bin/ra_admin.sh -r myra.rs 
      

      NoteIf, in your response file, you set start_instance to yes, your instance is also running. If you set initialize_instance to yes, your instance is also initialized.

    3. Results are returned as either:

      • Response-file processing completed

      • Response-file processing completed with errors

      For more information about the resource file or its use, refer to the Replication Agent Administration Guide, Chapter 2, “Setup and Configuration,” in the section titled, “Creating a Replication Agent instance using resource files.”

  9. NoteIf in your resource file you set start_instance to yes and the log indicates that the Replication Agent instance was started, skip this step, and continue with the next section.

    Change to the instance directory and run Replication Agent in the background:

     cd $SYBASE/RAX-15_1/myra
    

    Execute the RUN file in the background, for example:

    ./RUN_myra &
    

    Your Replication Agent for Oracle is now running.