once:radix Documentation

• once:radix
  • Overview
  • Getting started
  • Fundamentals
  • oADMIN
  • oCLI
  • oED
  • Database
  • Scripting
  • Models
  • Directories
  • Technical Notes

once:client (oCLI)

Applications developed using the once:radix application development environment create a feature-rich experience for users that is seldom seen in a browser. This section introduces the scope of the user experience through the once:client (oCLI).

Applications are page based, usually combining labels (fixed text), data (loaded from the database), images and event-driven programming (using once:script – an extended version of Javascript).

Pages created using once:editor (oED) are stored on the server (as XML blocks and subblocks).

For example: if a block is created called client_details in oED, it submits two files to oSS (client_details.xml and client_details.css). Also if you create a help page called client_details.html and park it in the help directory, it is automatically linked into the help system (oHELP).

In response to requests from once:client (oCLI), once:secureserver (oSS) performs an eXtensible Stylesheet Language Transformation (XSLT) into XHTML and Javascript, then returns the page as a single package (containing XHTML, Javascript and CSS) to oCLI. once:secureserver also caches the page for faster response to future requests for the same page. oCLI renders the page, then waits for user input or, if the page contains an onLoad event, may automatically send a request for data to populate its fields and/or subblocks.

The examples below show typical oCLI and oED pages.

Rich data presentation	Multiple subblocks 1:N relationships	Gantt chart example
Floating oED palettes	Place & position database fields	Event-driven Script Editor

To see practical examples of the power of once:radix, visit the once:fabrik demonstration system. After creating a user account, log on to the system and explore its functionality.

Note:There are many issues that affect system performance: the power of the server, the number of users connected and the distance from the user to the host being three main factors. These demonstration servers were set up for low-level usage, as is typically found in a small enterprise. If you find performance to be much slower than on your own installation, please let us know. We may need to install a higher-capacity server.

The system supports concurrent access to all once:radix applications. After logging on for the first time, you can open extra tabs or windows, then copy and paste the address with session key from the first tab view into the new tabs. As you make changes to a screen design, simply switch from the oED tab to an oCLI tab showing the same page. Refresh the page to show changes you have made, then test the page.

Similarly, users can switch between different views within the oCLI application. So, for example, a user might have one tab showing contact details while another tab could show a view of the invoice module and yet another tab could be connected to any HTML website, completely outside of once:radix.

With so much flexibility, the possibilities are endless!

As described in the Getting Started section, once:radix is provided with a standard username (once) and password (once123). After configuring your web browser, enter the address of your web server. For example, if oCLI and oSS are run on the same computer, and Tomcat is set to the standard port (8080), the address would be: http://127.0.0.1:8080/once/.

At the second Log on screen, set your user preferences, then click Continue or press the enter key to continue.

The once:client application loads, followed by the home page (index.xml). Now you are ready to start using once:radix.

The basic system distributed with once:radix can be accessed through the top menu and a context-sensitive menu that is accessed by right-clicking the mouse (ctrl-click on a Macintosh with a single-button mouse). These functions are described below.

Navigating once:client

once:radix is supplied with Contacts and Security tables. These provide enough functionality to start building a system:

• Contacts
• Security

The organization of data is transparent to the user. However understanding a few basic concepts will help you get the most out of the system.

Relational databases can be represented as a simple tree structure, in the same was as you can represent your family tree: child > parents > grandparents > great grandparents > ... > and so on.

For example, on the Contacts Organization page, each parent record (Organization) may 'own' any number of child records (Person). If the parent record is deleted, the child records should also be deleted or they would no longer have an owner. In other cases, it may not be appropriate to delete child records when a parent record is deleted.

As a general rule: If you have Delete Access Privileges and are not sure of the effect of deleting a record, check first!

Accessing the Database

The database is accessed through a standard set of pages for searching, browsing and editing details stored in the database. These can be reached through the Top Menu.

In addition, links between screens provide shortcuts between associated sets of data. The following sections introduce the techniques to access and manipulate the data. This is followed by a detailed description of the standard screens that serve to create the once:radix environment.

Page Organization

The working area of the once:radix page will vary depending on the page being displayed. For consistency, there are a number of common features:

• Sliding navigation menu at the top of the display (Top Menu).
• Common navigation and action buttons on the left-hand side (Sidebar).
• The Main Display area contains relevant page information, subblock(s) and page navigation buttons.

The main display area also contains a combination of fields and labels, as well as other elements such as checkboxes, radio buttons, links and special purpose action buttons.

The example below shows how a typical page is organized.

On the left-hand side of the header bar is the name of the page. In the example below, the Contact Details page is displayed. On the right, the header bar shows the current position within the found set of parent records. In this example, the search returned 35 parent records, the third parent record displayed shows: Record 3 of 35.

The information shown in the main display area of each page contains a combination of scrollable subblock windows, fields, labels, radio buttons, checkboxes, pop-up lists and images.

In this example, data are organized into one parent record per 'page' and into child subblock records in scrolling windows, which show two addresses plus email and phone details.

A summary of the purpose and application of each page layout is described in the next section: Top Menu.

Top Menu

This section introduces the top menu, which provides easy access to navigate once:fabrik screens. It contains three drop-down menus (some with sub-menus) which allow you to navigate to the key functions of the system.

Move your mouse over the top menu (Contact, Project, etc.) to see lists of sub-menu options. Move the mouse over the second level to view the third-level menus.

Example:
Select Contact on the top menu then Person on its sub-menu to display the Contact Details screen.

The top menu also features a drag handle (a shaded panel to the left of the ◆ icon), which allows the menu to be moved to any position across the top of the page.

Your system may not exactly match this example. It may have functions added or removed to suit your business requirements. Also, clicking on some functions may not respond or it may display a blank screen. This occurs if you don't have access privileges to the screen and/or data. If this occurs and you believe you should be able to access the data to perform your duties, please contact your System Administrator to have access privileges changed.

Menu Functions

Below is a list of all the functions available in the top menu:

• Home
  Displays the home page. This page is also displayed when first logging on to the system.
• Help
  Displays the About Help page, which allows you to navigate the once:fabrik help guide.
• About User
  Shows the current user status within once:fabrik. The information displayed includes the user's current preferences and organization details.
• Log Off
  Exits the current page and displays the personal settings page. Click Continue to return to the home page or Log Off to complete the exit process.
• Contacts
• Person
  Displays personal contact details for every person in the database, regardless of their Type. (There are three types of person contacts in the once:fabrik system: Client, Supplier and Staff). A person may be set to more than one type. Any number of contact addresses (i.e. home, work etc.) and methods of communication (i.e. phone, fax, direct, mobile, email) may be recorded
• Security
  This section is for use by System Administrators. (i.e. managing user permissions.)
• Session
  Displays a list of users logged onto the system. It allows the System Administrator to disconnect users who have not logged out correctly.
• User
  Allows the System Administrator to reset a user password if difficulties are encountered logging on.
• Structure
  Allows the System Administrator to manage the organization and branch names that each user may access when logging on.
• Membership
  Allows the System Administrator to add and remove users to and from Groups.
• Block
  Used to set up the block permissions for a group. These permissions include Read, Write, Modify and Delete. All the blocks can be imported into the table, then permissions can be updated individual or by using the template and applying it to multiple records at a time. The template may also be used when importing the blocks.
• Table
  Used to set up the table permissions for a group. The permissions include Read, Write, Modify and Delete. All the permissions can be updated individually or by using the template and applying it to multiple records at a time.