Jobs menu

Available Jobs tab

This tab shows all the jobs that you have access to. You can filter the jobs by their names by entering a value in the Filter Jobs box and by selecting a Folder used to organise job definitions.

Run a job by selecting it.

 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.

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

If you want to change what the job does, you have to edit it within Pentaho. See Writing Pentaho jobs for the AMI Jobs slideout for detailed information.

 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.

Select  to stop a running job. 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 completed, cancelled or failed) and a start and end time. 

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.

You can filter the job histories by their Status or by their names by entering a value in the Filter Jobs box.

You can remove entries from this tab by selecting the delete  icon. This will remove the history information from this tab, but the job itself will not be deleted from Agility.

Creating Jobs

Select Create New Job... to create an Agility job definition. This will contain the information required to run an existing DI job.

See the Editing Jobs in the Job slideout 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. You can change this structure point later by editing  the job.

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 slideout 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 slideout.