Add IBM Cloud Object Storage Data to Informatica Enterprise Data Catalog

Use the CData JDBC Driver for IBM Cloud Object Storage with the Informatica Enterprise Data Catalog to classify and organize data.

Informatica provides a powerful, elegant means of transporting and transforming your data. By utilizing the CData JDBC Driver for IBM Cloud Object Storage, you are gaining access to a driver based on industry-proven standards that integrates seamlessly with Informatica's Enterprise Data Catalog. This tutorial shows how to classify and organize IBM Cloud Object Storage data across any environment.

Load the JDBC Driver

To load the JDBC Driver:

  1. Install the JDBC Driver on the host running Informatica. For this article, it is assumed that the driver was installed into cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorage Driver.
  2. $ java -jar setup.jar
  3. Navigate to the JDBC install directory and create a zip file called genericJDBC.zip containing the driver and its license file.
  4. $ cd ~/cdata-jdbc-driver-for-ibmcloudobjectstorage/lib $ zip genericJDBC.zip cdata.jdbc.ibmcloudobjectstorage.jar cdata.jdbc.ibmcloudobjectstorage.lic
  5. Move the genericJDBC.zip file into the Catalog Service directory within Informatica. For this article, it is assumed that Informatica is installed into /opt/informatica. Working in this folder will probably require root permissions, so make sure to su or sudo to root before continuing.
  6. # mv genericJDBC.zip /opt/informatica/services/CatalogService/ScannerBinaries
  7. Edit the custom deployment configuration to unpack the zip file.
  8. # cd /opt/informatica/services/CatalogService/ScannerBinaries/CustomDeployer/ # nano scannerDeployer.xml

    After unpacking the existing ExecutionContextProperty nodes, add a new ExecutionContextProperty node with this content.

    <ExecutionContextProperty isLocationProperty="true" dependencyToUnpack="genericJDBC.zip"> <PropertyName>JDBCScanner_DriverLocation</PropertyName> <PropertyValue>scanner_miti/genericJDBC/Drivers</PropertyValue> </ExecutionContextProperty>
  9. Refresh the Catalog Service from the Admin console.

Configure the JDBC Resource

To configure the JDBC resource:

  1. Open the Catalog administrator and add a new JDBC resource with the following properties:
    • Driver Class: cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver
    • URL: jdbc.ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
    • Register a New Instance of Cloud Object Storage

      If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

      1. Log in to your IBM Cloud account.
      2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

      Connecting using OAuth Authentication

      There are certain connection properties you need to set before you can connect. You can obtain these as follows:

      API Key

      To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

      1. Log in to your IBM Cloud account.
      2. Navigate to the Platform API Keys page.
      3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
      4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

      Cloud Object Storage CRN

      If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

      • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
      • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

      Connecting to Data

      You can now set the following to connect to data:

      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
      • ApiKey: Set this to your API key which was noted during setup.
      • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

      When you connect, the connector completes the OAuth process.

      1. Extracts the access token and authenticates requests.
      2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

      Built-In Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the IBM Cloud Object Storage JDBC Driver. Either double-click the .jar file or execute the .jar file from the command-line.

      java -jar cdata.jdbc.ibmcloudobjectstorage.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

    Typical additional connection string properties follow:

    JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver;URL={jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;};
  2. Username: user
  3. Password: password
  4. Note that the Username and Password properties are required, even if the driver you are using does not require them. In those cases, you can enter a placeholder value instead.

  5. Configure the metadata options to perform at least one source metadata scan. This scan uses the driver to determine what tables, views, and stored procedures are available through the service.
    • Source Metadata: Enable this option.
    • Catalog: Set this to the appropriate catalog for multi-catalog data sources. Otherwise, set this to CData.
    • Schema: Set this to the appropriate schema for multi-schema data sources. Otherwise, set this to the name of the service (for example, Couchbase).
    • Case-sensitivity: Generally this option should be disabled. Enable it only for data sources which are case-sensitive.
    • Import stored procedures: Enable this if you want to import stored procedure definitions in addition to tables and views.

    Other metadata scanners may be enabled as desired.

  6. Complete the driver configuration, optionally configuring custom attributes and a scanner schedule.
  7. Perform the metadata scan by navigating to the Monitoring tab and clicking Run. Depending upon the data source, this may takes a few minutes.

When the scan is complete, a summary of all of the metadata objects is displayed along with the status of the Metadata Load job. If any errors occur, you can open the Log Location link for the job to see the errors reported by Informatica or the driver.

Validate the Discovered Metadata

Open the Catalog Service browser to view the metadata extracted from the data source. Depending upon the options you selected when configuring the metadata scanner, you may see any combination of tables, views, and stored procedures for the resource you defined.

 
 
ダウンロード