Get

The Get activity retrieves a row of a datagrid table. Before using the Get 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 get operation returns the contents of that row in a new row object. If the table does not contain a row with that key value, then the activity returns null.

General

In the General tab, you can specify the activity name and a table connection.

The following table describes the fields in the General tab of the Get 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 to select a table connection.

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 Get activity.

Advanced

In the Advanced tab, you can provide advanced settings for the Get activity.

The following table describes the fields in the Advanced tab of the Get activity:

Field Module Property? Description
Batch Get Operation No Specifies if you want to execute get operations as a batch.
Operations Per Batch No Specifies the number of rows to be processed as a batch.
Override Transaction Behavior No Specifies whether to override the existing transaction behavior for a local transaction.
Generate Only Key Output No Specifies the output based only on key fields.

Input

In the Input tab, you have to provide the key values of the rows to be queried.

Note: You have to input all the keys specified in the table.

Output

In the Output tab, you can find the operation results when a process is tested.

The following table describes the field in the Output tab of the Get 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 Fault tab, you can find the error code and error message of the Get activity. See Error Codes for more detailed explanation of the errors.

The following table describes the errors in the Fault tab of the Get activity:

Error Schema Element Data Type Description
msg String The plug-in error message.
msgCode String The plug-in error code.