Platform parameters

These are registered by the platform’s BaseStep, so every step in every SyncPack accepts them in addition to its own parameters. They are listed here once rather than repeated on each step page.

Name

Type

Required

Default

Description

name

string (multi-line)

yes

–

Application unique name to reference this step from Example: QueryDevices

file

string

yes

–

Name of the step to reference for performing this step Example: ExecuteREST

output_to

array of strings

no

[]

What steps should receive this steps data Example: ['stepA', 'stepB']

data_from

array of strings

no

[]

If this step should read data from another step, it can be beneficial to list is explicitly Example: ['stepC']

retry_countdown

number

no

180

The time between retry in seconds. This default value(180s) must NOT be changed without having a clear understanding of how the retries work. Example: 60

retry_max

number

no

0

the max retries for the step Example: 5

retry_backoff

BoolParameter

no

False

Introduce a backoff for the retry countdown. Read the documentation before enabling this. Example: True

retry_jitter

BoolParameter

no

False

Introduce a jitter (time randomization) for the retry countdown. Read the documentation before enabling this Example: True

retry_backoff_max

number

no

600

Introduce max backoff in seconds between retries. Read the documentation before changing this default value(600s).

queue

string

no

–

Queue in which this step will be executed

The retry_* parameters are the reason a step’s own documentation does not describe retry behaviour: retries are handled by the platform, not by the step. HTTPBaseStep.execute_request() reads retry_max from here.