6 Deploying and Configuring Oracle GoldenGate Veridata Agent

This chapter describes how to deploy and configure the Oracle GoldenGate Veridata agent for the Oracle WebLogic Server domain.

6.1 About Oracle GoldenGate Veridata Agent Deployment Scripts

After installing Oracle GoldenGate Veridata Agent using Oracle Universal Installer, you must deploy the agent to a non Oracle Home location and configure the agent before running comparison jobs using a deployment script provided in the installation.

The following table describes the directories and the variables that are used when referring to those directories in this section.

Table 6-1 Directories in an Oracle GoldenGate Veridata Installation

Directory Variable Directory Path

ORACLE_HOME

/install_location/Oracle_Home. This is the home directory for the Oracle Fusion Middleware products.

VERIDATA_PRODUCT_HOME

/ORACLE_HOME/veridata

AGENT_ORACLE_HOME

/VERIDATA_PRODUCT_HOME/agent

AGENT_DEPLOY_LOCATION

This is the location where the Veridata Agent is deployed in the WebLogic Server domain.

Note that this location should be outside the ORACLE_HOME.

The agent_config.sh|.bat script located in the AGENT_ORACLE_HOME directory is used for deploying the Veridata Agent.

Syntax:

agent_config.sh|.bat AGENT_DEPLOY_LOCATION

The AGENT_DEPLOY_LOCATION can be an absolute path or a path relative to the location from where the script is running.

Note:

You must deploy the Oracle GoldenGate Veridata Agent to a directory outside ORACLE_HOME.

6.2 Configuring Oracle GoldenGate Veridata Agent

You must configure the Oracle GoldenGate Veridata Agent to use your database.

  1. Go to the agent deployed location AGENT_DEPLOY_LOCATION.

    There is an agent.properties.sample file in this directory that contains database related properties like JDBC URL and driver.

  2. Copy the agent.properties.sample file and rename to agent.properties.

  3. Most of the properties defined in the file have default values. However, you must update the following properties:

    1. The server.port property is the port where the Veridata Agent listens for connection requests.

      server.port=server.port

      For example, server.port=7862.

    2. The database.url specifies the JDBC connection URL for the database. Samples for all supported databases are provided in the file.

      database.url=database.url

      For example, database.url=jdbc:oracle:thin:@localhost:1521:orcl.

    3. The server.jdbcDriver property specifies the list of JDBC driver JAR files. Sample lists for the supported databases are provided in the file.

      Use the driver corresponding to the database.url in the preceding step.

      server.jdbcDriver=<server.jdbcDriver>

      For example, server.jdbcDriver=ojdbc7.jar oracle.xdb_12.1.0.jar.

6.3 Starting the Oracle GoldenGate Veridata Agent

Go to the agent deployment location AGENT_DEPLOY_LOCATION and run following command.

$ ./agent.sh start agent.properties

Where agent.properties is the properties file that contains your database properties.

6.4 Using the Oracle GoldenGate Veridata Agent Deployment Script in Debug Mode

For debugging issues with the Veridata Agent deployment, run the agent_config script with an additional command line argument as follows:

Syntax:

agent_config.sh|.bat AGENT_DEPLOY_LOCATION true

When this option is true, the debug logs are printed on the screen.

6.5 Running Oracle GoldenGate Veridata as a Windows Service

On Windows platform, after installing the Oracle GoldenGate Veridata Agent, run the agent as a service. The scripts are located in AGENT_DEPLOY_LOCATION\service. The README.txt file in the service directory describes the procedure to run the agent as a service.

To install as a Windows service:

  1. Go to the Oracle GoldenGate Veridata Agent installation directory.

  2. Open the Set_Veridata_Agent_Env.bat file in an editor.

  3. Locate the '_VERIDATA_SERVICE_NAME' property, and edit it to add a service name for the agent. The name should not contain spaces or any other special characters. Only alphabets and numbers are allowed.

  4. Change the value of '_RUN_AS_SERVICE' property to true.

  5. Save and close the file.

  6. Open the command prompt and navigate to the directory where the agent is installed. Run the Install_veridata_Agent.bat script.

To uninstall the agent service:

  1. Open the command prompt and navigate to the directory where the agent is installed. Run the Uninstall_veridata_Agent.bat script.

  2. Revert changes made in the Set_Veridata_Agent_Env.bat file.

    Open the Set_Veridata_Agent_Env.bat file in an editor.

    Change the value of '_RUN_AS_SERVICE' property to false.

    Save and close the file.

To start and stop the Veridata agent:

  1. Open the command prompt and navigate to the directory where the agent is installed.

  2. Run one of the following commands:

    (starts the agent)

    Start_Veridata_Agent.bat

    or

    Stop_Veridata_Agent.bat

To reload logging properties of the Veridata agent:

  1. Open the command prompt and navigate to the directory where the agent is installed.

  2. Run the following command to load the AGENT_ORACLE_HOME/config/odl.xml configuration file:

    agent.sh|bat reloadLog