Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Once installed, the service will be exposed from your servlet container at "diringest/ingestSIP". For example:

Panel

http://localhost/diringest/ingestSIP

...

Navigating the URL above using your browser will present a simple HTML form where you can upload a SIP file, an optional rules file (if you want to use non-default conversion rules). Select "Submit". A successful submission will result in an XML file that contains a list of the PIDs of the objects that were ingested.

...

A successful response will return a 200 (OK) HTTP status code and a simple XML file containing PIDs, such as the one below:

Code Block
xml
xml
borderStylesolid

<?xml version="1.0" encoding="UTF-8"?>

...


<pidList>

...


  <pid>demo:42</pid>

...


  <pid>demo:43</pid>

...


  <pid>demo:44</pid>

...


  <pid>demo:45</pid>

...


</pidList>

4. Using the SIP2FOX Utility

The "SIP2FOX" utility is useful for command-line testing of SIPs and conversion rules. It is included in the distribution's "sip2fox" directory. To invoke it, change to that directory and type:

Panel

sip2fox sipFile.zip outputDir [fedoraHost fedoraPort fedoraUser fedoraPass pidNamespace]

If you only specify a SIP file and an output directory, the program will use a test PID generator for creating the objects. If you specify Fedora Repository login information, that repository's PID generator will be used instead. To use a PID namespace other than the default for a repository, specify it as the last parameter.

The SIP2FOX utility uses the rules that reside in the config/crules.xml when it runs.

5. Preparing a SIP
Anchor
sip
sip

A SIP file is a ZIP file containing metadata and content for a set of to-be-created Fedora objects.

...

Sample SIP files and a readme.txt file with descriptions of each are included in the sip2fox/samples directory in the diringest distribution.

6. Specifying Conversion Rules
Anchor
rules
rules

A conversion rules file is used by the service (or sip2fox) in deriving RELS-EXT relationships from the hierarchical structure (the structMap) in the SIP.

...