---
sourceDocument: Brazil IT Operations Management
sourceDocumentLink: https://www.servicenow.com/docs/r/it-operations-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Oracle GoldenGate

# Oracle GoldenGate discovery {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Oracle GoldenGate discovery

ServiceNow Discovery and Service Mapping applications support discovering Oracle GoldenGate 12c components using the Oracle Golden Gate pattern.
This enables customers to identify and map Oracle GoldenGate installations and their processes within their Configuration Management Database (CMDB).
Discovery performs horizontal data collection into a report file, while Service Mapping uses top-down discovery to identify outbound Oracle GoldenGate connections.
The pattern supports multiple Unix platforms (AIX, Linux, HP, Solaris) and runs on ServiceNow AI Platform releases Kingston, London, and Madrid.
Show full answer Show less  

## Key Features

* **Discovery Pattern Functionality:** Collects Oracle GoldenGate configurations and process data by parsing manager report files and parameter files.
* **CI Classes Introduced:** Adds Oracle GoldenGate-specific CIs extending the Application class, including Oracle GoldenGate, Replicat Process, and Extract Process.
* **Credential Requirements:** Requires SSH credentials with UNIX OS user permissions to read Oracle GoldenGate report files and run necessary OS commands (such as listing report and parameter files) on the target servers.
* **EVAL Closure Functions:** Used to remove duplicate entries, count extract and replicat processes, extract version info, and manage privileged commands during discovery.
* **Applicative Credentials Configuration:** Credentials configured in ServiceNow specify user access for discovery, applicable MID Servers, and order of use.
* **Discovery Data Collected:** Includes Oracle GoldenGate installation version, source database SID, counts of extract and replicat processes, configuration and report file paths, installation directory, and operational status.
* **CI Relationships:** Establishes key relationships between Oracle GoldenGate instances, replicat and extract processes, and underlying hardware to support accurate CMDB mapping.
* **Service Mapping Discovery:** Uses TCP entry points specifying host and port to discover Oracle GoldenGate processes and related data.

## Practical Guidance for ServiceNow Customers

* Ensure your Discovery and Service Mapping Patterns application is updated to the latest version for full Oracle GoldenGate support.
* Configure SSH credentials with appropriate UNIX user permissions to access report files and execute required commands on Oracle GoldenGate servers.
* Set up Applicative Credentials in ServiceNow to authorize discovery with the correct user context and assign them to relevant MID Servers.
* Use horizontal discovery to populate CMDB with Oracle GoldenGate components and Service Mapping for understanding dependencies and connections.
* Review collected CI attributes and relationships to verify that Oracle GoldenGate installations and processes are correctly identified and mapped.

## Expected Outcomes

By leveraging the Oracle Golden Gate discovery pattern, ServiceNow customers can achieve comprehensive visibility into Oracle GoldenGate environments. This enables accurate CMDB population with Oracle GoldenGate instances and processes, improved service mapping, and enhanced operational awareness of replication and extract workflows critical to data integration and replication strategies.  
The ServiceNow
Discovery and Service Mapping applications find Oracle GoldenGate version 12c components using the Oracle Golden Gate pattern. Discovering some of these resources might 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 {#oracle-golden-gate-discovery__section_gvb_cql_rlb}

Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#oracle-golden-gate-discovery__inline-send-to-store}

## Oracle Golden Gate data model {#oracle-golden-gate-discovery__section_data_model}

The Oracle Golden Gate pattern introduces the following CI classes that extend an existing CMDB class.  
{#oracle-golden-gate-discovery__table_extends_golden_gate__entry__2}

| 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\] |
[Table 1. CI classes introduced by this pattern]

{#oracle-golden-gate-discovery__table_extends_golden_gate}

## Prerequisites {#oracle-golden-gate-discovery__section_hv3_24j_mgb}

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:{#oracle-golden-gate-discovery__table_pw3_lgn_zfb__entry__3}

    | 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 " `† {#oracle-golden-gate-discovery__ul_gb5_hy2_njc} | 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 " `† {#oracle-golden-gate-discovery__ul_qw4_my2_njc} | Mandatory | List all parameter files under the Oracle Golden Gate parameter base directory. |
    [ ]

    {#oracle-golden-gate-discovery__table_pw3_lgn_zfb}† If this command doesn't return data, see the update set in [KB3069148](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=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.
    {#oracle-golden-gate-discovery__ul_hqw_dxy_dhb}

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);
    {#oracle-golden-gate-discovery__ul_a5y_szy_dhb}

    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
:
    1. Navigate to DiscoveryCredentials.
    2. Click New.
    3. Click Applicative Credentials.
    4. On the form, fill in the fields.  
       {#oracle-golden-gate-discovery__table_vkj_ft3_hhb__entry__2}

       | 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). |
       [Table 2. Applicative Credentials form]

       {#oracle-golden-gate-discovery__table_vkj_ft3_hhb}
    5. Click Submit.
    {#oracle-golden-gate-discovery__ol_exd_ljv_2hb}

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 {#oracle-golden-gate-discovery__section_znx_t1h_vgb}

Discovery uses the Oracle Golden Gate pattern to collect the
data described in the following tables.  
{#oracle-golden-gate-discovery__table_golden_gate_main__entry__2}

| 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 3. Oracle Golden Gate \[cmdb_ci_appl_oracle_golden_gate\]]

{#oracle-golden-gate-discovery__table_golden_gate_main}  
{#oracle-golden-gate-discovery__table_golden_gate_replicat__entry__2}

| 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 4. Oracle Golden Gate Replicat Process \[cmdb_ci_appl_ora_gg_replicat\]]

{#oracle-golden-gate-discovery__table_golden_gate_replicat}  
{#oracle-golden-gate-discovery__table_golden_gate_extract__entry__2}

| 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. |
[Table 5. Oracle Golden Gate Extract Process \[cmdb_ci_appl_ora_gg_extract\]]

{#oracle-golden-gate-discovery__table_golden_gate_extract}  
The Dependency Views map shows discovered load balancer CIs and the relationships between them.  

## CI relationships {#oracle-golden-gate-discovery__section_id1_n2q_vgb}

The Oracle Golden Gate pattern creates the following relationships to support Oracle Golden Gate discovery.  
{#oracle-golden-gate-discovery__table_vkt_ywd_rdb__entry__3}

| 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\] |
[Table 6. CI relationships]

{#oracle-golden-gate-discovery__table_vkt_ywd_rdb}

## Data collected by Service Mapping during top-down discovery {#oracle-golden-gate-discovery__section_g2q_tk4_vgb}

To discover the Oracle Golden Gate process, use the TCP entry point with the
proper host and port of the Oracle Golden Gate process.  
{#oracle-golden-gate-discovery__table_i4v_1l4_vgb__entry__2}

| 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. |
[ ]

{#oracle-golden-gate-discovery__table_i4v_1l4_vgb}

*[\>]: and then