Go to README
What does this plugin do?
This plugin will allow users to have a better experience in viewing the status of jobs running, already completed, or already failed jobs in the system. The new Job Viewer can be filtered down in multiple ways, by specific item, by specific status, or by specific Job Type. It even allows users to see the status of custom Job Types and custom messages or metadata for Job Types.
How to trigger:
Using the Heartbeat icon in the top right corner of the webpage, you can click on that icon to see your specific jobs and their current status.
- If you want to see any and all jobs that are running (or have already ran) in the system, click on the Heartbeat icon and then click on All Jobs.
- Users can also select the item gear and select View Jobs to open the Job Viewer filtered on just that one item's jobs.
User Experience:
Users can simply see the status of all of their jobs right in the Search page or they can open the Job Viewer page and be able to filter on Job Types, Status, Item ID, etc. to see the status of different jobs
README
What it adds:
- Job viewer page to see jobs running/job history
- Job panel in the header with notifications
- Job modal when starting some jobs
Configuration
{
"job_metadata": {
"destinationFileId": {
"title": "Destination File ID",
"copy_button": true
},
"destinationFileName": {
"title": "Destination File Name"
}
},
"custom_job_types": [
{
"title": "Example",
"vidispine_job_type": "Example Job Type",
"role": "portal_administrator"
}
]
}
Additional job metadata fields to display on the job detail view can be added.
job_metadata: The keys are the metadata field keys.
-
title: What to title the metadata field -
copy_button: Whether to show a button to allow quickly copying the field value
custom_job_types: A list of custom job types to show
-
title: The job type title to show -
vidispine_job_type: The vidispine job type, should match what is in vidispine -
role: (Optional) Restrict viewing this job type to a role
Portal Permissions
- This plugin respects the builtin portal job permissions for viewing and modifying jobs.