Data Ingestion and Replication
- Data Ingestion and Replication
- All Products
Connection property
| Description
|
---|---|
Runtime Environment
| Name of the runtime environment where you want to run the tasks.
Specify a Secure Agent, Hosted Agent, or serverless runtime environment.
You cannot run a streaming ingestion task on a Hosted Agent or serverless runtime environment.
|
Authentication Type
| If required, select the authentication method that the connector must use to login to the web service application. Default is none.
|
Auth User ID
| The user name to login to the web service application when you select the Basic authentication.
Digest authentication is not applicable.
|
Auth Password
| The password associated with the user name when you select the Basic authentication.
Digest authentication is not applicable.
|
OAuth Consumer Key
| The client key associated with the web service application.
Required only for OAuth authentication type.
|
OAuth Consumer Secret
| The client password to connect to the web service application.
Required only for OAuth authentication type.
|
OAuth Token
| The access token to connect to the web service application.
Required only for OAuth authentication type.
|
OAuth Token Secret
| The password associated with the OAuth token.
Required only for OAuth authentication type.
|
Swagger File Path
| The absolute path along with the file name or the hosted URL of the swagger specification file. The hosted URL must return the content of the file without prompting for further authentication and redirection.
If you provide the absolute path of the swagger specification file, the swagger specification file must be located on the machine that hosts the Secure Agent. The user must have the read permission for the folder and the specification file. Example:
C:\swagger\sampleSwagger.json
In a
streaming ingestion task, use only a hosted URL of the swagger specification file as the swagger file path.
|
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 .
For the serverless runtime environment, specify the truststore file path in the serverless agent directory.
For example: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks
|
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.
For the serverless runtime environment, specify the keystore file path in the serverless agent directory.
For example: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks
|
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>
You cannot configure an authenticated proxy server.
|
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
In a
streaming ingestion task, only
ConnectionTimeout and
retryattempts are applicable.
|