Table of Contents

Search

  1. Preface
  2. Connectors and connections
  3. Connection configuration
  4. Connection properties
  5. Swagger file generation for REST V2 connections

Connections

Connections

Oracle Database Ingestion connection properties

Oracle Database Ingestion connection properties

When you define an Oracle Database Ingestion connection for a
database ingestion
task, you must configure connection properties.
The following table describes the connection properties:
Property
Description
Connection Name
A name for the connection. This name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -
Spaces at the beginning or end of the name are trimmed and are not saved as part of the name. Maximum length is 100 characters. Connection names are not case sensitive.
Description
An optional description for the connection. Maximum length is 255 characters.
Type
The type of connection. For an Oracle Database Ingestion connection, the type must be
Oracle Database Ingestion
.
Runtime Environment
The name of the runtime environment where you want to run
database ingestion
tasks. You define runtime environments in
Administrator
.
User Name
User name for the Oracle database login. The user name cannot contain a semicolon.
Password
Password for the Oracle database login. The password cannot contain a semicolon.
Host
Host name of the database server.
Port
Network port number used to connect to the database server. Default is 1521.
Service Name
Service name or System ID (SID) that uniquely identifies the Oracle database. Specify the SID in the following format to connect to Oracle databases:
SID:<ORACLE_SID>
Schema
Schema used for the Oracle connection.
Code Page
The code page of the database server.
Database ingestion
tasks use the UTF-8 code page. Default is UTF-8.
Encryption Method
For initial load jobs, determines whether the data exchanged between the Secure Agent and the Oracle database server is encrypted:
Options are:
  • SSL
    . Establishes a secure connection using SSL for data encryption. If the Oracle database server cannot configure SSL, the connection fails.
  • No Encryption
    . Establishes a connection without using SSL. Data is not encrypted.
Default is No Encryption.
Crypto Protocol Version
If you selected SSL as the encryption method, you must specify a cryptographic protocol or a list of cryptographic protocols supported by your server to use with an encrypted connection. Options are:
  • SSLv2
  • SSLv3
  • TLSv1.2
Default is TLSv1.2.
Validate Server Certificate
If you selected SSL as the encryption method, controls whether the Secure Agent validates the server certificate that is sent by the Oracle database server.
  • True
    . Validate the server certificate.
  • False
    . Do not validate the server certificate.
Default is False.
If you also specify the
Host Name in Certificate
property, the Secure Agent also validates the host name in the certificate.
Trust Store
If you selected SSL as the encryption method and enabled validation of the server certificate, specify the path and name of the truststore file, which contains the list of the Certificate Authorities (CAs) that the client trusts for SSL authentication.
Trust Store Password
If you selected SSL as the encryption method and enabled validation of the server certificate, specify a password for accessing the contents of the truststore file.
Host Name in Certificate
If you selected SSL as the encryption method and enabled validation of the server certificate, specify the host name of the machine that hosts the Oracle database to provide for additional security. The Secure Agent validates the host name included the connection with the host name in the SSL certificate.
Key Store
If you selected SSL as the encryption method and client authentication is enabled on the Oracle database server, specify the path and name of the keystore file. The keystore file contains the certificates that the client sends to the Oracle server in response to the server's certificate request.
Key Store Password
If you selected SSL as the encryption method and client authentication is enabled on the Oracle database server, specify the password for the keystore file.
Key Password
If you selected SSL as the encryption method and client authentication is enabled on the Oracle database server, specify the password for the keys in the keystore file. Use this property when the keys have a different password than the keystore file.
Database Connect String
An Oracle connection string, defined in TNS, that
database ingestion
tasks use to connect to the Oracle database.
TDE Wallet Directory
The path and file name for the Oracle wallet file that is used for Oracle Transparent Data Encryption (TDE). Specify this property value only if you capture change data from
TDE-encrypted
tablespaces and one of the following conditions are true:
  • The Oracle wallet is not available to the database.
  • The Oracle database is running on a server that is remote from Oracle redo logs.
  • The wallet directory is not in the default location on the database host or the wallet name is not the default name of
    ewallet.p12
    .
  • The wallet directory is not available to the Secure Agent host.
TDE Wallet Password
A clear text password that is required to access the Oracle TDE wallet and get the master key. This property value is required if you need to read and decrypt data from TDE-encrypted tablespaces in the Oracle source database.
Directory Substitution
A local path prefix to substitute for the server path prefix of the redo logs on the Oracle server. This substitute local path is required when the log reader runs on a system other than the Oracle server and uses a different mapping to access the redo log files. Use this property in the following situations:
  • The redo logs reside on shared disk.
  • The redo logs have been copied to a system other than the Oracle system.
  • The archived redo logs are accessed by using a different NFS mount.
Do not use this statement if you use Oracle Automatic Storage Management (ASM) to manage the redo logs.
You can define one or more substitutions. Use the following format:
server_path_prefix
,
local_path_prefix
;
server_path_prefix
,
local_path_prefix
;...
Reader Active Log Mask
A mask that the log reader uses for selecting active redo logs when the Oracle database uses multiplexing of redo logs. The log reader compares the mask against the member names in an active redo log group to determine which log to read. In the mask, you can use the asterisk (*) wildcard to represent zero or more characters.
The mask can be up to 128 characters in length. It is case-sensitive on Linux or UNIX systems but not on Windows systems.
Reader Archive Destination 1
The primary log destination from which the log reader reads archived logs, when Oracle is configured to write more than one copy of each archived redo log. Enter a number that corresponds to a
n
value in an Oracle LOG_ARCHIVE_DEST_
n
initialization parameter, where
n
is a value from 1 to 10.
If you set only one of the Reader Archive Destination 1 and Destination 2 properties, the log reader uses that property setting. If you specify neither property, the archive log queries are not filtered by the log destination.
Reader Archive Destination 2
The secondary log destination from which the log reader reads archived logs when the primary destination becomes unavailable or when the logs at the primary destination cannot be read. For example, logs might have been corrupted or deleted. Enter a number that corresponds to the
n
value in an Oracle LOG_ARCHIVE_DEST_
n
initialization parameter, where
n
is a value from 1 to 10. Usually, this value is a number greater than 1.
Reader ASM Connect String
In an Oracle ASM environment, the Oracle connection string, defined in TNS, that the log reader uses to connect to the ASM instance that manages storage of active and archived redo logs for the source database.
Reader ASM User Name
In an Oracle ASM environment, an Oracle user ID that the log reader uses to connect to the ASM instance that manages storage of active and archived redo logs for the source database. This user ID must have SYSDBA or SYSASM authority. To use SYSASM authority, set the
Reader ASM Connect As SYSASM
property to Y.
Reader ASM Password
In an Oracle ASM environment, a clear text password for the user that is specified in the
Reader ASM User Name
property. The log reader uses this password and the ASM user name to connect to the ASM instance that manages storage of active and archived redo logs for the source database.
Reader ASM Connect As SYSASM
If you use Oracle 11
g
ASM or later and want the log reader to use a user ID that has SYSASM authority to connect to the ASM instance, select this check box. Also specify a user ID that has SYSASM authority in the
Reader ASM User Name
property. To use a user ID that has SYSDBA authority, clear this check box. By default, this check box is cleared.
Reader Mode
Indicates the source of and types of Oracle redo logs that the log reader reads. Valid options are:
  • ACTIVE
    . Read active and archived redo logs from the Oracle online system. Optionally, you can use the
    Reader Active Log Mask
    property to filter the active redo logs and use the
    Reader Archive Destination 1
    and
    Reader Archive Destination 2
    properties to limit the archived log destinations from which to read archived logs.
  • ARCHIVEONLY
    . Read only archived redo logs. Optionally, you can use the
    Reader Archive Destination 1
    and
    Reader Archive Destination 2
    properties to limit the archived log destinations from which to read archived logs.
  • ARCHIVECOPY
    . Read archived redo logs that have been copied to an alternate file system. Use this option in the following situations:
    • You do not have the authority to access the Oracle archived redo logs directly.
    • The archived redo logs are written to ASM, but you do not have access to ASM.
    • The archived log retention policy for the database server causes the archived logs to not be retained long enough.
    With this option, the
    Reader Archive Destination 1
    and
    Reader Archive Destination 2
    properties are ignored.
Default is
ACTIVE
.
Reader Standby Log Mask
A mask that the log reader uses for selecting redo logs for an Oracle physical standby database when the database uses multiplexing of redo logs. The log reader compares the mask against the member names in an redo log group to determine which log to read. In the mask, you can use the asterisk (*) wildcard to represent zero or more characters.
The mask can be up to 128 characters in length. It is case-sensitive on Linux or UNIX systems but not on Windows systems.
Standby Connect String
An Oracle connection string, defined in TNS, that the log reader uses to connect to the Oracle physical standby database for change capture when the database is not open with read only access.
Standby User Name
A user ID that the log reader uses to connect to the Oracle physical standby database for change capture. This user ID must have SYSDBA authority.
Standby Password
A password that the log reader uses to connect to the Oracle physical standby database for change capture.
RAC Members
The maximum number of active redo log threads, or
members
, in an Oracle Real Application Cluster (RAC) that can be tracked. For a Data Guard physical standby database that supports a primary database in a RAC environment, this value is the number of active threads for the primary database.
Valid values are 1 to 100. Default is 0, which causes an appropriate number of log threads to be determined automatically. If this value is not appropriate for your environment, set this property to a value greater than 0.
BFILE Access
Select this check box in the following circumstances:
  • You use BFILE access to redo logs in physical directories on the local Oracle server file system. BFILE access uses Oracle directory objects to remotely access the redo logs in the file system. This method is an alternative to other log access methods such as ASM or NFS mounts.
  • You have an Amazon Relational Database Service (RDS) for Oracle source. In this case, this option enables access to the redo logs of a cloud-based database instance deployed in RDS.
By default, this check box is cleared.

0 COMMENTS

We’d like to hear from you!