forceFail

Causes playbook execution to fail if the specified column is non-empty in any row. This operator is useful if a playbook is centered around an integration and you want the entire playbook to fail if the integration fails. You can include a column in the results table for any error messages from the integration execution and then cause the playbook to fail immediately if the error message column isn't empty.

Operator Usage in Easy Mode

  1. Click + on the parent node.
  2. Enter the Force Fail operator in the search field and select the operator from the Results to open the operator form.
  3. In the Table drop-down, enter or select a table to apply this operator.
  4. In the Column field, select a column in the table. The drop-down lists the items based on the input table selected.
  5. Click Run to view the result.
  6. Click Cancel to discard the operator form.
  7. Click Submit to add the operator to the playbook.
forceFail(table: TableReference, column: ColumnReference)

Input Parameters:

TableReference: The table to which the operator applies.
ColumnReference: A column in the table.

Output Table:
Returns the input table if the column is empty in all rows, otherwise returns an error.

Example

Input
table = _Start_Child1
column =_Error

Event

Error

Event1

Event2

Problem executing this event.

Event3

forceFail(table: Start_Child1, column: Error)

Output
No output, playbook fails.


Did this page help you?