Shopify 要求 ノード

Shopify 要求 ノードは、 Shopify に接続し、顧客、在庫アイテム、オーダー、商品、およびトランザクションなどのオブジェクトに対してアクションを実行する要求を発行するために使用します。

Shopify Request ノードは、 WindowsAIX®、および Linux® システムで使用できます。

このトピックには、以下のセクションが含まれています。

目的

メッセージ・フロー内で Shopify Request ノードを使用すると、 Shopify に接続し、オブジェクトに対して以下のようなアクションを実行できます。
お客様の住所
アドレスの作成または取得
顧客
顧客の作成、取得、または更新
在庫品目
在庫品目の取得または更新
在庫レベル
在庫レベルの作成または取得
ロケーション
ロケーションの取得
Orders
オーダーの作成、取得、更新、または削除
製品
商品の作成、取得、または更新
トランザクション
トランザクションの取得

Shopify Request ノード操作は、同期および非トランザクションです。つまり、メッセージ・フローが失敗し、 Shopify Request ノードの後にロールバックした場合でも、データ・ソース上の操作は完了します。

Shopify ノードは、メッセージ・フロー・ノード・パレットの 「Shopify」 ドロワーに含まれており、 IBM® App Connect Enterprise Toolkit では次のアイコンによって表されます。
このイメージは、Shopify Request ノード・アイコンを示しています。

ターミナルおよびプロパティー

Shopify Request ノードのインスタンスをメッセージ・フローに入れると、それを構成することができます。 詳しくは、 メッセージ・フロー・ノードの構成を参照してください。 ノードのプロパティーは「プロパティー」ビューに表示されます。 値を入力する必要のある (デフォルト値を持たない) すべての必須プロパティーには、アスタリスクが表示されます。

Shopify Request ノードのターミナルについては、次の表に説明されています。

ターミナル 説明
In ノードが処理するメッセージを受け入れる入力ターミナル。 Shopify 要求 ノードは、In ターミナルに到着するメッセージによって駆動されます。
Out メッセージ・ツリーの伝搬元となる出力ターミナル。 出力メッセージ・ツリーには、 Shopify コネクターから返されるオブジェクトが含まれます。
データなし Shopify コネクターが正常に呼び出されても、アクションがデータを戻さない場合 (レコードが見つからないため)、メッセージは No Data ターミナルに送信されます。 アクションがデータを返さず、No Data ターミナルがワイヤリングされていない場合、例外がスローされます。
Failure Shopify Request ノードでエラーが発生した場合、メッセージは Failure ターミナルに送信されます。

以下の表は、ノード・プロパティーについて説明しています。 M の見出しの列は、プロパティーが必須 かどうかを示します (デフォルトが定義されていない場合に値を入力する必要がある場合、パネル上にアスタリスクのマークが付きます)。C の見出しの列は、プロパティーが構成可能 (メッセージ・フローを BAR ファイルに追加してデプロイするとき、値を変更できる) かどうかを示します。

Shopify 要求 ノードの 「説明」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明
ノード名 はい いいえ ノード・タイプ、 Shopify Request ノードの名前。
簡略説明 いいえ いいえ   ノードの簡単な説明
詳細説明 いいえ いいえ   メッセージ・フロー内のノードの目的を説明するテキスト。
Shopify Request ノード 「基本」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明
アクション はい いいえ   このプロパティーは、 Shopify Request ノードによって実行されるアクションを示します。 アクションは、「コネクター・ディスカバリー」ウィザードを使用して定義され、読み取り専用形式で Action プロパティーに表示されます。

「コネクター・ディスカバリーの起動」 をクリックして、 Shopify コネクターの「コネクター・ディスカバリー」ウィザードを開始し、必要なアクションを定義します。

オブジェクト はい いいえ   このプロパティーは、指定されたアクションが実行されるオブジェクトを示します。 オブジェクトは「コネクター・ディスカバリー」ウィザードで定義され、Object プロパティーに読み取り専用形式で表示されます。
スキーマ・ベース名 はい いいえ   Shopify コネクターとの間で送受信される、要求メッセージおよび応答メッセージの形式を記述するスキーマ・ファイルの名前。 スキーマ・ファイルは、 Mapping ノードでデータ値をマップするために使用できます。 スキーマを開くには、 「要求スキーマを開く」 または 「応答スキーマを開く」 ボタンをクリックします。

要求スキーマは、選択したアクションおよびオブジェクトが要求メッセージを必要とする場合にのみ生成されます。 選択したアクションのタイプが RETRIEVE または DELETEの場合は、応答スキーマのみがコネクターによって返されます。

コネクター・プロパティー いいえ いいえ   ディスカバリー中に Shopify コネクターに対して指定されたオブジェクトおよびアクションに応じて、 「コネクター・プロパティー」 セクションには、「コネクター・ディスカバリー」ウィザードでコネクターに対して設定されたプロパティーが表示されます。 ディスカバリー中にコネクター・プロパティーが設定されなかった場合、このセクションは「基本」タブに表示されません。
Shopify 要求 ノード 「接続」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明 mqsiapplybaroverride コマンド・プロパティー
ポリシー はい はい   このプロパティーは、接続に使用されるセキュリティー ID の詳細を含むポリシーの名前を指定します。 ポリシーのタイプは Shopify であり、ポリシー・プロジェクトで定義されます。 policyUrl
タイムアウト (秒) いいえ はい 60 このプロパティーは、ノードが Shopify による操作の処理を待機する時間 (秒単位) を指定します。 デフォルトは 60 秒です。 timeout
Shopify Request ノードの 「フィルター」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明
フィルター・オプション いいえ はい 「フィルター・オプション」 セクションのプロパティーは、 Shopify Request ノードの実行時に操作対象となるオブジェクトを制御します。 フィルター・オプションは、ディスカバリー中に「コネクター・ディスカバリー」ウィザードで定義されますが、後でノードの「フィルター」タブの 「編集」 ボタンを使用して値を変更することができます。 コネクターのディスカバリー中にフィルター条件が設定されなかった場合、タブの 「フィルター・オプション」 セクションにプロパティーは表示されません。

プロパティー値は、テキスト値か、実行時に Shopify Request ノードに渡されるメッセージの内容から解決される ESQL または XPATH 式のいずれかです。

取得する項目の最大数 いいえ はい 15 「取得する項目の最大数」 プロパティーは、 Shopify コネクターから取得できる項目の最大数を指定します。 このプロパティーは、 Retrieve アクションにのみ適用されます。

このプロパティーは、ディスカバリー中に「コネクター・ディスカバリー」ウィザードで定義されますが、後で 「Shopify 要求」 ノードの 「フィルター制限」 セクションで値を変更することができます。 コネクターのディスカバリー中に「コネクターのディスカバリー」ウィザードでフィルター条件が設定されなかった場合、このプロパティーはノードの「フィルター」タブに表示されません。

制限を超えた場合 いいえ     「制限を超えた場合」 プロパティーは、コネクターから取得される項目の数が指定された最大数を超えた場合に実行されるアクションを指定します。 このプロパティーは、 Retrieve アクションにのみ適用されます。
以下のアクションのいずれかを選択できます。
  • エラーの報告
  • 取得する項目の最大数 プロパティーで設定されている、コレクションからの項目の最大数を処理します。

このプロパティーは、ディスカバリー中に「コネクター・ディスカバリー」ウィザードで定義されますが、後で 「Shopify 要求」 ノードの 「フィルター制限」 セクションで値を変更することができます。 コネクターのディスカバリー中に「コネクターのディスカバリー」ウィザードでフィルター条件が設定されなかった場合、このプロパティーはノードの「フィルター」タブに表示されません。

Shopify Request ノードの 「要求」 プロパティーについては、次の表に説明されています。

プロパティー M C デフォルト 説明
要求モード いいえ いいえ なし このプロパティーは、選択されたアクション (コネクターのディスカバリー時に指定される) が実行されたときにコネクターに送信されるメッセージを決定します。 「要求モード」 は、コネクター・ディスカバリー中に「コネクター・ディスカバリー」ウィザードを使用して設定されます。 このプロパティーを編集する場合は、ノード・プロパティー・エディターで 「コネクター・ディスカバリーの起動」 をクリックして、「コネクター・ディスカバリー」ウィザードを開始します。
このプロパティーは、以下のいずれかの値に設定できます。
入力のマップの使用
この値を選択すると、コネクターは、 「入力のマップ」 表に記述されている場所から入力データを取得し、コネクター・ディスカバリー中に定義されたマッピング・ロジックを適用します。
データ・ロケーションの使用
この値を選択すると、コネクターはマッピング・ロジックを適用せずに、 「データの場所」 フィールドで定義された単一の場所から入力データを取得します。 この入力データにはマッピング・ロジックが適用されないため、コネクターの要求スキーマと一致する必要があります。
入力のマッピング いいえ いいえ   「入力のマップ」 表は、コネクターに送信するメッセージを作成するときに使用できる入力を定義するため、およびフィルターを必要とする操作のフィルター値を定義するために使用されます。
入力のマップ 」表のエントリーは、メッセージ・アセンブリーの特定の部分と、それらを定義するスキーマを記述します。
  • 「入力名」 は、「入力のマップ」テーブル内の行の固有の名前です。
  • 「入力ロケーション」 は、メッセージ・アセンブリー内のロケーションを指定します。
  • 「メッセージ・ドメイン」 は、入力ロケーションのパーサーを指定します。
  • 「スキーマ・ロケーション」 は、入力ロケーションにあるメッセージを記述する JSON スキーマを指定します。
  • 「スキーマ・ルート」 は、メッセージ構造を記述するスキーマ・ファイル内の場所を指定します。 これは、JSON スキーマがスキーマ文書のルートにない場合にのみ必要です。

デフォルトでは、この表には、汎用入力メッセージおよびローカル環境ツリーの構造化部分を記述するデータが含まれています。

「入力のマップ」 テーブルにエントリーを追加して、関連付けられた JSON スキーマによって記述されるメッセージ・アセンブリー内のメッセージの場所を指定できます。 このノードの入力ターミナルに到着する JSON メッセージの構造を定義する先行メッセージ・フロー・ノードがある場合、スキーマが配置され、使用可能なオプションとして推奨されます。

JSONata マッピングの使用について詳しくは、 ディスカバリー・コネクター要求ノードのマッピングの構成 および JSONata マッピングの例を参照してください。

データのロケーション はい いいえ $Body このプロパティーは、要求ノードから送信される要求を形成するためにデータが取得される、着信メッセージ・ツリー内の場所を指定します。 デフォルト値の $Body は、着信メッセージ本体を表します。 直列化して 送信するために、メッセージ・ツリーのロケーションを定義する、任意の XPath または ESQL 式を入力できます。

このプロパティーは、 「要求モード」 プロパティーが 「データ・ロケーションの使用」に設定されている場合にのみ適用されます。

Shopify 要求 ノードの 「結果」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明
結果データのロケーション はい いいえ $ResultRoot このプロパティーは、出力メッセージの Output data location フィールドにコピーされるメッセージ内の場所を指定します。

例えば、 $ResultRoot (デフォルト) は、結果メッセージを出力ツリーの Output data location プロパティーで指定された場所に挿入します。

詳しくは、 外部システムからデータをフェッチする際の結果メッセージと入力メッセージの組み合わせを参照してください。

出力データのロケーション はい いいえ $OutputRoot このプロパティーは、 Shopify Request ノードが出力を送信する先のメッセージ・ツリー・ロケーションを指定します。 コピーされるメッセージの部分は、 Result data location プロパティーによって指定されます。 デフォルト値は、取り出されたメッセージが出力メッセージのルートにコピーされることを指定します。

外部システムからデータをフェッチする際の結果メッセージと入力メッセージの結合を参照してください。

ローカル環境のコピー いいえ いいえ 選択されている このプロパティーは、着信ローカル環境をコピーするか、着信ローカル環境を伝搬するかを制御します。 デフォルトでは、このチェック・ボックスは選択されています。つまり、着信ローカル環境が保持されるように、ローカル環境がコピーされることを意味します。 ローカル環境への追加は、このノードのダウンストリームのノードにおいてのみ可視となります。 このチェック・ボックスがクリアされると、着信ローカル環境は、出力メッセージに使用されます。 このノードによって行われたローカル環境に対する変更は、このノードが完了した後に、ダウンストリームとアップストリームの両方のノードで可視となります。
Shopify Request ノードの 「応答メッセージの構文解析」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明
メッセージ・ドメイン はい いいえ JSON 応答メッセージの構文解析に使用されるドメイン。 デフォルトで、伝搬されるメッセージは JSON ドメイン内にあります。 別のドメインを指定することはできません。
メッセージ・モデル いいえ いいえ   着信メッセージが定義されるメッセージ・モデル・スキーマ・ファイルの名前または場所。 このプロパティーを設定することはできません。
メッセージ いいえ いいえ   応答メッセージの名前。 ノードはメッセージ・タイプを自動的に検出します。このプロパティーを設定することはできません。
物理形式 いいえ いいえ   応答メッセージの物理形式の名前。 このプロパティーを設定することはできません。

Shopify 要求 ノードの 「妥当性検査」 プロパティーについては、次の表に説明されています。

プロパティー M C デフォルト 説明 mqsiapplybaroverride コマンド・プロパティー
妥当性検査 いいえ はい 内容と値 このプロパティーは、コネクターのディスカバリー中に検出され、デフォルトで有効になっている要求スキーマに対して要求メッセージを検証するかどうかを制御します。 このプロパティーを以下の値のうちの 1 つに設定することができます。
なし
要求メッセージの検証をオフにします。
内容と値
ディスカバーされた要求スキーマに照らして要求メッセージを検証します。 コンテンツ・チェックにはコンテンツの検証と構成が含まれ、値チェックには値がデータ・タイプ、長さ、範囲、および列挙に準拠しているかどうかのチェックが含まれます。 このオプションはデフォルトで設定されます。
継承
入力メッセージ・ツリーで提供されている妥当性検査設定を、ノードで提供されているものよりも優先して使用します。 そのため、 「継承」「なし」 または 「コンテンツと値」に解決されます。 「継承」 が選択されている場合、タブ上の他の検証プロパティーは使用できません。
validateRequestマスター
失敗時の処置 いいえ いいえ 例外リスト このプロパティーは、検証の失敗時に実行されるアクションを制御します。 以下のいずれかの値に設定できます。
例外
最初の妥当性検査の失敗で例外がスローされます。 メッセージ・フローのユーザー・トレースを要求している場合は、失敗のユーザー・トレースへの記録も行われ、妥当性検査が停止します。 失敗の発生時にただちにメッセージの処理を停止したい場合は、この設定を使用します。
例外リスト
現在の構文解析または書き込み操作が完了したときに妥当性検査が失敗すると、例外がスローされます。 メッセージ・フローのユーザー・トレースを要求している場合は、各失敗のユーザー・トレースへの記録も行われ、妥当性検査が停止します。 妥当性検査が失敗したときにメッセージの処理を停止したい場合、しかし発生した失敗のリストをすべて見たい場合にこの設定を使用します。 このオプションはデフォルトで設定されます。
ユーザー・トレース
メッセージ・フローのユーザー・トレースを要求しなかった場合でも、検証の失敗はすべてユーザー・トレースに記録されます。 この設定は、妥当性検査の失敗に関係なくメッセージの処理を続行する場合に使用します (可能な場合)。
ローカル・エラー・ログ
すべての検証の失敗は、エラー・ログ (例えば、Windows 上のイベント・ログ) に記録されます。 この設定は、妥当性検査の失敗に関係なくメッセージの処理を続行する場合に使用します (可能な場合)。
 
応答検証オプション いいえ いいえ 応答メッセージの妥当性検査は、このノードによって制御されません。 ディスカバリー・コネクターは応答メッセージを作成し、スキーマに一致する有効なメッセージを生成します。  
Shopify Request ノードの 「モニター」 プロパティーについては、次の表に説明されています。
プロパティー M C デフォルト 説明
イベント いいえ いいえ なし ノードに対して定義したイベントが、このタブに表示されます。 デフォルトでは、メッセージ・フローのどのノードにもモニター・イベントが定義されません。 「追加」「編集」、および 「削除」 を使用して、ノードのモニター・イベントを作成、変更、または削除します。詳しくは、 モニター・プロパティーを使用したモニター・イベント・ソースの構成 を参照してください。

「使用可能」チェック・ボックスを選択またはクリアすることによって、ここに表示されているイベントを使用可能および使用不可に設定できます。