XML Manager

: 特定のデバイスに存在する機能のみを表示するには、下の SmartDocs バーから 1 つまたは複数のフィルタを選択します。

言語に関する注: 入力フィールドには、英語のみを入力できます。

StageNow - 5.3

概要

XML Manager (XmlMgr) は、リクエスト XML ドキュメントの処理時のエラーを処理するために MX 管理システム (MXMS) で使用する処理モードを指定します。MXMS では、CSP で定義されている機能を 1 つまたは複数含むリクエスト XML ドキュメントを処理します。各機能は、CSP の機能と一致するタイプのリクエスト XML ドキュメント内の最上位の characteristic タグで表されます。たとえば、XML 内の「XmlMgr」という CSP の機能の最初の部分は次のようになります。


<characteristic type="XmlMgr" ...

MXMS は、対応する CSP に、リクエスト XML ドキュメントに記載されている順序で機能を渡すことで、その機能を実行します。CSP によって機能が実行されると、CSP から結果 XML のドキュメントが返されます。機能が正常に実行されると、CSP から characteristic タグが返されます。失敗すると、characteristic-error タグが返されます。MXMS は、最終的な結果 XML を作成する際の機能の実行順に、CSP から返された結果 XML を集計します。

優先順位の処理

XmlMgr では、リクエスト XML ドキュメントの処理時に使用する処理モードを選択できます。リクエスト XML ドキュメントに XmlMgr 機能が存在しない場合、ドキュメント全体がデフォルトの処理モード ([最後まですべて実行]) を使用して処理されます。XmlMgr 機能が存在する場合は、リクエスト XML ドキュメント内で後続の機能を実行する際に、次の XmlMgr 機能がモードを変更するまで、またはリクエスト XML ドキュメントの最後に到達するまで、その XmlMgr 機能で指定された処理モードが MXMS で使用されます。XmlMgr の処理モードについて、以下で説明します。

最後まですべて実行

このモード (デフォルト) では、MXMS はリクエスト XML ドキュメント内のすべての機能を、成功か失敗かに関係なく XML の最後に到達するまで実行しようとします。結果 XML は、実行を試行した順に、成功と失敗すべての結果を返します。結果 XML には、リクエスト XML ドキュメント内にあるものと同じ数の characteristic タグと、characteristic-error タグ (あれば) が含まれています。

ほとんどの状況では一般的にこのデフォルト モードが適切と考えられますが、一連の機能がいずれか 1 つの機能の成功に依存する場合は "ドミノ効果" が発生することがあります。解決策として、XmlMgr では、次に説明する [エラーまで実行して停止] という処理モードを提供しています。

エラーまで実行して停止

MXMS は、機能が正常に機能している限り、リクエスト XML ドキュメント内の機能を表示順に実行しようとします。最初に障害が発生すると実行が停止し、それ以降の機能は無視されます。このモードでは、正常に実行された機能の characteristic タグおよび停止の原因となった characteristic-error タグを含む結果 XML が返されます。このモードでは、後続の機能がそれ以前の機能に依存している場合の "ドミノ効果" が回避されます。

エラーまで試行し、キャッチまでスキップ

このモードを使用すると、問題のある箇所をスキップできます。MXMS は、機能が正常に機能している限り、リクエスト XML ドキュメント内の機能を表示順に実行しようとします。最初に機能の実行が失敗すると、MXMS はそこから機能をスキップします。[エラーをキャッチし、残りを実行] の XmlMgr 機能に遭遇するか、リクエスト XML ドキュメントの最後に到達すると、スキップを終了します。「キャッチ」に到達すると、MXMS は処理モードが [最後まですべて実行] に設定されている場合と同様に、後続の機能の実行を続行します。結果 XML は、機能の実行を試行した順に、すべての成功と最初の失敗の結果を返します。

エラーをキャッチし、残りを実行

先述の「キャッチ」のポイントの位置を示します。

成功/失敗

実行できた機能はすべて成功と見なされ、実行できなかった機能は失敗と見なされます。エラーは、有効な処理モードに基づいて、MXMS によって処理されます。新しいリクエスト XML ドキュメントが処理されるたびに、そのドキュメントの先頭でデフォルトのモード ([最後まですべて実行]) が常に有効になります。処理モードはデフォルトのままにしておくことも、1 つのリクエスト XML ドキュメント内で 1 回または複数回変更することも可能です。

主な機能

  • 以下のうちから、後続のリクエスト XML の機能の [XML 処理モード] を選択します。
    • すべての機能の実行を試行し、すべての成功と失敗を報告する (デフォルト)
    • 最初のエラーまで実行して停止し、すべての成功と失敗を報告する
    • 最初のエラーまで実行し、次の「キャッチ」または最後までスキップする
    • スキップを停止して機能の実行を再開する

XML 処理モード

リクエスト XML ドキュメントの処理中に発生したエラーを処理するために MXMS が使用する処理モードを入力する際に使用します。詳細については、「概要」セクションを参照してください。

パラメータ名: ProcessingMode

オプション 名前 説明注記 要件
1 最後まですべて実行 各機能の成功または失敗に関係なく、リクエスト XML ドキュメント内のすべての機能を実行するように MXMS を設定します (デフォルトのモード)。

MX: 4.2+

2 エラーまで実行して停止 リクエスト XML ドキュメント内の機能を実行して最初の失敗時に停止するように、MXMS を設定します。

MX: 4.2+

3 エラーまで試行し、キャッチまでスキップ リクエスト XML ドキュメント内の機能を実行して最初の失敗時に停止し、そこから機能をスキップして [エラーをキャッチし、残りを実行] の XmlMgr 機能が検出された時点で実行を再開するか、リクエスト XML ドキュメントの最後に到達したら終了するように、MXMS を設定します。

MX: 4.2+

4 エラーをキャッチし、残りを実行 先述の「キャッチ」のポイントの位置を示します。

MX: 4.2+