Difference between revisions of "BagIt"

From CollectiveAccess Documentation
Jump to: navigation, search
(Created page with "See also: BagIt support notes ==== About BagIt ==== [https://en.wikipedia.org/wiki/BagIt BagIt] is a standard for storage and transfer of arbitrarily s...")
 
Line 1: Line 1:
 
See also: [[BagIt_support_notes|BagIt support notes]]
 
See also: [[BagIt_support_notes|BagIt support notes]]
==== About BagIt ====
+
=== About BagIt ===
 
[https://en.wikipedia.org/wiki/BagIt BagIt] is a standard for storage and transfer of arbitrarily structured digital content. As defined by the BagIt standard, a "bag" consists of a "payload" of one or more content files and "tags" – metadata files – documenting the bag. Every “bag” comes with a data directory identifying the “payload” and a tag file that provides a manifest of all files in the “payload” and checksums for each.
 
[https://en.wikipedia.org/wiki/BagIt BagIt] is a standard for storage and transfer of arbitrarily structured digital content. As defined by the BagIt standard, a "bag" consists of a "payload" of one or more content files and "tags" – metadata files – documenting the bag. Every “bag” comes with a data directory identifying the “payload” and a tag file that provides a manifest of all files in the “payload” and checksums for each.
  
 
Its support for flexible payloads and the required inclusion of arbitrary metadata and checksums for data verification make BagIt well-suited for use in archival and digital preservation contexts.
 
Its support for flexible payloads and the required inclusion of arbitrary metadata and checksums for data verification make BagIt well-suited for use in archival and digital preservation contexts.
  
==== BagIt support in CollectiveAccess ====
+
=== BagIt support in CollectiveAccess ===
  
 
CollectiveAccess supports generation of BagIt files for any record, set of records or record hierarchy. Representation media may be included and optionally filtered on representation type, relationship type (where available), primary/non-primary status and/or version. Media attached to records using "media" metadata elements may be included and optionally filtered by metadata element, media version and other metadata values when the media element is part of a container. Files attached using "file" metadata elements may be included and optionally filtered by metadata element and other metadata values when the file element is part of a container
 
CollectiveAccess supports generation of BagIt files for any record, set of records or record hierarchy. Representation media may be included and optionally filtered on representation type, relationship type (where available), primary/non-primary status and/or version. Media attached to records using "media" metadata elements may be included and optionally filtered by metadata element, media version and other metadata values when the media element is part of a container. Files attached using "file" metadata elements may be included and optionally filtered by metadata element and other metadata values when the file element is part of a container
Line 22: Line 22:
 
* Locally mounted file systems (e.g. a local directory on the server, or a file server mounted on the server)
 
* Locally mounted file systems (e.g. a local directory on the server, or a file server mounted on the server)
 
* A remote file store such as Dropbox, Amazon S3, SFTP, Lockss or GoogleAPI.
 
* A remote file store such as Dropbox, Amazon S3, SFTP, Lockss or GoogleAPI.
 +
 +
=== Configuration ===
 +
The BagIt workflow in CollectiveAccess is configured in the file ''external_exports.conf'' located in ''/app/conf''. This file contains settings for BagIt targets, outputs, options and more.
 +
 +
Here we'll walk through each part of the file and the parameters for each setting. To begin we must configure a target. Multiple targets may be configured within a single CollectiveAccess system. Let's begin by setting up a custom BagIt export that packages an EAD XML finding aid along with it's related media assets. First, under ''target'', we set the preliminary details:

Revision as of 18:47, 6 November 2018

See also: BagIt support notes

About BagIt

BagIt is a standard for storage and transfer of arbitrarily structured digital content. As defined by the BagIt standard, a "bag" consists of a "payload" of one or more content files and "tags" – metadata files – documenting the bag. Every “bag” comes with a data directory identifying the “payload” and a tag file that provides a manifest of all files in the “payload” and checksums for each.

Its support for flexible payloads and the required inclusion of arbitrary metadata and checksums for data verification make BagIt well-suited for use in archival and digital preservation contexts.

BagIt support in CollectiveAccess

CollectiveAccess supports generation of BagIt files for any record, set of records or record hierarchy. Representation media may be included and optionally filtered on representation type, relationship type (where available), primary/non-primary status and/or version. Media attached to records using "media" metadata elements may be included and optionally filtered by metadata element, media version and other metadata values when the media element is part of a container. Files attached using "file" metadata elements may be included and optionally filtered by metadata element and other metadata values when the file element is part of a container

Metadata from included records may be exported using any available export mapping.

When exporting a hierarchy of records, files included in the BagIt “payload” may be structured in a directory structure mirroring the record hierarchy.

All CollectiveAccess BagIt output will be serialized as either ZIP or Gzip'ed TAR files.

BagIt output may be created automatically on creation or change to a CollectiveAccess record, or manually during an export of selected records.

CollectiveAccess will support transmission of BagIt output to remote targets. Target types will include:

  • As a direct download from within CollectiveAccess to a user's local machine.
  • Locally mounted file systems (e.g. a local directory on the server, or a file server mounted on the server)
  • A remote file store such as Dropbox, Amazon S3, SFTP, Lockss or GoogleAPI.

Configuration

The BagIt workflow in CollectiveAccess is configured in the file external_exports.conf located in /app/conf. This file contains settings for BagIt targets, outputs, options and more.

Here we'll walk through each part of the file and the parameters for each setting. To begin we must configure a target. Multiple targets may be configured within a single CollectiveAccess system. Let's begin by setting up a custom BagIt export that packages an EAD XML finding aid along with it's related media assets. First, under target, we set the preliminary details:

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools