GetBatchResult

The GetBatchResult activity is used to download the batch result on completion of a batch job.

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

Input

In the Input tab, you can specify the datasetID and batchProcessID to get the batch result file:

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 Specifies a batch job ID string. A batchProcessId is the return value from the StartBatch activity.

Output

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

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

Output Item Data Type Description
message String Return the response message of this batch job.
File Each result contains the following items:
  • fileContent: the file content of the batch result
  • fileName: the file name of the batch result
  • 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 GetBatchResult activity. See Error Codes for more detailed explanation of the errors.

The following table describes the errors in the Fault tab of the GetBatchResult 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.