ローコードアプリ開発プラットフォームOutSystems でAzure Data Lake Storage 連携アプリを作成

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

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData Connect Server を経由して OutSystems からAzure Data Lake Storage に連携するアプリを作成する方法を説明します。

CData Connect Server は、Azure Data Lake Storage データのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにAzure Data Lake Storage データへ連携することができます。さらに、CData Connect Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。

Azure Data Lake Storage の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

1. CData Connect Server にログインして、Databases をクリックします。
2. 利用できるデータソースアイコンから"Azure Data Lake Storage" を選択します。
3. Azure Data Lake Storage に接続するために必要なプロパティを入力します。

   Azure DataLakeStorage 接続プロパティの取得・設定方法

   Azure DataLakeStorage Gen 1 への接続

   Gen 1 DataLakeStorage アカウントに接続するには、はじめに以下のプロパティを設定します。

   • Schema：ADLSGen1 を指定。
   • Account：アカウント名に設定。
   • AzureTenant：テナントId に設定。Azure Portal 内のAzure Data Lake プロパティから取得できます。
   • Directory：（オプション）複製したファイルを格納するためのパスを設定。指定しない場合は、ルートディレクトリが使用されます。

   Azure DataLakeStorage Gen 1 への認証

   Gen 1 は、認証方法としてAzure Active Directory OAuth（AzureAD）およびマネージドサービスID（AzureMSI）をサポートしています。認証方法は、ヘルプドキュメントの「Azure DataLakeStorage Gen 1 への認証」セクションを参照してください。

   Azure DataLakeStorage Gen 2 への接続

   Gen 2 DataLakeStorage アカウントに接続するには、はじめに以下のプロパティを設定します。

   • Schema：ADLSGen2 に設定。
   • Account：ストレージアカウント名に設定。
   • FileSystem：このアカウントで使用するファイルシステム名に設定。例えば、Azure Blob コンテナ名など。
   • Directory：（オプション）複製したファイルを格納するためのパスを設定。指定しない場合は、ルートディレクトリが使用されます。

   Azure DataLakeStorage Gen 2 への認証

   Gen 2は、認証方法としてアクセスキー、共有アクセス署名（SAS）、Azure Active Directory OAuth（AzureAD）、マネージドサービスID（AzureMSI）など多様な方法をサポートしています。AzureAD、AzureMSI での認証方法は、ヘルプドキュメントの「Azure DataLakeStorage Gen 2 への認証」セクションを参照してください。

   アクセスキーを使用した認証

   アクセスキーを使用して接続するには、AccessKey プロパティを取得したアクセスキーの値に、AuthScheme を「AccessKey」に設定します。

   Azure ポータルからADLS Gen2 ストレージアカウントのアクセスキーを取得できます。

   1. Azure ポータルのADLS Gen2 ストレージアカウントにアクセスします。
   2. 設定で「アクセスキー」を選択します。
   3. 利用可能なアクセスキーの1つの値を「AccessKey」接続プロパティにコピーします。

   共有アクセス署名（SAS）

   共有アクセス署名を使用して接続するには、SharedAccessSignature プロパティを接続先リソースの有効な署名に設定して、AuthScheme を「SAS」に設定します。 共有アクセス署名は、Azure Storage Explorer などのツールで生成できます。

4. Test Database をクリックします。
5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。
7. 併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI タブにある「Open API」のファイルを以下から保存しておきましょう。

OutSystems にCData Connect Server のコネクションを追加

続いてCData Connect Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData Connect Server に接続します。

1. 「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。
2. 今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し
3. 保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。
4. すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。
5. これで CData Connect Server へのLogic を登録できました。
6. Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。
7. なお、これだけでは認証が通らないので、先程 CData Connect Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。

一覧画面を作成

それでは実際に CData Connect Server と連携した画面を作成していきましょう。

1. 「Interface」タブに移動して「Add Screen」をクリックします。
2. Screenのテンプレートは「Empty」で進めます。
3. Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData Connect Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。
4. まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData Connect Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。
5. そして、「Fetch Data from Other Source」のフローにCData Connect Server から全データを取得するメソッドをドラッグアンドドロップで配置します。
6. 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。
7. これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し
8. Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。
9. 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。
10. これだけで、CData Connect Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。
11. 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。
12. 一覧画面が表示されて、以下のようにCData Connect Server 経由で取得したAzure Data Lake Storage のデータがきれいに表示されました。

クラウドアプリケーションからAzure Data Lake Storage データにOData API アクセスを実現

このように、CData Connect Serverを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをOutSystems で開発できます。他にも多くのSaaS に対応するCData Connect Server の詳細をこちらからご覧ください。