faims / xmlexporter

FAIMS XML custom exporter, customised for Alveo and Open Context

Custom XML exporter

About this exporter:

This exports exports module data as XML files, required by specific projects such as for Alveo Virtual Lab or OpenContext.

Authorship:

This exporter was developed by Brian Ballsun-Stanton at the FAIMS Project, Department of Ancient History, Macquarie University.

Funding:

Development of this module was funded by ARC LE140100151, FAIMS: Transforming archaeological research through digital technologies

Date of release:

2016

FAIMS Mobile / server version:

FAIMS v2.6 (Android 8+)

Licence:

This exporter is licensed under an international Creative Commons Attribution 4.0 Licence (CC BY 4.0).

Access:

This exporter can be downloaded directly from this repository and used on FAIMS v2.6 server

1. Clone the repository
2. Create a tarball (tar.gz) of the repository directory (Do you know how-to-manage a tarball?)
3. Upload the tarball to the server through the plugins interface (for details, see below)

This exporter contains the following features:

• Exports records as custom XML file

Exporter Use Recommendations:

• Immediate field use with projects such as Alveo or OpenContext
• Demonstration and inspiration for other similar customisations

Contact info:

If you have any questions about the exporter, please contact the FAIMS team at [email protected] and we will get back to you within one business day.

General How-to Info to Exporters

Based on the 'FAIMS User to Developer Documentation' and 'FAIMS Data UI and Logic Cook Book' To get the data you have collected with the FAIMS Mobile app in a viewable, usable fashion, you'll need to find and download an exporter. An exporter allows you to export data from FAIMS server in many data formats (CSV, shapefile, sqlite database, json etc.). Each exporter has been customised for individual projects, but with none or minor changes it can be reused for other projects.

How do I make it work?

• On a PC, you can simply download / clone the file from GitHub.
• Create a tarball from the exporter using a program like 7zip; if you're using UNIX, enter something like tar -czf shapefileExport.tar.gz shapefileExport
• Now, if you navigate on the server to your module, you'll see a tab at the top labeled 'Plugin Management'. Click that and you'll be brought to a page with the handy feature, 'Upload Exporter'. Choose the tarball you've just created and hit 'Upload'. You now have an exporter permanently stored to your FAIMS server and may make use of it whenever you'd like.
• From now on, whenever you'd like to use your uploaded exporter, navigate to your module from the main page on the server and click 'Export module'. Select from the dropdown menu the exporter you'd like to use, review and select from any additional options, and click 'Export'.
• You'll be brought to your module's background jobs page while the server exports your data. After a few moments, you should be able to hit 'Refresh' and see a blue hyperlink to 'Export results'. Clicking that will allow you to download your exported data in a compressed file.

Exporting data doesn't close down the project or prevent you from working any further on it, so feel free to export data whenever it's convenient.