WaitForJobCompletion

You can use the WaitForJobCompletion activity to wait for a specified job to complete until it reaches a specified time.

General

In the General tab, you can specify the activity name in the process, establish a connection to HCatalog, specify the maximum time for the activity to wait for a job to complete, and specify the interval to check the job execution.

The following table lists the configurations in the General tab of the WaitForJobCompletion activity:
Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
HCatalog Connection Yes The HCatalog Connection shared resource that is used to create a connection between the plug-in and HCatalog. Click to select an HCatalog Connection shared resource.

If no matching HCatalog Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating an HCatalog Connection.

Timeout Yes The amount of time, in milliseconds, to wait for a job to complete. The default value is 1200000.
Interval Yes The time interval, in milliseconds, to check the job execution. The default value is 5000.

Description

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

Input

The values that you specify in the Input tab override the ones that you specify in the corresponding fields in the General tab.

The following table lists the input elements in the Input tab of the WaitForJobCompletion activity:

Input Item Data Type Description
jobId String The ID of the job to be waited for.
timeout Long The amount of time, in milliseconds, to wait for a job to complete.
interval Long The time interval, in milliseconds, to check the job execution.

Output

In the Output tab, you can view a job details including its status, profile, ID, and so on.

The following table lists the output elements in the Output tab of the WaitForJobCompletion activity:

Output Item Data Type Description
Job Complex The job.

This element contains the elements from status to userargs that are listed in this table.

status Complex The job status.

This element contains child elements, see Child Elements of Status for more information.

Profile Complex The job profile.

This element contains child elements, see Child Elements of Profile for more information.

id String The job ID.
parentId String The parent ID of the job.
percent

Complete

String The completion percentage of the job.
exitValue String The exit value of the job. If a value of 0 is returned, it indicates that the job is executed successfully. Otherwise, the job is completed with errors.
Note: You can get error messages of the job from the StatusDirectory/stderr directory. You can specify the StatusDirectory value in the Status Directory field in the General tab of the activity that executes the job. The ErrorHandler process in the sample project that is shipped with the installer shows how to get error messages of a job. See Working with the Sample Project for more information.
user String The user name of the job owner.
callback String The callback URL.
completed String The completion status of the job. For example, done.
userargs Complex The user arguments.

This element contains child elements, see Child Elements of Userargs for more information.

Fault

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

The following table lists the error schema elements in the Fault tab of the WaitForJobCompletion activity:

Error Schema Element Data Type Description
Hadoop

Exception

Complex The exception thrown by the plug-in.

This element contains the msg and msgCode elements.

msg String The error message description that is returned by the plug-in.
msgCode String The error code that is returned by the plug-in.
ActivityTimeout

Exception

Complex The exception thrown by TIBCO ActiveMatrix BusinessWorks.

This element contains the msg and msgCode elements.

msg String The error message description that is returned by TIBCO ActiveMatrix BusinessWorks.
msgCode String The error code that is returned by TIBCO ActiveMatrix BusinessWorks.