Dashboard - AudiovisualMetadataPlatform/amp_documentation GitHub Wiki
Dashboard
Page Sections:
- What is the Dashboard?
- Dashboard Columns & Customization
- Filters
- Tracking the Status of Workflow jobs
- Scenarios
- Scenario #1: A collection manager wishes to view one of the transcriptions their students had previously corrected.
- Scenario #2: The Collection manager wants to view facial recognition.
- Scenario #3: User wants to see a contact sheet for a couple of items that were submitted in a certain time/date template.
What is the Dashboard?
The Dashboard allows users to track the progress of files submitted to a workflow as well as to view the output results of the submissions once these are completed. It contains a robust search feature that allows users to filter results in a multifaceted manner, as well as sort the results. The Dashboard by default displays all job steps by date in descending order, though you are able to sort by any column in ascending or descending order. Users are additionally able to export the data displayed on the Dashboard as a CSV file for easier analysis in software outside of AMP.
Dashboard Columns & Customization
The Dashboard organizes output file information by the following attributes:
- Date
- Submitter
- Unit
- Collection
- External Source
- External ID
- Item
- Content file
- Workflow
- Step
- Status
- Actions
The user can customize which attributes are shown or hidden in the dashboard via the "Show/Hide Columns" dropdown. This dropdown can be found to the right of the filter buttons.
Once clicked, "Show/Hide Columns" will display a dropdown with each column name listed next to a checkbox.
To change the status of a column, click the box next to the column name. The box will have a blue checkmark next to the columns that are shown and a blank textbox next to columns that are hidden.
Once the box is clicked the column should immediately change.
Filters
The filter buttons indicate which attributes you are able to filter by.
Filters can be applied by clicking the button that corresponds to the attribute you wish to use to narrow your search. When clicked, a window will appear with a search bar as well as a list of values to select to filter the dashboard results.
In the image below, the user is attempting to filter by collections.
In this window you can choose to either type in the collection name or select a collection from the provided list. Once you have clicked the box next to your desired filter, you will hit "Save Changes" to apply the filter to the Dashboard.
When changes are applied, you will see a box next to the label "Currently Filtered By" displaying your active filters.
[]
More filters may be applied through the same process listed above. To remove a filter click the "x" in the top left corner of the labeled filter.
**Please note: Adding additional filters will continue to narrow the search. If you wish to broaden your search you must clear filters that may be limiting your search.
Tracking the Status of Workflow jobs
Each workflow result file listed in the dashboard has a status indicator to let you keep track of what is done, what is currently processing, what is waiting to be processed, and what has failed. Note: Data for deactivated submissions will not be available in the dashboard.
For easy readability, the workflow statuses are color-coded as follows:
]
Complete - The output file has successfully been generated by AMP.
Schedule - The workflow step that will generate this output file is scheduled in the workflow queue.
Paused - The workflow step that will generate this output file has been temporarily paused, most likely because of an error on a prior step.
Error - There was an issue while processing the file.
As the workflow steps are routed to AMP local servers, to IU's Carbonate computing cluster, or to cloud-based tools (Amazon Web Services, Azure) to undergo processing via the selected workflow, depending on system load you may occasionally see a workflow step in Scheduled for a while; this is expected when resources are being shared by my processes. This is especially the case with workflow steps sent to Carbonate, as it can occasionally take a few hours depending on what is ahead of it in Carbonate's queue. If a step fails, it will turn red and the status indicator will say "Error." All subsequent steps will then be set to "Paused," in orange. As with items failing to be submitted to a workflow, please let AMPPD staff know if this occurs, as they can figure out precisely what went wrong.
Use this toggle to reduce the number of results/outputs displayed in the Dashboard by hiding "irrelevant" entries. AMP considers irrelevant any Workflow output that the user unchecked when creating the workflow. See this example:
The general rule is that AMP does not display in the Dashboard the unchecked outputs when the toggle is set to Show Relevant Results Only. However, in order to ensure that the user always has visibility of what is happening or happened, a couple of exceptions to this rule exist: AMP will always show, regardless of the toggle setting, all outputs with a status of Error or In Progress, in addition to Human MGMs and audio extraction that are Scheduled.
Scenarios
Here are three example scenarios to demonstrate a few ways to use the Dashboard's features in AMP.
Scenario #1: A collection manager wishes to view one of the transcriptions their students had previously corrected.
A collection manager at a large university uses the AMP tool to generate transcriptions for the university collections' audiovisual materials. Student workers are tasked with reviewing the generated transcriptions to correct any inaccuracies. To review their students' work the collection manager uses the Dashboard feature provided by AMP.
To find the transcription, the collection manager filters by collection using the filter options at the top of the page.
The "collection" filter will have a pop up search window where the collection manager will select the collection they wish to use to narrow down the search.
The collection manager wants to narrow down their search based on workflow so they utilize the filter labeled "workflow". Once clicked a search window will appear and the collection manager will select "Speech Segmentation and NER."
The active filters will appear at the top of the Dashboard screen when in use.
Once they have narrowed down their search, the collection manager clicks the link listed under the "Output" column. The file will then be downloaded and viewable by the collection manager.
Scenario #2: The Collection manager wants to view facial recognition.
A collection manager wants to view the output of their facial recognition workflow using the AMP Dashboard. To narrow their search, the collection manager uses the Workflow filter.
Within the workflow's filter search, the collection manager types "facial recognition" into the search bar and checks the box next to the option that comes up.
Once checked all files that were under the facial recognition workflow will appear. The collection manager can then click on the output link associated with their file.
Scenario #3: User wants to see a contact sheet for a couple of items that were submitted in a certain time/date template.
From the Dashboard the user would like to filter by date and time to find his submitted items. To accomplish this, the user utilizes the filters at the top of the dashboard labeled "Date Range". Once clicked, a box will appear providing a space for the user to enter the date range they are looking for.
Once submitted, the Dashboard will show all workflow results under this date range.
To sort the files from ascending date
to descending date
the user will click the "Date" column title.
Attachments:
amp_dashboard.png (image/png)
AMP Dashboard
Base.png (image/png)
AMP
Sorting.png (image/png)
complete.png (image/png)
Scheduled.png (image/png)
PAused.png (image/png)
error.png (image/png)
AMP_Dashboard_Update.png
(image/png)
AMP_Dashboard_ShowhideButton.png
(image/png)
AMP_Dashboard_ShowHide.png
(image/png)
image2022-9-8_15-35-50.png
(image/png)
AMP_Dashboard_FilterPopup.png
(image/png)
AMP_Dashboard_CurrentFilter.png
(image/png)
Dashboard_Filters.png
(image/png)
Workflow_filter.png (image/png)
Collections_popup.png
(image/png)
DashActiveFilters.png
(image/png)
Output_Column.png (image/png)
Wrkflow_FacialRecognition.png
(image/png)
Output_FR.png (image/png)
DateRange_Filter.png (image/png)
Files in Date
Range.png (image/png)
AscendingDate.png (image/png)
DecendingDate.png (image/png)
ShowRelevantToggle.png
(image/png)
OutputToggle.png (image/png)
DashboardAMP.png (image/png)
Show_Hide_Button.png (image/png)
Show_Hide_Options.png
(image/png)
AMPFilters.png (image/png)\
Document generated by Confluence on Feb 25, 2025 10:39