StartBatch

The StartBatch activity is used to start a batch job for a project.

General

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

The following table describes the fields in the General tab of the StartBatch 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 StartBatch activity.

Input

In the Input tab, you can specify both datasetID and projectID to start a new batch:

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.
projectID Name String Specifies a project ID string. A project ID is a unique string, which represents the project in the Clarity server.

See TIBCO Clarity Developer’s Guide for detailed information on how to get a project ID.

Output

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

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

Output Item Data Type Description
message String Return the response message of this batch job.
batchStatus String Returns the status of this batch job.
status String Returns the status of this activity.
batchprocessID String Returns the ID for the new batch job.

Fault

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

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