Magic xpi からCData ODBC Driver for Backlog を使ってBacklog につないでみた

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

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

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

1. Magic xpi スタジオを起動してメニューバーからファイル > 新規 を選択します。新規プロジェクトウィンドウが起動したらプロジェクト名を指定して新規プロジェクトを作成します。
   
2. メニューバーからプロジェクト > リソース を選択します。リソース設定ウィンドウが起動したら左下の「新規」ボタンをクリックします。
   
3. 新規リソースウィンドウにて、リソースタイプを「Database」を選択、リソース名にCDataBacklogを指定して「OK」ボタンをクリックします。
   

4. リソース設定ウィンドウにて、DBMSには「ODBC」、データソース名には、Microsoft ODBC データソースアドミニストレーターのシステムDSNで定義されたデータソース名（DSN）、例えば「CData Backlog Source」などを設定します。
   Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、CData Backlogのヘルプドキュメントの「はじめに」をご参照ください。

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

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

   Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

   API キー認証

   ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

   1. Backlog の個人設定ページを開きます。
   2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
   3. ApiKey にAPI キーを指定します。
   4. URL はBacklog のテナントURL から取得できます。

   OAuth 認証

   ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。

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

Backlog データをCSV ファイルへ出力するフローの作成

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

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

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

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

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