README.md

SLUB SIP Builder

Description

A CLI tool to create valid BagIt-based SIPs for ingest into the SLUBArchiv, the digital long-term preservation archive of the Saxon State and University Library Dresden (SLUB).

As a user, you have one of three options to create your SIP: copy, move or replace.
NOTE: The use of option copy is strongly recommended. The other options modify your source directory. Please use this with caution!

Operating Systems

• Windows 10 (NOTE: check if UTF-8 flag set at Systemadministration/TimeAndRegion/Region/Administration/AreaPattern, if you want to use such characters as äöüÄÖÜß)
• Debian 10

Requirements

• Perl version 5.28 or higher
• cpan or cpanm
• several CPAN modules such as Archive::BagIt::Base (0.065 or higher)

Three ways to install a module

• with cpan cpan Archive::BagIt
• with cpanm cpanm Archive::BagIt (NOTE: cpan App::cpanminus must be installed).
• from source (Linux)
  1. Download for example Archive-BagIt-0.067.tar.gz from metacpan Archive::BagIt
  2. Extract it with tar zxf Archive-BagIt-0.067.tar.gz and go to project dir with cd in Archive-BagIt-0.067
  3. Run perl Makefile.pl
  4. (d)gmake
  5. (d)gmake test
  6. (d)gmake install
  7. with cpanm Archive::BagIt test for the version. Result will be something like Archive::BagIt is up to date (0.067).

Module deinstallation

Using cpanm is recommended for an assisted and clean uninstall.

1. cpan App::cpanminus must be installed.
2. Run cpanm --uninstall Archive::BagIt

Documentation

• RECOMMENDED for Windows 10: strawberry perl environment strawberry-perl-5.30.3.1-64bit-portable
  (includes cpanm with many preinstalled CPAN modules)
• Project based on BagIt 1.0 specification, visit RFC8493
• For valid SIP examples based on operating system please have a look at export_dir_kitodo/bagit/lin_* or export_dir_kitodo/bagit/win_*
• Specification for creating a SLUBArchiv SIP SLUBArchiv_Produzenten_SIP_Spezifikation.pdf
• SLUBArchiv rights coding specification SLUBArchiv_Produzenten_Rechteauszeichnung.pdf

Explanation

Usage

perl -I lib/ bin/slubsipbuilderbagit.pl -help

Result

Usage:
    slubsipbuilderbagit.pl [options]

    Options: -help brief help message -man full documentation

            -save_option=<option>           payload files save as <copy>, <move>, <replace>, the <copy> option should be prefered
            -IE_directory=<IE dir>          existing IE directory (absolute path!)
            -SIP_output_path=<target dir>   where to put the SIP dir (absolute path!)
            -ppn=<ppn>|-noppn=<noppn>       SWB-PPN or any identifier (uses minimalistic MODS)

            -SIP_version=<version>          mandatory, needs for identification of SIP format, supported <v2020.1>
            -external_workflow=<workflow>   mandatory, should be uniqe workflow name
            -external_id=<id>               mandatory, should be uniqe ID (i.e. a catalog ID), reuse an ID only when updating existing AIP
            -external_ISIL=<isil>           optional, ISIL number of library
            -external_conservation_flag     optional, if set no other "original" still exists
            -external_value_descr=<text>    mandatory, the reason why to archive
            -rights_version=<version>       mandatory, SLUB law managment specification, supported <1.0>

            -rights_xml=<file>              mandatory, path to SLUB rights xml file(absolute path!)
            -add_meta_file=<file>           optional, can be repeated, additional meta files(absolute path!)
            -add_key_value=<"key:value">    optional, can be repeated, additional key value pairs for bag-info.txt

Options:
    -help   Print a brief help message and exits.