Import of Sisis SunRise Files
This documentation describes the installation, configuration and use of the plugin to import Sisis SunRise files.
Details | |
Identifier | intranda_import_sisis_sunrise_files |
Source code | https://github.com/intranda/goobi-plugin-import-sisis-sunrise-file |
Licence | GPL 2.0 or newer |
Compatibility | Goobi workflow 2021.01 |
Documentation date | 16.07.2021 |
The plugin must be installed in the following folder:
/opt/digiverso/goobi/plugins/import/plugin_intranda_import_sisis_sunrise_file.jar
There is also a configuration file, which must be located at the following location:
/opt/digiverso/goobi/config/plugin_intranda_import_sisis_sunrise_file.xml
Additionally there is a tags file, whose location is specified in the configuration file:
<tags>/path/to/tags.txt</tags>
The configuration is done via the configuration file plugin_intranda_import_sisis_sunrise_file.xml and can be adapted during operation.
<config_plugin><config><!-- which workflow template shall be used --><template>*</template><!-- define if import shall use GoobiScript to run in the background --><runAsGoobiScript>true</runAsGoobiScript><!-- Ruleset for the MM files: --><rulesetPath>src/test/resources/ruleset.xml</rulesetPath><!-- Path to images: --><imagePathFile>/opt/digiverso/import/images</imagePathFile><!-- Ruleset for the MM files --><tags>/opt/digiverso/import/tags.txt</tags><!-- Use SGML files? --><withSGML>false</withSGML><!-- Path to SGML files, if withSGML --><sgmlPath></sgmlPath><!-- default publication type if it cannot be detected. If missing or empty, no record will be created --><defaultPublicationType>Monograph</defaultPublicationType><!-- Collection name --><collection>Disserationen</collection><!-- Prefix to add to every ID number --><idPrefix>mpilhlt_sisis_</idPrefix><!-- Remove the image files from their original folders --><moveFiles>false</moveFiles><!-- List of IDs to import. If empty, import all files --><listIDs></listIDs></config></config_plugin>
The configuration allows different configurations for different process templates. For this purpose, only the name of the desired template must be entered in the template field. The entry with the value * is used for all templates for which no separate configuration exists.
Configuration Element | Use |
| This is the path to the ruleset for the MetsMods files. |
| This parameter defines the path to the image files, which are located either in the folder itself or in subfolders with the name of the Catalogue identifier. |
| This parameter defines the translation file that translates mab2 codes into metadata. |
| If this parameter is set to |
| If SGML files are used, this is the folder in which they are found. |
| With this parameter the Type of the document is defined if it has no children or parents. A document with children is imported as MultiVolumeWork, the children are imported as Volumes. |
| This specifies the metadata |
| Here you define the path to a text file containing a list of Catalogue Identifiers. If this field is not empty, then only datasets with these Catalogue Identifiers will be imported from the Sisis SunRise file. |
A tags file may look something like this:
0000 CatalogIDDigital0014 shelfmarksource0015 DocLanguage0024 CurrentNoSorting0025 CurrentNoSorting0089 CurrentNo0100 Author0101 OtherPerson0200 Corporation0201 Corporation0304 OtherTitle0310 TitleDocMain0331 TitleDocMain0335 TitleDocSub10341 OtherTitle0359 StatementOfResponsibility0361 Note0403 EditionStatement0410 PlaceOfPublication0412 PublisherName0413 Printer0425 PublicationYear0432 Stock0433 physicalDescriptionExtent0440 PrintingLocation0451 TitleDocMainSeries0501 Note0519 DissertationNote0540 ISBN0590 Resource0655 URLbib0902 SubjectTopic0907 SubjectTopic0912 SubjectTopic0917 SubjectTopic0922 SubjectTopic0927 SubjectTopic0932 SubjectTopic0937 SubjectTopic1371 OtherTitle
Each line contains a MAB code, followed by the name of the metadata which it should be translated to. Every metadata type in the list must be defined in the ruleset used for the project into which the file is to be imported, and the CatalogIDDigital must be defined, as it is used to create the process ID.
To use the import, the mass import area must be opened in the process templates and the intranda_import_sisis_sunrise_file plugin must be selected in the File upload import tab. A Sisis SunRise file can then be uploaded and imported.
The import takes place in several steps. First the whole file is read, and the maps child-parent and parent-children are created and saved (as JSON files) in the Goobi temp folder for the current user. These maps are used to create anchor files in the next step.
The Sisis SunRise file is then broken into individual records. For each record, the process title is generated from the Catalogue Identifier (and any prefix specified in the configuration file) and checked to see whether the process already exists in Goobi. If this is not the case, the process is created and the configured metadata for anchor and volume is saved temporarily in a folder in the output path specified in the configuration. Any images are copied into an ´images` subfolder.
In the next step all these folders, containing the MetsMods files and the images, are imported into Goobi workflow as processes, and moved to the appropriate folders in Goobi.
