Connections > SAP Mass Ingestion connection properties
  

SAP Mass Ingestion connection properties

When you set up a SAP Mass Ingestion connection, you must configure the connection properties.
The following table describes the connection properties for a SAP Mass Ingestion connection:
Connection 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 SAP Mass Ingestion.
Runtime Environment
Name of the runtime environment where you want to run the ingestion tasks.
You must specify a Secure Agent as the runtime environment.
Note: You cannot run application ingestion tasks on a Hosted Agent or serverless runtime environment.
User Name
User name of the SAP instance.
Password
Password for the SAP instance.
Language Code
Language code that corresponds to the SAP language.
System Number
System number of the SAP server.
Client Number
Client number of the SAP server.
Port Range
HTTP port range to run the Netty server.
Connection Type
Type of connection to access the ABAP application server. Options are:
  • - Direct Connection: Accesses a single ABAP application server using the server host.
  • - Load Balancing Connection: Accesses a group of ABAP application servers through the message server.
Application Server
Name of the SAP application server host.
Note: This field appears only for the Direct Connection type.
Message Server
IP address or name of the SAP message server.
Note: This field appears only for the Load Balancing Connection type.
SAP Logon Group
Name of the group of servers that belong to the SAP system you want to access.
Note: This field appears only for the Load Balancing Connection type.
SAP System ID
ID of the SAP system that you want to access.
Note: This field appears only for the Load Balancing Connection type.
Message Server Port
Port number on which the SAP message server is listening.
Note: This field appears only for the Load Balancing Connection type.
Database
The name of the underlying database.
Select one of the following options:
  • - Oracle
  • - SAP HANA (S/4 trigger based)
For Oracle database
Database user name
User name of the database instance.
Database password
Password for the database instance.
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>
Code Page
The code page of the database server. Application 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:
Select one of the following options:
  • - 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.
Select one of the following options:
  • - SSLv2
  • - SSLv3
  • - TLSv1.2
Default is TLSv1.2.
Validate Server Certificate
If you selected SSL as the encryption method, this option controls whether the Secure Agent validates the server certificate that is sent by the Oracle database server.
Select one of the following options:
  • - 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 in 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 application ingestion tasks use to connect to the Oracle database.
TDE Wallet Directory
The path to the directory that contains the Oracle wallet file used for Oracle Transparent Data Encryption (TDE). Specify this property value only if you capture change data from TDE-encrypted table spaces 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.
Note: Do not use this property 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 an 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 11g 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.
Select one of the following options:
  • - 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.
For SAP HANA (S/4 trigger based) database
User Name
The user name to connect to the SAP HANA instance.
Password
The password to connect to the SAP HANA instance.
Host
The name of the machine that hosts the SAP HANA database server.
Port
The port number of the SAP HANA server that you want to connect to. Default is 30015.
Database Name
The SAP HANA source database name.
Advanced Connection Properties
Advanced properties for the SAP HANA JDBC driver, which is used to connect to the SAP HANA source. If you specify more than one property=value entry, separate them with an ampersand (&). The JDBC connection properties that you can enter in this field are described in the SAP JDBC Connection Properties documentation. For example: encrypt=true.
Log Clear
Required for incremental loads. The time interval, in days, after which the PKLOG table entries and shadow _CDC table entries are purged. The purging occurs only while an incremental load job is running.
Valid values for a database ingestion job are 0 to 366. Any positive value in this range causes automatic housekeeping to run while the incremental job is running. Default is 14.
A value of 0 means that the table entries are not purged. For manual housekeeping, enter 0 and use your in-house process.
Any value outside the range of 0 to 366, including a negative number or non-numeric value, causes database ingestion jobs that use the connection to fail with the following error:
LogClear contains a non numeric number. Caused by: LogClear contains a non numeric number.
Trigger Prefix
If you use the trigger-based capture type, you can add a prefix to the names of the AFTER DELETE, AFTER INSERT, and AFTER UPDATE triggers that the CDC script generates for each source table to get before images and after images of the DML changes. Enter any prefix value up to 16 characters in length. An underscore (_) follows the prefix in the trigger name, for example, TX_SAP_DEMO_TABLE_DBMI_USER_t_d. You can use the prefix to comply with your site's trigger naming conventions.