Jobs gadget

Browse tab

This tab shows all the jobs that you have access to. You can sort on the Job Name and Last Edit columns by clicking on the column header. You can further filter on name and date using the input boxes at the top of the tab. The Filter for Job Name works as a standard filter where you can enter the first few characters of a job name.

The Filter Last Edit After requires you to select a date using the date picker to display any jobs modified after that date. Any input value in the filters will be retained if you change workspace. Note that the Filter Last Edit After is an optional feature and may be turned off in the gadget configuration.

To clear the date and remove the date picker, press CTRL/COMMAND + END keys.

Select a job using the checkbox. You can select only one job at a time. Selecting a job enables the Run Job , Edit Job  and Delete Job  options. These options are only available from the Browse tab.

 Create Job

See the Editing Jobs in the Job gadget article for detailed information.

Jobs are stored as objects within an Agility structure, set when the gadget is configured. Job Name, Description and Repository Path are all required fields.

The Location dropdown selects a structure point where the job object will be created.

Parameters

• Parameter Name—The internal name of the parameter, as it is passed to Pentaho.
• Label—Text displayed when the job is run, to prompt the user to define a value.
• Type—How the parameter's value is set. See the Editing Jobs in the Job gadget article for detailed information.
• Default Value—An optional value for the parameter.
• Hidden Parameter—If enabled the parameter will not be editable when the job is run: its Default Value will always be used.

A File type parameter can only be selected at run time: it is not possible to set a Default Value when creating a job. You can optionally define which file types may be selected by entering file extensions in the Accept field. If you want to allow more than one file extension, delimit the file extensions with a comma and do not enter any spaces.

Selections

The Selection tab allows you to specify how to pass ID paths of object instances to the job. Checking one or more of the options means that when the job is run, ID paths of those instances will be passed to the job. The tooltips of each option show a brief description. For example, checking the Browse Gadget Selection will pass the ID paths of the instances selected in the Browse gadget at run time.

Access Rights

The Access Rights settings determine which users or groups of users are able to use the job. If a user does not have access to a job it will not appear on their Jobs gadget.

 Edit Job

This dialog allows you to modify an existing job within Agility. You can move the job to a different structure point by selecting one in the Location dropdown.

If you want to change what the job does, you have to edit it within Pentaho.

 Run Job

The Run Job option sends a request to start the associated job.

Any values that can be set at runtime will be displayed for editing before the request is sent.

 Delete Job

Deleting the job will unlink it from the Agility structure and put the job object in the appropriate bin. The job will not be removed from Pentaho.

Running tab

This tab shows all currently running jobs that you have access to.

The number of running jobs is displayed on the tab heading.

You can select a running job and stop it from this tab. Only jobs with End User can Abort the Job enabled can be stopped. Once a job is stopped it will be shown as "Cancelled" on the history tab.

History tab

The History tab shows jobs that have run, along with a status (either cancelled or completed) and a start and end time. 

You can remove entries from this tab by selecting them and selecting the erase  icon. This will remove the entries from this tab, but the job itself will not be deleted from Agility.

Select a job name in this tab to view details. These include the values passed to the job and values returned. You can view output files in the Files tab and download by selecting them.

Failures tab

The Failures tab shows any jobs that have failed to complete as expected. Select the job name to show details with a log of further information on why the job has failed.