Please enable JavaScript to view this site.

Process Designer

Navigation: PHP API > Work with Subtables

Clear a subtable (clearSubtable)

Scroll Prev Top Next More

This function allows deleting all rows of a subtable.

Parameter

Type

Description

$subtable

string

Subtable name

$deleteAttachedFiles

bool

Flag in order to set if the files attached to the subtable should also be deleted (optional), default value is false

 

Please note: The attachments are deleted, only when the function is called when sending the step (e.g. in rule execution functions).

The function does not return a response. In case of an error a JobRouterException is thrown.

Example:

$this->clearSubtable('INVOICEITEMS');

Please note: If you want to change subtable values within a form or step initialisation function, you have to call the save() method in addition to this function to write data into the sub-table during step processing.