This documentation is for Release 3.2. For the Release 1 version of this page, see v.124. For the Release 2 version of this page, see v.221. For the Release 3.0.0. see v.264. For release 3.1 see v.268 |
This guide is for Avalon 3.2.
The Avalon Collections Guide for Avalon Media System explains Avalon features, functionality, and how to navigate the system. It is designed for the collection Manager, Editor, or Depositor, whomever is responsible for uploading content, editing content, or providing content for playback through Avalon. See your system administrator for issues that relate to configuring Avalon "under the hood."
On the Avalon home page, click "Sign in>>" (upper right)
At the Login page, enter your username and password, click Login/Sign In Button.
If you log in and do not have editing rights, you must be added to at least one collection as a manager, editor, or depositor. Use the "Contact Us" form linked in the footer of the Avalon site to request access or contact your system administrator.
Browsing and searching is powered by Blacklight and Solr indexing. Flexible search features include Unicode support, Advanced Full-Text Search Capabilities, and faceted searching to help end users and Collection Staff refine their search results. Avalon also auto-generates search suggestions. Avalon provides multiple sorting options for search results, including relevancy sorting, and allows the user to set the number of results shown per page. Once items are added to Avalon, Near Real-Time indexing occurs. No additional steps are needed to index newly added or changed items.
Labels for sections are not searchable.
Boolean Commands (AND, OR, NOT) and Truncation are not supported by Avalon at this time.
By default, Avalon uses Solr's DisMax Query Parser (or dismax), which is designed to process simple phrases without a need for any complex syntax. There is support for + (required) and - (excluded) words, as well as the use of quotes for phrase searching.
Solr also comes with an Extended DisMax Query Parser (edismax), which supports the capabilities of dismax as well as:
Avalon does not use edismax by default. Contact your system administrator to make changes to the Solr configuration.
Avalon uses the MediaElement.js player for playback of both audio and video files.
Player controls - When viewing the Avalon player in the browser window, player controls can be found below the video. When in fullscreen mode, hover your mouse over the bottom area of the picture and you will see player controls appear.
To view a specific section when available, click the desired section for playback under the Section heading below the player.
To share the recording, you can
Mobile viewing: Avalon works on iOS and Android devices.
See Known Issues for Player & Controls
In Avalon, Units are used to define ownership and responsibility of collections and their items. Each collection must belong to a unit and collections can belong to only one unit. Each item within a collection can be discovered using Avalon's search bar or browsing the Unit facet.
In order to create or update unit names, the unit configuration file must be updated. Please contact your system administrator for assistance (see Managing Units).
If you are creating a collection for real use, as a pilot or in production, review the advice in Managing Collections Efficiently before deciding on your workflow.
You can refer to the Avalon Media System blog post, "Understanding Avalon Roles and Permissions," for information on which role best fits your needs.
Avalon has 4 default roles:
Permissions are also a hierarchy (i.e. an editor can do anything a depositor can do, a manager can do anything editors and depositors can do, an administrator can do anything).
At this time, Avalon does allow deletion of the contents of a collection in a single procedure. The content in a collection must be moved to a different collection. If items need to be deleted from Avalon, each item must be deleted at the item level. Collections that do not contain any items can be deleted without any additional steps.
See Known Issues for Content Creation
When viewing an item that you can edit, you will see an Edit button above the audio or video player. Clicking the Edit button allows authorized users to manage files by assigning labels, to upload additional files, change metadata about the item in the Resource Description page, reorder multiple files in the Structure page, edit who can access the item in the Access Control page, and Preview how the item will appear.
For video, the default setting for the poster image and thumbnail is two seconds into playback. There are two ways to change the poster image and thumbnail of a video. One way is to click Edit in the item page, go to Manage file(s), and change the Thumbnail (seconds) for the first file. Click Save or Save and Continue to keep your changes. Thumbnail (seconds) can also be set for individual video sections but will not appear in search results if they are not the first section.
The other way to set a custom thumbnail and poster image is on the Preview page. After initiating playback of a video in the player, click the camera icon in the lower right corner of the player window at a frame in the video you wish to use as the new thumbnail/poster image. Avalon will ask you to confirm your selection and the poster image will update automatically.
See Known Issues for Thumbnail/Poster Images
If you are creating a collection for real use, as a pilot or in production, review the advice in Managing Collections Efficiently before deciding on your workflow.
Types of files, size of files, etc
Avalon uses FFmpeg for transcoding. For a list of source file formats and codecs that are supported, see the FFmpeg Supported Source Formats and Codecs documentation.
There is an individual file size limit of 250MB when uploading files manually through the Avalon web interface.
There is no practical limit on the maximum file size of a source file uploaded to the system through the Avalon dropbox or through the batch upload feature.
File names cannot include the following characters: [ ] < > | &
Automatic handling of master files
Avalon can be configured at the system level to take one of several actions after the master file has been processed. The master file can be either:
Thumbnails
Thumbnails are captured at the 2 second mark of video files by default. To change this, see Changing the Thumbnail and Poster Images for a Video. When the item is audio, the thumbnail will be an illustration of headphones. When the item contains audio and video, the thumbnail will be an illustration of headphones and a screen.
Troubleshooting
To replace a content file:
Navigate to the Manage file(s) section when editing an item, locate the new content file(s) through the Web upload section or import the file(s) from the dropbox after placing them in the appropriate dropbox directory (contact your system administrator for dropbox location and connection information). Upload the file(s) and wait a moment for them to attach to the resource. Delete the incorrect content file(s) from the item in the Manage file(s) section of edit mode, then Save at the bottom of the Manage file(s) form.
To correct metadata errors for an item:
Web ingest is used for manual upload of one or more media items.
There is an individual file size limit of 250MB when uploading a file manually through the Avalon Web interface.
The Avalon Web interface allows for labels to be added to individual sections of a multipart Avalon item.
Avalon items can be created without associating media. Metadata and access control information can be created first which allows for collection managers to come back to that Avalon item and associate the correct media at a later time. You must click "Save and continue" to progress through the steps even if no changes are made.
Deleting files -
Deleting a single Avalon item deletes the record from the database and the derivatives created for each media file.
Deleting a content file of an Avalon item does not automatically delete that content file and its derivatives. If you would like those items deleted, follow the prompt “Several clean up jobs have been sent out. Their statuses can be viewed by your sysadmin at /var/www/avalon/shared/log/matterhorn_cleanup.log”
See Known Issues for Creating Single Item
Avalon’s dropbox is used to import large files over 250MB (this has no association to dropbox.com).
Uploading files - Large media files are placed in a dedicated Avalon dropbox (a file server usually connected via SFTP or a mapped network drive). Contact your system administrator for dropbox location and connection information. In release 3, dropboxes are in sub-folders with the name of the related collection instead of there being just one system-wide dropbox.
Once files are copied to the collection's dropbox, collection members can go to the Create an Item option or Edit option for an item within a collection to open the dropbox and attach selected files to an Avalon item. File processing begins once media is attached from the dropbox.
Deleting files from the Avalon dropbox - If your Avalon instance is not configured to automatically delete or move master files after processing, you can delete files from the Avalon Dropbox through the web interface or directly on the server the dropbox is located:
Avalon's Batch Ingest feature provides a method of building one or more media items at a time from uploaded content and metadata outside the user interface. A batch ingest is started by uploading an Ingest Package (the combination of content and metadata) consisting of one Manifest File and one or more Content Files to the Avalon dropbox.
To format a Manifest File as an xls, see Batch Ingest Package Format for a batch spreadsheet template and instructions on the metadata fields that can be included in a batch ingest.
When formatting a batch, all content and metadata files are placed in a dedicated collection-specific Avalon dropbox (a file server usually connected via SFTP or a mapped network drive). Contact your system administrator for dropbox location and connection information.
Upon loading the batch in the dropbox, Avalon checks to see if the spreadsheet is formatted properly and if all the files are copied to the server. Avalon sends an email (i.e. the address listed in the spreadsheet) either confirming that all is well and the batch is processing OR a report of problems with the batch (e.g. missing files or incorrect formatting). Upon completion of the batch, Avalon sends an email of success or failure.
Handling errors for Avalon items within a batch
Reload spreadsheet: Re-ingest a single Avalon item or set of items by reducing the batch spreadsheet to only those failed items and reload the spreadsheet to the same location as before. This will run the batch for the failed content files only.
If a single Avalon item with multiple content files has one or some of those files fail (but not all), either delete that item from Avalon and use the Reload spreadsheet method to load the entire item again or use the Avalon form method to add those failed content files to the dropbox and append them to the appropriate item in Avalon.
Suggestions for controlled vocabulary use
Some fields in Avalon have recommended controlled vocabularies. Genre, all types of Subjects (Location, Time Period) and names of Creators and Contributors should come from a controlled vocabulary when available. The contextual help accompanying the fields in the Resource Description form contains links to recommended vocabularies. Additionally, the Batch Ingest Package Format specifies controlled vocabularies for those fields.
If a single Avalon item is made up of multiple content files, those content files can be uploaded separately to the item, labeled individually, given different thumbnails (for video files only) and reordered at any time. If there is more than one content file, each content file will be listed on the Avalon item’s page and can be selected for individual playback. Labels specific to these content files can be helpful for users to better understand the content of the item. If no label is provided for a content file, the file name will be listed. You must click Save or Save and continue at the bottom of the Manage file(s) page for labels to persist.
Avalon has two default group categories: System and Ad Hoc Groups
System Groups - System groups are configured by a system administrator.
Adhoc Groups - Group managers can create new groups to share specific items with designated user groups. These groups will have view access only.
No ability exists in the interface to edit policies for groups. To add users to a group, enter their Avalon username as displayed in the upper right corner upon logging in. This is usually an email address.
Avalon can optionally be configured by system administrators to utilize "External Groups" for item access. These are similar to Adhoc Groups described above, but group membership is determined by external systems, such as LDAP or LMS/LTI. Access to any collection or item can be granted to one or more external groups by adding those groups via the Access Control sections of Collection and Item Edit screens. See the Access Control section above.
See Known Issues for Group Management
See Known Issues for Sharing via URL/Permalink
When multiple items are viewed in a search page, you can select one or more items with check boxes in the right hand column. When boxes are checked, then they are selected. Click the “Manage Selected Items” option displayed in the top navigation bar which lists the number of items selected. The Selected Items page will then provide the following Bulk Editing features:
Roles and permissions will determine the range of bulk editing actions available to a particular user. If a user has selected multiple items and the user does not have the same permissions to perform the various Bulk Editing actions across all items, then only those items with correct permissions will be successfully edited.