Create FAIMS Module

Reference ›› FAIMS ››
Parent Previous Next

Creating the FAIMS Module

A Module is a specific instance of a Project (i.e. the current state of the database structure and user interface).

To create a FAIMS module

  1. Having created the database and defined the record types, fields and terms you want to use, select Designer View | FAIMS | Build Project.
  2. Click Select  Record Types.
  3. From the Select Record Types dialog, select the record (entity) types you want in the FAIMS project and click Select

  1. The selected record types are listed.
  2. Click Start Export:

This creates a zip file and provides a link ("Click here to download FAIMS project definitions zip archive") to download it to your laptop/desktop. The file contains the three files required by the FAIMS synchronisation server to create a new FAIMS project.

These two files are ready to roll: they set up the database and provide a usable tablet interface layout. 

At the moment, this file is simply a template which has to be substantially edited to complete a working tablet application. Consult the FAIMS Cookbook athttp://wiki.fedarch.org:8090/display/FAIMS/FAIMS+Data%2C+UI+and+Logic+Cook-Book 

Note. The FAIMS app draws on the W3C XForms standard, Android native functionality and the Open Data Kit (ODK) data collection toolkit, supported by a custom Java Beanshell script to implement the logic of the interface. Until Sept 2013, setup of a module had to be done through a technically demanding and time consuming process of editing three files - db_schema.xml, ui_schema.xml and ui_logic.bsh - a process requiring as much as 5 days even for a simple one entity database. The two XML files can now be generated automatically from a Heurist database; development work for generation of the logic file will be undertaken in 2014.

Created with the Personal Edition of HelpNDoc: Full-featured EBook editor