Query

The Query activity retrieves the entries that match the filter string or criteria specified in the data grid 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.

Configuration

The following table describes the fields in the Configuration 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.
Description No Optional: Specifies a short description of the Query 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 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 Specifies a filter string.

A filtered 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.

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.

Error Output

In the Error Output 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 Error Output 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.
MyMessage String The plug-in error message with specific details, where required.