High-Volume Agent SAP ECC on Oracle with NetWeaver API Configuration Beta
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
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"agent_user": "hvr",
"instance_number": "00",
"connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"rfc_library_path": "/opt/nwlibs",
"agent_password": "agent_password",
"always_encrypted": true,
"agent_public_cert": "CERTIFICATE",
"enable_archive_log_only": true,
"client_id": "800",
"tunnel_user": "fivetran",
"tunnel_port": 22,
"password": "test_password",
"archive_log_format": "arc_EXAMPLE_%s_%t_%r_%z.log",
"host": "host.com",
"tunnel_host": "XXX.XXX.XXX.XXX",
"archive_log_path": "/opt/fivetran/EXAMPLE_archivelog",
"agent_port": 4343,
"agent_host": "host.com",
"user": "test_user",
"schema": "schema_name"
}
}Config parameters
| Name | Description |
|---|---|
agent_user | The agent's user. |
instance_number | Two-digit number (00-97) of the SAP instance within its host. |
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. |
rfc_library_path | Directory path containing the SAP NetWeaver RFC SDK library files. |
agent_password | The agent user's password. It must have a minimum length of 10 characters. |
always_encrypted | Require TLS. |
agent_public_cert | The agent public certificate. |
enable_archive_log_only | Default value: false. Set to true if you're using archive log only mode. |
client_id | Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
password | The user's password. |
archive_log_format | Archive log format. |
host | DB instance host or IP address. |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
archive_log_path | Archive log path. |
agent_port | The port number of the agent. |
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. |
user | The username. |
schema | 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_userandagent_passwordparameters 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.