パラメーター・メタデータ
自動化スクリプトに組み込まれたパラメーター・メタデータは、実装で必要な入力と出力を定義するために使用されます。
自動化スクリプトがアクション起動ポイントに関連付けられている場合、パラメーター・マッピングが起動ポイント変数内で指定され、再利用可能なアクションの開発が促進されます。このようなアクションは、さまざまなオブジェクト・コンテキスト (作業指示書やチケットなど) で使用できるように構成することができます。
メタデータには次の 3 タイプの情報が定義されます。
- 説明: アクションの実装の処理方法についての一般的な説明です。 この情報はアクション・アプリケーションでレンダリングされます。
- 入力パラメーター - アクションの実装によって使用される各入力パラメーターの特性を定義します。
- 出力パラメーター: 各出力パラメーターの特性を定義します。
入力パラメーターごとに以下がサポートされています。
| 属性 | 説明 |
|---|---|
| 名前 | 入力パラメーターの名前。 これは必須パラメーターです。 |
| 説明 | 入力パラメーターの説明を設定します。 これはオプション・パラメーターです。 |
| DefaultRelationship | パラメーター・マッピングの関係部分のデフォルト値を設定します。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「関係」フィールドが自動的に設定されます。 これはオプション・パラメーターです。 ユーザーは、アクション UI の「関係」フィールドの値を変更することを選択できます。 オーバーライド値が指定されている場合、このパラメーターは無視されます。 |
| DefaultAttribute | パラメーター・マッピングの属性部分のデフォルト値を設定します。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「属性」フィールドが自動的に設定されます。 これはオプション・パラメーターです。 ユーザーは、アクション UI の「属性」フィールドの値を変更することを選択できます。 オーバーライド値が指定されている場合、このパラメーターは無視されます。 |
| タイプ | (適切な「get」メソッドを使用した) データ・アクセス方法を定義します。 3 つのデータ・アクセス方法がサポートされています。 パラメーター・マッピングが定義されると、Type を使用してパラメーター・マッピングが適切に MBO 設定、単一の属性値、または属性値の配列を参照していることが検証されます。 Type が指定されていない場合、デフォルトは「Attribute」に設定されます。 配列を返す「get」メソッドを呼び出すには、Type を AttributeArray に設定がする必要があります。 以下の 3 つの値がサポートされています。
注: この値は、メタデータがアクションにインポートされるときに、「パラメーター」テーブルの「メソッド・タイプ」フィールドにデータを取り込むために使用されます。
|
| AttributeType | 戻される属性の予想されるデータ型を定義します (Type が Attribute または AttributeArray の場合に適用されます)。 AttributeType は、指定されたマッピングが、必要なタイプの属性を参照していることを検証するために使用されます。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「属性データ型」フィールドが自動的に設定されます。 有効な AttributeType の仕様は、以下の共通基盤がサポートするデータ型を反映しています。
注: これはオプション・パラメーターです。 ただし、Type が「Attribute」または「AttributeArray」として指定されている場合は必須オプションです。指定されると、アクションが保存されるときの検証時に適用されます。 例えば、メタデータが AttributeType="ALN" を指定し、マッピング・テーブルのデータ・マッピング属性に指定された属性の maxtype が「整数」のときは、例外がスローされ、アクションの保存時にエラーが表示されます。
|
| MBOType | パラメーター・マッピングの「関係」フィールドの最後の位置に定義される MBO のタイプを定義します。 例えば、MBOType="CI" の場合、以下のデータ・マッピングは有効または無効と見なされます。
注: これはオプション・パラメーターです。 ただし、指定されている場合、これはアクションが保存されるときの検証時に適用されます。 例えば、メタデータが MBOType="CI" を指定し、「関係」フィールドが MULTIASSETLOCCI.CI.ASSET であると、アクションの保存時に例外がスローされ、エラーが表示されます。
|
出力パラメーターごとに以下がサポートされています。
| 属性 | 説明 |
|---|---|
| 名前 | 出力パラメーターの名前。 これは必須パラメーターです。 |
| 説明 | 出力パラメーターの説明を設定します。 これはオプション・パラメーターです。 |
| DefaultRelationship | パラメーター・マッピングの関係部分のデフォルト値を設定します。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「関係」フィールドが自動的に設定されます。 これはオプション・パラメーターです。 ユーザーは、アクション UI の「関係」フィールドの値を変更することを選択できます。 |
| DefaultAttribute | パラメーター・マッピングの属性部分のデフォルト値を設定します。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「属性」フィールドが自動的に設定されます。 これはオプション・パラメーターです。 |
| AttributeType | 設定する属性値の予期されるデータ型が AttributeType に指定した値であることを定義します。 出力パラメーターについては、Type=Attribute のみがサポートされています (配列または MBO 設定の設定はサポートされていません)。 AttributeType は、指定されたパラメーター・マッピングが必要な型の属性を参照していることを検証するために使用されます。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「属性データ型」フィールドが自動的に設定されます。 有効な AttributeType は、共通基盤がサポートするデータ型を反映しています。
注: これは必須パラメーターです。 メタデータがアクションにインポートされると、この値を使用してパラメーター・テーブルの「属性データ型」フィールドが自動的に設定されます。
|
| MBOType | パラメーター・マッピングの「関係」フィールドの最後の位置に定義される MBO 設定のタイプを定義します。 例えば、MBOType=CI の場合、以下のデータ・マッピングは有効または無効と見なされます。
注: これはオプション・パラメーターです。 ただし、指定されている場合、これはアクションが保存されるときの検証時に適用されます。 例えば、メタデータが MBOType="CI" を指定し、「関係」フィールドが MULTIASSETLOCCI.CI.ASSET であると、アクションの保存時に例外がスローされ、エラーが表示されます。
|