once:radix Documentation

The full Java Development Kit (JDK) is required for JasperReports to function correctly.

This directory contains the PostgreSQL applications.

This directory contains the encrypted database files. They are maintained through the oADMIN backup and restore functions.

This directory contains details about the database users and groups.

PostgreSQL Client Authentication Configuration File.

This file controls which hosts are allowed to connect, how clients are authenticated, which PostgreSQL user names can be used and which databases can be accessed.

To prevent unauthorized access, this file must not be externally accessible.

It needs editing if Tomcat and PostgreSQL are not on the same machine.

Note If any changes are made to pg_hba.conf, PostgreSQL must be restarted.

The example below is the default:

The # IPv4 local connections are:

host all all 127.0.0.1/32 trust

host all once 0.0.0.0/0 md5

The first line allows unencrypted access to the database from the local machine. A valid username is required but the password is not checked. The second line allows any user submitting a valid user name with md5 encrypted password to access the database.

In this next example, the second line could represent a second Tomcat server at location 192.168.111.123. Both the first and second lines allow unencrypted access to the database. In both cases a valid username is required but the password is not checked. The third line allows any user submitting a valid user name with md5 encrypted password to access the database.

# IPv 4 local connections:

host all all 127.0.0.1/32 trust

host all all 192.168.111.123/32 trust

host all once 192.168.111.0/24 md5

PostgreSQL text logs.

Since most logging is handled within once:radix, these log files are seldom used.

Unless you are an experienced PostgreSQL developer, it is recommended that you do not use this feature.

This text file contains the PostgreSQL version number. It is displayed in the PostgreSQL console.

PostgreSQL configuration file.

WARNING: Great care must be taken when accessing this file. There are only two settings that usually require changing:

Set listen_address = '*'

Allows Tomcat and PostgreSQL to be on different machines or the database is to be connected for mantenance from another computer.

Set shared_buffers = 10000

WARNING: Changing this parameter could cause shared memory issues. It is essential that the machine has enough available memory to support larger buffer allocation. For more details, please refer to Managing Kernel Resources

#---------------------------------------------------------------------------

# CONNECTIONS AND AUTHENTICATION

#---------------------------------------------------------------------------

# - Connection Settings -

listen_addresses = '*' # what IP address(es) to listen on;

# comma-separated list of addresses;

# defaults to 'localhost', '*' = all

port = 5432

max_connections = 100

#---------------------------------------------------------------------------

# RESOURCE USAGE (except WAL)

#---------------------------------------------------------------------------

# - Memory -

shared_buffers = 10000 # min 16 or max_connections*2, 8KB each

This directory contains PostgreSQL documentation. Windows and Linux take different forms. It is suggested that you read a good PostgreSQL reference guide or PostgreSQL Documentation

This directory contains PostgreSQL extensions. It is not currently used by once:radix.

The ../Tomcat/bin/ directory contains the Tomcat binaries. With the following exception, its contents are not user accessible.

startup.sh is only required in the Linux/Unix versions of Tomcat:

Add the two export lines as shown below. The first statement increases the size of the Java Heap space to 1 GB.

The second line sets Java to run in 'headless' mode. It is required when running once:radix on a Mac OSX machine.

#!/bin/sh

# -----------------------------------------------------------------------------

# Start Script for the CATALINA Server #

# $Id: startup.sh 385888 2006-03-14 21:04:40Z keith $

# -----------------------------------------------------------------------------

export CATALINA_OPTS="-Xms256m -Xmx1024m";

export JAVA_OPTS="-Djava.awt.headless=true"

Note: The Windows version of Tomcat has an equivalent file - statup.bat - which requires no changes.

This is part of the standard Tomcat distribution, it includes internationalization. JasperReports files here are not used by oSS.

This is part of the standard Tomcat distribution, its contents are not used by once:radix unless a web server is linked to Tomcat.

This is part of the standard Tomcat distribution, it is not used by once:radix unless a web server is linked to Tomcat.

This is part of the standard Tomcat distribution, it is not used by once:radix unless a web server is linked to Tomcat.

WARNING: Great care must be taken when accessing this file.

The once:radix deployment is shipped with only one change to the standard Tomcat distribution. The section affected is as shown below:

<Connector port="8080" maxThreads="50" minSpareThreads="5"
maxSpareThreads="10" enableLookups="false" redirectPort="8443"
acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true"
maxHttpHeaderSize="655360" bufferSize="655360" URIEncoding="UTF-8" />

You may wish to change the port from 8080. The buffer size is set to the maximum value that Tomcat allows:

maxHttpHeaderSize="655360" bufferSize="655360"

DO NOT increase this setting or Tomcat will be unable to start.

Management of once:radix is usually handled entirely through oADMIN. Should you wish to manage the deployment through Tomcat Manager, add the following line to this file:

<user username="admin" password="jake" roles="admin,manager"/>

This setting is not currently recommended unless you are running other Tomcat applications within the same deployment.

This is part of the standard Tomcat distribution, it is not used by once:radix. Its functions are replaced by ../Tomcat/webapps/once/WEB-INF/web.xml.

If something is broken and there is no meaningful information in once.log, look in here. It can safely be deleted when Tomcat is not running.

This contains the standard Tomcat readme documentation. It is useful background, though some details are not relevant to once:radix installations.

This is part of the standard Tomcat distribution. Includes Java library files used exclusively with Tomcat and Tomcat's in-built GUI interface. It is not used by once:radix.

This is part of the standard Tomcat distribution. It is not used by once:radix.

This is part of the standard Tomcat distribution. It is not used by once:radix.

This is the standard Tomcat uninstaller for Windows.

Like all Windows uninstallers, files may be left behind. If your goal is to perform a clean uninstall, you may need to search for hidden files that have failed to be removed. Ultimately, the only way of being sure that everything has been removed is to re-format the drive.

Note that any changes made to the webapps directory are not deleted by this uninstaller.

Clicking on the Admin button on the logon screen loads this file. It is the oADMIN application loader. Using the same referencing system as start.html, the Admin.html file refers to ../once/classes/admin.js which loads and initialises the admin application.

This directory and its subdirectories store the user application block files (such as the startup application package supplied with the open source distribution). It is recommened that each main heading on the Top Menu has its own sub-directory here to make it easier to locate blocks.)

The open source distribution is shown below:

• _blank.css     This is the oED blank CSS page. Must have this file.
• _blank.xml    This is the oED blank XML page. Must have this file.
• admin
• license.css
• license.xml
• contacts
• organization_branch.css
• organization_branch.xml
• organization_contacts.css
• organization_contacts.xml
• organization.css
• organization.xml
• person.css
• person.xml
• index.css     This is the oCLI blank CSS page. Must have this file.
• index.xml    This is the oCLI blank XML page. Must have this file.
• security
• block_block.css
• block_block.xml
• block_details.css
• block_details.xml
• membership_block.css
• membership_block.xml
• membership_details.css
• membership_details.xml
• table_block.css
• table_block.xml
• table_details.css
• table_details.xml
• user_details.css
• user_details.xml

This should be regarded as the minimal installation. To this set, other applications pages would be added. It is good practice to arrange subdirectories to reflect the top-level headings on the Top Menu. The default set includes: admin, contacts and security.

Custom pages are stored in a sub-directory of the same name as the owner organisation name. e.g. "Acme Resources".

Here, blocks are stored in the same paths as in the standard application directories.

If a pair of XML and CSS files for a standard block is stored in ../once/application/contact/ the customised files would be stored in:

  ../once/application/Acme Resouces/contact/

It is recommended that a block be created (and usually accessed through the home page, thus it would usually be stored directly in ../webapps/once/application/.

This page should display a running history of changes and updates to the application.

This directory stores the backups of the database that are generated according to a schedule in oADMIN. oADMIN removes old backups when their expiry date is reached. Files follow the naming convention: auto-once-<date-time>.backup

It also stores the file ../once..lastvacuum which holds the date and time when vacuum was last executed. It is displayed in the licence details screen.

This file contains a shell script that has been designed to move backup files from any once:radix server running on a Unix/Linux platform to a windows backup server. This process is controlled through a Crontab.

It is assumed that the system administrator has experience managing Unix/Linux operating system as some configuration changes are required.

For this file to operate, it must be moved to /usr/bin.

Script

mkdir /mnt/onceshare

mount -t cifs-o username=[username],password=[password] //[windows_IP_address]/windowshare /mnt/onceshare

cd usr/local/tomcat/webapps/once/backup

rm *.tar

tar -czf backup_$(date +%y%m%d).tar.gz

mv *.tar /mnt/onceshare

cd ..

umount / mnt/onceshare

Note Some servers don't support cifs but smbfs will work instead.

Cron Tab entry (Scheduler)

* 1 * * * backup.sh >/dev/null 2>&1 #Once Backup

Note Backup runs at 1am every day.

This file provides a set of rules that govern the format of valid XML when the server's Block Manager converts them between XML and XHTML. It is used by oED and oCLI.

This file is used by oED to add a unique attribute to each element in an XML block file.

This file is used by the Block Manager to convert between XML and XHTML. It is executed when any page (that is not cached) is requested by oCLI. After transformation, the block is cached (as an XHTML file containing HTML, CSS and Javascript), then returned to oCLI.

This file is used by the Block Manager to convert between XML and XHTML before returning to oED.

Note that there is no XSL transformation by oED. The XHTML file is used solely to display the block on screen. A copy of the XML file is also stored in oED. As changes are made to the block, the details are written directly to the XML file. This file is then uploaded to the server when a block save operation is performed.

This is the central hub for oADMIN. It loads blocks, initialises the context menu and other functions. It contains common utility functions, etc.

This contains all of the commands in the oADMIN right-click menu.

This contains a list of all oADMIN error messages.

This contains all keyboard bindings (including shortcut keys) for oADMIN and calls to commands (usually in ContextMenu.js).

This contains the database backup, restore, model recaching and template recaching functions.

This provides functions common to all oADMIN palettes.

This displays the About oADMIN palette.

This defines the behaviour of the oADMIN Database Restore palette.

This defines the behaviour of the oADMIN Schedule Manager palette.

This provides an interface for showing/hiding oADMIN palettes.

This performs SQL console execution via the oADMIN Run SQL command.

This loads and initialises the admin application. It loads the following scripts.

once/config/version.js
Version information for all client side applications and server modules.

once/classes/util.js
Utility functions common to all applications.

once/classes/common/Biscuit.js
Handles getting and setting browser cookies.

once/classes/common/Menu.js
Code for the menus, menu bar and menu items.

once/classes/common/MutableLayer.js
Part of the layers library.

once/classes/common/LayerPanes.js
Part of the layers library.

once/classes/common/LayerFeatures.js
Part of the layers library.

once/classes/common/LayerComponents.js
Part of the layers library.

once/classes/common/Source.js
A module that handles sending/receiving XMLHttpRequests.

once/classes/common/md5.js
Handles MD5 hashing of strings (passwords, etc.).

once/classes/admin/Admin.js
The main oADMIN module.

once/classes/admin/ContextMenu.js
Contains all of the commands in the oADMIN right-click menu.

once/classes/admin/Keyboard.js
Contains all keyboard bindings for oADMIN and calls to commands (usu. in ContextMenu.js).

once/classes/admin/PaletteManager.js
Provides an interface for showing/hiding palettes.

once/classes/admin/object/Palette.js
Provides functions common to all palettes.

once/classes/admin/ErrorTable.js
Handles the display of error messages.

once/classes/admin/SQL.js
Runs a given SQL command on the server.

once/classes/admin/Maintenance.js
Performs maintenance operations (recaching models, templates, etc.).

once/classes/admin/object/Palette.js
Provides functions common to all palettes (repeated).

once/classes/admin/palette/RestorePalette.js
Defines the behaviour of the database restore palette.

once/classes/admin/palette/AboutPalette.js
Defines the behaviour of the about palette.

once/classes/admin/palette/SchedulePalette.js
Defines the behaviour of the schedule manager palette.

once/data/adminPalettes.xml
Contain controls for all of the palettes (no style info.) for oADMIN.

The following CSS files are also referred to by the HTML file:

once/css/admin.css
Refers to all of the different CSS files used by oADMIN.

admin.css refers to:

layers.css
Part of the layers library.

admin/admin.css
Defines the appearance of general oADMIN interface elements.

common/oldmenu.css
Defines the appearance of menus, menu bars and menu items.

layers.css refers to:

common/layers.css
Part of the layers library.

common/ghost.css
Part of the layers library.

This contains all the run-time implementations of the once:radix script commands.

This is a library of functions that package up requests to some of the action servlets. e.g. exporting and printing. Note that some actions were implemented directly in actionsLibrary.js and other areas.

This is the central hub for oCLI. It loads blocks, initialises the context menu and other functions. It contains common utility functions, etc.

This shows the menu and runs all the commands visible in the menu. The base functionality is provided by ../common/menu2/Menu.js.

This defines the appearance and behaviour of the calendar control.

This defines the appearance and behaviour of Gantt chants. (both drag and drop and earlier static type).

This controls the appearance and behaviour of the control that manages uploads and downloads.

This contains definitions for all the errors that can occur in oCLI.

This provides extra functions that extend the standard Javascript array objects.

This contains all keyboard bindings for oCLI and calls to commands (usually in ContextMenu.js).

This contains translations for messages, labels and other text.

This is the fast data view (table) mode. Not finished or implemented.

This is responsible for actions performed on parent records. e.g. navigating, deleting, creating, counting, etc.

This provides functions common to all palettes, for compatibility with the Layers library.

This defines the behaviour of the About oCLI palette.

This defines the behaviour of the About This User palette.

This defines the behaviour of the text area palette (Details) which can be initiated using the editAsArea() and subblockEditAsArea() script commands.

This defines the behaviour of the Email... palette.

This defines the behaviour of the Export... palette.

This defines the behaviour of the underlay for the About oCLI palette.

This defines the behaviour of the Field Index... palette.

This defines the behaviour of the pull-up List palette.

This defines the behaviour of the Open... block palette.

This defines the behaviour of the Continue palette that asks the user to enable popups during log on for the first time to a server.

Popups are used for visual feedback in scripting (e.g. if a script is using 100% of CPU time, popups enable the operation to be interrupted so the screen can be updated to indicate progress) and the openNewWindow() command.

This defines the behaviour of the Preferences... palette.

This defines the behaviour of the Print... palette.

This displays a progress bar for the thumbnail, file and Templates... upload palettes.

This defines the behaviour of the Replace... palette.

This holds the sort orders for the currently-displayed blocks. There will be an instance for the parent block and each subblock, whether visible or hidden.

This holds details about database fields on the page and their sort direction. There is an instance for each field. For sorted fields, the field name and sort direction are stored. For unsorted fields only the field name is stored.

This defines the behaviour of the sort palette. It refers to SortBlock.js and SortOrder.js

This defines the behaviour of the Templates... upload palette.

This defines the behaviour of the progress palette used for file uploads (not used, see ProgressPalette.js).

This defines the behaviour of the Choose Thumbnail... and Choose File... palettes. They are used for uploading files to the server and attaching links to them in database fields.

This provides an interface for showing/hiding palettes.

This stores and retrieves user preferences. It is called by PreferencesPalette.js.

This handles dynamic changes to stylesheet information.

This contains code for moving between and displaying subblock records.

This loads and initialises the client application. It also loads the following Javascript files:

once/config/version.js
Version information for all client side applications and server modules.

once/classes/util.js
Utility functions common to all applications.

once/classes/common/Biscuit.js
Handles getting and setting browser cookies.

once/classes/common/menu2/Menu.js
The menu container for new style menus.

once/classes/common/menu2/MenuBar.js
The menu bar part of new style menus.

once/classes/common/menu2/MenuItem.js
Code for menu items in menus.

once/classes/common/menu2/MenuMetrics.js
Measurements that define the size/shape of menus.

once/classes/common/menu2/MenuSeparator.js
Code for separators in menus.

once/classes/common/menu2/MenuTitle.js
Code for menu items in menu bars.

once/classes/client/Language.js
Contains translations for messages, labels and other text.

once/classes/common/database/DatabaseQuery.js
Runs and caches results from database queries.

once/classes/common/database/Record.js
Groups sets of WHERE ... AND restrictions.

once/classes/common/database/QueryPage.js
An interface for accessing a single database tuple.

once/classes/common/MutableLayer.js
Part of the layers library.

once/classes/common/LayerPanes.js
Part of the layers library.

once/classes/common/LayerFeatures.js
Part of the layers library.

once/classes/common/LayerComponents.js
Part of the layers library.

once/classes/client/Client.js
The main oCLI module.

once/classes/common/Source.js
A module that handles sending/receiving XMLHttpRequests.

once/classes/common/Transformer.js
Transforms XML to XHTML via XSL.

once/classes/common/DateParser.js
Parses date strings and formats date numbers.

once/classes/client/ContextMenu.js
Contains all oCLI menu commands.

once/classes/client/action/ActionsLibrary.js
Contains all oCLI scripting commands.

once/classes/client/action/Protagonist.js
Handler for ñactionsî (servlets) on the server, packages up requests, etc.

once/classes/common/database/QueryParser.js
Converts find criteria to SQL wildcard patterns.

once/classes/client/Navigator.js
Handles moving between parent records.

once/classes/client/StyleManager.js
Handles dynamic changes to stylesheet information.

once/classes/client/Keyboard.js
Contains all keyboard bindings for oCLI and calls to commands (usu. in ContextMenu.js).

once/classes/client/Prefaroni.js
Stores and retrieves user preferences for oCLI.

once/classes/client/PaletteManager.js
Provides an interface for showing/hiding palettes.

once/classes/client/object/Palette.js
Provides functions common to all palettes.

once/classes/client/palette/SortPalette.js
Defines the behaviour of the sort palette.

once/classes/client/palette/ExportPalette.js
Defines the behaviour of the export palette.

once/classes/client/palette/OpenBlockPalette.js
Defines the behaviour of the open palette.

once/classes/client/palette/PrintPalette.js
Defines the behaviour of the print palette.

once/classes/client/palette/IndexPalette.js
Defines the behaviour of the field index palette.

once/classes/client/palette/AboutPalette.js
Defines the behaviour of the about palette.

once/classes/client/palette/AboutUserPalette.js
Defines the behaviour of the user (who is) palette.

once/classes/client/palette/PreferencesPalette.js
Defines the behaviour of the preferences palette.

once/classes/client/palette/PopupPalette.js
Defines the behaviour of the first time use palette asking the user to enable popups.

once/classes/client/palette/GangPalette.js
Defines the behaviour of the underlay for the about palette.

once/classes/client/palette/ListPalette.js
Defines the behaviour of the pull up list palette.

once/classes/client/palette/AreaPalette.js
Defines the behaviour of the text area palette used for notes icons.

once/classes/client/palette/TemplatePalette.js
Defines the behaviour of the template upload palette.

once/classes/client/palette/EmailPalette.js
Defines the behaviour of the email palette.

once/classes/client/palette/TransferPalette.js
Defines the behaviour of the progress palette used for file uploads (not used, see ProgressPalette.js).

once/classes/client/Subblock.js
Contains code for moving between and displaying subblock records.

once/classes/common/database/Locker.js
Handles record locking.

once/classes/common/NumberParser.js
Parses and formats numbers.

once/classes/client/ErrorTable.js
Handles the display of error messages.

once/classes/client/control/GanttChart.js
Handles displaying Gantt charts.

once/classes/client/control/Calendar.js
Handles displaying calendar controls.

once/classes/common/md5.js
Handles MD5 hashing of strings (passwords, etc.).

once/classes/common/StringBuffer.js
Fast string builder.

once/classes/common/Matcher.js
Allows a single regular expression to be applied step by step with interactive replacement via JS.

once/classes/client/palette/sort/SortBlock.js
Holds the sort orders for a block.

once/classes/client/palette/sort/SortOrder.js
Holds a single sort order and its direction.

once/classes/client/control/Thumbnail.js
Handles displaying thumbnail controls.

once/classes/client/palette/UploadPalette.js
Defines the behaviour of the thumbnail/file upload palettes.

once/classes/client/palette/ProgressPalette.js
A progress bar for the thumbnail/file/template upload palettes.

once/classes/client/extension/Array.js
Extensions to the default JS Array object.

once/classes/client/palette/ReplacePalette.js
Defines the behaviour of the replace palette.

once/classes/client/ListView.js
Incomplete code for a fast list view of data.

once/data/clientPalettes.xml
Contains controls for all of the palettes (no style info) in oCLI.

The following CSS files are also referred to by Client.html:

once/css/client.css
Stub that refers to all of the CSS files for oCLI.

client.css refers to:

once/css/layers.css
Part of the layers library.

once/css/client/client.css
Appearance of the list view mode.

once/css/client/list-view.css
Appearance of general interface elements in oCLI.

once/css/common/menu2.css
Appearance of menus and menu bars (includes themes).

layers.css refers to:

common/layers.css
Part of the layers library.

common/ghost.css
Part of the layers library.

This handles getting and setting browser cookies.

This is instantiated by BlockManager.js. When an XML and CSS block pair is loaded into oED, this file is used to create the stylesheet and transformer for the blocks that are created and loaded. It is also used to get the XML and XHTML documents for retrieving data or editing.

This is used to create and manage blocks in oED. Creates instances of Block.js for each block.

This sends database requests and caches results from database queries.

This makes requests to the server for record locking and passes details about what records were locked or failed to lock to oCLI.

This object holds sets of WHERE ... AND restrictions. It is equivalent to the restrictions that can be held in one Find page in oCLI. One instance is created for each Find page.

This converts once:radix Find syntax (e.g. >, <, *, ?, !, =, etc.) to the equivalent SQL ILIKE criteria.

This is an interface for accessing a single database tuple (i.e. a row of one or more physical records). It is used whenever a query is made by DatabaseQuery.js

This converts dates & times between a string and PostgreSQL format. It is mostly used in oCLI.

This encapsulates synchronous requests to the server for text data. Newer code now uses this to make HTTP requests. Older code performs this function.

This is the main script in the Layers library.

This is part of the layers library. It sets up the basic parts of layers/palettes.

This is part of the layers library. It is used to allow palettes to be moved, resized (currently disabled) shaded etc.

This is part of the layers library. It is used to allow palettes to have multiple panes/layers; e.g. for tabs.

This is a copy of the Java matcher class. It takes a regular expression, applies it to a body of text multiple times and selectively replaces the captured parts of the expressions using the output of any javascript. It is used in oCLI and oADMIN.

This converts a string to an md5 one-way hash. It is used for passwords in oLOGON and oCLI.

This provides old style menu support for oED, oHELP and oADMIN. It is primarily used for the right-click menu for each application, but could be used for other things.

This is the menu container for new style menus.

This is the container of the menu bar part of new style menus. Currently, this is only implemented in oCLI.

This contains code for menu items in new style menus (including items contained within the Top Menu).

This stores measurements that define the size/shape of menus for the new style menus.

This sets up separators in new style menus.

This contains code for menu items in new style menu bar (Top Menu).

This forms part of the layers library. It handles the basic layer types (tabbed, modal, dialog and plain).

This converts integer and floating point numbers between string and number formats. It is used for formatting numbers (mostly in oCLI).

This is used to construct an instance of a palette. It is called by PaletteManager.js

This creates and manages all palettes.

This module handles sending/receiving XMLHttpRequests. It is used once in oCLI. It is an old version of HttpSyncTextRequest to get XML files for palettes.

This fast string builder is a Javascript implementation of the Java StringBuffer class.

This is used by oED to transform XML to XHTML on the client side.

This handles Delete, Copy, Paste and duplicate functionality between the block displayed on screen and the clipboard. Copy serializes the element information along with the css data and stores the formated data in the clipboard. Paste extracts the copiable data from the clipboard and builds up xml and css data and inserts it into the block.

This displays the menu and runs all the commands visible in the menu. It handles the setting up of the editor's context menu, along with all the functions necessary to perform all the commands that can be performed with the context menu. It also handles enabling and disabling items in the context menu depending on what is clicked. The base functionality is provided by ../common/menu2/menu.js.

Cut is handled by calling copy and delete from clipboard.js.

Help opens the help window and resizes both the editor and the help windows so that they appear side by side.

Logout checks the dirty flag (set whenever changes are made) and prompts the user to save if needed, then loads the login screen.

Move to back copies the xml of the selected element(s) being moved and inserts it at the start of the block, then removes the original element(s) from the block.

Move to front copies the xml of the selected element(s) being moved and appends it to the end of the block, then removes the original element(s) from the block.

New checks the dirty flag (set whenever changes are made) and prompts the user to save if needed, then removes the current blocks xml from the editor, clears the stylesheets sets up the _blank block and opens the page setup palette.

Open checks the dirty flag (set whenever changes are made) and prompts the user to save if needed, then opens the open block palette.

Revert clears the currently open block and stylesheet from the editor and reopens the block. It then refrehses the scripts in the actions palette (if open).

Save calls the save block functionality from the save palette, and clears the dirty flag.

This handles dragging of elements in the editor, including moving the overlays with the mouse, and setting the position of each element in the css when the mouse button is released.

This sets up the managers for the editor, initialises the window, keyboard and mouse bindings. Also included are element insert code, undo, saving and checking for invalid elements (elements that don't match the metamodel chosen).

This is used by various palettes to obtain data sources (models/metamodels/relationships, etc.). Interacts with various servlets (actionDirectory, actionMetamodel) to retrieve metamodel, model and field data.

This handles oED-specific key presses.

This handles language support for oEd.

This provides drag functionality for the Database Manager.

This provides drag functionality for the Database Manager.

This provides drag functionality for the Database Manager.

This provides drag functionality for the Database Manager.

This handles the construction of each palette, sets its size, name, whether it is tabbed, a dialog or modal. It is called from the palette files.

This is a dialog palette that shows version and copyright information. It only has show/hide functionality. Clicking on the palette wil hide it.

The actions palette (script editor) allows scripts to be created, saved, deleted and attached to elements and the block. It keeps a list of Reserved words that aren't allowed to be used in scripts. Maintains arrays, which are inserted into lists, for operators, elements, script actions and action categories. Binds/unbinds elements so that double clicking an element will insert the elements scriptid into the script.

This is a tabbed palette that is used to insert radio buttons, checkboxes, dropdown lists, fieldsets and menus (databound dropdown lists) as well as labels that are linked to the inserted element. Currently only menus can be databound through this palette, however checkboxes can have data associated with them through the format datasource palette. Half-menus (static list of options that get saved to a record) can't be created through this palette yet.

This is used for displaying and changing fill and border colours, border sizes, styles and padding of elements and choosing which sides of the element they apply to.

This is a modal palette. It is used to add style types to the element styles palette for use in styling elements. It holds lists of style types in arrays, grouped by what they affect (background, border, text, etc) which can be chosen via a dropdown list, for the groups, and list box for the style).

This is a modal palette.

There is a list of elements, built up when the palette opens, that can be used to choose which element (as well as the block) that a script can be attached to. This list will automatically load with the selected element, or the block if nothing is selected.

It has a list of events that scripts can be attached to, which is used to dynamically create a dropdown list which is relevant for the selected element.

It has a third dropdown with a list of scripts. When the attach button is clicked the script will be bound to the selected element to fire on the selected event.

This uses the metamodel information from the block to get a list of models that can be used to assign a field. If no elements are selected no model information will be displayed.

Once an element is selected, the model and alias information for that element will be highlighted (or nothing is highlighted if no datasource is assigned).

Pressing remove will remove any datasource information from the element.

Pressing change will assign new datasource information including metamodel, relationship, model, alias, field and datatype. It will also update the label (if linked to the element) to match the alias (minus any underscores).

This is a modal palette.

When the palette is first loaded the current colour of the style that needs to be changed from the selected element is displayed in the colour text field, as well as the RGB values in their respective text fields.

The colour table displays a set of preselected colours that can be single clicked to add the RGB values to the display fields or double clicked to choose and set the chosen colour either in the palette that called it or to the highlighted element.

This loads the metamodel and relationship for the block, and populates a list of the available models from the relationship.

When a model is chosen, it updates the list of alias that can be inserted.

Change Setup button opens the block setup palette.

Multiple aliases can be chosen, either manually with checkboxes, or with Select (all except for keys), Select All and deselected manually or with the Deselect button.

Clicking on the block will set the x/y coordinates at the bottom of the palette, which can be manually overridden.

The insert direction, vertical and horizontal, can be chosen and when Add is clicked, it inserts the selected aliases as field/label pairs (entries).

This is a modal palette.

It is called from the parameters palette to setup date/time formats on the selected field.

Formats can be set by default (using the users login format) or manually using rules that can be set from a list of rules.

Validation rules can also be set, so that only Date, Time or both date and time can be used in the field.

A preview is built using the current formatting that the user has input and displayed in a field. When the formatting is accepted it returns the format back to the parameters palette.

This is used to set horizontal and vertical offsets when duplicating elements. These offsets can include the width of the element that is being duplicated from, or just be a straight offset.

It calls the copy and paste functions from clipboard.js, passing along new x,y coordinates for the pasted element.

The Duplicate > Repeat menu item also calls the duplicate function from the palette, using the stored x,y coordinates.

This contains an element selector made from a table and a series of images. When an image is clicked it changes the style class that the image uses and displays a different image and dynamically displays customisable information for the chosen element.

When an element is selected the cursor changes; and when the user clicks on the block, it builds the xml, xhtml and css, then inserts it into the page.

Elements that can be inserted are labels, fields, entries (fields with labels), buttons, subblocks, rules and images.

The Element Styles palette has a Type dropdown list. It selects the set of rules being changed. The different sets of rules refer to element types.

When a type is chosen it loads the default rules into the list in the palette. If a rule is changed it affects all elements of the type that are using the default rule.

Set as Master extracts the style information for the elements, saves the rules as text in a string and saves it to the _blank stylesheet.

Set Type Master takes the rules out of the css for the selected element and assigns them to the css for all of the same elements in the block.

Delete Attribute removes the rule from the default set of css for the page.

Add Attribute displays the add element style palette, which is used to add a default style to the page for the element type.

If a rule that can have colour set for it is selected, the colour palette button is enabled. Clicking on this button will display the colour palette, and when a colour is chosen its RGB values are passed back to the styles palette and inserted into the rule.

The Font palette displays a Windows or Mac OSX font list, as appropriate.

When the palette is loaded, or an element is selected, it gets the font values from the selected element's css class.

When a font setting is changed, it updates the selected elements css.

Choosing the font colour calls the colour select palette and uses the value manager to receive the colour from the palette, which is then added to the css of the element.

This palette holds a list of existing maps for the selected image, which gets refreshed when an image is selected or when the palette loads.

Creating a new map will bind the click event to the image. When the click event is fired, it takes the x,y coordinates on the image, assigns it to an object that is loaded in the palette and into an array of maps.

When the Create Map button is pressed it saves the map to the xhtml and xml in a CSS imap tag.

When clicking on the image to make a map, or loading an existing map, markers are placed on the coordinates of the map.

This is a modal palette.

The actionImageSave servlet is used to Upload, Delete and rename images on the server. It is also used to create and rename directories.

Navigating and displaying directories uses the actionDirectory servlet.

The Source text field and button are part of an input element with type file. This allows the button to open an OS-specific file navigation dialog that will store the location of a local file in the source field.

When uploading it uses privileged Mozilla functions to get the file as a stream that is then converted into ASCII, which is then passed to the actionImageSave servlet to be uploaded to the server and saved with the name in the destination field.

This defines the behaviour of the Database Manager Alias Editor palette.

This defines the behaviour of the Database Manager Condition Editor palette.

This defines the behaviour of the Database Manager Context Menu.

This defines the behaviour of the Database Manager Model Editor palette.

This defines the behaviour of the Database Manager Open Metamodel Editor palette.

This defines the behaviour of the Database Manager Open Model Editor palette.

This defines the behaviour of the Database Manager Open Model Editor palette.

This defines the behaviour of the Database Manager Relationship Editor palette.

This defines the behaviour of the Database Manager Save Metamodel Editor palette.

This defines the behaviour of the Database Manager Save Model Editor palette.

This defines the behaviour of the Database Manager Table Editor palette.

This provides functionality for the Database Manager.

This provides metamodel editor palette functionality for the Database Manager.

This provides model editor palette functionality for the Database Manager.

This is a modal palette. It is called from the Parameters palette to setup number formats on the selected integer or float field.

Formats can be set by default (using a preset default format) or manually using a list of rules.

A preview is built using the current formatting that the user has input and displayed in a field.

When the formatting is accepted it returns the format back to the parameters palette.

This is a modal palette.

The actionLoad servlet is used to delete and rename blocks on the server. It is also used to create and rename directories.

Navigating and displaying directories uses the actionDirectory servlet. It calls the Block Manager to load the block into the editor. Once the block is loaded it refreshes the metamodels in any open palettes that use metamodels and the scripts in the actions palette.

This opens the metamodel editor palette for the Database Manager.

This opens the model editor palette for the Database Manager.

This opens the table palette for the Database Manager.

This is a modal palette. It can be called by the menu (and shortcut keys) and by the insert data source palette.

It can be used to :

• Change the dimensions of the page
• Turn on and off the page borders
• Set group permissions (which affect the editor reading, editing and deleting, as well as the client reading)
• Set which metamodel and relationship are used and
• Set/unset linkage to a subblock.

If setting the linked subblock option the model and field to link on is also able to be chosen.

When saving changes, it updates the blocks xml and xhtml and also highlights any elements that don't match the chosen metamodel and relationship.

It also refreshes any palettes that display metamodel and relationship information for the page.

On load this sets up bindings on each element, to allow selecting an element and displaying information, and to refresh directory lists.

When an element is selected, or deselected, the relevant attribute's values are taken from the XML and loaded into the fields and controls of the palette.

Scripts are checked to see if the element has any scripts attached to it. If so, they are loaded into two dropdowns, one for the script name and one for the event.

Once the attributes and scripts are loaded the 'frame' is then displayed. The frames are setup to include all of the controls that are needed for each element type inside fieldsets.

When an attribute is changed, the changes are set back into the xml and xhtml. When the script id of an element is changed it is checked to see if any other elements are using that ID. If it matches, a dialog box is displayed and requests a new ID be entered. The old script ID is shown as a suggestion.

Once an ID is accepted, any scripts attached to the element have the scriptid (they are attached to) updated.

When a subblock is selected, the metamodel and relationship can be updated. This takes the blocks metamodel and relationship and assigns them to the XML for the subblock.

This is used to set x,y coordinates, height, width and z index of elements. x,y coordinates, width and height are handled by updating the CSS of the elements. z index handling is limited to move to front and back, and is handled by the Context Menu.

It can be used to resize or move a selection, which is handled by moving the element the farthest left or top (depending on what is being changed and positioning it at the new coordinates), then moving all the other elements to an offset position from the first element based on the offsets before the move.

x,y coordinates can also be manipulated by aligning with other items (top, bottom, left and right). Left and top are handled by taking the x/y position of the leftmost/topmost item and assigning it to the other items in the selection. Right and bottom check each items x/y position added to the width/height to find the item that is farthest right or down the page and setting the x/y minus the width/height for each element.

This is a modal palette.

It displays the editor preferences for the user.

It saves and retrieves the preferences by accessing functions in the prefaroni.js file.

This opens the relationship editor palette for the Database Manager.

This is a modal palette.

The actionSave servlet is used to save the XML to the server.

The actionStyleSave servlet is used to save the CSS to the server.

The actionLoad servlet is used to delete and rename blocks on the server. It is also used to create and rename directories.

Navigating and displaying directories uses the actionDirectory servlet. It calls the Editor.js prepareSave function to package up the XML to be sent to the actionSave servelet.

This is a modal palette.

It builds a list of fields to compile a list of elements on the page and to retrieve information for each element from the models. This is displayed in two lists, unsorted and sorted, depending on which elements are set as sorted in the sort tag in the XML file.

Fields can be moved between the two lists using the buttons to move all or single fields. Fields in the sorted list can be set to ascending or descending and moved up and down the list to give priority. When OK is clicked the sorted list is saved to the sort tag in the XML file.

This is a dialog palette that is displayed when oED is first launched. It shows similar information to the About palette, but it has three extra buttons that call the New, Open and Logout functions from the context menu.

This manages loading, hiding/showing, toggling (saving visible status, position and shaded mode) and stacking of all palettes.

This loads and saves editor preferences to the database. Preferences are set in the preferences palette.

It also handles the turning on and off of the borders and marquees associated with the preferences.

This handles resizing of the marquee and elements while the resize handle is being moved as well as setting the new sizes to the element when the mouse button is released.

This is used by the Actions palette to save and load scripts.

It is also used to parse the script to turn script-specific code into Javascript code.

It handles attaching and unattaching scripts to and from elements and the block, deleting scripts, checking if deleting an element will break any scripts and unattaching any attached scripts from the element.

This handles:

• The selection marquee if mouse button 1 is pressed.
• Hiding the menu if any button except mouse 2 is pressed.
• Selecting/deselecting the elements within the marquee depending on what keys (ctrl, shift) are held down when the mouse button is unpressed.
• Performing a Select All.
• Resizing all selected elements when the resize tool is used.
• Converting labels to propercase without underscores when ctrl+space is pressed.

This manages style sheets including, constructing sheets, setting which sheet to use, setting and deleting rules by various identifiers (classid, element, rule) as well as getting and setting classids, clearing style sheets and getting default style sheet properties for elements.

This sets up notifications that return a value to a calling function once the value has been retrieved.

It is currently used for colours of backgrounds, borders, subblock highlighting, fonts and styles in the styles pallete.

It is also used for files accessed in the image url palette.

This loads all files needed for the editor. Creates an Editor object (../editor/Editor.js), lockmanager and context menu.

This contains two extensions to the standard Javascript array object – one to allow searching through the contents of arrays and the other to allow removal via a search. It is used by oCLI.

This shows the menu and runs all the commands visible in the oHELP menu.

This contains a list of errors returned in oHELP.

This is the main Javascript class in oHELP.

This handles oHELP-specific key presses that cause certain functions to run.It may store the menu function or it calls an external menu function. It stores a named constant for each special keypress.

This displays the About palette for oHELP.

This displays and handles the behaviour of the Search palette.

This displays and handles the behaviour of the Search Results palette.

This is the main loader for oHELP.

This contains translations for messages, labels and other text.

This constructs the initial username/password form.

This contains translations for messages, labels and other text.

By default, when no HTML file is specified after a Once server's address, the following page is loaded:

once/start.html
Contains various parts of the interface as outlined below. It contains one line of Javascript and a tag referring to the following JS file:

once/classes/logon.js
Loads and initialises the logon application.

once/classes/logon.js refers to and loads the following Javascript files:

once/config/version.js
Version information for all client side applications and server modules.

once/classes/util.js
Loaded by once/classes/logon.js, it contains utility functions common to all applications.

once/classes/common/Biscuit.js
Loaded by once/classes/logon.js, it handles getting and setting browser cookies.

once/classes/logon/Language.js
Loaded by once/classes/logon.js, it contains translations for messages, labels and other text.

once/classes/logon/Logon.js
Loaded by once/start.html, it is the main logon program. It handles form transitions.

once/classes/common/md5.js
Handles MD5 hashing of strings (passwords, etc.).

once/classes/logon/Menu.js
Loaded by once/classes/logon.js, it constructs the menu form (commonly known as the second logon screen).

once/classes/logon/Identify.js
Loaded by once/classes/logon.js, it constructs the initial username/password form.

once/classes/logon/Status.js
Loaded by once/classes/logon.js, it is responsible for status information during a logon.

once/classes/logon/NewAccount.js
Loaded by once/classes/logon.js, it constructs the new account form.

once/classes/common/Biscuit.js
Handles getting and setting browser cookies (repeated).

once/classes/common/database/DatabaseQuery.js
Runs and caches results from database queries.

once/classes/common/database/QueryPage.js
Groups sets of WHERE ... AND restrictions.

once/classes/common/database/Record.js
An interface for accessing a single database tuple.

The following CSS files are also referred to by once/start.html:

once/css/logon.css
Contains styles that define the appearance of forms on a page

This handles MD5 hashing of strings (passwords, etc.).

This constructs the menu form (commonly known as the second logon screen).

This constructs the new account form which allows a Public Group user to be created.

This is responsible for displaying status information during a logon.

This is the main logon program. It handles form transitions.

This contains utility functions common to all applications. (e.g. logging and cross-browser event binding)

Clicking the Continue button on the logon screen loads this file. It is the stub/loader for oCLI. Using the same referencing system as start.html, the Client.html file refers to ../once/classes/client.js (which loads various .js files) and once/css/client.css.

This contains text that is displayed on the log on screen. It usually contains the name of the system's licensee. If the file is empty or missing, no name is displayed.

This file contains Tomcat and once:radix configuration data. Restart Tomcat after making changes to its content. The example below shows the settings for this file as distributed in the open source package.

[Database]

; The system has been optimized for best performance and reliability. Except as noted below, settings in this file should not be changed.

; The PostgreSQL database is packaged with the required version of the JDBC driver.

Driver=org.postgresql.Driver

Protocol=jdbc:postgresql:

; If Tomcat and the PostgreSQL database are installed on the same server, the local host address is used. If the port number is changed in ../pgsql/data/postgresql.conf, it must also be changed here. These details are required for the JDBC driver to connect to the database.

Server address=127.0.0.1

Server port=5432

; WARNING: To protect the security of your database, the configuration.dat file should never be installed in a directory that is externally accessible.

; These details are required for oSS to connect to the database.

; If you wish to change the Database name, User name and Password, refer to the PostgreSQL documentation for details.

Database=once

User=myPostgresqlSuperUserName

Password=myPostgresqlSuperUserPassword

; Set the Connections limit to about three times the number of concurrent users. If there are not enough connections, users will wait in a queue until a connection becomes available. If max_connection is changed in ../pgsql/data/postgresql.conf, it must also be changed here. The default setting is 100.

Connections limit=100

Wait for free connection=true

Execute SQL using separate thread=true

; The timeout is set to three minutes to allow for large reports that can take a long time to complete. If a query times out, dataAccessor will make a second asynchronous request. If this also times out, an exception is thrown. If a bad transaction block that hasn't been closed is detected, it will infinitely loop until this is resolved. In other cases, a query timeout will return an Error #08 to oCLI.

Query timeout=180

[Security]

; This sets the time limit that a session may remain inactive.

Login session timeout=10800000

Use cache for login sessions=true

Create individual groups=false

[Scheduler]

; scheduler.dat is located in the same directory as this file (configuration.dat). It is used by oADMIN to perform automatic operations such as Vaccuum and backups.

File=/config/scheduler.dat

[License]

; licence.dat is located in the same directory as this file (configuration.dat). It is SHA-1 encoded file for commercially-licenced systems. It sets the maximum number of concurrent users. It is not required in an open source package.

File=/config/license.dat

; branding.dat is located in the same directory as this file (configuration.dat). It contains text that is displayed on the log on screen. It ususally contains the name of the system's licensee. If the file is empty or missing, no name is displayed.

Branding=/config/branding.dat

[Export]

; Sets the date format when exporting data using JasperReports and the inbuilt CSV export function which includes the ability to produce MYOB and Quickbooks export files, as well as Gantt charts. Note that only one date format is supported per Tomcat deployment.

Date format=dd/MM/yyyy

; Sets the servlet to be used when printing Gantt charts.

Local Gantt chart printer URL=http://127.0.0.1:8080/once/ganttchartprinter

[Languages]

; Not implemented in once:radix.

User file=/application/language.dat

System file=/config/language.dat

[Repositories]

; While the system will function with any of the following directory paths changed, for ease of maintenance, it is recommended that the standard settings are used.

; Save application XML and CSS block files here (../webapps//application/..):

Blocks=/application/

; Save application JasperReports JRXML files here (../webapps//templates/..):

Templates=/templates/

; Store Metamodel and Model files here (../webapps//models/..):

Models=/models/

; Store images contained in application block files (usually uploaded using the oED Upload function) here (../webapps//images/user/..):

Images=/images/user/

; Files export by JasperReports are stored temporarily here. It is deleted periodically as set in oADMIN scheduler.

Exports=/temp/export/

; Tomcat logs are stored here. It is deleted periodically as set in oADMIN scheduler.

Logs=/logs/

; This is the repository for non-specific temp files as well as out-going emails. It is deleted periodically as set in oADMIN scheduler.

Temp=/temp/

; Store fonts used by JasperReports here:

Fonts=/fonts/

; Attachments to outgoing email are stored temporarily here. It is deleted periodically as set in oADMIN scheduler.

Attachments=/temp/attachments/

; XSL files used to transform XML block files into XHTML format are stored here.

XSL=/block/

; All oHELP content files including images are stored within this directory.

Help=/help/

; Temporary folder used by oHELP's implementation of the Apache Lucene search function.

Search=/temp/search/

[Defaults]

; Default database settings used by security servlets when establishing a connection.

; Note: Charge rate table not required in the open source version.

Table=person

Schema=contacts

Table permission table=security.securitytable

Block permission table=security.securityblock

Group permission table=security.personmembergroup

Login table=security.loginhistory

Membership table=contacts.personmember

Password table=security.usersecurity

Group table=security.group

Charge rate table=contacts.staffchargerate

; Maximum time that a record can remain unlocked (in milliseconds).

Record lock timeout=1200000

[Database backup/restore]

; If the database fails, oADMIN can be accessed to perform a database recovery by entering the username and password stored here, then pressing the Ctrl key. The Log On button changes to Restore. Click Restore to access the oADMIN Restore function. No other oADMIN functions are available in this mode. The Password may be set to any MD5 encrypted hash.

User=myDatabaseRecoveryUserName

Password=myMD5EncryptedRecoveryPassword

Repository=/backup/

; pg_dump and pg_restore

; PostgreSQL database backup/restore/vacuum with full path options for Linux.

Backup=/usr/local/pgsql/bin/pg_dump -i -h %host% -p %port% -U %user% -F c -b -v -f %file% %database%

Restore=/usr/local/pgsql/bin/pg_restore -i -h %host% -p %port% -U %user% -d %database% -c -O %file%

Vacuum=/usr/local/pgsql/bin/vacuumdb -h %host% -p %port% -U %user% %database%

; If installing on Windows use the following lines in lieu of the Linux statements above:

; Backup="C:\Program Files\once-fabrik\Postgres\bin\pg_dump" -i -h %host% -p %port% -U %user% -F c -b -v -f %file% %database%

; Restore="C:\Program Files\once-fabrik\Postgres\bin\pg_restore" -i -h %host% -p %port% -U %user% -d %database% -c -O %file%

; Vacuum="C:\Program Files\once-fabrik\Postgres\bin\vacuumdb" -h %host% -p %port% -U %user% %database%

[Mail]

; These details need to be set to a valid SMTP account for outgoing email to work correctly.

SMTP server address=127.0.0.1

SMTP server port=25

SMTP server user=

SMTP server password=

This sets the maximum number of concurrent users in a commercially-licenced system. It is not required in the open source package.

This contains schedule information for tasks set to run at specified times or intervals.

This contains version information for all client side applications and server modules.

This defines the appearance of general oADMIN interface elements.

This refers to all of the CSS files used by oADMIN. This includes:

layers.css
Part of the layers library.

admin/admin.css
Defines the appearance of general oADMIN interface elements.

common/oldmenu.css
Defines the appearance of menus, menu bars and menu items.

layers.css refers to:

common/layers.css
Part of the layers library.

common/ghost.css
Part of the layers library.

This defines the appearance of general interface elements in oCLI.

This defines the appearance of the list view mode. This is still under development.

This is the stub that refers to all of the CSS files for oCLI.

This defines the style for old style menus in oED, oHELP and oADMIN.

This contains the theme for the old menu to look like style the new menus. It is used in oED.

This is the basic style sheet for the editor.

This contains miscellaneous styles for the editor environment. It is currently used for the character select palette which isn't called from anywhere.

This loads ../css/layers.css, ../css/editor/editor.css, ../css/editor/misc.css, ../css/common/oldmenued.css and ../css/common/menu2.css for oED.

This file contains the layout information for oHELP.

This file loads layers.css, help/help.css and common/oldmenu.css for oHELP.

This is the CSS file for the layers library. It contains two lines of code, one to include ../css/common/layers.css and the other to include ../css/common/ghost.css.

This contains styles that define the appearance of forms in oLOGON. It is referred to by once/start.html

The oADMIN HTML file has an empty i-frame and references to the CSS and Javascript files.

This defines the bottom frame in oADMIN.

This defines the top frame in oADMIN.

This contains controls for all of the palettes (no style info.) for oADMIN. There is appropriately named javascript for each palette inside the ../classes/admin/palettes/ directory.

This defines the content and behaviour of the Top Menu. This file can be edited in a text menu to create a custom Top Menu.

This contains controls for all of the palettes (no style info.) for oCLI. There is appropriately named javascript for each palette inside the ../classes/client/palettes/ directory.

This is the behaviour file for Internet Explorer 5 compatibility. This is being kept for future development of IE compatibility.

This holds the header templates for palettes. Currently two different headers are available: Normal and Modal.

This contains controls for all of the palettes (no style info.) for oHELP. There is appropriately named javascript for each palette inside the ../classes/help/palettes/ directory.

This contains controls for all of the palettes (no style info.) for oED. There is appropriately named javascript for each palette inside the ../classes/editor/palettes/ directory.

This is the basic HTML template used for empty pages. It is used in oED.

This details all changes made to oSS, oLOGON, oHELP, oADMIN, oED and oCLI.

Changes to the application program should be recorded in this text file each time a change is made. The developer may also wish to display the details in a screen page (Block).

This directory contains licences for the various packages used by once:radix. This includes:

• license.antlr.txt
• license.bcel.txt
• license.commons-beanutils.txt
• license.commons-collections.txt
• license.commons-digester.txt
• license.commons-email.txt
• license.commons-fileupload.txt
• license.commons-io.txt
• license.commons-javaflow.txt
• license.commons-logging.txt
• license.dom4j.txt
• license.groovy.txt
• license.ini4j.txt
• license.itext.txt
• license.jaf.txt
• license.jasperreports.txt
• license.javamail.txt
• license.jcommon.txt
• license.jdt-compiler.txt
• license.jfreechart.txt
• license.jxl.txt
• license.log4j.txt
• license.lucene-core.txt
• license.lucene-highlighter.txt
• license.mondrian.txt
• license.once-radix.txt
• license.png-encoder.txt
• license.poi.txt
• license.postgresql.txt
• license.rhino.txt
• license.serializer.txt
• license.xalan.txt
• license.xerces.txt
• license.xml-apis.txt

This is the open source licence for once:radix.

This contains the oED application loader.

JasperReports gets its fonts from here.

This directory and its sub-directories contain HTML and image files.

Help pages loaded within oCLI when the F1 key is pressed should have directories that follow the same paths as their associated Application directories.

This holds the oADMIN Help pages. It must contain index.html. This has not been fully implemented.

This directory path contains application-specific help pages. (e.g. once:fabrik, once:traffic and once:fortuna).

The oCLI Help pages. Must contain index.html. This is loaded from Diamond > Help in oCLI and by selecting Help > Overview (Ctrl-H) in the context menu.

The oED Help pages are shown when F1 is pressed or by selecting Help > Contents (F1) in the context menu. Must contain index.html.

This is the screen format CSS file used to define the look and feel of help pages.

This shows the help navigation on mouseover and hides it on mouseout for the oCLI help pages.

This is the print format CSS file for the oCLI application help pages.

Most application help images are stored here.

The contains the oLOGON help pages.

The oHELP application loader.

A specific page can be loaded by including the 'p' parameter in the URL. (e.g. http://URL/once/Help.html?p=help/Client/index.html)

This directory contains images used by oCLI, oED and oADMIN. It is further subdivided into other subdirectories. ../user/ is a subdirectory that houses all of the user application images.

This directory contains the once:radix logs. (See also: standard Tomcat logs.) A new one is created when the current log reaches 1000 kB.

Note: If not set up correctly in configuration.dat, they get placed in the parent directory.

The performance directory contains logs for performance analysis with one file being opened for each user. Filenames are of the form:performance<username>-<date>.log and performance<username>-<date-overrun>.log

The second file type holds logging information for processes that timed out.

All metamodels (except system files which are stored elsewhere to make them invisible) are parked inside this directory (../Tomcat/webapps/once/models/). Their name is usually the same as their associated schema name. They can be identified by their .met extension.

They are usually created by the Database Manager.

The format of these files can be viewed in a text editor.

The basic distribution includes:

• admin.met
• block_permissions.met
• contacts.met
• login_details.met

However some of these metamodels will be added to as applications are developed.

All models (except system models, which are stored in a separate directory) are usually parked inside this sub-directory (..Tomcat/webapps/once/models/data/. Their name is usually the same as their associated table name (or with an additional digit if there is more than one model referring to the same table. They can be identified by their .mdl extension.

They are usually created by the Database Manager.

The format of these files can be viewed in a text editor.

This directory holds the model files required by the system to operate. It usually contains the following models:

• admin_loginperson.mdl
• admin_personmember.mdl
• block_permissions.met
• contacts_levelstructure.mdl
• contacts_organization.mdl
• contacts_person.mdl
• contacts_personmember_email.mdl
• contacts_personmember.mdl
• login_details.met
• security_dateformat.mdl
• security_group.mdl
• security_ipfilter.mdl
• security_loginhistory.mdl
• security_loginlocation.mdl
• security_personmembergroup.mdl
• security_securityblock.mdl
• security_securitytable.mdl
• security_securityupdate.mdl
• security_timeformat.mdl
• security_timezone.mdl
• security_usersecurity.mdl

Error page. This page is shown when an invalid page request is made. e.g. http://localhost:8080/once/fred

This seems to be something to be displayed when working in localhost only.

The oLOGON application loader. By default, when no HTML file is specified after a Once servers address, this page is loaded. It contains various parts of the interface as outlined in ../once/classes/.. It contains one line of Javascript and a tag referring to once/classes/logon.js. once/css/logon.css is also referred to by once/start.html. It contains styles that define the appearance of forms on a page.

This is a temporary storage location for storing, exports, attachments and search results. It is cleared periodically by the server.

When a template is compiled, it is stored here as a <filename>.jasper file.

This contains images used by custom JasperReports layouts are parked here. e.g. logo_address.png

This is where uploaded image files are parked. It can be used for creating a content management system. Files are divided into subdirectories by the name of the owner organisation. A further division into subdirectories can be created by scripting.

The default class for actions, this defines all common functions used by servlets. Most servlets inherit from this class. Nearly all of them refer to functions in it. Most of the functions are convenience methods. We combine doGet() and doPost() into serve() to avoid repetition in the servlet code.

This retrieves the contents of the branding.dat file in the config directory.

Example

http://192.168.10.111:8000/once/actionbranding

This would return the name of the installation, as shown on the first Log on screen. This is usually the name of the organisation that is the licencee of the software.

This stores and retrieves oCLI preferences.

This action is invoked when commiting data from the client to the database.

This creates a password for a user with a blank password (factory supplied user).

This provides a service for creating anonymous new users.

This performs emergency database backup and restore.

This finds, updates, inserts and deletes data from the database.

This action is invoked when there is no matching action for a specified "action-like" URI.

This deletes the specified model.

This action returns the contents of a directory.

This action duplicates a series of records server-side.

This duplicates a set of data, replacing values from a list.

This sets or gets oED preferences to/from the client.

This exports data to specified file formats (RTF, CSV, etc.).

This gets information for the export template.

This contains a fast loading routine for oCLI. Quickly loads the XML and then the CSS and combines them into one output.

This action is invoked when finding data in the database.

This retrieves information about the database structure.

This downloads a JasperReports export template.

This retrieves metamodel information.

This retrieves data model information.

This gets organisational information about a user from the server.

This gets the blank template for an iFrame.

This action downloads a previously uploaded file from the server.

This performs the search function in oHELP pages.

This loads and transforms the XML into HTML and then combines with the CSS into HTML output.

This saves an image file to disk on the server.

This action is used by client-side scripting to allow versatile record insert(s).

This shows a table containing the session cache contents. It can be accessed by entering the URI request directly into the browser address field, in the form:

http://<URL>/once/actioninspectsessioncache

The server returns a table similar to the example shown below: