rodain.roda-community.orgRODA-In | RODA-in

. RODA-In Tool to create Submission Information Packages (SIP) Download latest release Inspect source code RODA-In RODA-in is a tool specially designed for producers and archivists to create Submission Information Packages (SIP) ready to be submitted to an Open Archival Information System (OAIS). The tool creates SIPs from files and folders available on the local file system. In version 2 we revolutionized the way SIPs are created to satisfy the need for mass processing of data. In this version you can create thousands of valid SIPs with just a few clicks, complete with data and metadata. The tool includes features such as: Create, load and edit classification schemas Automatic association of files/folders to SIP Automatic association of metadata to SIP Definition of metadata templates Support for various metadata formats (EAD, DC, etc.) Creation of SIP of unlimited size Creation of SIP in various formats: BagIt and E-ARK (versions 1.x & 2.x) This application was part of the RODA project and now has been released as a project by its own due to the increasing interest in its particular functionality. It was further developed in the E-ARK project and now it is being developed in the CEF eArchiving Building Block . Supported SIP formats RODA-in supports several Submission Information Package formats. At the moment we have included support for: BagIt, a hierarchical file packaging format for storage and transfer of arbitrary digital content. A bag” has just enough structure to enclose descriptive tags” and a payload” but does not require knowledge of the payload’s internal semantics. This BagIt format should be suitable for disk-based or network-based storage and transfer. BagIt is widely used in the practice of digital preservation. The specification of BagIt can be found here . E-ARK SIP format, both versions 1.x & 2.x, a Submission Information Package format developed by the EU funded E-ARK Project and maintained by the Digital Information LifeCycle Interoperability Standards Board (DILCIS Board). The specification can be found here . Requirements RODA-in has been successfully tested on Windows, MacOS and Linux Desktop versions. The RODA-in installer comes with a free and open-source version of Java included and will use the internal Java by default. Download pre-compiled version The latest version of RODA-in is available here . How to use The basic workflow of the application is as follows: Choose a working folder in your file system (panel on the left). This will serve as the root of your project. Choose or create a classification scheme (panel on the center). There’s two options: Load a classification scheme. You can obtain a classification scheme from RODA repository, for example. Create a new classification scheme. Drag files/folders from the left panel to the center panel into the appropriate node in the classification scheme. Choose the creatorOption of data and metadata association. This will have impact on the number and structure of the SIPs created. (Optional) Inspect the created SIPs, edit metadata and content. Export the SIPs to a folder To select more than one file/folder you can press SHIFT or CTRL. The following actions are supported to edit the classification scheme: Add node Edit the title and the description level of the node Move node (using drag and drop) Change parent Move to the root of the tree Remove node Tutorials In this section you may find a few video tutorials on how to use the RODA-in tool to create Submission Information Packages (SIP). How to download and run the application How to create SIPs from local files and folders Advanced ways of creating SIPs The templating system Since it’s tedious to edit the template files by hand, we added a way to create forms based on the fields of the templates. These files are located in the roda-in” folder (My Documents when using Windows and the user’s home directory if using Unix), under the templates” folder. Using the powerful Handlebars engine, anyone can create template files with the necessary information to create the form. In addition to a simple tag, (e.g. ), we can now add options which will modify the way each field is created. These options are key-value elements, e.g. title="SIP creation using RODA-in" , where the key is the name of the option and the value is the value that will be given to that option. Only the first tag should have options, i.e., if there’s two tags with the same name, the options of the second are ignored. The options are not required, the form is still created with a simple tag, which creates a simple text field. The available options that alter the fields created for each tag are: value - the predefined value of the field order - the order of the field type - the type of the field. The possible values are: text - text field text-area - Text area. Larger than a field text. date - text field with a date picker list - list with the possible values (combo box) list - List with the possible values that a field can have. Usable when type="list" . The format is a JSON array. Example: [option A, option B, "option C"] label - The label that appears to the left of the field. mandatory - If set to true the label is styled in bold to draw attention. hidden - If set to true the field is hidden auto-generate - Fills the value with one of the available generators. Overrides the value option: now - the current date in the format year/month/day id - generates an identifier title - generates a title level - adds the current description level parentid - adds the parent’s id, if it exists language - adds the system language, based on the locale. Example: português” or English” The following is an example of how the tags can be used: {{ title order = 1 type = "text" label = "Template title" mandatory = true auto-generate = "title" }} How to build from source Make sure you have installed Java 8 and Maven. Clone the repository by issuing the command git clone https://github.com/keeps/roda-in.git Change directory to roda-in” Install by running the following command: mvn -Dmaven.test.skip=true clean package That’s it! Binaries will be on the target folder. To run the application just double click on the file or run the following command on the console/terminal: java -jar roda-in-app-x.y.z.jar RODA-in uses TestFX to execute tests using the user interface. TestFX needs full control of the mouse and keyboard when running the tests, so you won’t be able to use them. In order to make the tests run in the headless mode (so that they can run in the background) follow these steps: Download the Monocle graphic environment jar Copy the jar to JDK_HOME/jre/lib/ext Run the command mvn clean package -Dtestfx.robot=glass -Dglass.platform=Monocle -Dmonocle.platform=Headless -Dprism.order=sw Troubleshooting How do I change the default metadata that is added to SIPs? Metadata templates exist under the folder roda-in” in your home directory (Documents” for Windows users). Open the files with your favourite text editor and make sure they remain valid XML files acording to the provided schemas. Got error java.lang.OutOfMemoryError: Java heap space”. What do I do? The application might need more memory than what is available by default (normally 64MB). To increase the available memory use the -Xmx option. For example, the following command will increase the heap size to 3 GB. $ java -Xmx3g -jar roda-in-app-x.y.z.jar The application needs enough memory to put the file structure definition in memory (not the data). Commercial support For more information or commercial support, contact KEEP SOLUTIONS . Further reading Bagit specification E-ARK SIP specification (all versions) E-ARK SIP specification (latest version) E-ARK Common specification (all versions) E-ARK Common specification (latest version) RODA source code RODA Community Web site E-ARK Project Web site CEF eArchiving Building Block RODA-in master thesis (2016) Contributing Maven is required to build RODA-in. Fork it! Create your...