GetJobInfo

You can use the GetJobInfo activity to retrieve the job information for the provided job ID. The job information includes status of the job, app name, app path, start time, end time, details about actions, and so on.

General

On the General tab, you can specify the activity name in the process, establish a connection with Oozie, and select the specific Oozie operation that you want to perform.

The following table lists the configurations on the General tab of the GetJobInfo activity:

Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
Oozie Connection Yes The Oozie Connection shared resource that is used to create a connection between the plug-in and Oozie server. Click to select an Oozie Connection shared resource.

If no matching Oozie Connection shared resources are found, click Create Shared Resource to create one. For more information about creating a shared resource, see Creating an Oozie Shared Resource Connection.

Wait Till Completion No Whether to wait to get the job status until the process is completed.
Interval (Sec) Yes The amount of time, in seconds, to poll the activity status.
Timeout (Sec) Yes The amount of time, in seconds, to wait for this activity to complete.

By default, this activity times out in 180 seconds.

Note: Ensure that you do not use GetJobInfo activity (with Wait Till Completion option selected) for coordinator, bundle, or any other long running workflow jobs. Other alternatives such as JMS notifications configuration on Oozie server are advised. For more details, see the Oozie documentation.

Description

On the Description tab, you can enter a short description for the GetJobInfo activity.

Input

On the Input tab, you can configure the Oozie operation that you select on the General tab.

The following table lists all the possible input elements on the Input tab of the GetJobInfo activity:

Input Item Data Type Description
jobId String The job ID of the submitted Oozie job.
Note: The job ID returned by Submit Job activity after successful submission of the Oozie Job can be provided as input for jobId.
waitTillCompletion Boolean Whether to wait to get the job status until the process is completed.
interval Int The amount of time, in seconds, to poll the activity status.
timeout Int The amount of time, in seconds, to wait for this activity to complete.

By default, this activity times out in 180 seconds.

Output

On the Output tab, you can view whether the process ran successfully.

The following table lists the output elements on the Output tab of the GetJobInfo activity:

Output Item Data Type Description
GetJobInfoOutput Complex The root element, which contains the elements from ID to bundleCoordJobs that are listed in this table.
id String The job ID.
appName String The job application name.
appPath String The job application path.
status String The status of the job such as RUNNING, KILLED, SUCCEEDED.
startTime DateTime The date and time when the job started running.
endTime DateTime The date and time when the job stopped running.
actions Complex The complex element, which includes details about individual actions in the job.
id String The action ID.
type String Type of action such as hive, pig, and so on.
name String The name of the action.
status String The status of the action.
externalStatus String The external status of the action.
conf String The XML configuration of the action.
startTime DateTime The date and time when the action started running.
endTime DateTime The date and time when the action stopped running.
externalId String The external ID of the action.
errorCode String The error code when the action fails.
errorMessage String The error message of the failed action.
bundleCoordJobs Complex The complex element, which includes details about individual coordinator jobs in the bundle job.
coordJobId String The job ID of the coordinator.
coordJobName String The job name of the coordinator.
coordJobPath String The job path of the coordinator.
status String The status of the coordinator job.
startTime DateTime The date and time when the coordinator job started running.
endTime DateTime The date and time when the coordinator job stopped running.
actions Complex The complex element, which includes details about individual actions in the job.

Fault

On the Fault tab, you can view the error code and error message of the GetJobInfo activity. For more information about errors, see Error Codes.

The following table lists the error schema elements on the Fault tab of the GetJobInfo activity:

Error Schema Element Data Type Description
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.