Considerations for IBM Connectivity Service stages

IBM Connectivity Service stages use the IBM Connectivity Service integration framework to connect to and communicate with the database, convert data types, and report issues detected when interacting with the database. IBM Connectivity Service and all stages that use the service are bundled into the IBM Connectivity Service stage library, streamsets-datacollector-ibm-connectivity-service-lib. By default, Data Collector runs IBM Connectivity Service when the IBM Connectivity Service stage library is installed.

The following stages rely on IBM Connectivity Service:

IBM Db2 source
IBM Db2 target
IBM watsonx.data target

Before you can use IBM Connectivity Service stages, you must complete some prerequisite tasks.

IBM Connectivity Service stage prerequisite

About this task

Before you configure an IBM Connectivity Service stage, complete the following prerequisite task.

Procedure

Verify that the Db2Data Collector flight.enable property is set to auto or true.

Troubleshooting IBM Connectivity Service

If IBM Connectivity Service stops responding, Data Collector attempts to restart the service. If Data Collector is unable to restart IBM Connectivity Service, you can use the following API calls to view the IBM Connectivity Service state and restart IBM Connectivity Service:

Call	CURL request
Get IBM Connectivity Service state	curl --location 'https://<engine url>/rest/v1/flight/state' --header 'Authorization: Bearer <IBM Cloud API key>
Restart IBM Connectivity Service	curl --location 'https://<engine url>//rest/v1/flight/restart' --header 'Authorization: Bearer <IBM Cloud API key>
Get IBM Connectivity Service logs	curl --location 'https://<engine url>//rest/v1/flight/state' --header 'Authorization: Bearer <IBM Cloud API key>

Note: You use an IBM Cloud API key to make these API calls. For information on managing IBM Cloud API keys, see the IBM Cloud documentation.