<paramList> 要素

<paramList> 要素は、<executionPlan> 要素のオプションの子です。この要素は、プラン内に含まれるステップおよびそれらのステップが参照するコンポーネントが使用するパラメタのリストを宣言するために使用されます。この要素を指定する場合、この要素は 1 回しか出現できません。

このプランが最上位のプランとして実行される場合、呼び出し側はこのリストで宣言された全パラメータの値を入力するように求められます。このプランがほかのプラン内で <execSubplan> ステップの結果として呼び出される場合、呼び出し側のプランは、デフォルト値を持たない <paramList> で宣言されたすべてのパラメタの値を明示的に渡す必要があります。

<paramList> 要素には 1 つの必須子要素 <param> があり、これはプランパラメータの宣言です。この宣言には、名前、プロンプト、デフォルト値が含まれます。宣言する必要があるパラメータごとに、1 つの <param> 要素を指定できます。

<param> 要素

<param> 要素はプラン <paramList> 要素の子であり、プラン内で使用するパラメタの宣言に使用されます。

<param> 要素の属性

<param> 要素には次の属性があります。

• name – identifier 型の必須属性で、プランパラメタの名前です。この名前は、最上位のすべてのプランパラメータおよびプラン変数にわたって一意でなければなりません。

• prompt – 文字列のオプション属性で、パラメタの値を入力するよう求める際のユーザーインタフェースで表示されます。この属性を指定しないと、name の値が使用されます。

• default – 文字列のオプション属性で、パラメタのデフォルト値。このデフォルト値は、セッション変数への参照を含むことはできません。

• displayMode – オプション属性で、パラメタの表示モードを指定します。次の有効な値が使用できます。

  • PASSWORD – ユーザー指定の値が隠されます。つまりパスワードは表示されないか、アスタリスクに置き換えられます。

  • BOOLEAN – チェックボックスを使用してパラメタが指定されます。

  • CLEAR – 入力時に値が表示されます。

  値が CLEAR または BOOLEAN である場合、入力時に安全に表示されます。この属性を指定しないと、値は CLEAR になります。