once:radix Documentation

once:secureserver Directory Map

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

Applications: Postgres/pgsql

bin

Description

This directory contains the PostgreSQL applications.

Applications: Postgres/pgsql

data

base

Description

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

Applications: Postgres/pgsql

data

global

Description

This directory contains details about the database users and groups.

Applications: Postgres/pgsql

data

pg_hba.conf

Description

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

Applications: Postgres/pgsql

data

pg_log

Description

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.

Applications: Postgres/pgsql

data

PG_VERSION

Description

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

Applications: Postgres/pgsql

data

postgresql.conf

Description

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

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.

Applications: Tomcat

conf

tomcat-users.xml

Description

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.

Applications: Tomcat

conf

web.xml

Description

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.

Applications: Tomcat

logs

Description

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.

Applications: Tomcat

RUNNING.txt

Description

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

Applications: Tomcat

server

Description

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.

Applications: Tomcat

shared

Description

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

Applications: Tomcat

temp

Description

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

Applications: Tomcat

Uninstall.exe

Description

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.

Applications: Tomcat

webapps

once

Admin.html

Description

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.

Applications: Tomcat

webapps

once

application

Description

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.

Applications: Tomcat

webapps

once

application

<owner organisation name>

Description

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/

Applications: Tomcat

webapps

once

application

version_history.css & version_history.xml

Description

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.

Applications: Tomcat

webapps

once

backup

Description

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.

Applications: Tomcat

webapps

once

backup.sh

Description

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.

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.

Applications: Tomcat

webapps

once

block

blockid.xsl

Description

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

Applications: Tomcat

webapps

once

block

client.xsl

Description

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.

Applications: Tomcat

webapps

once

block

editor.xsl

Description

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.

Applications: Tomcat

webapps

once

classes

admin

Admin.js

Description

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

Applications: Tomcat

webapps

once

classes

admin

ContextMenu.js

Description

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

Applications: Tomcat

webapps

once

classes

admin

ErrorTable.js

Description

This contains a list of all oADMIN error messages.

Applications: Tomcat

webapps

once

classes

admin

Keyboard.js

Description

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

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

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

once/classes/admin/palette/AboutPalette.jsDefines the behaviour of the about palette.

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

once/data/adminPalettes.xmlContain 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.cssRefers to all of the different CSS files used by oADMIN.

admin.css refers to:

layers.cssPart of the layers library.

admin/admin.cssDefines the appearance of general oADMIN interface elements.

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

layers.css refers to:

common/layers.cssPart of the layers library.

common/ghost.cssPart of the layers library.

Applications: Tomcat

webapps

once

classes

client

action

ActionsLibrary.js

Description

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

Applications: Tomcat

webapps

once

classes

client

action

Protagonist.js

Description

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.

Applications: Tomcat

webapps

once

classes

client

Client.js

Description

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

Applications: Tomcat

webapps

once

classes

client

ContextMenu.js

Description

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

Applications: Tomcat

webapps

once

classes

client

control

Calendar.js

Description

This defines the appearance and behaviour of the calendar control.

Applications: Tomcat

webapps

once

classes

client

control

GanttChart.js

Description

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

Applications: Tomcat

webapps

once

classes

client

control

Thumbnail.js

Description

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

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

Applications: Tomcat

webapps

once

classes

client

Language.js

Description

This contains translations for messages, labels and other text.

Applications: Tomcat

webapps

once

classes

client

ListView.js

Description

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

Applications: Tomcat

webapps

once

classes

client

Navigator.js

Description

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

Applications: Tomcat

webapps

once

classes

client

object

Palette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

AboutPalette.js

Description

This defines the behaviour of the About oCLI palette.

Applications: Tomcat

webapps

once

classes

client

palette

AboutUserPalette.js

Description

This defines the behaviour of the About This User palette.

Applications: Tomcat

webapps

once

classes

client

palette

AreaPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

EmailPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

ExportPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

GangPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

IndexPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

ListPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

OpenBlockPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

PopupPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

client

palette

PreferencesPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

PrintPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

ProgressPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

ReplacePalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

sort

SortBlock.js

Description

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.

Applications: Tomcat

webapps

once

classes

client

palette

sort

SortOrder.js

Description

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.

Applications: Tomcat

webapps

once

classes

client

palette

SortPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

TemplatePalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

TransferPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

client

palette

UploadPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

client

PaletteManager.js

Description

This provides an interface for showing/hiding palettes.

Applications: Tomcat

webapps

once

classes

client

Prefaroni.js

Description

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

Applications: Tomcat

webapps

once

classes

client

StyleManager.js

Description

This handles dynamic changes to stylesheet information.

Applications: Tomcat

webapps

once

classes

client

Subblock.js

Description

This contains code for moving between and displaying subblock records.

Applications: Tomcat

webapps

once

classes

client.js

Description

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

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

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.

Applications: Tomcat

webapps

once

classes

common

BlockManager.js

Description

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

Applications: Tomcat

webapps

once

classes

common

database

DatabaseQuery.js

Description

This sends database requests and caches results from database queries.

Applications: Tomcat

webapps

once

classes

common

database

Locker.js

Description

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

Applications: Tomcat

webapps

once

classes

common

database

QueryPage.js

Description

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.

Applications: Tomcat

webapps

once

classes

common

database

QueryParser.js

Description

This converts once:radix Find syntax (e.g. >,

Applications: Tomcat

webapps

once

classes

common

database

Record.js

Description

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

Applications: Tomcat

webapps

once

classes

common

DateParser.js

Description

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

Applications: Tomcat

webapps

once

classes

common

HttpSyncTextRequest.js

Description

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

Applications: Tomcat

webapps

once

classes

common

Layer.js

Description

This is the main script in the Layers library.

Applications: Tomcat

webapps

once

classes

common

LayerComponents.js

Description

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

Applications: Tomcat

webapps

once

classes

common

LayerFeatures.js

Description

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

Applications: Tomcat

webapps

once

classes

common

LayerPanes.js

Description

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

Applications: Tomcat

webapps

once

classes

common

Matcher.js

Description

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.

Applications: Tomcat

webapps

once

classes

common

md5.js

Description

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

Applications: Tomcat

webapps

once

classes

common

Menu.js

Description

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.

Applications: Tomcat

webapps

once

classes

common

menu2

Menu.js

Description

This is the menu container for new style menus.

Applications: Tomcat

webapps

once

classes

common

menu2

MenuBar.js

Description

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

Applications: Tomcat

webapps

once

classes

common

menu2

MenuItem.js

Description

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

Applications: Tomcat

webapps

once

classes

common

menu2

MenuMetrics.js

Description

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

Applications: Tomcat

webapps

once

classes

common

menu2

MenuSeparator.js

Description

This sets up separators in new style menus.

Applications: Tomcat

webapps

once

classes

common

menu2

MenuTitle.js

Description

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

Applications: Tomcat

webapps

once

classes

common

MutableLayer.js

Description

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

Applications: Tomcat

webapps

once

classes

common

NumberParser.js

Description

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

Applications: Tomcat

webapps

once

classes

common

Palette.js

Description

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

Applications: Tomcat

webapps

once

classes

common

PaletteManager.js

Description

This creates and manages all palettes.

Applications: Tomcat

webapps

once

classes

common

Source.js

Description

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.

Applications: Tomcat

webapps

once

classes

common

StringBuffer.js

Description

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

Applications: Tomcat

webapps

once

classes

common

Transformer.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

Clipboard.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

ContextMenu.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

DragSupporter.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

Editor.js

Description

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).

Applications: Tomcat

webapps

once

classes

editor

FetchDataSource.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

Keyboard.js

Description

This handles oED-specific key presses.

Applications: Tomcat

webapps

once

classes

editor

Language.js

Description

This handles language support for oEd.

Applications: Tomcat

webapps

once

classes

editor

misc

drag.js

Description

This provides drag functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

misc

dragUtils.js

Description

This provides drag functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

misc

wz_dragdrop.js

Description

This provides drag functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

misc

wz_jsgraphics.js

Description

This provides drag functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

object

Palette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

AboutPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

ActionsPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

AddAdvancedWidgetPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

AddBorderPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

AddElementStylePalette.js

Description

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).

Applications: Tomcat

webapps

once

classes

editor

palette

AttachScriptPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

ChangeDataSourcePalette.js

Description

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).

Applications: Tomcat

webapps

once

classes

editor

palette

ColourSelectPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

DataSourcePalette.js

Description

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).

Applications: Tomcat

webapps

once

classes

editor

palette

DateTimePalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

DuplicateAtPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

ElementsPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

ElementStylesPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

FontPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

ImageMapPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

ImageUploadPalette.js

Description

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.

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.

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

AliasEditorPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

ConditionEditorPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

MetamodelEditorContextMenu.js

Description

This defines the behaviour of the Database Manager Context Menu.

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

ModelEditorPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

OpenMetamodelPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

OpenModelPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

OpenTablePalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

RelationEditorPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

SaveMetamodelPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

SaveModelPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

TableEditorPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditor

wz_jsgraphics.js

Description

This provides functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

MetamodelEditorPalette.js

Description

This provides metamodel editor palette functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

ModelEditorPalette.js

Description

This provides model editor palette functionality for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

NumberPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

OpenBlockPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

OpenMetamodelPalette.js

Description

This opens the metamodel editor palette for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

OpenModelPalette.js

Description

This opens the model editor palette for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

OpenTablePalette.js

Description

This opens the table palette for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

PageSetupPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

ParametersPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

PositionPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

PreferencesPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

RelationEditorPalette.js

Description

This opens the relationship editor palette for the Database Manager.

Applications: Tomcat

webapps

once

classes

editor

palette

SaveBlockPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

SortPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

palette

StartUpPalette.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

PaletteManager.js

Description

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

Applications: Tomcat

webapps

once

classes

editor

Prefaroni.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

ResizeSupporter.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

ScriptManager.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

Selection.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

StyleManager.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor

ValueManager.js

Description

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.

Applications: Tomcat

webapps

once

classes

editor.js

Description

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

Applications: Tomcat

webapps

once

classes

extensions

array.js

Description

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.

Applications: Tomcat

webapps

once

classes

help

ContextMenu.js

Description

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

Applications: Tomcat

webapps

once

classes

help

ErrorTable.js

Description

This contains a list of errors returned in oHELP.

Applications: Tomcat

webapps

once

classes

help

Help.js

Description

This is the main Javascript class in oHELP.

Applications: Tomcat

webapps

once

classes

help

Keyboard.js

Description

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.

Applications: Tomcat

webapps

once

classes

help

palette

AboutPalette.js

Description

This displays the About palette for oHELP.

Applications: Tomcat

webapps

once

classes

help

palette

SearchPalette.js

Description

This displays and handles the behaviour of the Search palette.

Applications: Tomcat

webapps

once

classes

help

palette

SearchResultsPalette.js

Description

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

Applications: Tomcat

webapps

once

classes

help.js

Description

This is the main loader for oHELP.

Applications: Tomcat

webapps

once

classes

layers.js

Description

This contains translations for messages, labels and other text.

Applications: Tomcat

webapps

once

classes

logon

Identify.js

Description

This constructs the initial username/password form.

Applications: Tomcat

webapps

once

classes

logon

Language.js

Description

This contains translations for messages, labels and other text.

Applications: Tomcat

webapps

once

classes

logon

Logon.js

Description

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

once/start.htmlContains 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.jsLoads and initialises the logon application.

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

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

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

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

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

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

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

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

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

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

Applications: Tomcat

webapps

once

classes

logon

md5.js

Description

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

Applications: Tomcat

webapps

once

classes

logon

Menu.js

Description

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

Applications: Tomcat

webapps

once

classes

logon

NewAccount.js

Description

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

Applications: Tomcat

webapps

once

classes

logon

Status.js

Description

This is responsible for displaying status information during a logon.

Applications: Tomcat

webapps

once

classes

logon.js

Description

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

Applications: Tomcat

webapps

once

classes

util.js

Description

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

Applications: Tomcat

webapps

once

Client.html

Description

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.

Applications: Tomcat

webapps

once

config

branding.dat

Description

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.

Applications: Tomcat

webapps

once

config

configuration.dat

Description

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.

; 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.

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.

Applications: Tomcat

webapps

once

help

Editor

Description

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

Applications: Tomcat

webapps

once

help

help.css

Description

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

Applications: Tomcat

webapps

once

help

help.js

Description

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

Applications: Tomcat

webapps

once

help

helpprint.css

Description

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

Applications: Tomcat

webapps

once

help

images

Description

Most application help images are stored here.

Applications: Tomcat

webapps

once

help

Logon

Description

The contains the oLOGON help pages.

Applications: Tomcat

webapps

once

Help.html

Description

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)

Applications: Tomcat

webapps

once

images

Description

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.

Applications: Tomcat

webapps

once

logs

Description

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.

Applications: Tomcat

webapps

once

logs

performance

Description

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.

Applications: Tomcat

webapps

once

models

<metamodel_name>.met

Description

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.

Applications: Tomcat

webapps

once

models

data

<model_name>.mdl

Description

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.

Applications: Tomcat

webapps

once

models

system

Description

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

Applications: Tomcat

webapps

once

resource

error.html

Description

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

Applications: Tomcat

webapps

once

resource

error.html

Description

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

Applications: Tomcat

webapps

once

start.html

Description

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.

Applications: Tomcat

webapps

once

temp

Description

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

Applications: Tomcat

webapps

once

templates

<report_name>.jrxml and <report_name>.jasper

Description

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

Applications: Tomcat

webapps

once

templates

<image.png>

Description

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

Applications: Tomcat

webapps

once

upload

<ownerorganisation>

<subdirectory>

Description

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.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

Action.class

Description

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.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionBranding.class

Description

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.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionCliPreferences.class

Description

This stores and retrieves oCLI preferences.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionCommit.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionCreatePassword.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionCreateUser.class

Description

This provides a service for creating anonymous new users.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDatabaseMaintenence.class

Description

This performs emergency database backup and restore.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDataSource.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDefault.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDeleteModel.class

Description

This deletes the specified model.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDirectory.class

Description

This action returns the contents of a directory.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDuplicate.class

Description

This action duplicates a series of records server-side.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionDuplicateFromList.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionEdPreferences.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionExportData.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionExportTemplateInfo.class

Description

This gets information for the export template.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionFastLoad.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionFind.class

Description

This action is invoked when finding data in the database.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetDatabaseInfo.class

Description

This retrieves information about the database structure.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetExportTemplate.class

Description

This downloads a JasperReports export template.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetMetamodelInfo.class

Description

This retrieves metamodel information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetModelInfo.class

Description

This retrieves data model information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetOrganisation.class

Description

This gets organisational information about a user from the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetTemplate.class

Description

This gets the blank template for an iFrame.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionGetUploadedFile.class

Description

This action downloads a previously uploaded file from the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionHelpSearch.class

Description

This performs the search function in oHELP pages.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionHTMLLoad.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionImageSave.class

Description

This saves an image file to disk on the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionInsertSet.class

Description

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

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionInspectSessionCache.class

Description

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:

This contains Actions for retrieving model information. Use tag=table to get all table names and tag=field to get all field names.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionPullUpList.class

Description

This returns values to pullup lists in oCLI. See also ActionValueList which returns data for the View Index function.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionRecache.class

Description

This recaches the models/metamodels on the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionReplace.class

Description

This action replaces a series of values in a defined set of records.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionReplaceCheck.class

Description

This provides status information during the Replace Records operation. It returns the percentage completed.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionReportsRecompile.class

Description

This starts JasperReports templates recompilation.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSave.class

Description

This action is invoked when saving a layout block using a URI.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSaveMetamodel.class

Description

This creates and updates metamodels.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSaveModel.class

Description

This creates and updates data models.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionScheduler.class

Description

This performs scheduler management.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionServerInfo.class

Description

This displays miscellaneous server information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionServerLog.class

Description

This logs a message to the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionShiftDays.class

Description

This shifts a group of data by a no. of days. This is used by Scheduler.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSQL.class

Description

This retrieves from and stores records to the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSQLConsole.class

Description

This is the SQL console for administrative maintenance.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionStyleLoad.class

Description

This action loads a stylesheet file.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionStyleSave.class

Description

This action saves a stylesheet file.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSyncBlockList.class

Description

This action synchronizes the entries in the database for block listings with those actually on the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionSyncTableList.class

Description

This action syncs the entries in the permission table for table listings with those actually in the database.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionTimesheetGetChargeRate.class

Description

This returns the charge rate for an activity.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionUploadFile.class

Description

This uploads a file to the server.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionUploadFileCheck.class

Description

This checks the status of a file upload.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionValueList.class

Description

This lists all of the values in one field.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

ActionWhoIs.class

Description

This checks what username belongs to a session.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

BaseException.class

Description

This is the base class for all exception handlers.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

cache

IObjectCache.class

Description

This is the public interface of ObjectCache.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

cache

IObjectCacheEntry.class

Description

This is the public interface of ObjectCacheEntry.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

cache

ObjectCache.class

Description

This is the implementation of ObjectCache.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

cache

ObjectCacheEntry.class

Description

This is the implementation of ObjectCacheEntry (keeps cache object, lifetime, cache time).

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

cache

ObjectCacheFactory.class

Description

This invokes the ObjectCache instance.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

cache

UnsynchronisedObjectCache.class

Description

This is the implementation of ObjectCache without synchronized methods. It was introduced to eliminate excess synchronization as was being performed by ObjectCache.class.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

GanttChartPrinter.class

Description

This prints Gantt Charts as PNG images.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

FinishLogEntry.class

Description

This marks an event as finished and writes the event info into the server performance logger log file.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

ILogEntry.class

Description

This is the common public event entry interface.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

InfoLogEntry.class

Description

This places information about the entry into the log file.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

LogEntry.class

Description

This is the common implementation of the log entry.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

PerformanceLogger.class

Description

This class creates log entries and saves them in cache memory.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

PerformanceLogThread.class

Description

Detailed logging is performed on most classes within the /once/server/ directory path. Each public method calls the logger to record execution times on start and completion.

The performance logs record timing information of java classes to allow server performance to be evaluated.

This function writes log entries from cache to the log file every 30 seconds, as specified in config.dat:

Operation execution timeout=30000

Note that this parameter also sets the maximum SQL queries time out.

Log files are stored in the repository, specified by:

Performance Logs=/logs/performance/

The details returned for each class are listed below:

Action

This is the base class. There is nothing to log.

ActionBranding

Start / End

ActionCliPreferences

Start / End

ActionCommit

Start / End

ActionCreatePassword

Start / End

ActionCreateUser

Start / End

Create user

Suggest username

Ensure that the username does not exist.

ActionDatabaseMaintenence

Start / End

Mode (backup or restore)

ActionDataSource

Start / End

ActionDefault

Start / End

ActionDeleteModel

Start / End

ActionDirectory

Start / End

What directory is operated

ActionDuplicate

Start / End

Search time

Insert time

ActionDuplicateFromList

Start / End

Search time

Insert time

ActionEdPreferences

Start / End

ActionExportData

Start / End

ExportDataWrapper execution time

Send mail execution time

ActionExportTemplateInfo

Start / End

ActionFastLoad

Start / End

Block load time.

Stylesheet load time.

transformToXHTML time

transformCSS time

ActionFind

Start / End

ActionGetDatabaseInfo

Start / End

ActionGetExportTemplate

Start / End

ActionGetMetamodelInfo

Start / End

ActionGetModelInfo

Start / End

ActionGetOrganisation

Start / End

The organisation details returned.

ActionGetTemplate

Start / End

ActionGetUploadedFile

Start / End

ActionHelpSearch

Start / End

ActionHTMLLoad

Start / End

block file time read

Stylesheet file time read

transformToXHTML time

transformCSS time

ActionImageSave

Start / End

ActionInsertSet

Start / End

ActionInspectSessionCache

Start / End

ActionLanguage

Start / End

ActionLoad

Start / End

The name of the operation executed.

ActionLock

Start / End

Records search time

Records lock time

ActionLogin

Start / End

ActionLogout

Start / End

ActionMetamodel

Start / End

what operation is executing

ActionMetamodelsIntegrityCheck

Start / End

ActionModel

Start / End

ActionPullUpList

Start / End

ActionRecache

Start / End

ActionReplace

Start / End

ActionReplaceCheck

Start / End

ActionReportsRecompile

Start / End

ActionSave

Start / End

ActionSaveMetamodel

Start / End

ActionSaveModel

Start / End

ActionScheduler

Start / End

The name of the operation being executed.

ActionServerInfo

Start / End

ActionServerLog

nothing

ActionServerScript

Start / End

ActionShiftDays

Start / End

ActionSQL

Start / End

ActionSQLConsole

Start / End

ActionStyleLoad

Start / End

ActionStyleSave

Start / End

ActionSyncBlockList

Start / End

ActionSyncTableList

Start / End

ActionTCL

Start / End

ActionTimesheetGetChargeRate

Start / End

scan for rate execution time

ActionUploadFile

Start / End

ActionUploadFileCheck

Start / End

ActionValueList

Start / End

ActionWhoIs

Start / End

BaseException

nothing

GanttChartPrinter

Start / End

Log4jInit

nothing

LogViewer

nothing

MetamodelCacheInit

nothing

WebAPI

Start / End

The name of the operation being executed.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

log

StartLogEntry.class

Description

This marks an event as having started.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

Log4jInit.class

Description

This is the helper servlet for initializing the log4j framework in a webcontainer.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

LogViewer.class

Description

This displays all entries from the trigger logs table in a web browser.

WARNING: This function should not be installed in this directory except when specifically required to perform system debugging. At other times, park the file anywhere outside of this directory and it will not start.

Note: After moving the file to this directory, restart Tomcat to make it operational.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

mail

IMailMessage.class

Description

This is the public interface for Displayshandling emails.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

mail

MailException.class

Description

This handles email error exceptions.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

mail

MailMessage.class

Description

The MailMessage class can be considered the foundation class. It deals with creating and managing the email message. All other classes interact with this class. The MailMessage class exposes such properties as:

Property

Description

Attachments

Gets the attachment collection used to store data attached to this e-mail message.

Bcc

Gets the address collection that contains the blind carbon copy (BCC) recipients for this e-mail message.

Body

Gets or sets the message body.

CC

Gets the address collection that contains the carbon copy (CC) recipients for this e-mail message.

From

Gets or sets the from address for this e-mail message.

Subject

Gets or sets the subject line for this e-mail message.

To

Gets the address collection that contains the recipients of this e-mail message.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

mail

MailQueue.class

Description

This manages the outgoing email queue.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

mail

MailSender.class

Description

This sets up connections to the mail server and sends the email.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

MetamodelCacheInit.class

Description

Initially this is set to 1.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

IScheduleQueue.class

Description

This is the public generic interface for individual schedules.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

IScheduleTask.class

Description

This is the public generic interface for schedule tasks.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

IScheduleTime.class

Description

This is the public generic interface for managing shedule run times.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

ScheduleException.class

Description

This handles schedule error exceptions.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

ScheduleFactory.class

Description

This operates the schedules.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

Scheduler.class

Description

This invokes the instance of the ScheduleFactory.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

SchedulerThread.class

Description

This handles individual threads and launches shedules at specific times/intervals.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

ConnectionsCleanup.class

Description

This closes all database connections.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

DatabaseBackup.class

Description

This manages database backups.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

DatabaseBackupsCleanup.class

Description

This removes old database backup files.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

DatabaseReindex.class

Description

This reindexes the database.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

DatabaseVacuum.class

Description

This performs a vacuum of the database.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

ExportsCleanup.class

Description

This removes temporary files from the exports repository.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

LogsCleanup.class

Description

This removes old log files.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

SendMail.class

Description

This performs a send mail operation.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

scheduler

task

ServerInfo.class

Description

This contains Log server information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

Finder.class

Description

This performs server-side string searches in help files.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

HelpIndexThread.class

Description

This indexes help files when the server starts.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

Entities.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

HTMLParser.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

HTMLParser.jj

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

HTMLParserConstants.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

HTMLParserTokenManager.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

ParseException.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

ParserThread.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

SimpleCharStream.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

Tags.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

Test.class

Description

This is part of the Apache Lucene distribution. No user intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

Token.class

Description

This is part of the Apache Lucene distribution. No intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

html

TokenMgrError.class

Description

This is part of the Apache Lucene distribution. No intervention required.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

HTMLDocument.class

Description

This is from Apache Lucene's demo - HTML document parser.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

search

SearchException.class

Description

This handles oHELP error exceptions.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

AbstractBlock.class

Description

This contains default methods used by all base classes to represent block files.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

BlockCacheManager.class

Description

This handles repeated calls to the block cache, returning a reference to a single static block cache as requested.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

BlockErrorHandler.class

Description

This handles errors that occur during the creation of a DefaultBlock (DataBlock or LayoutBlock).

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

DataBlock.class

Description

This is a representation of a find query stored as XML with appropriate methods for getting result data, number of results, columns, etc.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

DefaultBlock.class

Description

This is the base class for a representing a block file (XML+CSS) or a find query stored as XML.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

LayoutBlock.class

Description

This is a representation of a block file (XML+CSS) with methods for getting the block as text or a Document object.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

block

TransformErrorListener.class

Description

This listens for errors during the XML to XHTML transformation that occurs in ActionFastLoad.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

Block.class

Description

This is a generic interface for representing a block file (XML+CSS) or a find query stored as XML.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

BlockManager.class

Description

This loads a set of CSS/XML block files (referenced by their block name) and returns a LayoutBlock object.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

config

ConfigManager.class

Description

This reads the configuration file and passes the details to oSS.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

config

IniFile.class

Description

This reads and parses files in Windows .ini format.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

crypto

EncryptionUtils.class

Description

This encrypts and decrypts data using the DES algorithm.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

crypto

HashUtils.class

Description

This encrypts data using MD5 & SHA-1 formats.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

crypto

PKIUtils.class

Description

This generates keys for DES encryption and signs the data.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

DataAccessException.class

Description

This handles error exceptions for data management related classes.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

DataReplacerThread.class

Description

This performs search & replacement of data.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

DataWrapper.class

Description

This performs calls to lower levels of data management classes (select/update etc.) and converts the received results to readable format for oCLI.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

DataExportException.class

Description

This handles error exceptions for data export related classes.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

ExportDataWrapper.class

Description

This formats responses from lower-level export classes to readable format for oCLI.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

FormatPatternUtils.class

Description

This converts date/time patterns from once-related to java-related format.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

OnceReport.class

Description

This provides additional functions for once:radix compatibility in i-Report. It is used by specifying an INCLUDE properties statement with the template created in i-Report.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

sql

CircularQueue.class

Description

This is used by SQLExportQB 1 & 2 to iterate over a set of values provided for a column. It is used by the QuickBooks export. This is not included in the open source distribution.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

sql

JasperReports

IParameter.class

Description

This describes the parameters than can be passed to JasperReports.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

sql

ReportsCompileThread.class

Description

This performs compilation of JasperReports files when the server starts and when initiated manually.

This exports data in MYOB-compatible CSV-formatted files. This is not included in the open source distribution.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

sql

SQLExportQB.class

Description

This performs the export function for QuickBooks, except time sheets. This is not included in the open source distribution.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

sql

SQLExportQB2.class

Description

This performs the export function for time sheets in QuickBooks. A separate class is required as the export format is different to the other export functions. This is not included in the open source distribution.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

export

sql

SQLExportXML.class

Description

This exports data as an XML-formatted file.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

IDataConstants.class

Description

This handles some data management constants.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

imp0rt

DataImportException.class

Description

This handles error exceptions of data import related classes.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

imp0rt

ImportDataWrapper.class

Description

This formats responses from lower-level import classes to readable format for oCLI.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

imp0rt

sql

SQLImportXLS.class

Description

This imports data to SQL database related classes from excel-formatted files. It performs mapping between aliases and database fields.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

lock

LockManager.class

Description

This locks and unlocks records, and watches for expiration timeouts and lock ownership.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

check

MetamodelChecker.class

Description

This validates (checks the existence of child items: models/aliases/database fields) for a nominated metamodel, model or alias.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

DataModelFactory.class

Description

This manages data model representations.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataFieldCardianlity.class

Description

This checks cardinality constants for aliases. It is generally not used.

??

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataFieldFunction.class

Description

This maintains function constants for aliases.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataFieldInfo.class

Description

This is the public interface for alias information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataFieldType.class

Description

This maintains alias constants.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataModel.class

Description

This is the public interface to datamodel manager.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataModelType.class

Description

This maintains data model constants.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IDataRelationInfo.class

Description

This is the public interface for relation inforomation.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

IMetaModel.class

Description

This is the public interface to metamodels.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

MetaModel.class

Description

This is the generic implementation of metamodels.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

MetamodelCacheThread.class

Description

This performs metamodel caching when the server starts.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

MetaModelFactory.class

Description

This manages metamodels and relationships.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

ISQLDataFieldInfo.class

Description

This is the public interface for SQL alias information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

ISQLDataModel.class

Description

This is the public interface to SQL datamodels.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

ISQLDataRelationExtendedInfo.class

Description

This is the public interface for SQL relationship information for the Database Manager (saved drawing coordinates) and the mutate property.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

ISQLDataRelationInfo.class

Description

This is the public interface to SQL relationship information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

SQLComposer.class

Description

This joins the owner organisation condition for all SQL queries.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

SQLDataFieldInfo.class

Description

This handles SQL alias information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

SQLDataModel.class

Description

This is an object representation of an SQL model file.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

SQLDataRelationExtendedInfo.class

Description

This is the implementation for SQL relationship information for the Database Manager (saved drawing coordinates). It also contains the mutate property which modifies the behaviour of UPDATE.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

model

sql

SQLDataRelationInfo.class

Description

This is the implementation for SQL relationship information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

security

SecurityUtils.class

Description

This checks to ensure that the user is allowed to execute the selected operation on the associated model/relationship.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

IDataSource.class

Description

This is the public generic interface to datasource.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

InsertStatementSetTemplate.class

Description

This contains a template for a set of insert statements, precompiled to native SQL where possible. It is used for the oCLI insertRecordsFromArrays which goes through actionInsertSet.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

ISQLResults.class

Description

This interface handles results returned from select/update/delete operations.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLDataSourceCommon.class

Description

This provides common functionality for select/update/delete operations.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLDataSourceDelete.class

Description

This deletes the data from models/relationships, parses parameters, composes required SQL and returns the results.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLDataSourceExport.class

Description

This fetches the data for export from model/relation, parses parameters, composes required sql and returns the results.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLDataSourceInsert.class

Description

This inserts the data for models/relationships, parses parameters, composes required SQL and returns the results.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLDataSourceSelect.class

Description

This fetches the data from models/relationships, parses parameters, composes required SQL and returns the results.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLDataSourceUpdate.class

Description

This updates the data from models/relationships, parses parameters, composes required SQL and returns the results.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLResults.class

Description

This handles results returned from select/update/delete operations (next, previous, first and last navigation, records count and so on).

This is similar to DatabaseQuery.js on the client side.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

source

sql

SQLTranslator.class

Description

This translates from meta-SQL to native SQL using model information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

data

util

SQLUtils.class

Description

This contains some help methods for the SQLTranslator but they can also be used in the DataModel and Metamodel classes.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

FileUploadProgressListener.class

Description

This returns the percentage of a file upload that has been completed to oCLI.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

jdb

ConnectionPool.class

Description

This establishes connections and keeps them pooled.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

jdb

DataAccessor.class

Description

This performs SQL queries to the database (synchronous or asynchronous, depending on configuration.dat).

This reads and parses the encrypted license file (license.dat). This is only required in the commercial version of once:radix.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

license

LicenseManager.class

Description

This is the commercial license manager.

See also: LicenseManagerFree.class.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

license

LicenseManagerCL.class

Description

This is the class loader for LicenseManager. It loads LicenseManager code from the license file. This is only required for the commercial system.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

license

LicenseManagerFree.class

Description

This is the open source license manager. It overrides the restriction that limits the maximum number of users in the commercial version of once:radix.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

OwnerOrgKeeperThread.class

Description

This puts 0 byte "ownerorg.tmp" files in each owner org. directory so that we can distinguish between those directories and normal ones (e.g. contacts).

This is not required by oSS but can be useful for other processes.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

ReplaceProgressStatus.class

Description

This returns to oCLI, the percentage of a search-and-replace process that has been completed.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

scripting

ScriptHelper.class

Description

This contains public server-defined Javascript functions (read/update/delete data from the database).

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

scripting

ScriptingException.class

Description

This handles server-side Javascript error exceptions.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

scripting

ScriptRunner.class

Description

This executes Javascript using the Mozilla Rhino library.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

AccessDeniedException.class

Description

This handles error exceptions for the oSS security system.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

Authenticator.class

Description

This performs login, logout and returns user information.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

IAuthenticator.class

Description

This is the public interface to Authenticator.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

ISecurityManager.class

Description

This is the public interface to SecurityManager.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

LoginRestrictions.class

Description

This implements check/set IP-based and time-based login restrictions from Authenticator.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

SecurityFactory.class

Description

This returns instances of Authenticator, SecurityManager and it gets/sets the serial key.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

security

SecurityManager.class

Description

This checks/sets permissions to read/write tables, models and blocks.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

ServerInfo.class

Description

This returns the MAC address of the server. It is only used in the commercial license system.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

ServerIntegrityChecker.class

Description

This returns the SHA-1 checksum of the selected .class file. It is only used in the commercial license system.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

SessionManager.class

Description

This is used by ActionUploadFile and ActionReplace to store information associated with your session. This information can then be retrieved by ActionUploadFileCheck and ActionReplaceCheck to calculate the overall progress of a file upload or replacement operation.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

SingletonKeeper.class

Description

This ensures that only one BlockManager exists. It could be integrated into BlockManager.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

SQLTool.class

Description

This is used by ActionGetOrganisation and ActionLoad. It contains common macros used to quote and escape column names and values in SQL.

Applications: Tomcat

webapps

once

WEB-INF

classes

com

once

server

UTF8Filter.class

Description

All responses from servlets pass through this filter to ensure that they use the UTF8 character set.

More details can be found at apache.org and other open source websites, however they are not user accessible so no details are provided here.

Applications: Tomcat

webapps

once

WEB-INF

log4j.properties

Description

Log4j is a package to write log statements to a variety of output targets.

The log statements don't incur a heavy performance cost. The logging behavior can be controlled by editing log4j.properties, without modifying the application. e.g. To change the date format to suit local requirements.

One of the distinctive features of log4j is the notion of inheritance in loggers. By using a logger hierarchy it is possible to control which log statements are output at arbitrarily fine granularity. This helps reduce the volume of logged output and minimizes the cost of logging.

The target of the log output can be a file, an OutputStream, a java.io.Writer, a remote log4j server, a remote Unix Syslog daemon, or even an NT Event logger among many other output targets.

Log4j has three main components (loggers, appenders and layouts) which work together to enable developers to log messages according to message type and level, and to control at runtime how these messages are formatted and where they are reported. More information about log4j can be found at http://logging.apache.org/log4j/docs/index.html.

Applications: Tomcat

webapps

once

WEB-INF

web.xml

Description

This is based on the default web.xml file as supplied by the Apache Software Foundation: ../Tomcat/conf/web.xml. It tells Tomcat how to control servlets.