GenericPollingScheduledTask

Runs the polling command repeatedly, completes a blocking manual task when polling is done.

javascript · Common Scripts

Details

IDGenericPollingScheduledTask
Languagejavascript
From Version5.0.0

README

Runs the polling command repeatedly, completes a blocking manual task when polling is done.

Script Data

Name Description
Script Type javascript
Cortex XSOAR Version 5.0.0

Inputs

Argument Name Description
ids List of IDs to poll
pendingIds IDs with pending status
pollingCommand Name of the polling command to run
pollingCommandArgName Name of the argument of the polling command
interval Polling frequency - how often the polling command should run (minutes)
timeout How much time to poll before declaring a timeout and resuming the playbook (minutes)
playbookId The ID of the playbook that contains the manual task which will be completed once the polling is done.
tag The tag of the blocking manual task (“Wait For Polling Task To Finish”)
additionalPollingCommandArgNames Names of additional arguments for the polling command (e.g. arg1,arg2,…)
additionalPollingCommandArgValues Commas separated arguments values of the polling command
scheduledEntryGuid The GUID of the scheduled entry that runs the polling command.
endTime The time to end the polling.

Outputs

There are no outputs for this script.

Source

GenericPollingScheduledTask.js GenericPollingScheduledTask.yml
Download History Raw 
commonfields:
  id: GenericPollingScheduledTask
  version: -1
name: GenericPollingScheduledTask
script: ''
type: javascript
tags: []
comment: Runs the polling command repeatedly, completes a blocking manual task when polling is done.
enabled: true
args:
- name: ids
  required: true
  description: List of IDs to poll.
  isArray: true
- name: pendingIds
  description: IDs with pending status.
- name: pollingCommand
  required: true
  description: Name of the polling command to run.
- name: pollingCommandArgName
  required: true
  description: Name of the argument of the polling command.
  defaultValue: ids
- name: interval
  required: true
  description: Polling frequency - how often the polling command should run (minutes).
- name: timeout
  required: true
  description: How much time to poll before declaring a timeout and resuming the playbook (minutes).
- name: playbookId
  description: The ID of the playbook that contains the manual task which will be completed once the polling is done.
- name: tag
  required: true
  description: The tag of the blocking manual task ("Wait For Polling Task To Finish").
  defaultValue: polling
- name: additionalPollingCommandArgNames
  description: Names of additional arguments for the polling command (e.g. arg1,arg2,...)
  isArray: true
- name: additionalPollingCommandArgValues
  description: Commas separated arguments values of the polling command.
  isArray: true
- name: scheduledEntryGuid
  description: The GUID of the scheduled entry that runs the polling command.
- name: endTime
  description: The time to end the polling.
- name: extractMode
  description: Extraction mode for subsequent runs of the command.
scripttarget: 0
tests:
- Generic Polling Test
fromversion: 5.0.0