This exporter was created for the Australia’s Asian Garrisons, based at Macquarie University, Sydney, and Monash University, Melbourne, Australia. The exporter and the corresponding module were designed to record archival documents in degraded conditions. The archives were often without stable internet connection, without access to scanner / photocopier with the exception of mobile phone for taking pictures. The server exporter compiles taken photos into PDF format and automatically attaches available metadata, and provides OCR text version of the scanned document.
This exporter was co-developed by Prof Sean Brawley at Macquarie University, Department of Modern History, Politics and International Relations and Shawn Ross and Brian Ballsun-Stanton at the FAIMS Project, Department of Ancient History, Macquarie University.
Development of this exporter was funded by the Australian Research Council Discovery Grant ARC DP160100750 and by the Research Attraction and Acceleration Program (RAAP) NSW Department of Industry 16805/00 aimed to support innovation and investment in the New South Wales in 2016 and 2017.
April 2016
FAIMS v2.5 (Android 6+)
This exporter is licensed under an international Creative Commons Attribution 4.0 Licence (CC BY 4.0).
This exporter can be downloaded directly from this repository and used on FAIMS v2.5 server
- Clone the repository
- Create a tarball (tar.gz) of the repository directory (Do you know how-to-manage a tarball?)
- Upload the tarball to the server through the plugins interface (for details, see below)
- PDF with compiled photos in original quality and colours
- PDF with Black & White enhanced and compiled photos
- Structured archival metadata appended to all records
- OCR version of the compiled photos, saved as .txt
- Immediate field use with FAIMS Scanner or Document Scanner
- Output Data format: Custom PDFs with attached metadata, .txt file
For more details about the Australia’s Asian Garrisons please visit http://artsonline.monash.edu.au/australias-asian-garrisons. If you have any questions about the Australia’s Asian Garrisons, contact jodie.boyd@monash.edu.
If you have any questions about the module, please contact the FAIMS team at enquiries@fedarch.org and we will get back to you within one business day.
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.