Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Incorporated Amy's requested edits

...

  • Collection: A set of items that are subject to the same access control settings.
  • Bundle: A set of items from a collection or multiple collections. The bundle gathers items that the user wants to submit through a workflow at the same time.

  • Item: A bibliographic item. It contains metadata and A/V binary content. Items belong to a collection.
  • File: A file is a media file (sound recording, moving image) that is part of an item. Multiple related files can exist in one item
  • Primary Files: Binary objects that are provided as primary resources from a collection-holding institution
  • Supplemental File: Any file that is provided to supplement the information about a collection, an item, or a primary file.
  • Workflow: A representation of a graph that describes the routing rules for a set of MGMs. The input of a workflow may be an item or a group of items.
  • Metadata Generation Mechanism (MGM): A machine learning tool or a manual tool provided to users to interact with AMP.
  • Job: One execution of a workflow for a particular Primary File
  • Unit: A tenant in a multi-tenant AMP; collections belong to a Unit.

...

If this is your first time using AMP (or if you are not currently logged in), the URL for AMP will direct you to the login page. Before logging in for the first time, you will need to create an account. After creating your account, you will need to verify it prior to logging in for the first time. The email verification link will not be sent until approved by hand AMPPD staff currently, so please be patient for the short term, you may be required to wait until they are able to respond. Once your account has been verified, you should be able to log in with your email and password. 

...

(Note: the following borrows significantly from Maria Whitaker's documentation on creating a batch manifest file; see more at Batch Manifest - this is a work in progress page)

The Batch Ingest feature is currently the only way to upload files is how files are uploaded to AMP. To use the Batch Ingest, you need to create a batch manifest in CSV format, and then upload it to AMP on the Batch Ingest page. All the files in the batch manifest first need to be uploaded to their respective collection's subfolder in the dropbox via an SFTP client; the Batch Ingest will fail if a file is not found. Detailed instructions for how to upload files to a dropbox using a tool like WinSCP or Cyberduck can be found here

...

The collection must already exist in AMP, and collection names must match exactly. The name of the collection is used to determine:

  • which collection dropbox holds the media files to be uploaded
  • to which collection in AMP the information in that line refers.

Collection names cannot be changed by end users; however, they are able to be changed by AMPPD staff.

External Source (

...

optional)

This field may be left blankis optional. It is used to tell AMP the source system of the item. This information is added by AMP in the bag it provides with AMP-generated metadata for target systems to consume. Within AMP this currently serves no purpose.

...

 

Note: "Source" is the old column name.

External Item ID (optional, recommended)

This field may be left blank is optional, although recommended. When provided, it is used as the unique identifier of the item during the batch ingest process (if not, Item Title is the unique identifier). This allows items within the same collection to have the same Title (this is a relatively common occurrence, at least in some of the pilot collections).

Note: "Source ID" is the old column name.

Item Title (required)

The bibliographic title of the item. If the External Item ID is not provided, this title field serves as the unique identifier for an item in a collection; in this case, one cannot have multiple items with the same title within a collection. 

Item Description (optional)

This field may be left blank. When provided, it will be displayed as the item description in AMP.

...

Warning: if a batch manifest includes 2 two lines with the same value in the Primary file File column for different items in the same collection, the validation step will let it pass, but the ingestion process will have a runtime error because in the dropbox there can only be one copy of a file with that name.

...

Users must provide a label (or title) for the file. That label will be used to uniquely identify the file within this item. In other words, one cannot have multiple primary files with the same label if they are associated with the same item within the same collection. 

Primary File Description (optional)

This field may be left blank. When provided, it will be displayed as the file description in AMP.

...

Multiple supplemental files can be specified per line. For each supplemental file, you need 4 four fields:

  • Supplemental file File Type - user must specify at if they want to place the file at the Collection, Item, or Primary file level
  • Supplemental fileFile - the filename of the binary file (which needs to be found in the same Dropbox as the media files)
  • Supplemental file File Label - the user must provide a label (or title) for the supplemental file. That label will be used to uniquely identify the file in association with the item. One cannot have multiple supplementary files with the same name associated with the same item within the same collection.

...

Once files have been ingested, they can be submitted to a workflow. Currently, only primary files can be submitted to workflows, but supplementary files will soon be able to be submitted. To use the Workflow Submissions feature, first search for the item(s) you wish to submit to a workflow. Only items that have been submitted to AMP via the Batch Ingest feature will appear in the search results. The search feature allows users to limit search results by media type (audio, video, or other). The search results appear as items, with individual files contained in the item visible via a dropdown menu on each item, with an "add file" button to the right of the filename. For convenience, each item has an "add all files" button that adds every file to the "Selected Files" box. Once files have been added, they can either be submitted directly to a workflow or saved as a bundle. Saving a grouping of files as a bundle can be very helpful when adding a large number of files at once. To select a workflow, click on the "Select Workflow" dropdown menu. Once the workflow has been selected, the "submit to workflow" button will enable, allowing you to submit the files. Once one or more files have been submitted, AMP will display a message telling you how many jobs were successfully submitted to the workflow, and how many failed. 

...