Oracle GoldenGate discovery

Release version: Australia

Updated June 8, 2026

7 minutes to read

Summarize

Summarized using AI

Summary of Oracle GoldenGate discovery

The ServiceNow Discovery and Service Mapping applications identify Oracle GoldenGate 12c components using the Oracle GoldenGate pattern. This pattern enables horizontal discovery to gather data into a report file and top-down discovery to map outgoing Oracle GoldenGate connections. It supports platforms including AIX, Linux Hewlett Packard, and Solaris, and runs on ServiceNow AI Platform versions Kingston, London, or Madrid.

Show full answer Show less

To discover Oracle GoldenGate components effectively, customers may need to update the Discovery and Service Mapping Patterns application to the latest version from the ServiceNow Store.

Prerequisites and Configuration

Credentials: Configure SSH credentials for the OS hosting the Oracle GoldenGate Server with UNIX user permissions to read the Oracle GoldenGate report file (with .rpt extension) and execute necessary OS commands such as listing report and parameter files.
Permissions: The UNIX user requires permissions to run specific commands to list report and parameter files in the Oracle GoldenGate directories. Command syntax varies depending on the pattern version.
Applicative Credentials: Define applicative credentials in ServiceNow for discovery, specifying the credential name, applicable MID Servers, user name, and enabling the credential. Password entry is optional because data is extracted from a local cache.
Entry Point for Service Mapping: Use the Oracle GoldenGate IP address and specify the MID Server for top-down discovery.

Data Model and Collected Information

The Oracle GoldenGate pattern introduces new configuration item (CI) classes extending the Application [cmdbciappl] class:

Oracle GoldenGate [cmdbciapploraclegoldengate]
Oracle GoldenGate Replicat Process [cmdbciapploraggreplicat]
Oracle GoldenGate Extract Process [cmdbciapploraggextract]

Discovery collects detailed information including CI names, versions, source database SIDs, counts of replicat and extract processes, configuration and report files, installation directories, and operational statuses. Service Mapping collects similar data during top-down discovery by using TCP entry points.

CI Relationships

The pattern creates relationships among Oracle GoldenGate components to represent management and operational dependencies:

Oracle GoldenGate manages replicat and extract processes.
Oracle GoldenGate and its processes run on hardware CIs.

Practical Benefits for ServiceNow Customers

This discovery pattern enables customers to automatically identify and model Oracle GoldenGate components and processes within their CMDB, improving visibility and configuration management.
Supported platforms and ServiceNow versions provide flexibility for diverse environments.
Proper credential and permission setup ensures secure and successful data collection.
Clear CI relationships help visualize dependencies and support impact analysis and service mapping.
Using the latest pattern versions ensures compatibility and access to improved command syntax and functionality.

The ServiceNow Discovery and Service Mapping applications find Oracle GoldenGate version 12c components using the Oracle Golden Gate pattern. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

Discovery uses the Oracle Golden Gate pattern to perform horizontal discovery to collect data into the $report_file file. Service Mapping performs top-down discovery on the $report_file file to find outgoing Oracle Golden Gate connections.

The Oracle Golden Gate pattern supports the following platforms: AIX, Linux Hewlett Packard, and Solaris.

You can use this pattern on the ServiceNow AI Platform using Kingston, London, or Madrid.

Request apps on the Store

Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

Oracle Golden Gate data model

The Oracle Golden Gate pattern introduces the following CI classes that extend an existing CMDB class.

Table 1. CI classes introduced by this pattern
CI class	Extends from
Oracle Golden Gate [cmdb_ci_appl_oracle_golden_gate]	Application [cmdb_ci_appl]
Oracle Golden Gate Replicat Process [cmdb_ci_appl_ora_gg_replicat]	Application [cmdb_ci_appl]
Oracle Golden Gate Extract Process [cmdb_ci_appl_ora_gg_extract]	Application [cmdb_ci_appl]

Prerequisites

Credentials

Configure the SSH credentials, for the operating system of the server that hosts the Oracle Golden Gate Server.

User access

Give the UNIX OS user permissions to read the $report_file. The $report_file is the report file that is extracted from the Oracle Golden Gate manager/replicat/extract process, with the extension .rpt. For example:

Configuration file:

/base/ggs_beta/oracle/bt01pims/ggs/dirprm/mgr.prm REPORTFILE

Report file:

/base/ggs_beta/oracle/bt01pims/ggs/dirrpt/MGR.rpt PROCESSID MGR

Permissions to run commands

The OS user must have permissions to run the relevant OS commands for each supported platform.

Give the UNIX OS user permissions to run the following commands against the Oracle Golden Gate Server:


Command	Mandatory/Optional	Description
Starting with Discovery and Service Mapping Patterns version 1.31.0: `$sudo + " ls " + $rpt_base_dir + " \| grep '\.rpt$' \| sort "` Before Discovery and Service Mapping Patterns version 1.31.0: `$sudo + " ls -d " + $rpt_base_dir + "*.rpt \| sort "` †	Mandatory	List all report files under the Oracle Golden Gate report base directory.
Starting with Discovery and Service Mapping Patterns version 1.31.0: `$sudo + " ls " + $prm_base_dir + " \| grep '\.prm$' \| sort "` Before Discovery and Service Mapping Patterns version 1.31.0: `$sudo + " ls -d " + $prm_base_dir + "*.prm\| sort "` †	Mandatory	List all parameter files under the Oracle Golden Gate parameter base directory.

† If this command doesn't return data, see the update set in KB3069148.

Retrieve data

Retrieve data by parsing:

The Oracle Golden Gate manager report file (report_file) to retrieve related configuration item (CI) names and counter information.
Variables in the process command line to retrieve the install folder, manager process name, configuration file, and parameters file.
Variables in the Oracle Golden Gate installation folder to retrieve a list of parameter and configuration files.

EVAL closure functions

Use the following EVAL closure functions to remove duplicate entries from the extract process and the replicat process.

var tableWithoutDuplicates = '';tableWithoutDuplicates = DuplicateRemover.removeDuplicates(${extracts},["name"]);CTX.setAttribute("extracts", tableWithoutDuplicates);
var tableWithoutDuplicates = '';tableWithoutDuplicates = DuplicateRemover.removeDuplicates(${replicats},["name"]);CTX.setAttribute("replicats", tableWithoutDuplicates);

Use the following EVAL closure functions to count the number of extract processes and replicat processes.

return ${cmdb_ci_appl_ora_gg_replicat[*].config_file}.size()
return ${cmdb_ci_appl_ora_gg_extract[*].config_file}.size()

Use the following EVAL closure function to return the privileged command.

return ${ctx}.getDiscoveryProvider(com.snc.sw.dto.ProviderType.SSH).getPrivilegedCommand();

Use the following EVAL closure function to return the discovery type.

ctx.getWork().getDiscoveryType();

Use the following EVAL closure function to extract the version from the installation directory path if it is empty.

inst_dir = ${install_directory}if(inst_dir.isEmpty()){return ${version}}if(inst_dir.startsWith('/')){return inst_dir.replaceAll('/.*/','')}if(!inst_dir.startsWith('/') && !inst_dir.isEmpty()){return inst_dir.replaceAll('.*\\\\','')}

Applicative credentials

Navigate to Discovery > Credentials.
Click New.
Click Applicative Credentials.

On the form, fill in the fields.

Table 2. Applicative Credentials form
Field	Description
Name	Credential name. An example is oracle_db_user.
Active	Option for enabling this credential for discovery. Select this check box to enable discovery.
Applies to	Credentials that you may or may not want to apply to All MID servers in your network, or to one or more Specific MID servers. Select Specific MID servers.
MID Servers	MID Servers that the credentials apply to. Select the required MID Server. This field appears when Specific MID servers is selected from the Applies to field.
Order	Order in which the platform tries this credential as it attempts to log on to devices. A smaller number indicates that the credential appears higher in the list. Establish the credential order when using large numbers of credentials or when security locks out users after three failed login attempts. If all the credentials have the same order number, or none, the instance tries the credentials in a random order. The default value is 100.
User name	Name of the user of this applicative credential. An example is oracle_db_user. You can use any user for the credential for this pattern, because the information is extracted from a local cache.
Password	Not required. You can leave this field blank or enter any value.
CI type	CI type for which this credential is used: Storage Server [cmdb_ci_storage_server]. Note: ServiceNow applications refer to devices and applications that comprise a service instance as configuration items (CIs).

Click Submit.

Entry point

For top-down discovery, use the Oracle Golden Gate IP address and specify the MID Server.

Data collected by Discovery during horizontal discovery

Discovery uses the Oracle Golden Gate pattern to collect the data described in the following tables.

Table 3. Oracle Golden Gate [cmdb_ci_appl_oracle_golden_gate]
Field	Description
Name [name]	Name of the CI in the CMDB (<process name>@<source db>).
Version [version]	Version of the Oracle Golden Gate installation.
Source DB SID [source_db]	Manager process source database system identifier (SID).
Counter for replicat processes [count_replicat]	Counter of replicat processes that are managed by the Oracle Golden Gate manager instance.
Counter for extract processes [count_extract]	Counter of extract processes that are managed by the Oracle Golden Gate manager instance.
Configuration file [config_file]	Parameter file of the Oracle Golden Gate process. Specify the path to the configuration file and the file name, <name>.prm
Replicat File [report_file]	Report file of the Oracle Golden Gate process. Specify the path to the report file and the file name, <name>.rpt
Type [type]	Type of the Oracle Golden Gate installation. Specify the Oracle Golden Gate for Oracle technologies.
Installation directory [install_directory]	Folder that contains all the Oracle Golden Gate setup, configuration, libraries, and executable files.

Table 4. Oracle Golden Gate Replicat Process [cmdb_ci_appl_ora_gg_replicat]
Field	Description
Name [name]	Name of the CI in the CMDB (<process name>@<source db>).
Replicat File [report_file]	Replicat process report file. Specify the path to the report file and the file name <name>.rpt
Configuration file [config_file]	Parameter file of the replicat process. Specify the path to the configuration file and the file name <name>.prm
Installation directory [install_directory]	Folder that contains all the Oracle Golden Gate setup, configuration, libraries, and executable files.
Version [version]	Version of the Oracle Golden Gate installation.
Source DB SID [source_db]	Manager process source database SID.
Operational status [operational_status]	Operational status of the CI. Select Operational.

Table 5. Oracle Golden Gate Extract Process [cmdb_ci_appl_ora_gg_extract]
Field	Description
Name [name]	Name of the CI in the CMDB (<process name>@<source db>).
Replicat File [report_file]	Report file of the extract process. Specify the path to the report file and the file name <name>.rpt
Configuration file [config_file]	Parameter file of the extract process.
Version [version]	Version of the Oracle Golden Gate installation.
Installation directory [install_directory]	Folder that contains all the Oracle Golden Gate setup, configuration, libraries, and executable files.
Source DB SID [source_db]	Manager process source database SID.
Operational status [operational_status]	Operational status of the CI. Select Operational.

The Dependency Views map shows discovered load balancer CIs and the relationships between them.
CIs and connections on a Dependency Views map

CI relationships

The Oracle Golden Gate pattern creates the following relationships to support Oracle Golden Gate discovery.

Table 6. CI relationships
CI	Relationship	CI
Oracle Golden Gate [cmdb_ci_appl_oracle_golden_gate]	Managed by::Manages	Oracle Golden Gate Replicat Process [cmdb_ci_appl_ora_gg_replicat]
Oracle Golden Gate [cmdb_ci_appl_oracle_golden_gate]	Managed by::Manages	Oracle Golden Gate Extract Process [cmdb_ci_appl_ora_gg_extract]
Oracle Golden Gate [cmdb_ci_appl_oracle_golden_gate]	Runs on::Runs	Hardware [cmdb_ci_hardware]
Oracle Golden Gate Replicat Process [cmdb_ci_appl_ora_gg_replicat]	Runs on::Runs	Hardware [cmdb_ci_hardware]
Oracle Golden Gate Extract Process [cmdb_ci_appl_ora_gg_extract]	Runs on::Runs	Hardware [cmdb_ci_hardware]

Data collected by Service Mapping during top-down discovery

To discover the Oracle Golden Gate process, use the TCP entry point with the proper host and port of the Oracle Golden Gate process.


Field	Description
Name [name]	Name of the CI in the CMDB (<process name>@<source db>).
Version [version]	Version of the Oracle Golden Gate installation.
Installation directory [install_directory]	Folder that contains all the Oracle Golden Gate setup, configuration, libraries, and executable files.
Configuration file [config_file]	Parameter file of the Oracle Golden Gate process.
Replicat File [report_file]	Report file of the Oracle Golden Gate replicat process.
Source DB SID [source_db]	Manager process source database SID.
Counter for extract processes [count_extract]	Counter of extract processes that are managed by the Oracle Golden Gate manager instance.
Counter for replicat processes [count_replicat]	Counter of replicat processes that are managed by the Oracle Golden Gate manager instance.