Fluxo de trabalho
O Workflow é um documento XML que descreve o processo de recuperação de eventos. O Workflow define um ou mais parâmetros, que podem receber valores explicitamente no XML do Workflow ou podem derivar valores do documento XML Workflow Parameter Values. O Workflow consiste em diversas ações que são executadas sequencialmente. Ao executar o Workflow, os valores de parâmetro são adicionados ao Estado, e o Estado pode então ser acessado e alterado por ações conforme o Workflow executado.
A tabela a seguir mostra os atributos do Workflow.
| Nome | Descrição | Necessário |
|---|---|---|
| nome | O nome do Workflow. | Sim |
| descrição | A descrição do Workflow. | Não |
| versão | A versão do Workflow. | Sim |
| minimumRecurrence | A recorrência mínima permitida para um Workflow em segundos. É possível configurar esse atributo para as APIs que possuem uma quantia de tempo mínimo entre as solicitações. | Não |
Parâmetros
Use as ações do Workflow para acessar os valores do parâmetro. Os parâmetros consistem principalmente em credenciais de autenticação, mas podem ser usados para qualquer coisa que você deseje que o usuário configure. A tabela a seguir mostra os parâmetros do Workflow.
| Nome | Tipo de dados | Descrição |
|---|---|---|
| nome | Sequência | O nome do parameter. O nome deve corresponder ao valor de nome correspondente no XML de valores de parâmetro. |
| label | Sequência | O nome de exibição do parâmetro. |
| descrição | Sequência | A descrição do parâmetro. |
| requerido | Booleano | Indica se o parâmetro é obrigatório. |
| secret | Booleano | Indica se o parâmetro é confidencial, por exemplo, uma senha. |
| padrão | Sequência | O valor padrão do parâmetro. Se você não inserir um valor para este parâmetro no XML de valores de parâmetro, o valor padrão será usado. |
Exemplo de XML
Este exemplo mostra um exemplo de fluxo de trabalho que requer um host com um nome de usuário e senha, em que <x> é a versão do esquema do fluxo de trabalho que você está usando.
<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>