ローコードアプリ開発プラットフォームOutSystems でOdoo 連携アプリを作成
OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData API Server を経由して OutSystems からOdoo に連携するアプリを作成する方法を説明します。
CData API Server は、Odoo のデータのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにOdoo のデータへ連携することができます。さらに、CData API Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。
Odoo データ連携について
CData を使用すれば、Odoo のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています:
- Odoo API 8.0+ と Odoo.sh クラウド ERP の両方からライブデータにアクセスできます。
-
多対一、一対多、多対多のデータプロパティをインテリジェントに処理することで、ネイティブの Odoo 機能を拡張できます。CData の接続ソリューションは、Odoo 内の複雑なデータプロパティもインテリジェントに処理します。テキストや日付などの単純な値を持つカラムに加えて、各行に複数の値を含むカラムもあります。ドライバーは、値の元となるカラムのタイプに応じて、これらの種類の値を異なる方法でデコードします:
- 多対一カラムは、別のモデル内の単一の行への参照です。CData ソリューションでは、多対一カラムは整数として表され、その値は他のモデルで参照している ID です。
- 多対多カラムは、別のモデル内の多くの行への参照です。CData ソリューションでは、多対多カラムはカンマ区切りの整数リストを含むテキストとして表されます。リスト内の各値は、参照されている行の ID です。
- 一対多カラムは、別のモデル内の多くの行への参照です。多対多カラムと同様(カンマ区切りの整数リスト)ですが、参照されるモデルの各行はメインモデルの 1 つにのみ属する必要があります。
- SQL ストアドプロシージャを使用して、Odoo 内のサーバーサイド RFC を呼び出すことができます。
ユーザーは、Power BI や Qlik Sense などの分析ツールと Odoo を統合し、当社のツールを活用して Odoo データをデータベースやデータウェアハウスにレプリケートしています。
はじめに
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなOdoo OData サービスを作成していきましょう。
Odoo への接続
OutSystems からOdoo のデータを操作するには、まずOdoo への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Odoo」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Odoo への接続設定を行っていきましょう!
-
接続するには、URL にOdoo インスタンスURL、User およびAPIToken にユーザー資格情報、Database にOdoo データベース名を設定します。 API トークン(Odoo 14 以降でのみ利用可能)を使用していない場合、代わりにAPIToken フィールドにパスワードを直接入力することができます。
接続方法の詳細は、ヘルプドキュメントの「はじめに」セクションを参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
接続するには、URL にOdoo インスタンスURL、User およびAPIToken にユーザー資格情報、Database にOdoo データベース名を設定します。 API トークン(Odoo 14 以降でのみ利用可能)を使用していない場合、代わりにAPIToken フィールドにパスワードを直接入力することができます。
接続方法の詳細は、ヘルプドキュメントの「はじめに」セクションを参照してください。
API Server のユーザー設定
次に、API Server 経由でOdoo にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Odoo 用のAPI エンドポイントの作成
ユーザーを作成したら、Odoo のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
-
併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ(https://myserver/api.rst#oas)にある「Open API」のファイルを以下から保存しておきましょう。
OData のエンドポイントを取得
以上でOdoo への接続を設定してユーザーを作成し、API Server でOdoo データのAPI を追加しました。これで、OData 形式のOdoo データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
OutSystems にCData API Server のコネクションを追加
続いてCData API Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData API Server に接続します。
- 「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。
- 今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し
- 保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。
- すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。
- これで CData API Server へのLogic を登録できました。
- Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。
- なお、これだけでは認証が通らないので、先程 CData API Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。
一覧画面を作成
それでは実際に CData API Server と連携した画面を作成していきましょう。
- 「Interface」タブに移動して「Add Screen」をクリックします。
- Screenのテンプレートは「Empty」で進めます。
- Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData API Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。
- まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData API Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。
- そして、「Fetch Data from Other Source」のフローにCData API Server から全データを取得するメソッドをドラッグアンドドロップで配置します。
- 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。
- これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し
- Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。
- 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。
- これだけで、CData API Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。
- 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。
- 一覧画面が表示されて、以下のようにCData API Server 経由で取得したOdoo のデータがきれいに表示されました。
クラウドアプリケーションからOdoo のデータにOData API アクセスを実現
このように、CData API Serverを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをOutSystems で開発できます。他にも多くのSaaS に対応するCData API Server の詳細をこちらからご覧ください。