リアルタイムIBM Cloud Object Storage のデータをkrewData 経由でkintone にノーコードで同期

こんにちは！リードエンジニアの杉本です。

この記事では、IBM Cloud Object Storage のObjects データをkintone に同期する方法を紹介します。グレープシティ社のkrewData というkintone プラグインとCData Connect Server を使うと、IBM Cloud Object Storage をはじめとする100を超えるSaaS データをノーコードでkintone に取り込むことが可能です。

krewData とは？

krewData は、グレープシティ社が提供するkintone のプラグインで、kintone の複数のアプリ間やExcel・CSV ファイルとkintone のデータ統合をkintone 上で行うことができます。

IBM Cloud Object Storage のデータの仮想データベースを作成する

CData Connect Server は、シンプルなポイントアンドクリックインターフェースを使用してデータソースに接続し、データを取得します。まずは、右側のサイドバーのリンクからConnect Server をインストールしてください。

1. Connect Server にログインし、「CONNECTIONS」をクリックします。
2. 一覧から「IBM Cloud Object Storage」を選択します。
3. IBM Cloud Object Storage に接続するために必要な認証プロパティを入力します。

   Cloud Object Storage 接続プロパティの取得・設定方法

   Cloud Object Storage に接続する前に、Cloud Object Storage インスタンスを登録してCloud Object Storage API キーとCRN を取得していきます。

   Cloud Object Storage の新規インスタンスの登録

   IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

   1. IBM Cloud アカウントにログインします。
   2. Cloud Object Storage ページに移動して、インスタンス名を指定して「作成」をクリックします。Cloud Object Storage の新規インスタンスにリダイレクトされます。

   API キー

   API キーは以下の手順で取得できます。

   1. まずは、IBM Cloud アカウントにログインします。
   2. API キーページに移動します。
   3. 中央右隅のIBM Cloud APIキーの作成 をクリックして、新しいAPI キーを作成します。
   4. ポップアップウィンドウが表示されたら、API キーの名前を指定して作成をクリックします。ダッシュボードからはアクセスできなくなるため、API Key を控えておきましょう。

   Cloud Object Storage CRN

   デフォルトでは、CData 製品はCloud Object Storage CRN を自動で取得します。ただし、複数のアカウントがある場合は、CloudObjectStorageCRN を明示的に指定する必要があります。この値は、次の2つの方法で取得できます。

   • Services ビューをクエリする。これにより、IBM Cloud Object Storage インスタンスとそれぞれのCRN がリストされます。
   • IBM Cloud で直接CRN を見つける。これを行うには、IBM Cloud のダッシュボードに移動します。リソースリストで、ストレージからCloud Object Storage リソースを選択してCRN を取得します。

   IBM Cloud Object Storage への接続

   これで準備は完了です。以下の接続プロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 認証を繰り返す必要がなく、さらに自動でアクセストークンを設定できます。
   • ApiKey：セットアップ中に控えたAPI キーを指定。
   • CloudObjectStorageCRN（オプション）：控えておいたCloud Object Storage のCRN に設定。Cloud Object Storage アカウントが複数ある場合のみ設定する必要があります。

   プロパティを設定したら、これで接続設定は完了です。

   
4. 「 Test Connection」をクリックします。
5. 「Permission」->「 Add」とクリックし、適切な権限を持つ新しいユーザー(または既存のユーザー) を追加します。

仮想データベースが作成されたら、krewData を含むお好みのクライアントからIBM Cloud Object Storage に接続できるようになります。

コネクションが構成されたら、kintone 上のkrewData プラグインからIBM Cloud Object Storage に接続できるようになります。

krewData でIBM Cloud Object Storage のデータをkintone に同期する

ここからは、kintone のプラグインであるkrewData での設定になります。

krewData の設定

krewData のプラグインインストールとkintone での設定については、こちらのリンクを参照してください。

kintone にkrewData プラグインを入れ、必要な権限設定を行ってください。

krewData の入力としてIBM Cloud Object Storage を設定

ここからは、実際にIBM Cloud Object Storage をkintone にロードするフローを作成していきます。krewData 自体は、複数データソースの統合、データのフィルタリング、集計処理など多様な機能を有するETL ですが、今回はシンプルにIBM Cloud Object Storage のObjects データをkintone のアプリに同期するフローを作成します。

1. kintone 画面でアプリにkrewData が表示されているので、これをクリックします。
2. krewData アプリ画面の右上の「⚙」をクリックし、「設定」を開きます。
3. 「設定」タブからプラグインをクリックします。これでkrewData のプラグイン操作画面に来ました。
4. 「＋データ編集フローを作成」の文字をクリックしてフローを作成します。作成されたフローが表示されますので、「⚙」マークをクリックしてフローを編集します。

5. フロー編集画面が開きます。通常のkrewData フローは「入力アプリ」ではじまり、間にいくつかの処理モジュールを入れた後に「出力アプリ」で閉じる形です。CData Connect Server を使う場合には、一番下の「外部連携」の「CData Connect Server入力」モジュールを使います。
   「CData Connect Server入力」を左ペインからドラッグして、フローキャンバスにドロップします。そこからコマンド設定を行っていきます。「アプリを選択」をクリックします。

6. 「＋新しい外部サービス情報アプリを作成する」をクリックして、アプリ名を入力してアプリを作成します。こちらはkrewData の連携で使われるアプリですので、通常のkintone アプリを設定することはできません。OK をクリックします。
7. 同じ入力コマンドで「サインイン」をクリックして、CData Connect Server にkrewData からサインインします。アカウント選択画面がでるので、「別のアカウントを追加」ボタンをクリックします。CData Connect Server アカウント設定画面が表示されるので、Connect Server への接続を行います。
   CData Connect Server アカウント：Connect Server のユーザー名
   Personal Access Token：Connect Server ユーザーのパスワード
   OK を押してConnect Server に接続します。

8. 次に「データソースを選択」ボタンをクリックします。まずどのConnection を使うかを選択するので、先ほど作成したIBM Cloud Object Storage のConnection をドロップダウンから選択します。
9. IBM Cloud Object Storage のどのオブジェクト（テーブル）を使うかを選択します。CData Connect Server がIBM Cloud Object Storage のオブジェクト（含むカスタムオブジェクト）をフラットなテーブル構造にモデル化しています。今回はObjects を選択します。OK を押してテーブル選択を保存します。

10. ここでIBM Cloud Object Storage からkrewData に取得するデータの絞り込み条件をかけることができます。特にデータ量が多い場合には、パフォーマンスを上げるためにフィルタ条件をかけることをおすすめします。krewData のGUI でフィルタリング条件をかけるカラムを指定し、条件を設定することが可能です。
11. 最後にkrewData で使用するフィールドを選択します。

12. テーブル設定、フィルタリング設定、フィールド設定まで終わったら「プレビュー」タブをクリックして、実際に取得されるデータを見ることができます。

kintone へのアウトプットを設定

kintone への出力を行う設定を行います。

1. 「出力アプリ」を左ペインからドラッグしてフローキャンバスにドロップします。先ほどのCData Connect Server入力アプリと出力アプリを線でつなぎます。
2. 「アプリを選択」ボタンをクリックして、入力アプリと同様に新しいアプリを作成します。
3. 出力アプリの設定として、２回目以降の同期の際のデータの更新の方法をしていします。今回はUPSERT 設定で更新または追加にチェックをいれています。
4. 更新キーをしていできるので、ID カラムにチェックを入れて更新キーにします。

5. これで出力アプリの設定が完了したので、左上の「アプリを更新」をクリックしてフローを保存します。

IBM Cloud Object Storage Objects のkintone への同期フローを実行

では、実際にフローを実行していきます。

まずはユーザー情報を指定する必要があります。左上の「設定ファイル」タブをクリックします。kintone のログイン名とパスワードを入力します。セキュアアクセスを使っている場合にはセキュアアクセス設定が必要です。

右上の「▶実行」ボタンをクリックして、フローを実行しましょう！！！
「成功」の表示がでました。

実際にkintone 上で出力アプリとして設定したアプリを開いてみます。ちゃんとIBM Cloud Object Storage Objects 情報がkintone アプリのレコードとして同期されていました。

まとめ

いかがでしたか？このようにCData Connect Server とkrewData を使って、簡単にIBM Cloud Object Storage のObjects データをkintone にノーコードで同期することができました。

是非、CData Connect Server で他の100を超えるデータソースでもkintone への同期をお試しください。