The Delete activity deletes a row from a data grid 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.
Configuration
The following table describes the fields in the
Configuration 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.
|
Description
|
No
|
Optional: Specifies a short description of the Delete activity.
|
Table
|
Yes
|
Click
to select a table.
Rows are stored to the table with the defined fields of the selected table connection.
|
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.
|
In the
Error Output tab, you can find the error code and error message. See
Error Codes for more detailed explanation of the errors.
The following table describes the errors in the
Error Output tab of the Delete activity:
Error Schema Element
|
Data Type
|
Description
|
msg
|
String
|
The plug-in error message.
|
msgCode
|
String
|
The plug-in error code.
|
MyMessage
|
String
|
The plug-in error message with more details, where required.
|
Copyright © Cloud Software Group, Inc. All rights reserved.