Configure pipeline commands
- Last UpdatedAug 25, 2026
- 2 minute read
Subsequent sections list configuration specific to individual commands.
Most command parameters are set by data expressions and expect to return a certain result, for example, IExpression<bool> must evaluate to a true or false result.
The following table lists the general command parameters:
|
Parameter |
Value |
Phase |
Description |
|---|---|---|---|
|
Name |
String |
Begin |
[SettingOptional] The name of the command, which will be used in logging output. A random name will be selected if this is unspecified. |
|
Template |
String |
Begin |
[SettingOptional] A template to inherit settings from. |
|
Description |
IExpressi on <string> |
Begin |
[SettingOptional] A description for the command, currently unused by the application. |
|
Buffer-Size |
IExpressi on <uint> |
Begin |
This setting is defaulted by the application. It is recommended not to override this setting and let the application decide. |
|
Output-limit |
IExpressi on <int> |
Begin |
[SettingOptional] If set to a positive number, the command will stop when the limit is reached, otherwise, there is no limit. |
|
Apply-Where |
IExpressi on <bool> |
Execute |
[SettingOptional] Not applicable to Read and Branch commands. If specified, the condition must be met for the command to execute. If the rule may be successfully evaluated in the Begin phase, the rule will activate or deactivate the command for the lifecycle of the pipeline, otherwise this will be evaluated in the Execute phase per record. |
|
Pin |
PinConfig |
Execute |
[SettingOptional] If set, specifies metadata to pin to each output record. |
The following table lists the details about Command PinConfig parameters:
|
Parameter |
Value |
Phase |
Description |
|---|---|---|---|
|
Metadata |
Metadata[] |
Execute |
[SettingOptional] 0-n Metadata as described below. |
The following table lists the details about Command PinConfig Metadata parameters:
|
Parameter |
Value |
Phase |
Description |
|---|---|---|---|
|
Name |
IExpression<string> |
Begin |
[SettingRequired] |
|
Value |
IExpression<string> |
Begin |
[SettingRequired] |
General command configuration
Example:
<read name="Capture_Files" apply-where="{{ $[capture-files].isTrue }}">
<file folder="{{ $filepath }}" file="{{ $filename }}">
<excel />
<pin>
<metadata name="#file-name" value="{{ $[file.name] }}" />
<metadata name="#file-index" value="{{ $index }}" />
</pin>
</file>
</read>