Bottom of Page     Previous Chapter    

TFM Database

  • Server
  • HSQLDB
  • Administration
  •     - Import...
        - Export...
        - Export Whole DB
        - Backup Database
        - Restore Database
        - Database Admin
            * DB Admin

    Server

    TFM uses a relational database accessed with Structured Query Language(SQL) via Java Database Connectivity(JDBC) for it's server. TFM is capable of using any SQL database that allows a JDBC connection. This information is included for reference only. The office staff does not need to be concerned about this JDBC.

    HSQLDB

    TFM is distributed with a database server called HSQLDB. It is an open source database that means it is maintained by an Internet community and is freely available for use. It is a Java™ application and will run on any 1.3 or 1.4 JVM on any platform. More information and documentation can be found at the HSQL website. The office staff does not need to be concerned about the HSQLDB licensing however, installation of the HSQLDB is a separate operation. Refer to the TreFre Medical web site for details.


    Administration

    TFM has some database administration utilities in the File menu of the TFM Main Menu. These include Import..., Export..., Export Whole DB , Backup Database, Restore Database, and Database Admin.

    Import...

    This allows you to import any TFM formatted export file into the database.

    Export...

    This allows you to export data from the database in TFM format for any given database table or TFM object type.

    Export Whole DB

    This allows you to export all TFM data into a directory of TFM formatted export files.

    Backup Database

    This menu option is only available when TFM is running on the same computer that the TFM Database server is running. Selecting the menu option instructs TFM to make a backup of all the data currently in the TFM database. Every office must decide what is the appropriate time interval when backups must be performed. In the case where a severe computer malfunction occurs, it is possible that the computer and all TFM data on it may be destroyed. The office must be prepared to recover all TFM data in this situation. By backing up the TFM data on a regular basis, after the computer is repaired, all TFM data could then be restored to it's original state.

    Likewise, it is possible that some TFM data in inadvertantly deleted by the office staff. By maintaining a recent backup, deleted data may be restored. Future versions of TFM will make restoration of individual data records possible.

    When this menu option is selected, the TFM database server will automatically shut down. This is a requirement so that all data can be successfully saved. When complete, the sever will automatically restart. If access to the computer is password protected, the password will be required to restart the TFM server. The saved data will be created in a file named with the current date. The file will be stored in the database backup folder specified in the File Locations chapter.

    Restore Database

    This menu option is only available when TFM is running on the same computer that the TFM Database server is running. This menu option instructs TFM to restore all TFM data from a previous backup. A file selection screen will be displayed to select the appropriate backup file to restore from.

    Database Admin

    This password protected dialog allows authorized personnel to perform some select database operations. You can run an SQL tool with the "DB Admin" button, import a testing database with the "Import Test DB" button or rebuild the entire database with the "Rebuild" button. If not used correctly, these operations can destroy all of the information stored in the TFM database. The password will only be provided to customers by the TFM staff on an as-needed basis.


    Top of Page     Previous Chapter