Magic xpi からCData ODBC Driver for IBM Cloud Object Storage を使ってIBM Cloud Object Storage につないでみた

CData ODBC Driver for IBM Cloud Object Storage を使って、IBM Cloud Object Storage へのデータ連携をMagic xpi から行うことができます。Magic xpi の「データマッパー」機能を使って、IBM Cloud Object Storage のデータをMagic xpi で使ってみましょう。

ノンコーディングでデータを連携・同期・統合するデータ連携(EAI)ツール「Magic xpi」には、ODBC でデータベースへ接続する機能が備わっているので、これを使ってIBM Cloud Object Storage データ連携を行うことが可能です。 通常、IBM Cloud Object Storage などのSaaS として提供されるアプリケーションにはWeb API でアクセスしますが、CData IBM Cloud Object Storage ODBC Driver によって、RDB にアクセスするのと同感覚で、IBM Cloud Object Storage のデータを扱うことができます。

プロジェクトの作成、および、ODBCの接続設定

Magic xpi スタジオにてプロジェクトを作成して、ODBC接続設定を行います。

  1. Magic xpi スタジオを起動してメニューバーからファイル > 新規 を選択します。新規プロジェクトウィンドウが起動したらプロジェクト名を指定して新規プロジェクトを作成します。
  2. メニューバーからプロジェクト > リソース を選択します。リソース設定ウィンドウが起動したら左下の「新規」ボタンをクリックします。
  3. 新規リソースウィンドウにて、リソースタイプを「Database」を選択、リソース名にCDataIBM Cloud Object Storageを指定して「OK」ボタンをクリックします。
  4. リソース設定ウィンドウにて、DBMSには「ODBC」、データソース名には、Microsoft ODBC データソースアドミニストレーターのシステムDSNで定義されたデータソース名(DSN)、例えば「CData IBM Cloud Object Storage Source」などを設定します。
    Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、CData IBM Cloud Object Storageのヘルプドキュメントの「はじめに」をご参照ください。

    一般的な接続文字列は次のとおりです:

    • ApiKey
    • CloudObjectStorageCRN
    • Region
    • OAuthClientId
    • OAuthClientSecret
    Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

    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.

    「検証」ボタンをクリックしてデータベースとの接続が成功することを確認して、リソース設定ウィンドウを「OK」ボタンをクリックして終了します。

IBM Cloud Object Storage データをCSV ファイルへ出力するフローの作成

Magic xpi スタジオにて、データマッパーコンポーネントを使用してIBM Cloud Object Storage データをCSV ファイルへ出力するフローを作成します。

  1. プロジェクト内に作成されたフローを右クリックして、特性を選択します。フロー特性ウィンドウが起動したら自動起動をYesに変更して「OK」ボタンをクリックします。
  2. トリガコンポーネントが「自動起動」に設定されたことを確認します。コンポーネント内のデータマッパーを右側のペインにドラッグ&ドロップします。
  3. データマッパーウィンドウが起動するので「構成」ボタンをクリックします。
  4. 送り元/送り先管理ウィンドウが開くので、送り元のタイプをDatabase、送り先のタイプをフラットファイルに設定します。
  5. 送り元の「特性」ボタンをクリックして、データベーススキーマ特性ウィンドウにてDB オペレーションで「Select」を選択、データベース定義で「CDataIBM Cloud Object Storage」を選択して「ウィザード」ボタンをクリックします。
  6. 使用可能テーブルからテーブルを選択して「追加」ボタンをクリックして選択済テーブルに追加されたことを確認して「次へ」ボタンをクリックします。
  7. データベースウィザードにて出力したいカラムを使用可能カラムから「追加」ボタンをクリックして選択済カラムに追加されたことを確認して「次へ」ボタンをクリックします。 Where 句とOrder By 句の定義ウィンドウが表示されるので必要であれば設定して「次へ」ボタンをクリックします。
  8. ウィザードの結果にてSQL が表示されます。誤りがなければ「終了」ボタンをクリックします。
  9. 次に、送り先の「特性」ボタンをクリックして、フラットファイルウィンドウにてデータの送り先で「ファイル」を選択、右横のウィンドウにパス付の出力ファイル名を入力します。 下段の「新規」ボタンを、出力するカラム数分クリックして出力項目を定義します。出力項目に併せて必要に応じて型や桁数を定義してください。
  10. 送り元/送り先管理ウィンドウに戻り「マップ」ボタンをクリックします。
  11. 「マップ」ウィンドウが起動するので、送り元から送り先の項目へのドラッグ&ドロップ操作で線でつなぎます。「OK」ボタンをクリックします。 送り元/送り先管理ウィンドウに戻り「OK」ボタンをクリックします。

Magic xpi スタジオからのテスト実行

Magic xpi スタジオから作成したフローを実行します。

  1. メニューバーからデバッガ > 開く を選択します。チェック処理が実行され正常に終了すると、メニューバーからデバッガ > 実行 が活性化されるので選択します。
  2. フローが実行されて正常に終了すると送り先のフラットファイルウィンドウで指定したファイルが作成されてIBM Cloud Object Storage 内の指定したカラムのデータが出力されていることを確認できます。
 
 
ダウンロード