From c13787713cae8ad9931672081c565c6c0dbe51d1 Mon Sep 17 00:00:00 2001 From: sallain Date: Mon, 10 Feb 2020 14:13:56 -0800 Subject: [PATCH] Add section on special bag structures I've added a section about alternate configurations for bags. It's a bit of a punt, as we don't test all of the possible bag configurations, but I'm not sure how else to communicate that there may be other setup options out there while also acknowledging that A) Artefactual doesn't test them all, B) some of them might not work, and C) if they don't work it doesn't mean it's a bug. So this is what I've landed on. Connected to archivematica/Issues#669 --- user-manual/transfer/bags.rst | 46 +++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 7 deletions(-) diff --git a/user-manual/transfer/bags.rst b/user-manual/transfer/bags.rst index 6b36daa8..bc77b351 100644 --- a/user-manual/transfer/bags.rst +++ b/user-manual/transfer/bags.rst @@ -8,12 +8,16 @@ Archivematica supports the ingest of materials packaged in accordance with the Library of Congress `BagIt`_ specification. Users can ingest both zipped and unzipped bags by using the appropriate :ref:`transfer type `. -*On this page:* +*On this page* * :ref:`Bag structure requirements ` -* :ref:`Unzipped bags ` -* :ref:`Zipped bags ` -* :ref:`Adding metadata to bags ` +* :ref:`Configuring bags ` + + * :ref:`Unzipped bags ` + * :ref:`Zipped bags ` + * :ref:`Adding metadata to bags ` + * :ref:`Other ways to configure bags ` + * :ref:`Index and search bag metadata ` .. _bag-structure-requirements: @@ -33,10 +37,18 @@ Some issues that can cause bags to inadvertently fail include: * Structural issues. See :ref:`Adding metadata to bags ` for more information on how to structure bags. +.. _configure-bags: + +Configuring bags +---------------- + +Bags can be configured in a variety of ways to achieve specific preservation +goals. + .. _unzipped-bags: Unzipped bags -------------- +^^^^^^^^^^^^^ Unzipped bags can be created by hand or by using a BagIt tool like `BagIt-python`_ or `Bagger`_. The bag must comply with the `BagIt`_ @@ -64,7 +76,7 @@ For more information on processing your transfer, see :ref:`process transfer .. _zipped-bags: Zipped bags ------------ +^^^^^^^^^^^ Zipped bags can be created by hand or by using a BagIt tool like `BagIt-python`_ or `Bagger`_. The bag must comply with the `BagIt`_ specification. @@ -92,12 +104,31 @@ For more information on processing your transfer, see :ref:`process transfer .. _adding-metadata-bags: Adding descriptive/rights metadata and submission documentation to bags ------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Similar to standard transfers, it is possible to add descriptive and rights metadata to unzipped and zipped bag transfers. See :ref:`Adding metadata to bags ` for more information. +.. _other-bag-configs: + +Other ways to configure bags +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There may be other ways to combine standard transfer configurations with bags, +such as: + +* :ref:`Transfers with submission documentation ` +* :ref:`Persistent identifiers ` +* :ref:`Transferring material with preservation or access derivatives (manual normalization) ` +* :ref:`Transferring material with access copies only ` +* :ref:`Transferring material with service (mezzanine) files ` + +However, Artefactual does not test all configurations. It is recommended to +thoroughly test any unique configuration and review the results before running +your workflow in production. If you have questions about different ways to set +up bags for transfer, consider a post to the `Archivematica user forum`_. + .. _searching-bags: Index and search bag metadata @@ -213,3 +244,4 @@ user enters two dates in ISO date format separated by a colon. For example, .. _BagIt: https://tools.ietf.org/html/rfc8493 .. _BagIt-python: https://github.com/LibraryOfCongress/bagit-python .. _Bagger: https://github.com/LibraryOfCongress/bagger +.. _Archivematica user forum: https://groups.google.com/forum/#!forum/archivematica