OData のデータをモバイル開発のUnifinity で利用する方法

杉本和也
リードエンジニア

クロスプラットフォームモバイルアプリ開発ができるUnifinity から OData のデータに接続する方法

Unifinity は、iOS / Android / Windows のマルチOS 向けのモバイルアプリ開発が可能なプラットフォームです。Unifinity Studio という専用のツールで、UIをベースにアプリ画面をデザインしたり、DB・APIなどと連動した処理・ロジックを作成することができます。Unifinity では、REST API への接続ができるため、CData の製品を組み合わせることで対応データソースを増やすことができます。この記事では CData API Server と ADO.NET Provider for OData を使って、Unifinity でOData にデータ連携するモバイルアプリを開発する方法を説明します。
Unifinity モバイルアプリからOData にデータ連携。

OData データ連携について

CData は、OData サービスのライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています：

OData バージョン 2.0、3.0、4.0 にアクセスでき、レガシーサービスと最新の機能・性能の両方に対応できます。
$filter、$select、$expand などの高度なクエリオプションを活用し、サードパーティツールからのデータ取得を強化できます。
サーバーサイドでの集計とグループ化の実行により、データ転送を最小化し、パフォーマンスを向上させます。
Azure AD、ダイジェスト、ネゴシエート、NTLM、OAuth など、さまざまなスキームを使用して安全に認証でき、すべての接続でセキュアな認証を実現します。
SQL ストアドプロシージャを使用して、OData サービスエンティティを管理できます。エンティティ間の関連付けの一覧表示、作成、削除などが可能です。

お客様は、Power BI、MicroStrategy、Tableau などのお気に入りのツールと OData サービスを定期的に統合し、OData サービスからデータベースやデータウェアハウスにデータをレプリケートするために CData のソリューションを使用しています。

はじめに

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなOData OData サービスを作成していきましょう。

OData への接続

Unifinity からOData のデータを操作するには、まずOData への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「OData」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、OData への接続設定を行っていきましょう！

OData への接続

OData に接続するには、Url を有効なOData サービスルートURI に設定する必要があります。 OData サービスにルートドキュメントがない場合、テーブルとして公開したい特定のエンティティをFeedURL に指定してください。

OData への認証

OData は、以下を経由する認証をサポートします。

HTTP
Kerberos
SharePoint Online
OAuth
Azure AD

HTTP 認証スキーム

HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。

Scheme	AuthScheme	その他の設定
None	None	認証を必要としない場合に使用。
Basic	Basic	User、Password
NTLM	NTLM	User、Password
Digest（サポートされている場合）	Digest	User、Password

その他の認証方法の詳細は、ヘルプドキュメントの「接続の確立」セクションを参照してください。

接続情報の入力が完了したら、「保存およびテスト」をクリックします。

OData への接続

OData への認証

OData は、以下を経由する認証をサポートします。

HTTP
Kerberos
SharePoint Online
OAuth
Azure AD

HTTP 認証スキーム

HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。

Scheme	AuthScheme	その他の設定
None	None	認証を必要としない場合に使用。
Basic	Basic	User、Password
NTLM	NTLM	User、Password
Digest（サポートされている場合）	Digest	User、Password

その他の認証方法の詳細は、ヘルプドキュメントの「接続の確立」セクションを参照してください。

API Server のユーザー設定

次に、API Server 経由でOData にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

OData 用のAPI エンドポイントの作成

ユーザーを作成したら、OData のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でOData への接続を設定してユーザーを作成し、API Server でOData データのAPI を追加しました。これで、OData 形式のOData データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

オンプレミスDB やファイルからのAPI Server 使用（オプション）

オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法記事を参考にしてください。

Unifinity でOData のREST サービスに接続

Unifinity プロジェクトの作成

Unifinity から APIServer への接続設定をしていきます。

Unifinity Studioを立ち上げてます。
新しくプロジェクトを作成します。今回は「inquiriesProject」としました。
次に画面を作る前に、データを格納するためのDBを作ってしまいます。 DBタブを選んで、「＋」ボタンでDBを追加します。名前は「inquiries」です。

画面を作成します。一覧画面に表示している「表」は先程作成したDBの「inquiries」と紐付けています。

画面本体のオープン時の処理として後ほど解説するデータ取得ロジックを指定しています。これによって、表にデータが表示されるようになります。

アプリの要となるロジック部分を構成します。
一覧画面を表示するための「データ取得ロジック」を作成します。登録・更新のロジック作成も可能です。
データ取得ロジックは以下のような処理で構成されています。Cdata API Serverにリクエストを送り、そのデータをデータベースに書き込むことで一覧表示を実現しています。

API Serverへのリクエストには、ヘッダーで認証情報を指定する必要があります。そのため、ディクショナリー作成コンポーネントを使って、ContentTypeとともに、「x-cdata-authtoken」というプロパティで先程API Serverのユーザー作成画面で構成したToken情報を設定するようにします。

HTTPリクエストには「ネットワーク/GET2」のコンポーネントを使用し、URIにAPI Serverのinquiriesリソースエンドポイント「例：http://localhost:8387/api.rsc/sakila_inquiries」を指定し、ヘッダーオプションに先程作成したディクショナリを指定します。