QueryBatch

The QueryBatch activity is used to query the status of a batch job or all batch jobs in one dataset.

General

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

The following table describes the fields in the General tab of the QueryBatch activity:

Field Module Property? Description
Name No Specifies the name to be displayed as the label for the activity in the process.
Clarity Connection Yes Click to select a Clarity Shared Resource.

If no matching Clarity connections are found, click Create Shared Resource to create one. See Creating a Clarity Shared Rescource for details.

Description

In the Description tab, you can enter a short description for the QueryBatch activity.

Input

In the Input tab, you can specify the datasetID and batchProcessID to check the status of batch jobs:

Input Item Data Type Description
datasetID String Specifies a dataset ID string. A dataset ID is a unique string, which represents the dataset in the Clarity server.

See TIBCO Clarity Developer’s Guide for detailed information on how to get a dataset ID.
batchProcessID String (Optional) Specifies a batch job ID string. If this field is empty, then all batch jobs in this dataset will be returned. Otherwise, only the specified batch job will be returned.

Output

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

The following table describes the fields in the Output tab of the QueryBatch activity:

Output Item Data Type Description
message String Return the response message of this batch job.
Batch Each result contains the following items:
  • batchProcessId: the id of the specified batch job
  • batchStatus: the status of one specified batch job
  • percent: the percentage completion of a specified batch job

Fault

In the Fault tab, you can find the error code and error message of the QueryBatch activity. See Error Codes for more detailed explanation of the errors.

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

Error Schema Element Data Type Description
msg String The TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Clarity error message.
msgCode String The TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Clarity error code.