HVA SAP ECC on Oracle API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "oracle_sap_hva",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "agent_host": "host.com",
    "agent_ora_home": "/opt/oracle/product/19c/dbhome_1",
    "agent_password": "agent_password",
    "agent_port": 4343,
    "agent_public_cert": "CERTIFICATE",
    "agent_user": "hvr",
    "always_encrypted": true,
    "archive_log_format": "arc_EXAMPLE_%s_%t_%r_%z.log",
    "archive_log_path": "/opt/fivetran/EXAMPLE_archivelog",
    "asm_option": true,
    "asm_oracle_home": "/asm/oracle/home",
    "asm_password": "asm_password",
    "asm_tns": "localhost:1521/ASM_TNS",
    "asm_user": "asm_user",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "database": "oracledb",
    "direct_capture_method": "ARCHIVE_ONLY | ASM | BFILE | DIRECT",
    "enable_archive_log_only": true,
    "enable_tde_encryption": true,
    "host": "host.com",
    "password": "test_password",
    "pdb_name": "pdb_name",
    "port": 1521,
    "sap_user": "sap_test_user",
    "tde_wallet_password": "tde_wallet_password",
    "tns": "localhost:1521/TNS",
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "tunnel_port": 22,
    "tunnel_user": "fivetran",
    "update_method": "TELEPORT",
    "use_oracle_rac": true,
    "user": "test_user",
    "schema_prefix": "prefix"
  },
  "external_secrets_keys_config": {
    "password": "PASSWORD_KEY",
    "user": "USER_KEY"
  }
}

Config parameters

Name	Description
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_ora_home`	The home directory of the Oracle database.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_port`	The port number of the agent.
`agent_public_cert`	The agent public certificate.
`agent_user`	The agent's user.
`always_encrypted`	Require TLS through Tunnel
`archive_log_format`	Archive log format.
`archive_log_path`	Archive log path.
`asm_option`	Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.
`asm_oracle_home`	The Oracle ASM home directory.
`asm_password`	The ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_tns`	ASM TNS.
`asm_user`	The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`database`	The database name.
`direct_capture_method`	Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`
`enable_archive_log_only`	Default value: `false`. Set to `true` if you're using archive log only mode.
`enable_tde_encryption`	Default value: `false`. Set to `true` if you're using TDE encryption.
`host`	DB instance host or IP address.
`password`	The user's password.
`pdb_name`	(Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
`port`	The port number.
`sap_user`	The Oracle schema name where the SAP tables reside.
`tde_wallet_password`	TDE wallet password. Required for password based wallet.
`tns`	Single-tenant database: The database SID. Multi-tenant database: The database TNS.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`update_method`	The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
`use_oracle_rac`	Default value: `false`. Set to `true` if you're using a RAC instance.
`user`	The username.
`schema_prefix` (required)	Destination schema prefix. Prefix for each replicated schema. For example with prefix 'x', source schemas 'foo' and 'bar' get replicated as 'x_foo' and 'x_bar'. The prefix is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the host, port, user, password, sap_user, agent_host, agent_port, agent_public_cert, agent_user and agent_password parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "oracle_sap_hva",
  "group_id": "group_id",
  "config": {
    "host": "host.com",
    "port": 1521,
    "user": "test_user",
    "password": "test_password",
    "sap_user": "sap_test_user",
    "agent_host": "host.com",
    "agent_port": 4343,
    "agent_public_cert": "CERTIFICATE",
    "agent_user": "hvr",
    "agent_password": "agent_password"
  }
}

By using the Connect Card or the Fivetran dashboard.