Query

The Query activity retrieves the entries that match the filter string or criteria specified in the datagrid table. Before using the Query activity, you must supply a filter string as an argument. This filter specifies the content of the query, that is, criteria for selecting a subset of rows from the table.

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

Input

In the Input tab, you can specify the filter and the number of rows to be returned.

The following table describes the fields in the Input tab of the Query activity:

Input Item Data Type Description
Filter String Optional: Specifies a filter string.

A filter query only returns the entries that match the specified filter.

Note: Ensure that the filter syntax is correct according to the TIBCO ActiveSpaces documentation. If an invalid filter is given, no results are reported.

See TIBCO ActiveSpaces Developer’s Guide for more information on how to use filters.

Prefetch No Specifies the units of data to be transferred in a row.
Note: If you set a value in the "prefetch" field when you created a DataGrid connection, then the value you provide here overrides that value.
Snapshot Level No Specifies the snapshot level to be displayed for a row in the process. You can select either global snapshot or local snapshot.
Note: If you set a value in the "Global_Snapshot_Required_for_Iterator" field when you created a DataGrid connection, then the value you provide here overrides that value.
Timeout No Specifies the timeout value for the activity. The value specified here overrides the ActiveMatrix BusinessWorks™ default timeout value.
Iterator Fetch Timeout No Specifies the timeout value for the filter query to be executed and the results to be fetched.
Note: If you set a value in the Timeout field when you created a DataGrid connection, then the value you provide here overrides that value if the value provided here is greater than that provided in the DataGrid configuration.

Output

In the Output tab, you can find the operation results.

The following table describes the field in the Output tab of the Query activity:

Output Item Data Type Description
Activity output String Specifies the HasError value, the error, the total count, and the rows that match the filter. It specifies the error message, the total count, and the rows if the HasError value is true. It specifies the total count of rows and the rows if the HasError value is false.
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 Query activity. See Error Codes for more detailed explanation of the errors.

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

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