ワークフロー
ワークフローは、イベント取得プロセスを記述する XML 文書です。 ワークフローは 1 つ以上のパラメーターを定義します。パラメーターには、ワークフロー XML で値を明示的に割り当てることも、ワークフロー・パラメーター値 XML 文書から値を派生させることもできます。 ワークフローは、順次実行される複数のアクションで構成されます。 ワークフローを実行すると、パラメーター値が 「状態」に追加され、ワークフローの実行時にアクションによって状態にアクセスして変更できるようになります。
以下の表に、ワークフローの属性を示します。
| 名前 | 説明 | 必須 |
|---|---|---|
| 名前 | ワークフローの名前。 | はい |
| 説明 | ワークフローの説明。 | いいえ |
| バージョン | ワークフローのバージョン。 | はい |
| minimumRecurrence | ワークフローで許可される最小繰り返し間隔 (秒)。 要求間の最小時間間隔が設定される API に対してこの属性を設定できます。 | いいえ |
パラメーター
パラメーター値にアクセスするには、ワークフローの アクション を使用します。 パラメーターはほとんど、認証資格情報で構成されていますが、ユーザーが構成する必要がある任意の項目で使用できます。 以下の表に、ワークフローのパラメーターを示します。
| 名前 | データ・タイプ | 説明 |
|---|---|---|
| 名前 | ストリング | パラメーターの名前。 この名前は、パラメーター値 XML の対応する名前の値と一致している必要があります。 |
| label | ストリング | パラメーターの表示名。 |
| 説明 | ストリング | パラメーターの説明。 |
| 必須 | ブール値 | パラメーターが必須かどうかを示します。 |
| secret | ブール値 | パラメーターが機密情報であるかどうかを示します (例えば、パスワードなど)。 |
| デフォルト | ストリング | パラメーターのデフォルト値。 パラメーター値 XML でこのパラメーターの値を入力しなかった場合は、デフォルト値が使用されます。 |
XML の例
この例は、ユーザー名とパスワードを持つホストを必要とするワークフローの例を示しています。ここで、 <x> は、使用しているワークフロー・スキーマのバージョンです。
<Workflow name="Test" version="1.0" xmlns="http://qradar.ibm.com/UniversalCloudRESTAPI/Workflow/V<x>">
<Parameters>
<Parameter name="host" label="Host" required="true" />
<Parameter name="username" label="Username" required="true" />
<Parameter name="password" label="Password" required="true" />
</Parameters>
<Actions>
...
</Actions>
</Workflow>