Info |
---|
Information valid from AMI version 8.0 initial release |
Summary
The Job Gadget provides functions for viewing, modifying, deleting and running gadget lets you view, edit, delete and run jobs. It has four tabs; ': Browse', 'Running', 'History' and 'Failures'. Note that this
This gadget is responsive and will resize to fit the available space. It is also possible to pop the gadget so that it fills the whole screen. You can expand the gadget with the button.
See the Jobs gadget articles for detailed information on how to use the Job gadget.
Table of Contents maxLevel 2
Browse tab
From this tab you are able to view This tab shows all the jobs that you have access to in Agility. You can sort on the name and last edit 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 tob top of the tab. The filter Filter for job name Job Name works as a standard filter where you can enter the first few characters of a jobname and jobs matching the filter will be displayed. The 'job name.
The Filter Last Edit after' After requires you to select a date using the date picker and it will then to display any jobs that have been modified after this that date. Any input value in the filters will be retained if you navigate away from the page and then returnchange workspace. Note that the 'the Filter Last Edit ' After is an optional feature and may be turned off in the gadget configuration.
To clear the date input and remove the datepickerdate picker, press CTRL/COMMAND + END keys.
Select a job using the checkbox - it is only possible to select one box . You can select only one job at a time. On selection of Selecting a job , the options to Edit, Delete or Run the job become available to you. Note that these enables the Run Job , Edit Job and Delete Job options. These options are only available from the Browse tab.
Create Job
This dialog allows you to create a new job within an Agility Structure. Note that the fields
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. Parameters can be added, edited and removed using the Edit/Add/Remove parameter buttons. A separate dialog opens that allows you to easily add or edit a parameter. The location field is a dropdown field that allows you to select an existing folder within the structure given (either in the gadget configuration or if not specified, in the config.json file) to store the job. A folder object id must be specified in the gadget configuration for this feature to work. If the folder object id is not specified, then all jobs will be created within the specified structure.The Selection tab allows you to specify which selections to add to the job. Checking one of the selections means that
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
The Access Rights tab allows you to modify view access to a particular job per user. Removing view access to a job means that the user will not be able to see the job in the gadget.
Parameters
On creating a parameter for a job, there are a number of parameter types that can be selected from a dropdown field. If you check the 'hidden' box, this means that the parameter will not be editable by or visible to the user at job run time. The value defined in the job will be the one used when running the job. However some parameter types can not be hidden. It is not necessary to give the parameter a default value if you want the value to be amended by the user at run time.
File Parameters: Note that the value for a file- 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 define a file value when set a Default Value when creating a job. In the Accept field you You can optionally define which file types to select when uploading the file at run timemay be selected by entering file extensions in the Accept field. If you want to select allow more than one file typeextension, delimit the file types extensions with a comma and do not enter any spaces.
Edit.
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 select a different folder location if move the job to a different structure point by selecting one in the Location dropdown.
If you want to move change what the job to a different folder.
Rundoes, you have to edit it within Pentaho.
Run Job
The Run job dialog displays options that are available using values from the job's configuration attribute. This attribute is defined in the config.json file. You may edit these values using this dialog if you wish to amend them for a new run of the job. Submitting this dialog will run the job using the values input in the form.
DeleteJob 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. A prompt will ask you to confirm the deletionThe 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 the a running job and stop it from this tab. Only jobs that have a status of 'abortable' can be stopped. A prompt will indicate to you whether the job can not be stopped and ask you to confirm stopping the job in the case where it with End User can Abort the Job enabled can be stopped. Once a job is stopped , it will move to be shown as "Cancelled" on the history tab with a status of cancelled. A count of the total amount of Running jobs is displayed within the tab.
History tab
The history History tab shows jobs that have run, along with a status (either cancelled or completed) and a start and end time. It is possible to
You can remove entries from this tab by selecting the jobs you want to remove and clicking on the erase iconthem and selecting the erase icon. This will remove the entries from this tab, but the job itself will not be deleted from Agility. By clicking on the
Select a job name in this tab , you can to view the job details. That is, These include the values that were passed to by the job , and the values returned. Any You can view output files can be viewed in the 'Files' tab and are downloaded download by clicking on selecting them.
Failures tab
The failures Failures tab shows any jobs that have failed , clicking on to complete as expected. Select the job name will allow you to see the show details with a log that should give of further information on why the job has failed.