5. OData(V4) サービスのエンティティ操作¶
5.1. チュートリアル¶
このチュートリアルが終了すると、次のような事ができます。
- OData(V4) サービスのエンティティを操作する。
- 登録
- 参照
- 更新
- 削除
5.1.1. ゴールの説明¶
このチュートリアルでは、以下で公開されている OData(V4) リファレンスサービスを利用し、製品エンティティの操作を行います。
エンティティの登録
- エンティティを登録するユーザ定義タスクを作成します。
- 動作確認のためのフロー定義を作成します。
- 動作確認を行います。
エンティティの取得
- エンティティを取得するユーザ定義タスクを作成します。
- 動作確認のためのフロー定義を作成します。
- 動作確認を行います。
シングルエンティティの取得
- シングルエンティティを取得するユーザ定義タスクを作成します。
- 動作確認のためのフロー定義を作成します。
- 動作確認を行います。
エンティティの更新
- エンティティを更新するユーザ定義タスクを作成します。
- 動作確認のためのフロー定義を作成します。
- 動作確認を行います。
エンティティの削除
- エンティティを削除するユーザ定義タスクを作成します。
- 動作確認のためのフロー定義を作成します。
- 動作確認を行います。
このような順番で OData(V4) サービスのエンティティの操作方法や作業の流れを説明します。
5.1.2. 準備¶
チュートリアルの準備に書かれている準備が行われていることを確認してください。
5.1.3. エンティティの登録¶
IM-LogicDesignerのユーザ定義タスクを作成します。作成するのは「OData(V4)定義」です。
後述の「メソッド」を「POST」として作成することで OData サービスのエンティティの登録を行うようにします。
5.1.3.1. OData(V4)定義の作成¶
intra-mart Accel Platform にテナント管理者またはLogicDesigner管理者でログインします。
「サイトマップ」→「LogicDesigner」→「OData(V4)定義新規作成」を開きます。
「サービスURL」に「https://services.odata.org/Experimental/OData/(S(im_odata))/OData.svc」を設定します。
コラム
本チュートリアルでは必要ありませんが、利用する OData サービス に認証がかけられている場合、必要に応じて「認証種別」を「BASIC認証」または「OAuth認証」に設定し、認証情報を設定してください。コラム
OData サービスが独自のリクエストヘッダで認証を行う場合、以下のようにリクエストヘッダを追加して認証情報を設定してください。- リクエストヘッダ名に独自のリクエストヘッダ名を設定(上記画像では「Authorization」を設定)
- リクエストヘッダ値に認証情報を設定(上記画像では「my custom authorization」を設定)
「エンティティセット名」の横にあるリロードアイコンをクリックします。
「エンティティセット名」に「Products」を選択します。
「メソッド」に「POST」を選択します。
「入力/返却値取得」の横にある「取得」ボタンをクリックします。
その他の項目は以下のように入力してください。
ユーザ定義ID ODataV4Post ユーザ定義名 ODataV4Post ユーザカテゴリID SampleCategory 「登録」ボタンをクリックします。
確認ダイアログで「OK」ボタンをクリックします。
これで「OData(V4)定義」の作成は終了です。
5.1.3.2. フロー定義の作成¶
続いてフロー定義の作成を行います。
「サイトマップ」→「LogicDesigner」→「フロー定義」を開きます。
「新規作成」リンクをクリックし、「ロジックフロー定義編集」画面を表示します。
「入出力設定」リンクをクリックし、「入力」に次のような項目を追加し、「決定」ボタンをクリックします。
キー名 型 ID integer Name string Description string ReleaseDate sqltimestamp DiscontinuedDate sqltimestamp Rating short Price double ロジックフロー定義編集画面のデザイナに、先ほど作成した「ODataV4Post」タスクを追加し、「開始」「終了」と接続します。
「ODataV4Post」タスクをクリックし、「マッピング設定」ボタンをクリックします。
「入力」の各項目と、「ODataV4Post」の各項目を紐づけ、「決定」ボタンをクリックします。
「新規保存」リンクをクリックし、新規保存ダイアログを表示します。ダイアログに次のような内容を入力し「決定」ボタンをクリックします。
フロー定義ID ODataV4Post フロー定義名 標準 ODataV4Post フローカテゴリID SampleCategory 「確認」ダイアログで「決定」ボタンをクリックします。
5.1.3.3. 動作確認¶
最後に動作確認を行います。 IM-LogicDesigner のデバッグ機能を使ってフローを実行し、OData サービスにエンティティが作成されることを確認します。
「ODataV4Post」フローの「編集」アイコンをクリックします。
「ロジックフロー定義編集」画面の「デバッグ」リンクをクリックします。
「ロジックフロー定義のデバッグ」画面の「実行」リンクをクリックします。
「デバッグの実行」ダイアログが表示されるので、次のように入力し「実行」ボタンをクリックし、「確認」ダイアログで「決定」ボタンをクリックします。
ID 11 Name テスト(Name) Description テスト(Description) ReleaseDate 2016-12-01T10:00:00Z DiscontinuedDate 2017-12-01T10:00:00Z Rating 100 Price 1000 これで、OData サービスにエンティティが作成されました。
本当に作成されたかどうかを確認します。
ブラウザから「https://services.odata.org/Experimental/OData/(S(im_odata))/OData.svc/Products」にアクセスします。
フローのデバッグ画面で入力した値でエンティティが作成されていることを確認できます。
5.1.4. エンティティの取得¶
次に、 エンティティを参照する IM-LogicDesigner のユーザ定義タスクを作成します。作成するのは「OData(V4)定義」です。
「メソッド」を「GET」として作成することで OData サービスのエンティティの取得を行うようにします。
5.1.4.1. OData(V4)定義の作成¶
エンティティの登録の 1 から 5 までの手順を繰り返してください。
「メソッド」に「GET」を選択します。
「クエリオプション」の横にある「追加」アイコンをクリックし、以下のクエリオプションを追加します。
- 「クエリオプション名」を「$orderby」
- 「クエリオプション値」を「ID」
コラム
「$orderby」に「ID」を指定することで、IDでソートされた結果を取得する事が出来ます。クエリオプションの詳細については以下のドキュメントを参照してください。「入力/返却値取得」の横にある「取得」ボタンをクリックします。
その他の項目は以下のように入力してください。
ユーザ定義ID ODataV4Get ユーザ定義名 ODataV4Get ユーザカテゴリID SampleCategory 「登録」ボタンをクリックします。
確認ダイアログで「OK」ボタンをクリックします。
これで「OData(V4)定義」の作成は終了です。
5.1.4.2. フロー定義の作成¶
続いてフロー定義の作成を行います。
「サイトマップ」→「LogicDesigner」→「フロー定義」を開きます。
「新規作成」リンクをクリックし、「ロジックフロー定義編集」画面を表示します。
ロジックフロー定義編集画面のデザイナに、先ほど作成した「ODataV4Get」タスクと、「繰り返し開始」「繰り返し終了」「ログ出力」タスクを追加し、「開始」「終了」と接続します。
「定数設定」リンクをクリックし、次のような項目を追加し、「決定」ボタンをクリックします。
「定数ID」を「el」
「定数値」を以下
ID:${im_startLoop1.item.ID} Name:${im_startLoop1.item.Name} Description:${im_startLoop1.item.Description} ReleaseDate:${im_startLoop1.item.ReleaseDate} DiscontinuedDate:${im_startLoop1.item.DiscontinuedDate} Rating:${im_startLoop1.item.Rating} Price:${im_startLoop1.item.Price}
「繰り返し開始」タスクをクリックし、「繰り返し対象」に「ODataV4Get1/data」を設定します。
「ログ出力」タスクをクリックし、「マッピング設定」ボタンをクリックし、次のように各項目を紐づけ、「決定」ボタンをクリックします。
「新規保存」リンクをクリックし、新規保存ダイアログを表示します。ダイアログに次のような内容を入力し「決定」ボタンをクリックします。
フロー定義ID ODataV4Get フロー定義名 標準 ODataV4Get フローカテゴリID SampleCategory 「確認」ダイアログで「決定」ボタンをクリックします。
これでフロー定義の作成が終了です。
5.1.4.3. 動作確認¶
最後に動作確認を行います。 IM-LogicDesigner のデバッグ機能を使ってフローを実行し、OData サービスのデータが取得されることを確認します。
「ODataV4Get」フローの「編集」アイコンをクリックします。
「ロジックフロー定義編集」画面の「デバッグ」リンクをクリックします。
「ロジックフロー定義のデバッグ」画面の「実行」リンクをクリックします。
「デバッグの実行」ダイアログが表示されるので、「実行」ボタンをクリックし、「確認」ダイアログで「決定」ボタンをクリックします。
以下のログが出力されます。
[INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:0 Name:Bread Description:Whole grain bread ReleaseDate:1992-01-01 09:00:00.0 DiscontinuedDate: Rating:4 Price:2.5 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:1 Name:Milk Description:Low fat milk ReleaseDate:1995-10-01 09:00:00.0 DiscontinuedDate: Rating:3 Price:3.5 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:2 Name:Vint soda Description:Americana Variety - Mix of 6 flavors ReleaseDate:2000-10-01 09:00:00.0 DiscontinuedDate: Rating:3 Price:20.9 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:3 Name:Havina Cola Description:The Original Key Lime Cola ReleaseDate:2005-10-01 09:00:00.0 DiscontinuedDate:2006-10-01 09:00:00.0 Rating:3 Price:19.9 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:4 Name:Fruit Punch Description:Mango flavor, 8.3 Ounce Cans (Pack of 24) ReleaseDate:2003-01-05 09:00:00.0 DiscontinuedDate: Rating:3 Price:22.99 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:5 Name:Cranberry Juice Description:16-Ounce Plastic Bottles (Pack of 12) ReleaseDate:2006-08-04 09:00:00.0 DiscontinuedDate: Rating:3 Price:22.8 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:6 Name:Pink Lemonade Description:36 Ounce Cans (Pack of 3) ReleaseDate:2006-11-05 09:00:00.0 DiscontinuedDate: Rating:3 Price:18.8 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:7 Name:DVD Player Description:1080P Upconversion DVD Player ReleaseDate:2006-11-15 09:00:00.0 DiscontinuedDate: Rating:5 Price:35.88 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:8 Name:LCD HDTV Description:42 inch 1080p LCD with Built-in Blu-ray Disc Player ReleaseDate:2008-05-08 09:00:00.0 DiscontinuedDate: Rating:3 Price:1088.8 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:9 Name:Lemonade Description:Classic, refreshing lemonade (Single bottle) ReleaseDate:1970-01-01 09:00:00.0 DiscontinuedDate: Rating:7 Price:1.01 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:10 Name:Coffee Description:Bulk size can of instant coffee ReleaseDate:1982-12-31 09:00:00.0 DiscontinuedDate: Rating:1 Price:6.99 [INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:11 Name:テスト(Name) Description:テスト(Description) ReleaseDate:2016-12-01 19:00:00.0 DiscontinuedDate:2017-12-01 19:00:00.0 Rating:100 Price:1000.0
ブラウザから「https://services.odata.org/Experimental/OData/(S(im_odata))/OData.svc/Products」にアクセスします。
ブラウザに表示されるデータと、出力されたログの内容が一致することが確認できます。
5.1.5. シングルエンティティの取得¶
次に、 シングルエンティティを参照する IM-LogicDesigner のユーザ定義タスクを作成します。作成するのは「OData(V4)定義」です。
「メソッド」を「GET」、「シングルエンティティ」を選択することで OData サービスのシングルエンティティの取得を行うようにします。
5.1.5.1. OData(V4)定義の作成¶
エンティティの登録の 1 から 5 までの手順を繰り返してください。
「メソッド」に「GET」を選択します。
「メソッド」の横にある「シングルエンティティ」を選択します。
「入力/返却値取得」の横にある「取得」ボタンをクリックします。
その他の項目は以下のように入力してください。
ユーザ定義ID ODataV4GetSingle ユーザ定義名 ODataV4GetSingle ユーザカテゴリID SampleCategory 「登録」ボタンをクリックします。
確認ダイアログで「OK」ボタンをクリックします。
これで「OData(V4)定義」の作成は終了です。
5.1.5.2. フロー定義の作成¶
続いてフロー定義の作成を行います。
「サイトマップ」→「LogicDesigner」→「フロー定義」を開きます。
「新規作成」リンクをクリックし、「ロジックフロー定義編集」画面を表示します。
ロジックフロー定義編集画面のデザイナに、先ほど作成した「ODataV4GetSingle」タスクと「ログ出力」タスクを追加し、「開始」「終了」と接続します。
「入出力設定」リンクをクリックし、「入力」に次のような項目を追加し、「決定」ボタンをクリックします。
キー名 型 ID integer 「定数設定」リンクをクリックし、次のような項目を追加し、「決定」ボタンをクリックします。
「定数ID」を「el」
「定数値」を以下
ID:${ODataV4GetSingle1.data.ID} Name:${ODataV4GetSingle1.data.Name} Description:${ODataV4GetSingle1.data.Description} ReleaseDate:${ODataV4GetSingle1.data.ReleaseDate} DiscontinuedDate:${ODataV4GetSingle1.data.DiscontinuedDate} Rating:${ODataV4GetSingle1.data.Rating} Price:${ODataV4GetSingle1.data.Price}
「ODataV4GetSingle」タスクをクリックし、「マッピング設定」ボタンをクリックし、次のように各項目を紐づけ、「決定」ボタンをクリックします。
「ログ出力」タスクをクリックし、「マッピング設定」ボタンをクリックし、次のように各項目を紐づけ、「決定」ボタンをクリックします。
「新規保存」リンクをクリックし、新規保存ダイアログを表示します。ダイアログに次のような内容を入力し「決定」ボタンをクリックします。
フロー定義ID ODataV4GetSingle フロー定義名 標準 ODataV4GetSingle フローカテゴリID SampleCategory 「確認」ダイアログで「決定」ボタンをクリックします。
これでフロー定義の作成が終了です。
5.1.5.3. 動作確認¶
最後に動作確認を行います。 IM-LogicDesigner のデバッグ機能を使ってフローを実行し、OData サービスのデータが取得されることを確認します。
「ODataV4GetSingle」フローの「編集」アイコンをクリックします。
「ロジックフロー定義編集」画面の「デバッグ」リンクをクリックします。
「ロジックフロー定義のデバッグ」画面の「実行」リンクをクリックします。
「デバッグの実行」ダイアログが表示されるので、次のように入力し「実行」ボタンをクリックし、「確認」ダイアログで「決定」ボタンをクリックします。
ID 7 以下のログが出力されます。
[INFO] j.c.i.f.l.e.g.OutputLogTask - [] ID:7 Name:DVD Player Description:1080P Upconversion DVD Player ReleaseDate:2006-11-15 09:00:00.0 DiscontinuedDate: Rating:5 Price:35.88
ブラウザから「https://services.odata.org/Experimental/OData/(S(im_odata))/OData.svc/Products(7)」にアクセスします。
ブラウザに表示されるデータと、出力されたログの内容が一致することが確認できます。
5.1.6. エンティティの更新¶
次に、 エンティティを更新する IM-LogicDesigner のユーザ定義タスクを作成します。作成するのは「OData(V4)定義」です。
「メソッド」を「PUT」または「PATCH」として作成することで OData サービスのエンティティの更新を行うようにします。
コラム
「PUT」と「PATCH」はどちらもエンティティの更新を行いますが、「PUT」は入力プロパティの更新を行い、入力プロパティに与えられなかったプロパティは初期値に更新されます。これとは逆に「PATCH」では入力プロパティに与えられたプロパティの更新のみ行い、入力プロパティに与えられなかったプロパティは更新されません。
本チュートリアルでは「メソッド」に「PATCH」を指定してエンティティの更新を行います。
5.1.6.1. OData(V4)定義の作成¶
エンティティの登録の 1 から 5 までの手順を繰り返してください。
「メソッド」に「PATCH」を選択します。
「入力/返却値取得」の横にある「取得」ボタンをクリックします。
その他の項目は以下のように入力してください。
ユーザ定義ID ODataV4Patch ユーザ定義名 ODataV4Patch ユーザカテゴリID SampleCategory 「登録」ボタンをクリックします。
確認ダイアログで「OK」ボタンをクリックします。
これで「OData(V4)定義」の作成は終了です。
5.1.6.2. フロー定義の作成¶
続いてフロー定義の作成を行います。
「サイトマップ」→「LogicDesigner」→「フロー定義」を開きます。
「新規作成」リンクをクリックし、「ロジックフロー定義編集」画面を表示します。
ロジックフロー定義編集画面のデザイナに、先ほど作成した「ODataV4Patch」タスクを追加し、「開始」「終了」と接続します。
「入出力設定」リンクをクリックし、「入力」に次のような項目を追加し、「決定」ボタンをクリックします。
キー名 型 ID integer ReleaseDate sqltimestamp Rating short Price double 「ODataV4Patch」タスクをクリックし、「マッピング設定」ボタンをクリックし、次のように各項目を紐づけ、「決定」ボタンをクリックします。
「新規保存」リンクをクリックし、新規保存ダイアログを表示します。ダイアログに次のような内容を入力し「決定」ボタンをクリックします。
フロー定義ID ODataV4Patch フロー定義名 標準 ODataV4Patch フローカテゴリID SampleCategory 「確認」ダイアログで「決定」ボタンをクリックします。
これでフロー定義の作成が終了です。
5.1.6.3. 動作確認¶
最後に動作確認を行います。 IM-LogicDesigner のデバッグ機能を使ってフローを実行し、OData サービスのデータが更新されることを確認します。
「ODataV4Patch」フローの「編集」アイコンをクリックします。
「ロジックフロー定義編集」画面の「デバッグ」リンクをクリックします。
「ロジックフロー定義のデバッグ」画面の「実行」リンクをクリックします。
「デバッグの実行」ダイアログが表示されるので、次のように入力し「実行」ボタンをクリックし、「確認」ダイアログで「決定」ボタンをクリックします。
ID 3 ReleaseDate 2016-12-01T10:00:00Z Rating 100 Price 1000 これで、OData サービスのエンティティが更新されました。
本当に作成されたかどうかを確認します。
ブラウザから「https://services.odata.org/Experimental/OData/(S(im_odata))/OData.svc/Products(3)」にアクセスします。
フローのデバッグ画面で入力した値でエンティティが更新されていることを確認できます。
コラム
更新処理では、キープロパティを変更することはできません。コラム
入力データとして与えられた「ReleaseDate」「Rating」「Price」プロパティが更新され、入力データに与えられなかった「Name」、「Description」、「DiscontinuedDate」プロパティは更新されていないことが確認できます。メソッドに「PUT」を指定した場合、入力データとして与えられた「ReleaseDate」「Rating」「Price」プロパティは同様に更新されますが、入力データに与えられなかった「Name」、「Description」、「DiscontinuedDate」プロパティは初期値に更新されます。
5.1.7. エンティティの削除¶
最後に、エンティティを削除する IM-LogicDesignerのユーザ定義タスクを作成します。作成するのは「OData(V4)定義」です。
「メソッド」を「DELETE」として作成することで OData サービスのエンティティの削除を行うようにします。
5.1.7.1. OData(V4)定義の作成¶
エンティティの登録の 1 から 5 までの手順を繰り返してください。
「メソッド」に「DELETE」を選択します。
「入力/返却値取得」の横にある「取得」ボタンをクリックします。
その他の項目は以下のように入力してください。
ユーザ定義ID ODataV4Delete ユーザ定義名 ODataV4Delete ユーザカテゴリID SampleCategory 「登録」ボタンをクリックします。
確認ダイアログで「OK」ボタンをクリックします。
これで「OData(V4)定義」の作成は終了です。
5.1.7.2. フロー定義の作成¶
続いてフロー定義の作成を行います。
「サイトマップ」→「LogicDesigner」→「フロー定義」を開きます。
「新規作成」リンクをクリックし、「ロジックフロー定義編集」画面を表示します。
ロジックフロー定義編集画面のデザイナに、先ほど作成した「ODataV4Delete」タスクを追加し、「開始」「終了」と接続します。
「入出力設定」リンクをクリックし、「入力」に次のような項目を追加し、「決定」ボタンをクリックします。
キー名 型 ID integer 「ODataV4Delete」タスクをクリックし、「マッピング設定」ボタンをクリックし、次のように各項目を紐づけ、「決定」ボタンをクリックします。
「新規保存」リンクをクリックし、新規保存ダイアログを表示します。ダイアログに次のような内容を入力し「決定」ボタンをクリックします。
フロー定義ID ODataV4Delete フロー定義名 標準 ODataV4Delete フローカテゴリID SampleCategory 「確認」ダイアログで「決定」ボタンをクリックします。
これでフロー定義の作成が終了です。
5.1.7.3. 動作確認¶
最後に動作確認を行います。 IM-LogicDesigner のデバッグ機能を使ってフローを実行し、OData サービスのデータが削除されることを確認します。
「ODataV4Delete」フローの「編集」アイコンをクリックします。
「ロジックフロー定義編集」画面の「デバッグ」リンクをクリックします。
「ロジックフロー定義のデバッグ」画面の「実行」リンクをクリックします。
「デバッグの実行」ダイアログが表示されるので、次のように入力し「実行」ボタンをクリックし、「確認」ダイアログで「決定」ボタンをクリックします。
ID 10 ブラウザから「https://services.odata.org/Experimental/OData/(S(im_odata))/OData.svc/Products(10)」にアクセスします。
以下のように表示され、ID=10 のエンティティが削除され存在しないことが確認できます。
<m:error xmlns:m="http://docs.oasis-open.org/odata/ns/metadata"> <m:code/> <m:message>Resource not found for the segment 'Products'.</m:message> </m:error>
5.1.8. まとめ¶
以上で OData(V4) サービスのエンティティ操作のチュートリアルはすべて完了です。
これまでのチュートリアルを通して、以下のことを学びました。
- OData(V4) サービスのエンティティを操作する。
- 登録
- 参照
- 更新
- 削除