Home > コンポーネント シリーズ > OData > OData - 設定 > OData - XML

OData - XML

 

ODataコネクタは、OData APIのページネーション機能と統合されており、データをチャンクでフェッチします。 ページ設定は、ODataリクエストの@ odata.nextLinkプロパティを使用してODataによってサポートされます。 ユーザーはリクエストごとに返されるページの最大数を指定し、@ odata.nextLinkをMagic xpiプロジェクトの変数にマップできます。 これらの値は、プロパティMax pagesおよびNext Page Linkをそれぞれ使用して、このリソースで構成できます。 どちらのプロパティもGET操作にのみ適用されます。

コネクタを設定するには、ステップをダブルクリックまたは右クリックし、コンテキストメニューから Configuration を選択して OData Configuration ダイアログボックスを開きます。

このダイアログボックスには以下のフィールドが含まれています。

プロパティ

説明

接続

リソース名

コネクタの[プロパティ]ペインで選択されたリソースの名前。リソースは、[設定]ダイアログボックスの[リソース]セクションで定義されます。

オペレーション

ヘッダ

オペレーションのヘッダ情報。

必要なヘッダ情報を入力する2つの方法があります。をクリックして、式エディタを開か、をクリックしてヘッダフォームを開きます。

エンティティ

をクリックしてエンティティセット選択リストを開きます。実行されるエンティティを選択してください。

メソッド

選択されたエンティティ上で実行されるメソッド。

ドロップダウンリストから以下のメソッドのどれかを選択してください。

  • Get

  • Put

  • Post

  • Delete

  • Patch

エンドポイントURL

ODataリソースURLと選択されたエンティティとパラメータ。このフィールドは、パークできますが編集はできません。

パラメータ

ODataクエリパラメータ。

必要なクエリに入力する2つの方法があります。をクリックして式エディタを開き手動でクエリに入力するか、をクリックしてODataクエリウィザードを開きます。クエリを作成するためにウィザードを使用した後、このプロパティの中で手動でクエリを変更することもできます。

[メソッド]パラメータ(上記)でGetを選択すると有効になります。

ページネーション

最大ページ数

ODataリクエストの一部として返されるページの最大数を定義します。

ユーザーが値を0として入力した場合、デフォルト値の50になります。

(Since version: 4.13)

Next Page Link

クリックして変数リストを開きます。 変数を選択して、ODataリクエストからの次のページのリンク値をマップします。

(Since version: 4.13)

エンドポイントとしてNextLinkを使用

ページネーションを使用すると、Next Page Link(上記)の変数にURLが入力され、次のページセットが取得されます。 次のODataステップでこれらのページのセットをフェッチするには、エンドポイントURLの代わりにNext Page Linkの値を使用する必要があります。

Next Page Linkの値をエンドポイントURLではなくODataエンドポイントとして設定するには、このチェックボックスをオンにします。

同じステップでNext Page Linkのセットをフェッチするには、ステップをループで実行します。

チェックボックスは、Next Page Linkの変数が選択されている場合にのみ有効になります。

(Since version:4.13)

出力

結果を保存

結果として生じるXMLファイルをどこに格納するかを定義します。ドロップダウンリストから、以下のどれかを選択してください。

  • Variable …… ODataによって返されるエンティティデータを格納する変数を選択してください。をクリックして変数リストを開きます。この情報が格納される変数(デフォルトはC.UserBlob)を選択してください。

  • File …… ODataによって返されるエンティティデータを格納するファイルを選択してください。 をクリックして式エディタを開きます。をクリックしてこの情報が格納されるファイルパスを入力してください。

処理成功

このフィールドは、データエンティティがODtaに正常に配置されたかどうかを容易に定義できます。ドロップダウンリストから以下のどれかを選択してください。

  • None: …… コネクタの成否のステータスを保存したくない場合、このオプションを選択してください。

  • Variable: …… をクリックして変数リストを開きます。コネクタの成否のステータスを格納したい変数を選択してください。

スキーマを更新

スキーマを更新]ボタンをクリックして、選択した OData エンティティのスキーマを作成します。スキーマは、リソースに生成された OData metadata.xml に基づいて生成されます。

スキーマがすでに存在する場合は、現在のスキーマが上書きされ、OData メタデータと同期されます。スキーマが存在しない場合は、OData リソースの metadata.xml に基づいてスキーマが作成されます。設定情報が保存され、選択したスキーマをデスティネーションとして Data Mapper ウィンドウが開きます。これは、Get オペレーション以外のすべてのオペレーションに適用されます。

OData アノテーション

データマッパースキーマは、エンティティレベルと行レベルのアノテーションを表示します。アノテーションはODataリソースで定義され、以下の画像に示すようにデータマッパーステップに反映されます。

 

エンティティレベルのアノテーションは、デフォルトとユーザー定義の両方で、最上位のエンティティ名要素の直接の子要素となるアノテーション要素の下で使用できます。

デフォルトおよびユーザー定義の両方の行レベルのアノテーションは、row要素の直接の子要素となるrowAnnotations要素の下で使用できます。 エンティティの各行で使用できます。

  • アップグレードまたはマイグレーションしたプロジェクトの場合、アノテーションを使用する前にスキーマを更新する必要があります。 スキーマが更新されると、リソースの新しいアノテーションがデータマッパーで使用できるようになります。

  • カウント要素のマッピングは、スキーマの更新後に壊れる可能性があり、再マッピングする必要があります。

詳細は、ODataリソースを参照してください。

(Since version:4.13)