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 |
|---|---|---|---|---|
|
string (multi-line) |
yes |
– |
Application unique name to reference this step from Example: |
|
string |
yes |
– |
Name of the step to reference for performing this step Example: |
|
array of strings |
no |
|
What steps should receive this steps data Example: |
|
array of strings |
no |
|
If this step should read data from another step, it can be beneficial to list is explicitly Example: |
|
number |
no |
|
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: |
|
number |
no |
|
the max retries for the step Example: |
|
BoolParameter |
no |
|
Introduce a backoff for the retry countdown. Read the documentation before enabling this. Example: |
|
BoolParameter |
no |
|
Introduce a jitter (time randomization) for the retry countdown. Read the documentation before enabling this Example: |
|
number |
no |
|
Introduce max backoff in seconds between retries. Read the documentation before changing this default value(600s). |
|
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.