Delete
The Delete activity deletes a row from a datagrid table. Before using the Delete activity, you must first create a row object and set a value in all fields of the primary key. The value of the key is unique. If the table contains a row with that key value, then the Delete activity deletes that row from the table. If the table does not contain a row with that key value, then the activity returns without changing the table.
General
In the Delete tab, you can specify the activity name and a table connection.
The following table describes the fields in the General tab of the Delete activity:
| Field | Module Property? | Description |
|---|---|---|
| Name | No | Specifies the name to be displayed as the label for the activity in the process. |
| Table Connection | Yes | Click
If the datagrid for the required table connection is not found, in the Select FireflyResource Resource Template dialog box that opens, click Create Shared Resource to create a datagrid connection first. See Creating a DataGrid and Adding a Table for details. |
| Timeout (sec) | No | Specifies the timeout value for the activity. The value specified here overrides the ActiveMatrix BusinessWorks™ default timeout value. |
Description
In the Description tab, you can enter a short description for the Delete activity.
Advanced
In the Advanced tab, you can provide advanced settings for the Delete activity.
The following table describes the fields in the Advanced tab of the Delete activity:
| Field | Module Property? | Description |
|---|---|---|
| Batch Delete Operation | No | Specifies if you want to execute delete operations as a batch. |
| Operations Per Batch | No | Specifies the number of rows to be processed as a batch. |
| Generate Delete Output | No | Specifies the output schema and also indicates if there was an error in the ResultList of the Output tab. By default, the check box for this field is not selected. |
| Override Transaction Behavior | No | Specifies whether to override the existing transaction behavior for a local transaction. |
Input
In the Input tab, you can specify the rows with the key values to be deleted.
Output
In the Output tab, you can view the rows that are deleted.
The following table describes the fields in the Output tab of the Delete activity:
| Output Item | Data Type | Description |
|---|---|---|
| ResultList | String | Specifies the HasError boolean value and the result. The result contains the HasError boolean value and the ROWs. If HasError is true, the result contains the Error message as well.
Note: The HasError value is true when one or more results have errors. The HasError value is false when no error occurs. |
Fault
In the
The following table describes the errors in the
| Error Schema Element | Data Type | Description |
|---|---|---|
| msg | String | The plug-in error message. |
| msgCode | String | The plug-in error code. |