Bots From Extension: control

Control Bots

This extension provides 7 bots.

---

Bot @c:bookmark-loop

Bot Position In Pipeline: Block

Start a looping block that reads a specified bookmark name (bookmark must be saved as part of the loop block)

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
name	Text		Name of the block
bookmark*	Text		Name of the bookmark to load. Value will be set to variable 'bookmark'
initial_value*	Text		If the bookmark is not already saved, use this initial value
stop_after	Text		If specified, will stop after specified number of seconds have elapsed
max_iterations	Text		If specified, will stop specified number of iterations have occured.

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

Example Pipelines Using this Bot

• ebonding-servicenow-to-stream-v2

---

Bot @c:count-loop

Bot Position In Pipeline: Block

Start a looping block that counts from 'start' to 'end' with 'increment' numerical values

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
name	Text		Name of the block
start	Text	0	Starting count (default 0). variable 'loop_index' will start with this value
end*	Text		Ending count. loop will stop when the 'loop_index' is 1 less than end value
increment	Text	1	Increment count, must be a postive integer >= 1

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

Example Usage

@c:count-loop start = 0 & end = 10 & increment = 1
    --> @dm:empty
    --> @dm:addrow message = "This is row number ${loop_index}"
    --> @dm:save name = "temp-df-${loop_index}"

--> @c:new-block  (2)
    --> @dm:concat names = "temp-df-.*" 

    -> #dm:query-persistent-stream *

---

Bot @c:data-loop

Bot Position In Pipeline: Block

Start a looping block using 'dataset' name of the saved dataset, and unique values from 'columns'

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
name	Text		Name of the block
columns*	Text		Comma separated list of columns in saved dataset
dataset*	Text		Name of the saved dataset to load
return_empty	Text	no	Return an empty dataframe if an error occurs loading the dataset

---

Bot @c:flex-block

Bot Position In Pipeline: Block

Start a new flexible block within the pipeline. Flexible blocks do not enforce Source and Sink rules.

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
isTemplate	Text	yes	If set to 'yes', rest of the workflow will be a template
name	Text		Name of the block

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

---

Bot @c:new-block

Bot Position In Pipeline: Block

Start a new block within the pipeline

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
isTemplate	Text	yes	If set to 'yes', rest of the workflow will be a template
name	Text		Name of the block

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

Example Pipelines Using this Bot

• aws-dependency-mapper-inner-pipeline
• dli-generate-synthetic-syslogs
• dli-process-synthetic-syslogs
• li-stream-tcp-syslogs
• sample-ecommerce-analytics
• sample-incident-analytics
• sample-incident-clustering
• sample-ml-classification-prediction
• sample-vm-analytics
• sample-vrops-alert-analytics

---

Bot @c:simple-loop

Bot Position In Pipeline: Block

Start a simple looping block using 'loop_var' as list of values

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
name	Text		Name of the block
loop_var*	Text		Comma separated list of values to iterate during the loop

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

---

Bot @c:timed-loop

Bot Position In Pipeline: Block

Start a looping block that waits 'interval' seconds between each iteration

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name	Type	Default Value	Description
name	Text		Name of the block
interval*	Text		Wait interval in seconds between each loop iteration. Time to execute one iteration will be deducted from the interval.
stop_after	Text		If specified, will stop after specified number of seconds have elapsed
max_iterations	Text		If specified, will stop specified number of iterations have occured.

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

Example Pipelines Using this Bot

• aws-dependency-mapper
• dli-generate-synthetic-syslogs