Jobs Tree
Jobs
The Jobs tree allows the users to quickly create/edit and view existing jobs in the project.
Using Jobs
To use the Jobs tree, the user will want to make sure they set it as visible in the Select Tree... drop-down. Once visible, the user can select it in the Available Trees panel.
New Job/Add
To create a Job, the user would select the parent tree and then either click on the plus sign and then selecting "New Job" or the Add button on the grid view side. The user can also create a new one while having a job selected.
Once selected, the user will be prompted with the below popup that they need to fill out or cancel.
- Name - pick a name for the job
- Function - enter function to be executed by this job
- Schedule - frequency as to how often this job should execute the function
Once done, click on the Add button to create it. Then it will display the Job in the grid view where they can see quick info on it or any they may have.
Delete
To delete a Job, the user can accomplish this a few ways and they are below.
- Select parent tree and then clicking on the minus sign , which will prompt a popup below for the user to select available Jobs to delete.
- Another is to select the Job under the parent tree and clicking the minus sign , which will prompt a warning popup if the user wants to continue to delete the select job.
- The third option is to select the job from the grid view and clicking on the Delete button, which will prompt a warning popup like above to confirm deletion.
Edit
To edit a job, the user can accomplish this a few ways and they are below.
- Select parent tree and then clicking on the edit icon will prompt the below popup to select from available jobs to edit. Then after selecting one, they will be prompted with similar popup when first creating one.
- Another is to select the job under the parent tree and clicking the edit icon either on the Available Trees Tools Menu or Grid View Tools Menu.
- The third option is to select the job from the gird view and clicking the Edit button, which will prompt the edit popup like above.
New Folder
If the user has a lot of Jobs, they can use the "New Folder" option to organize them.
The user can find that option in the Available Trees Tools Menu by clicking on the plus and selecting New Folder when having the parent tree selected.
Once selected, the user will be prompted with the below popup to select a folder name.
Once created, the folder will appear under the parent Jobs tree, where the user can then select and drag and drop jobs onto the folder to nest them in there.
If the user selects the jobs first to be included in the same folder, then clicking to create a new folder, it will put them all in the same folder. The user won't have to drag and drop them in there.
The rest of the tool properties apply to the folder as well such as editing and deleting.
Job Logs
To view the Job Logs to see progress and status of the jobs, the user can select the parent tree. Then they'll find the Job Logs button on the Grid Tools Menu.
Once selected, the jobs list in the grid view will move down to cover second half of the screen. Then the top side will be the different job logs if any. They'll be able to view the progress, status, runtime etc.
Run
To manually run a job, the user can select the parent tree. Then they'll need to select a job in the grid view to enable the Run button on the Grid Tools Menu. Once enabled, the user can select it to use. Clicking on Run button will execute the job. So whatever function is applied to the job, that will be executed.
Enable
To enable a job, the user can select the parent tree. Then they'll need to select a job in the grid view to enable the Enable button on the Grid Tools Menu (only if the job is currently disabled). Once the button is enabled, the user can select it to use. Clicking on the Enable button will enable the job and allow it to run.
Disable
To disable a job, the user can select the parent tree. Then they'll need to select a job in the grid view to enable the Disable button on the Grid Tools Menu (only if the job is currently enabled). Once the button is enabled, the user can select it to use. Clicking on the Disable button will disable the job and not allow it to run.
Grid View Results
This is where the user can view the available jobs. They can select any to use any of the Grid Tools.