Table of Contents

Search

  1. Preface
  2. Connectors and connections
  3. Connection configuration
  4. ActiveCampaign connection properties
  5. Adabas CDC Connection Properties
  6. Adabas connection properties
  7. Adaptive Insights Connection Properties
  8. Adobe Analytics connection properties
  9. Adobe Analytics Mass Ingestion connection properties
  10. Adobe Experience Platform connection properties
  11. Advanced FTP Connection properties
  12. Advanced FTP V2 connection properties
  13. Advanced FTPS connection properties
  14. Advanced FTPS V2 connection properties
  15. Advanced SFTP connection properties
  16. Advanced SFTP V2 connection properties
  17. Amazon Athena connection properties
  18. Amazon Aurora connection properties
  19. Amazon DynamoDB connection properties
  20. Amazon DynamoDB V2 connection properties
  21. Amazon Kinesis connection properties
  22. Amazon Redshift connection properties
  23. Amazon Redshift V2 connection properties
  24. Amazon S3 connection properties
  25. Amazon S3 V2 connection properties
  26. Amplitude connection properties
  27. AMQP connection properties
  28. Anaplan V2 connection properties
  29. Ariba V2 connection properties
  30. AS2 connection properties
  31. BigMachines connection properties
  32. Birst Cloud Connect connection properties
  33. Box connection properties
  34. Business 360 connection properties
  35. Business 360 Events connection properties
  36. Business 360 FEP connection properties
  37. CallidusCloud Commissions connection properties
  38. CallidusCloud File Processor connection properties
  39. Cassandra V2 connection properties
  40. Chatter connection properties
  41. Cloud Integration Hub connection properties
  42. Concur V2 connection properties
  43. Couchbase connection properties
  44. Coupa connection properties
  45. Coupa V2 connection properties
  46. Cvent connection properties
  47. Databricks Delta connection properties
  48. Datacom CDC Connection Properties
  49. Datacom Connection Properties
  50. Db2 Data Map connection properties
  51. Db2 for i CDC connection properties
  52. Db2 for i connection properties
  53. Db2 for i Database Ingestion connection properties
  54. Db2 for LUW CDC connection properties
  55. Db2 for LUW Database Ingestion connection properties
  56. Db2 for z/OS Bulk Load connection properties
  57. Db2 for z/OS CDC connection properties
  58. Db2 for z/OS connection properties
  59. Db2 for zOS Database Ingestion connection properties
  60. Db2 for z/OS Image Copy connection properties
  61. Db2 for z/OS Unload File connection properties
  62. DB2 Loader connection properties
  63. Db2 Warehouse on Cloud connection properties
  64. Domo connection properties
  65. Dropbox connection properties
  66. Elasticsearch connection properties
  67. Eloqua Bulk API connection properties
  68. Eloqua REST connection properties
  69. FHIR connection properties
  70. File List connection properties
  71. File Processor connection properties
  72. FileIO connection properties
  73. Flat file connections
  74. FTP/SFTP connections
  75. Google Ads connection properties
  76. Google Analytics connection properties
  77. Google Analytics Mass Ingestion connection properties
  78. Google BigQuery connection properties
  79. Google BigQuery V2 connection properties
  80. Google Bigtable connection properties
  81. Google Cloud Storage connection properties
  82. Google Cloud Storage V2 connection properties
  83. Google Drive connection properties
  84. Google PubSub - Mass Ingestion Streaming connection properties
  85. Google PubSub connection properties
  86. Google PubSub V2 connection properties
  87. Google Sheets connection properties
  88. Google Sheets V2 connection properties
  89. Greenplum connection properties
  90. Hadoop connection properties
  91. Hadoop Files connection properties
  92. Hadoop Files V2 connection properties
  93. Hive connection properties
  94. HubSpot connection properties
  95. IBM MQ connection properties
  96. IDMS CDC connection properties
  97. IDMS connection properties
  98. IMS CDC Connection Properties
  99. IMS connection properties
  100. JD Edwards EnterpriseOne connection properties
  101. JDBC connection properties
  102. JDBC V2 connection properties
  103. JIRA Cloud connection properties
  104. Jira connection properties
  105. JMS connection properties
  106. JSON Target connection properties
  107. Kafka connection properties
  108. Klaviyo connection properties
  109. LDAP connection properties
  110. Magento V1 connection properties
  111. Mailchimp connection properties
  112. Marketo V3 connection properties
  113. Microsoft Access connection properties
  114. Microsoft Azure Blob Storage connection properties
  115. Microsoft Azure Blob Storage V2 connection properties
  116. Microsoft Azure Blob Storage V3 connection properties
  117. Microsoft Azure Cosmos DB SQL API connection properties
  118. Microsoft Azure Data Lake Storage Gen2 connection properties
  119. Microsoft Azure DocumentDB Connection Properties
  120. Microsoft Azure Event Hub connection properties
  121. Microsoft Azure SQL Data Warehouse - Database Ingestion connection properties
  122. Microsoft Azure SQL Data Warehouse connection properties
  123. Microsoft Azure SQL Data Warehouse V2 connection properties
  124. Microsoft Azure Synapse Analytics Database Ingestion connection properties
  125. Microsoft Azure Synapse SQL connection properties
  126. Microsoft CDM Folders V2 connection properties
  127. Microsoft Dynamics 365 for Operations connection properties
  128. Microsoft Dynamics 365 for Sales connections
  129. Microsoft Dynamics 365 Mass Ingestion connection properties
  130. Microsoft Dynamics AX V3 connection properties
  131. Microsoft Dynamics CRM connection properties
  132. Microsoft Dynamics NAV connection properties
  133. Microsoft Excel connection properties
  134. Microsoft Fabric Data Warehouse connection properties
  135. Microsoft Fabric Lakehouse connection properties
  136. Microsoft Fabric OneLake connection properties
  137. Microsoft Power BI Connection Properties
  138. Microsoft SharePoint connection properties
  139. Microsoft Sharepoint Online connection properties
  140. Microsoft SQL Server CDC connection properties
  141. Microsoft SQL Server connection properties
  142. Mixpanel connection properties
  143. MLLP connection properties
  144. MongoDB Mass Ingestion connection properties
  145. MongoDB connection properties
  146. MongoDB V2 connection properties
  147. MQTT connection properties
  148. MRI Software connection properties
  149. MySQL CDC connection properties
  150. MySQL connection properties
  151. Netezza connection properties
  152. NetSuite connection properties
  153. NetSuite Mass Ingestion connection properties
  154. NetSuite RESTlet V2 connection properties
  155. NICE Satmetrix connection properties
  156. OData connections properties
  157. OData consumer connection properties
  158. OData V2 Protocol Reader connection properties
  159. OData V2 Protocol Writer connection properties
  160. ODBC connection properties
  161. OpenAir connection properties
  162. Oracle Business Intelligence Publisher connection properties
  163. Oracle CDC V2 connection properties
  164. Oracle Cloud Object Storage connections
  165. Oracle connection properties
  166. Oracle CRM Cloud V1 connections properties
  167. Oracle CRM On Demand connection properties
  168. Oracle Database Ingestion connection properties
  169. Oracle Financials Cloud connections properties
  170. Oracle Financials Cloud V1 connection properties
  171. Oracle Fusion Cloud Mass Ingestion connection properties
  172. Oracle HCM Cloud connection properties
  173. Oracle HCM Cloud V1 connection properties
  174. PostgreSQL CDC connection properties
  175. PostgreSQL connection properties
  176. Power BI connection properties
  177. QuickBooks V2 Connection Properties
  178. Redis connection properties
  179. REST API connection properties
  180. REST V2 connection properties
  181. REST V3 Connection Properties
  182. Salesforce Analytics connection properties
  183. Salesforce Commerce Cloud connection properties
  184. Salesforce connection properties
  185. Salesforce Marketing Cloud connection properties
  186. Salesforce Mass Ingestion connection properties
  187. Salesforce Pardot connection properties
  188. SAP ADSO Writer connection properties
  189. SAP BAPI connection properties
  190. SAP BW BEx Query connection properties
  191. SAP BW Reader connection properties
  192. SAP HANA CDC Connection Properties
  193. SAP HANA connection properties
  194. SAP HANA Database Ingestion connection properties
  195. SAP IDoc and BAPI/RFC connections
  196. SAP IDoc Reader connection properties
  197. SAP IDoc Writer connection properties
  198. SAP IQ connection properties
  199. SAP Mass Ingestion connection properties
  200. SAP ODP Extractor connection properties
  201. SAP RFC/BAPI interface connection properties
  202. SAP Table Connector connection properties
  203. SAS connection properties
  204. Satmetrix connection properties
  205. Sequential File connection properties
  206. ServiceNow connection properties
  207. ServiceNow Mass Ingestion connection properties
  208. Shopify connection properties
  209. Snowflake connection properties
  210. Snowflake Data Cloud connection properties
  211. Stripe connection properties
  212. SuccessFactors LMS connection properties
  213. SuccessFactors ODATA connection properties
  214. SuccessFactors SOAP connection properties
  215. SurveyMonkey connection properties
  216. Tableau V2 connection properties
  217. Tableau V3 connection properties
  218. Teradata connection properties
  219. UKGPro V2 connection properties
  220. UltiPro connection properties
  221. VSAM CDC connection properties
  222. VSAM connection properties
  223. Web Service Consumer connection properties
  224. WebServices V2 connection properties
  225. Workday connection properties
  226. Workday Mass Ingestion connection properties
  227. Workday V2 connection properties
  228. Xactly connection properties
  229. Xero connection properties
  230. XML Source connection properties
  231. XML Target connection properties
  232. Yellowbrick Data Warehouse connection properties
  233. Zendesk connection properties
  234. Zendesk Mass Ingestion connection properties
  235. Zendesk V2 connection properties
  236. Zuora AQuA Connection properties
  237. Zuora connection properties
  238. Zuora Multi-Entity connection properties
  239. Zuora REST V2 connection properties

Connections

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.
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.
This field appears only for the
Direct Connection
type.
Message Server
IP address or name of the SAP message server.
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.
This field appears only for the
Load Balancing Connection
type.
SAP System ID
ID of the SAP system that you want to access.
This field appears only for the
Load Balancing Connection
type.
Message Server Port
Port number on which the SAP message server is listening.
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.
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 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.
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.

0 COMMENTS

We’d like to hear from you!