Cloud Data Integration Connectors
All Products
Connection property
| Description
|
|---|---|
Access Token URL
| Access token URL configured in your application.
|
Client ID
| Client ID of your application.
|
Client Secret
| Client secret of your application.
|
Scope
| Specifies access control if the API endpoint has defined custom scopes. Enter space separated scope attributes. For example:
root_readonly root_readwrite manage_app_users
|
Access Token Parameters
| Additional parameters to use with the access token URL. Parameters must be defined in the JSON format. For example:
[{"Name":"resource","Value":"https://<serverName>"}]
|
Client Authentication
| Select an option to send Client ID and Client Secret for authorization either in the request body or in the request header. Default is Send Client Credentials in Body .
|
Generate Access Token
| Generates access token based on the information provided in the above fields.
|
Access Token
| Enter the access token value or click
Generate Access Token to populate the access token value.
|
Swagger File Path
| The absolute path along with the file name or the hosted URL of the swagger specification file.
If you are providing the absolute path of the swagger specification file, the swagger specification file must be located on the machine that hosts the Secure Agent.
You can generate the swagger specification file from
Administrator . Click
Administrator > Swagger Files |
TrustStore File Path
| The absolute path of the truststore file that contains the TLS certificate to establish a one-way or two-way secure connection with the REST API. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
You can also configure the truststore file name and password as a JVM option or import the certificate to the following directory:
<Secure Agent installation directory\jre\lib\security\cacerts .
|
TrustStore Password
| The password for the truststore file that contains the SSL certificate.
You can also configure the truststore password as a JVM option.
|
KeyStore File Name
| The absolute path of the keystore file that contains the keys and certificates required to establish a two-way secure communication with the REST API. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
You can also configure the keystore file name and location as a JVM option or import the certificate to any directory.
|
KeyStore Password
| The password for the keystore file required for secure communication.
You can also configure the keystore password as a JVM option.
|
Proxy Type
| Type of proxy. You can select one of the following options:
|
Proxy Configuration
| The proxy configuration format:
<host>:<port>
Proxy server with authentication is not supported.
|
Advanced Fields
| Enter the arguments that the Secure Agent uses when connecting to a REST endpoint. You can specify the following arguments, each separated by a semicolon ( ; ):
ConnectionTimeout : The wait time in milliseconds to get a response from a REST endpoint. The connection ends after the connection timeout is over. Default is the timeout defined in the endpoint API.
If you define both the REST V2 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout.
connectiondelaytime : The delay time in milliseconds to send a request to a REST endpoint. Default is 10000.
retryattempts : Number of times the connection is attempted when 400 and 500 series error codes are returned in the response. Default is 3. Specify 0 to disable the retry attempts.
qualifiedSchema : Specifies if the schema selected is qualified or unqualified. Default is false.
Example:
connectiondelaytime:10000;retryattempts:5
|
Updated December 14, 2020
