IBM Cloud Data Engine Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium IBM Cloud Data Engine connector.

IBM Cloud Data Engine empowers businesses with advanced analytics capabilities in the cloud, driving data-driven decision-making.

This topic describes how to authenticate to IBM Cloud Data Engine and configure any necessary connection properties in the IBM Cloud Data Engine connection connector.

Connection Configuration #

Each connection property available in the IBM Cloud Data Engine connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Access Token #

The access token for connecting using OAuth.

The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

Refresh Token #

The OAuth refresh token for the corresponding OAuth access token.

Api Key #

The API Key used to identify the user to IBM Cloud.

Access to resources in the IBM Cloud Data Engine REST API is governed by an API key in order to retrieve token.

An API Key is created by navigating to Manage -> Access (IAM) -> Users and clicking ‘Create’.

Cloud Object Storage CRN #

The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud.

Access to resources, such as data, in the IBM Cloud Data Engine REST API is governed by an Instance Cloud Resource Name.

To retrieve your CloudObjectStorage CRN, select your Cloud Object Storage instance from the Dashboard, then click the ‘Service credentials’ tab on the right hand side and create or select one of the existing credentials by clicking on view credentials.

Among the information displayed, you will find the CloudObjectStorageCRN (resource_instance_id). Use that value for this property. If not specified, the IBM Cloud Data Engine will automatically retrieve the CloudObjectStorageCRN. If more than one CloudObjectStorage service is available, then the first one in the list will be picked.

Sql Query CRN #

The CRN which uniquely identifies your SQL Query instance in IBM Cloud.

Access to resources, such as jobs, in the IBM Cloud Data Engine REST API is governed by an Instance Cloud Resource Name.

To retrieve your SqlQuery CRN, select your SQL Query instance from the Dashboard. On the left hand side, the manage tab should be automatically selected. On that page, you may find the SqlQuery CRN of that instance under the ‘Deployment details’ pane. If not specified, the IBM Cloud Data Engine will automatically retrieve the SqlQueryCRN. If more than one SqlQuery service is available, then the first one in the list will be picked.

Bucket #

The name of the bucket in IBM Cloud that you will be connecting to.

In order to access resources in the IBM Cloud Data Engine REST API, a Bucket can be used.

All bucket names are listed on the IBM Cloud Dashboard.

This is value is optional and can be left blank.

Result Location URI #

A COSURI (e.g. cos://region/bucket) where job files will be stored.

Region #

The geographic location of the bucket you’re connecting to.

Only specify this value if Bucket is also set.

Enable SSL #

Option for creating the connection with SSL enabled.

Upload Keystore File #

Option to upload keystore file.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.