Page History

Importador y exportador de paquetes

Esta herramienta de línea de comandos te da acceso a los complementos de empaquetado (Packager plugins). Puede ingerir un paquete para crear un nuevo objeto DSpace (comunidad, colección o ítem), o diseminar un objeto DSpace como un paquete.

Para ver todas las opciones, ejecútala de la siguiente manera:

[dspace]/bin/dspace packager --help

Este modo también muestra una lista con los nombres de los complementos de empaquetado para ingestión y diseminación que están actualmente instalados en tu instancia de DSpace. Cada complemento de empaquetado (Packager plugin) también puede permitir opciones personalizadas, que te brindan mayor control sobre cómo se importa o exporta un paquete. Puedes ver una lista de todas las opciones específicas del empaquetador usando la opción --help (o -h) junto con la opción --type (o -t):

[dspace]/bin/dspace packager --help --type METS

El ejemplo anterior mostrará el mensaje de ayuda habitual, además de listar cualquier opción adicional disponible para el complemento de empaquetado "METS".

Formatos de paquete compatibles

DSpace incluye varios complementos preconfigurados para la ingestión y diseminación de paquetes, que te permiten importar y exportar contenido en una variedad de formatos.

Tipos de paquete de envío (SIP) preconfigurados

• AIP - Ingiera contenido que está en el formato de Paquete de Información Archivística (AIP) de DSpace. Se utiliza como parte del AIP Backup and Restore proceso de respaldo y restauración AIP de DSpace
• DSPACE-ROLES - Ingiera usuarios y grupos de DSpace en el esquema XML DSPACE-ROLES. Este formato es utilizado principalmente por el AIP Backup and Restore proceso de respaldo y restauración AIP de DSpace para ingresar o reemplazar usuarios y grupos de DSpace.
• METS - Ingiera contenido que está en el formato METS SIP de DSpace
• PDF - Ingiera un único archivo PDF (del cual se extraen metadatos básicos a partir de las propiedades del documento PDF).

Tipos de paquete de diseminación (DIP) preconfigurados

• AIP - Exporta contenido en el formato de Paquete de Información Archivística (AIP) de DSpace. Se utiliza como parte del AIP Backup and Restore proceso de respaldo y restauración AIP de DSpace.
• DSPACE-ROLES - Exporta usuarios y grupos de DSpace en el esquema XML DSPACE-ROLES. Este formato es utilizado principalmente por el AIP Backup and Restore proceso de respaldo y restauración AIP de DSpace para exportar usuarios y grupos de DSpace.
• METS - Exporta contenido en el formato METS SIP de DSpace

Para obtener una lista de todos los complementos de ingestión y diseminación de paquetes que están actualmente instalados en tu instancia de DSpace, puedes ejecutar:

[dspace]/bin/dspace packager --help

Algunos complementos de ingestión y diseminación de paquetes también cuentan con opciones o parámetros personalizados. Por ejemplo, para ver una lista de las opciones personalizadas del complemento "METS", puedes ejecutar:

[dspace]/bin/dspace packager --help --type METS

Ingesta

Modos y opciones de ingestión

Al ingerir paquetes, DSpace admite varios modos diferentes. (Ten en cuenta que no todos los complementos de empaquetado son compatibles con todos los modos de ingestión).

1. Modo de envío/ingesta (opción -s, por defecto) – Envía el paquete a DSpace para crear uno o más objetos nuevos.
2. Modo de restauración (opción -r) – Restaura objetos preexistentes en DSpace a partir de uno o más paquetes. También intenta restaurar todos los handles y relaciones (objetos padre/hijo). Este es un tipo especializado de "envío", en el que el objeto se crea con un Handle y relaciones conocidas.
3. Modo de reemplazo (opción -r -f) – Reemplaza objetos existentes en DSpace utilizando uno o más paquetes. También intenta restaurar todos los handles y relaciones (objetos padre/hijo). Este es un tipo especializado de "restauración", donde el contenido de los objetos existentes se reemplaza por el contenido de los paquetes AIP. Por defecto, si una "restauración" normal detecta que el objeto ya existe, se revertirán todos los cambios (rollback) y se informará qué objeto ya existe.

Ingestar un solo paquete

Para ingresar un solo paquete desde un archivo, utiliza el siguiente comando:

[dspace]/bin/dspace packager -e [user-email] -p [parent-handle] -t [packager-name] /full/path/to/package

Donde [user-email] es la dirección de correo electrónico de la E-Person bajo cuya autoridad se ejecuta el proceso; [parent-handle] es el Handle del objeto padre en el cual se ingesta el paquete, [packager-name] es el nombre del complemento de ingestión de paquetes que se utilizará, y /full/path/to/package es la ruta completa al archivo que se va a ingresar (o "-" para leer desde la entrada estándar).

A continuación, se muestra un ejemplo que carga un archivo PDF con metadatos internos como un paquete:

[dspace]/bin/dspace packager -e admin@myu.edu -p 4321/10 -t PDF thesis.pdf

Este ejemplo toma el resultado de recuperar una URL y lo ingesta:

wget -O - http://alum.mit.edu/jarandom/my-thesis.pdf | [dspace]/bin/dspace packager -e admin@myu.edu -p 4321/10  -t PDF -

Ingesta de múltiples paquetes a la vez

Algunos complementos de empaquetado (Packager plugins) admiten la funcionalidad de ingesta masiva utilizando la opción --all (o -a). Cuando se utiliza --all, el empaquetador intentará ingerir todos los paquetes secundarios referenciados por el paquete inicial (y continuará recursivamente). A continuación, se muestran algunos ejemplos:

• Para un paquete basado en el Sitio – se ingresarán todas las comunidades, colecciones e ítems según los archivos de paquete encontrados.
• Para un paquete basado en una Comunidad – se ingresará esa comunidad y todas sus subcomunidades, colecciones e ítems según los archivos de paquete encontrados.
• Para una Colección – se ingresará esa colección y todos los ítems que contiene según los archivos de paquete encontrados.
• Para un Ítem – solo se ingresará el ítem (incluyendo todos sus bitstreams y bundles) según el archivo de paquete.

A continuación se muestra un ejemplo básico de una plantilla de comando para ingesta masiva con un 'packager':

 [dspace]/bin/dspace packager -s -a -t AIP -e <eperson> -p <parent-handle> <file-path>

Por ejemplo:

 [dspace]/bin/dspace packager -s -a -t AIP -e admin@myu.edu -p 4321/12 collection-aip.zip

El comando anterior ingresará el paquete llamado "collection-aip.zip" como un hijo del objeto padre especificado (handle = "4321/12"). Al objeto resultante se le asignará un nuevo Handle (ya que se especificó la opción -s). Además, cualquier paquete secundario referenciado directamente por "collection-aip.zip" también se ingresará de forma recursiva (a cada AIP secundario también se le asignará un nuevo Handle).

Restaurar/Reemplazar usando paquetes

Restaurar es ligeramente diferente a simplemente ingresar contenido. Al restaurar, el empaquetador hace todo lo posible por reconstruir el objeto tal como era originalmente (incluyendo su handle, objeto padre, etc.).

Actualmente existen tres modos de restauración:

1. Modo de restauración predeterminado (-r) = Intenta restaurar el objeto (y opcionalmente sus hijos). Si se detecta que algún objeto ya existe, se revierte todos los cambios realizados (rollback).
2. Modo de restauración conservando existentes (-r -k) = Intenta restaurar el objeto (y opcionalmente sus hijos). Si se detecta que un objeto ya existe, se omite (junto con todos sus objetos hijos) y se continúa restaurando los demás objetos que no existen.
3. Modo de reemplazo forzado (-r -f) = Restaura un objeto (y opcionalmente sus hijos) y sobrescribe cualquier objeto existente en DSpace. Por lo tanto, si se detecta que un objeto ya existe en DSpace, su contenido será reemplazado por el contenido del paquete. ADVERTENCIA: Este modo es potencialmente peligroso, ya que destruirá permanentemente cualquier contenido de objeto que no esté presente actualmente en el paquete. Se recomienda realizar una copia de seguridad primero, a menos que esté completamente seguro de lo que está haciendo.

Modo de restauración predeterminado

Por defecto, el modo de restauración (opción -r) revertirá todos los cambios si se detecta que algún objeto ya existe. Se informará al usuario cuál es el objeto que ya existe dentro de su instalación de DSpace.

Utiliza esta plantilla de comando 'packager':

 [dspace]/bin/dspace packager -r -t AIP -e <eperson> <file-path>

Por ejemplo:

 [dspace]/bin/dspace packager -r -t AIP -e admin@myu.edu aip4567.zip

Ten en cuenta que, a diferencia de la opción -s (para envío/ingesta), la opción -r no requiere que se especifique el objeto padre (opción -p ) si este puede determinarse a partir del propio paquete.

En el ejemplo anterior, el paquete "aip4567.zip" se restaura en la instalación de DSpace utilizando el Handle provisto dentro del propio paquete (y se añade como hijo del objeto padre también especificado en el paquete). Si se detecta que el objeto ya existe, se revierten todos los cambios (es decir, no se restaura nada en DSpace).

Modo de restauración conservando existentes

Cuando se especifica la opción "Conservar existentes" (-k), la restauración intentará omitir cualquier objeto que ya exista. Informará al usuario que se encontró un objeto existente (y que no fue modificado ni alterado). Luego continuará restaurando todos los objetos que no existan aún. Esta opción es especialmente útil al realizar una restauración masiva (utilizando la opción --all (o -a)).

Un caso especial a tener en cuenta: si se detecta que una colección o comunidad ya existe, también se omiten sus objetos hijos. Por lo tanto, este modo no restaurará automáticamente ítems dentro de una colección ya existente.

A continuación, se muestra un ejemplo de cómo usar este comando 'packager':

 [dspace]/bin/dspace packager -r -a -k -t AIP -e <eperson> <file-path>

Por ejemplo:

 [dspace]/bin/dspace packager -r -a -k -t AIP -e admin@myu.edu aip4567.zip

En el ejemplo anterior, el paquete "aip4567.zip" se restaura en la instalación de DSpace utilizando el Handle provisto dentro del propio paquete (y se añade como hijo del objeto padre también especificado en el paquete). Además, cualquier paquete secundario referenciado por "aip4567.zip" también se restaurará de forma recursiva (la opción -a indica que también se deben restaurar todos los paquetes secundarios). Estos también se restauran con los Handles y objetos padre definidos en sus respectivos paquetes. Si se detecta que algún objeto ya existe, se omite (junto con sus objetos hijos). Todos los objetos que no existen serán restaurados.

Modo de reemplazo forzado

Cuando se especifica la opción "Reemplazo forzado" (-f), la restauración sobrescribirá cualquier objeto que ya exista en DSpace. En otras palabras, el contenido existente se elimina y luego se reemplaza con el contenido del(los) paquete(s).

A continuación se muestra un ejemplo de cómo utilizar este comando 'packager':

 [dspace]/bin/dspace packager -r -f -t AIP -e <eperson> <file-path>

Por ejemplo:

 [dspace]/bin/dspace packager -r -f -t AIP -e admin@myu.edu aip4567.zip

En el ejemplo anterior, el paquete "aip4567.zip" se restaura en la instalación de DSpace utilizando el Handle provisto dentro del propio paquete (y se añade como hijo del objeto padre también especificado en el paquete). Además, cualquier paquete secundario referenciado por "aip4567.zip" también se ingesta de forma recursiva. Estos también se restauran con los Handles y objetos padre definidos en sus respectivos paquetes. Si se detecta que algún objeto ya existe, su contenido será reemplazado por el contenido del paquete correspondiente.

Si ocurre algún error, el script intentará revertir todo el proceso de reemplazo.

Diseminación

Diseminación de un solo objeto

Para diseminar un solo objeto como un paquete, utiliza el siguiente comando:

[dspace]/bin/dspace packager -d -e [user-email] -i [handle] -t [packager-name] [file-path]

Donde [user-email] es la dirección de correo electrónico de la E-Person bajo cuya autoridad se ejecuta el proceso; [handle] es el Handle del objeto que se desea diseminar; [packager-name] es el nombre del complemento de diseminación de paquetes que se utilizará; y [file-path] es la ruta del archivo que se va a crear (o "-" para escribir en la salida estándar). Por ejemplo:

 [dspace]/bin/dspace packager -d -e admin@myu.edu -i 4321/4567 -t METS 4567.zip

El comando anterior exportará el objeto con el Handle especificado (4321/4567) a un archivo METS llamado "4567.zip".

Diseminación de múltiples objetos a la vez

Para exportar una jerarquía de objetos, utiliza el parámetro de paquete -a (o --all).

Por ejemplo, usa esta plantilla de comando 'packager':

 [dspace]/bin/dspace packager -d -a -e [user-email] -i [handle] -t [packager-name][file-path]

Por ejemplo:

 [dspace]/bin/dspace packager -d -a -t METS -e admin@myu.edu -i 4321/4567 4567.zip

El comando anterior exportará el objeto con el Handle especificado (4321/4567) a un archivo METS llamado "4567.zip". Además, exportará todos los objetos hijos al mismo directorio donde se encuentra el archivo "4567.zip".

Paquetes de Información Archivística (AIP)

Desde DSpace 1.7, DSpace puede realizar copias de seguridad y restaurar todo su contenido como un conjunto de archivos AIP. Esto incluye todas las comunidades, colecciones, ítems, grupos y personas en el sistema.

Esta funcionalidad surgió a partir de la necesidad de que DSpace se integrara mejor con DuraCloud, y otros sistemas de almacenamiento para copias de seguridad. Uno de estos requisitos es la capacidad de "respaldar" esencialmente el contenido local de DSpace en la nube (como una forma de respaldo externo) y "restaurar" ese contenido en un momento posterior.

Esencialmente, esto significa que DSpace puede exportar toda la jerarquía (es decir, bitstreams, metadatos y relaciones entre comunidades, colecciones e ítems) a un formato relativamente estándar (un formato AIP basado en METS). Toda esta jerarquía también puede ser reimportada en DSpace en el mismo formato (lo que equivale a una restauración de ese contenido en la misma instalación de DSpace o en una diferente).

Para más información, consulta la sección sobre respaldo y restauración AIP para DSpace.

Paquetes METS

Desde la versión 1.4 de DSpace, el sistema incluye un diseminador de paquetes y un ingestor correspondiente para el formato DSpace METS SIP (Submission Information Package). Estos fueron creados para ayudar a los usuarios finales a preparar conjuntos de recursos digitales y metadatos para su envío al repositorio, utilizando estándares bien definidos como METS, MODS, y PREMIS. El nombre del complemento es METS por defecto, y utiliza MODS para los metadatos descriptivos.

El perfil METS SIP de DSpace está disponible en: DSpaceMETSSIPProfile