Skip to content

PyPI version

Incremental xmlupload

When uploading data with the xmlupload command, resources can reference each other with an internal ID, e.g. in the <resptr> tag. Once the data is in DSP, the resources cannot be referenced by their internal ID anymore. Instead, the resource's IRI has to be used. After a successful xmlupload, the mapping of internal IDs to their respective IRIs is written to a file called id2iri_mapping_[timestamp].json.

What is this mapping used for? It can happen that at a later point of time, additional data is uploaded. Depending on what kind of references the additional data contains, there are 4 cases how this can happen:

  1. no references to existing resources: normal xmlupload
  2. references to existing resources via IRIs: incremental xmlupload
  3. references to existing resources via internal IDs: first id2iri, then incremental xmlupload
  4. continue an interruped xmlupload: first id2iri, then incremental xmlupload

1. No references to existing resources

The first case is the simplest one. Nothing has to be considered. The additional data can be uploaded with 

dsp-tools xmlupload additional_data.xml

2. References to existing resources via IRIs

The second case is relatively easy, too: The file additional_data.xml contains references like <resptr>http://rdfh.ch/4123/nyOODvYySV2nJ5RWRdmOdQ</resptr>. Such a file can be uploaded with 

dsp-tools xmlupload additional_data.xml

3. References to existing resources via internal IDs

The third case, however, is a bit more complicated: The file additional_data.xml contains references like <resptr>book_1</resptr>, or <text><a class="salsah-link" href="IRI:book_1:IRI">link to book_1</a></text>, where book_1 was the internal ID of a resource that had previously been uploaded to DSP.

Before such an XML file can be uploaded, its internal IDs must be replaced by their respective IRIs. That's where the JSON mapping file comes in: It contains a mapping from book_1 to http://rdfh.ch/4123/nyOODvYySV2nJ5RWRdmOdQ.

As a first step, a new file must be generated with the id2iri command, like this:

dsp-tools id2iri additional_data.xml id2iri_mapping_[timestamp].json

As second step, the newly generated XML file can be uploaded to DSP:

dsp-tools xmlupload additional_data_replaced_[timestamp].xml

4. Continue an interruped xmlupload

If an xmlupload didn't finish successfully, some resources have already been created, but others have not. If one of the remaining resources references a created resource by its ID, this ID must be replaced by the IRI of the created resource.

In addition, the created resources must be removed from the XML file, otherwise they would be created a second time.

In such a case, proceed as follows:

  1. Initial xmlupload: dsp-tools xmlupload data.xml
  2. A crash happens. Some resources have been uploaded, and a id2iri_mapping_[timestamp].json file has been written
  3. Fix the reason for the crash
  4. Replace the IDs and remove the created resources with: `dsp-tools id2iri data.xml --remove-resources id2iri_mapping_[timestamp].json``
  5. Upload the outputted XML file with dsp-tools xmlupload data_replaced_[timestamp].xml
Last update: September 1, 2023