워크플로우

워크플로우는 이벤트 검색 프로세스를 설명하는 XML 문서입니다. 워크플로우는 워크플로우 XML에서 명시적으로 지정된 값이거나 워크플로우 매개변수 값 XML 문서에서 값을 파생할 수 있는 하나 이상의 매개변수를 정의합니다. 워크플로우는 순차적으로 실행되는 여러 조치로 구성됩니다. 워크플로우를 실행하면 매개변수 값이 상태에 추가되고 워크플로우가 실행될 때 조치를 통해 상태에 액세스하고 변경할 수 있습니다.

다음 표에는 워크플로우 속성이 표시되어 있습니다.

표 1. 워크플로우 속성
이름 설명 필수
이름 워크플로우의 이름.
설명 워크플로우에 대한 설명입니다. 아니오
버전 워크플로우의 버전입니다.
minimumRecurrence 워크플로우에 허용되는 최소 반복 시간 (초) 입니다. 요청 사이에 최소 시간이 있는 API에 대해 이 속성을 설정할 수 있습니다. 아니오

매개변수

워크플로우 조치 를 사용하여 매개변수 값에 액세스하십시오. 매개변수는 대부분 인증 신임 정보로 구성되지만 사용자가 구성할 모든 항목에 사용할 수 있습니다. 다음 표는 워크플로우 매개변수를 표시합니다.

표 2. 워크플로우 매개변수
이름 데이터 유형 설명
이름 문자열 매개변수의 이름 이름은 매개변수 값 XML의 해당 이름 값과 일치해야 합니다.
레이블 문자열 매개변수의 표시 이름입니다.
설명 문자열 매개변수에 대한 설명입니다.
필수 부울 매개변수가 필수인지 여부를 표시합니다.
시크릿(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>