once:radix Documentation
once:administration (oADMIN)
In the section Connecting to the Server, you are instructed to click Continue. This loads the once:client application (oCLI). If you click Admin, you will load the once:admin applications (oADMIN). Its functions are described in this section.
Commands are accessed via the context menu, which is displayed when the right-hand mouse button is clicked; or ctrl-click on Mac OSX with a single-button mouse.
Run SQL
Raw SQL database commands can be entered in the small panel at the bottom of the screen and results are displayed in the large panel at the top of the screen. SQL statements are executed by selecting Run SQL from the context menu. The statements are performed and the results are displayed at the top of the screen.
WARNING: Direct SQL statements to the database must be performed with caution. This function should be restricted to trained Database Administrators.
To create a new Schema
In oADMIN, enter the following command:
CREATE SCHEMA "new_schema";
where "new_schema" is the name of the schema to be added.
Then execute the Run SQL command.
If successful, the following message is displayed:
0 row(s) affected.
If you attempt to create a schema using an existing schema name, an error message is displayed:
org.postgresql.util.PSQLException: ERROR: schema "new_schema" already exists
For the Database Manager to recognise a new schema, it must contain at least one table. Every table must have primary and owner organisation fields. Here is a simple way to do that, by creating the table with the two fields that every table MUST contain:
CREATE TABLE "schema_name"."table_name" (
"primary" SERIAL,
"ownerorganisation" TEXT,
PRIMARY KEY("primary")
);
where "schema_name" is the name of an existing schema and "table_name" is the name of the table to be added.
If successful, the following message is displayed:
0 row(s) affected. 0 row(s) affected.
Note: The table can also be created in the Database Manager.
WARNING: An intermittent fault has been reported where the Database Manager issues invalid SQL commands that will cause the server to hang, forcing you to have to restart the server. e.g. Creating a field in a table that already exists.
Note: New schema and at least one table are created in oADMIN. Extra tables can be created in the Database Manager.
File
There are three options displayed when the File sub-menu is displayed:
- Backup
- Restore
- Log Off
Backup
The database linked to your application can be backed up manually to the server's backup directory by executing this command. This message is displayed following successful completion. Remember to perform a backup prior to performing any work on your system.
Restore
When the Restore command is selected, a list of backed up copies of the database is displayed. This operation overwrites the current database so remember to make a backup before executing this command.
Tools
There are four options displayed when the Tools sub-menu is displayed:
- Rebuild Cache
- Recompile Reports
- Check Metamodel Integrity
- Scheduler
Rebuild Cache
Metamodels define the relationships that join the database tables. Models define the tables. After restarting the server, the relationships are loaded by the server's metamodel manager to construct and pre-cache the SQL statements that will be used to reference the database. This process can be executed manually at any time by executing the Rebuild Cache command. Depending on current activity on the server, this operation may take a few minutes to complete.
Recompile Reports
Reports are generated using JasperReports – 'The world's most advanced reporting engine'. The reports are created using i-Report (also from JasperSoft) and stored on the server. Reports are compiled and cached the first time they are loaded after restarting the server. When designing reports, this command is used to clear the cache and reload reports after changes are made.
Check Metamodel Integrity
This command performs an integrity check of the Metamodels and Models by comparing them to the current database. This is a useful tool during system development to verify that the data structure has been correctly defined.
Scheduler
The Scheduler palette is a multi-function control for a number of housekeeping operations that are performed periodically or at a specific day of the week and time of day. There are four panels within the Scheduler window:
- Available Tasks
- Running Schedules
- Schedule Details
- Run Time
Examples of tasks performed by the Scheduler include:
- Database backup
- Cleanup old database backups
- Cleanup logs
- Reindex database
- Cleanup export files
- Vacuum database
- Send mail
- Write debug info to log
A list of Running Schedules is displayed to the right of Available Tasks. New schedules can be:
- Added to (Select the schedule name in the Available Tasks panel, then click Run.),
- Changed (Select the schedule name in the Running Schedules panel, then click Edit) or
- Cancelled (Select the schedule name in the Running Schedules panel, then click Delete).
The Schedule Details panel allows a schedule to be set to run at intervals of time (e.g. every 15 minutes) as set in the Interval panel or at a specific time of day, as set in the Run Time palette.
A list of Run Times is displayed to the right of the Schedule Details panel. They can be:
- Added to (Select the schedule name in the Available Tasks panel, then click Add.),
- Changed (Select the schedule name in the Running Schedules panel, then click Edit) or
- Cancelled (Select the schedule name in the Running Schedules panel, then click Delete).
Help
The last option in the Context palette is the Help function.
This opens the oADMIN section of the help system (oHELP).
It also displays the oADMIN flash screen which shows the software version number as well as software license and copyright details.