HVA SAP ECC on Oracle with NetWeaver 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_netweaver",
  "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_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",
    "client_id": "800",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "enable_archive_log_only": true,
    "enable_tde_encryption": true,
    "host": "host.com",
    "instance_number": "00",
    "password": "test_password",
    "rfc_library_path": "/opt/nwlibs",
    "tde_wallet_password": "tde_wallet_password",
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "tunnel_port": 22,
    "tunnel_user": "fivetran",
    "user": "test_user",
    "schema": "schema_name"
  },
  "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_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.
`archive_log_format`	Archive log format.
`archive_log_path`	Archive log path.
`client_id`	Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
`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.
`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.
`instance_number`	Two-digit number (00-97) of the SAP instance within its host.
`password`	The user's password.
`rfc_library_path`	Directory path containing the SAP NetWeaver RFC SDK library files.
`tde_wallet_password`	TDE wallet password. Required for password based wallet.
`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.
`user`	The username.
`schema` (required)	Destination schema name. Schema name 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, user, password, 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_netweaver",
  "group_id": "group_id",
  "config": {
    "host": "host.com",
    "user": "test_user",
    "password": "test_password",
    "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.