6.8. Export do eARK

Balíčky je možné převádět a exportovat do výměnného formátu eARK dle platného českého profilu, viz https://stands.nacr.cz/da-aip/. Převod je realizován dvou krokově:

  • výběr balíčků k exportu na straně ESM

  • volání konverzního nástroje, který balíčky převede do formátu eARK

Obě činnosti jsou dostupné v agendě Exportních dávek.

6.8.1. Nástroj pro převod

Nástroj pro převod balíčků je samostatná aplikace, která se spouští z příkazové řádky nad jednotlivým balíčkem a souvisejícími metadatay. Nástroj je možné také spustit v dávkovém režimu prostřednictvím ESM.

Zdrojový kód nástroje je dostupná v repozitáři: https://gitlab.lightcomp.cz/ukais/earkconvert

Vývojová sestavení jsou dostupná na adrese: https://frnk.lightcomp.cz/download/cuni-ais/snapshots/earkconvert/

Nástroj pro svůj běh vyžaduje Java 17 a vyšší.

Parametrizace nástroje

Nástroj je možné spustit vždy pro převod jednoho balíčku.

earkconvert [--orig-ids|-i] [--scope|-s <rozsah>] [--unpacked|-d] [--mets|-m <soubor s metadaty>] [--ead|-e <soubor s pomůckou>] [--uuid|-u <UUID cílového balíčku>] [--workdir|-w <adresář>] <input> <output>

Parametry:

  • --orig-ids nebo -i: zachování původních identifikátorů souborů a balíčku (pro předání do Elza)

  • --scope nebo -s: rozsah výsledného balíčku, viz Rozsah balíčku; výchozí aip_base

  • --unpacked nebo -d: výstup bez zabalení do ZIP, viz Výstup bez zabalení do ZIP

  • --mets nebo -m: cesta k souboru s metadaty balíčku (METS XML)

  • --ead nebo -e: cesta k souboru s archivní pomůckou (EAD XML)

  • --uuid nebo -u: UUID cílového balíčku, pokud není zadáno, bude vygenerováno automaticky

  • --workdir nebo -w: pracovní adresář, kam se uloží dočasné soubory a výsledný balíček

  • <input>: vstupní soubor nebo adresář, který obsahuje datový obsah balíčku

  • <output>: výstupní adresáře, kam bude uložen výsledný eARK balíček a jeho protokol

Výsledkem převodu je balíček v podobě <uuid>.zip ve výstupním adresáři a protokol s průběhem převodu a případnou chybou v souboru <uuid>.log. Při použití --orig-ids je identifikátorem balíčku číslo archiválie, výsledný soubor se pak jmenuje <číslo archiválie>.zip (například 436848.zip); protokol zůstává <uuid>.log.

Nástroj je možné spustit ve třech režimech:

  • s jedním vstupním parametrem (soubor), kdy balíček je předán ve formě jednoho ZIP souboru

  • s jednim vstupním parametrem (adresář), kdy balíček je předán jako adresář, který obsahuje soubor s metadaty a další ZIP soubor s datovým obsahem

  • s více vstupními parametry, kdy je možné předat jak soubor s metadaty, tak datový obsah jako ZIP soubor a také UUID cílového balíčku

Příklad spuštění s více vstupními parametry, výstup bude uložen do adresáře D:\earkconvert.work\output:

earkconvert -w D:\earkconvert.work\work -u 3b87a2a5-d26f-4475-a979-f6dfe61b339e -m "D:\earkconvert.work\extracted\3b87a2a5-d26f-4475-a979-f6dfe61b339d\3b87a2a5-d26f-4475-a979-f6dfe61b339d_xml_6.xml" "D:\earkconvert.work\extracted\3b87a2a5-d26f-4475-a979-f6dfe61b339d\3b87a2a5-d26f-4475-a979-f6dfe61b339d.zip" D:\earkconvert.work\output

Rozsah balíčku

Software pro zpracování archiválií (Elza) si může přes DA API vyžádat balíček v několika rozsazích (parametr dipType dle NMET2, viz https://stands.nacr.cz/da-zpracovani/). Odpovídající rozsah se nástroji předává parametrem --scope:

rozsah

obsah výsledného balíčku

aip_base

úplný balíček: metadata i binární data komponent (výchozí hodnota)

metadata_base

metadatový balíček: METS.xml, PACKAGE-INFO.xml, archivní popis (EAD) a metadata o uchování (PREMIS), bez binárních dat komponent. Adresář representations v balíčku není.

archdesc

pouze archivní metadata jako samostatné soubory PACKAGE-INFO.xml, EAD-INHERENT.xml a EAD-CONTEXT.xml (pokud existují), bez METS.xml a bez adresářové struktury

V rozsahu metadata_base je METS.xml shodný s úplným balíčkem: obsahuje úplný seznam souborů (fileSec) i obě strukturální mapy a RETENTION-METADATA.xml popisuje i soubory, které v balíčku fyzicky nejsou. Identifikátory všech součástí balíčku jsou tak shodné bez ohledu na rozsah, což umožňuje následné vyžádání jednotlivých komponent podle jejich identifikátoru (POST /download/files).

Rozsah package_info (samostatný PACKAGE-INFO.xml) nástroj zatím nenabízí.

Výstup bez zabalení do ZIP

Dávka ke stažení podle NMET2 je tvořena sadou adresářů pojmenovaných identifikátorem balíčku, v nichž je obsah balíčku umístěn přímo. Pro tento účel slouží parametr --unpacked:

  • obsah balíčku (METS.xml, metadata, representations) se zapíše přímo do adresáře <output>, nevzniká ZIP ani vnořená kořenová složka s identifikátorem balíčku

  • adresář <output> musí být prázdný nebo nesmí existovat (bude vytvořen); jinak převod skončí chybou ještě před zahájením

  • za pojmenování adresáře <output> (identifikátor balíčku, tj. číslo archiválie při --orig-ids) odpovídá volající, tedy ESM

  • protokol <uuid>.log se v tomto režimu ukládá do nadřazeného adresáře adresáře <output>, aby nebyl součástí balíčku

Příklad přípravy balíčku v rozsahu metadata_base do dávky D:\esm\batch\17 pro archiválii s číslem 436848:

earkconvert -w D:\earkconvert.work\work -i -s metadata_base -d D:\esm\export\0ea6e9ad-424f-44dc-9413-373678fccf71.zip D:\esm\batch\17\436848

Výsledkem je adresář D:\esm\batch\17\436848 s obsahem balíčku a protokol D:\esm\batch\17\0ea6e9ad-424f-44dc-9413-373678fccf71.log.