Full Documentation Index
The following is a full, indexed list of Orixa help documentation generated on: 02/05/2024.
Please remember that your Orixa system does not need to incorporate all, or even many of the features detailed here. Orixa is a well-developed, mature framework, but individual Apps will often focus on a single simple function. Features such as email, reporting, kanban-boards, charting and so on, may not be relevant for your needs. In that case these features would not be added to your App.
1. What is the Orixa Framework?
2. General User-Interface Features
1. The System Entities Screen, general features
2. Customizing the System Entities Screen
4. The Calender / Diary / Scheduler
5. Worksurfaces: Panels that show interlinked data in an intuitive way
6. View Grids for viewing, sorting and finding larger numbers of records
7. System Dataviewers: Panels that show data
8. The Communications Treeview
10. Data Dashboards: Viewing data visually
11. The Data-cube: powerful data analysis
12. Charts: using the system to Visualize data
13. The Resources Treeview: Accessing Resources and Reports
15. Kanban Boards: Panels that organise data by "Status"
16. Using Forecasts within an Orixa App
17. Synchronizing Data between users in a Multi-server Orixa App
3. Data Edit Forms: Viewing, Inserting and Editing Data in Business Objects
1. The main features of Edit Forms: customized controls to enable effective data-entry
2. The "People" and "Organisations" BusinessObjects
3. Built-in data-entities: Comments, FileNotes, Images, Addresses, EmailAddresses and Phones
5. The "Comments" and "FileNotes" Edit Forms
8. The "Email Addresses" Edit Form
9. The "Communications" Edit Form
12. HTML Editor: User Interface to hold formatted text, images and tables
13. The Orixa "Memo" window for editing and viewing long sections of text
14. The Orixa Token Edit Control
15. Spreadsheet Editor: User Interface to hold Excel-spreadsheet-like data
2. Administrator / Developer Guide
1. Overview of Orixa System tables and Database Framework Standards
2. Structuring Your Database - Orixa Standards and "How To" Guide
1. "Relational Data" how Orixa models data
3. Creating a new BusinessObject for an Orixa System
4. Decorating your table column definitions to add functionality to an App
5. Reverse engineering a BusinessObject from an existing record
6. Some example BusinessObjects and explanations of parts of their scripts
7. The Purpose of the BusinessObjects Scripts and how to use them
3. Underlying concepts of the Orixa Framework
1. What actually ends up on a Computer running an Orixa App?
2. Using the "Resources" system-table to create reports, charts, data-cubes and dashboards
3. System Tables: Types and Status
7. System Tables: Comments and FileNotes
9. Using the "ResourceName" field in Resources to chain resources together
4. Specialized Orixa Tools and Apps used by the Developer
2. Customizing the User Interface "Layout Controls"
4. Database Management Utility
5. Registry Management Utility
6. The SQL Scripting "Syntax Editor" and "SQL Modeller"
7. The System "Run Tests" window
9. The CSV Importation (and Export) Utility
10. Customizing or creating your own WorkSurfaces
11. The Upgrader / Installer Utility Program
1. System Actions: Stored Procedures surfaced in the App
2. Adding a Kanban Board to your system
3. Adding a report, chart, cube or dashboard which can be run from the Calender / Scheduler
4. Running SQL scripts to change your App
6. Dynamic Pascal-Scripting in Orixa: Adding a Resource to create Rapid-Entry-Grids in your App
6. Exporting Orixa data to an Excel Spreadsheet using ODBC
7. Importing Data into Your App from Excel, XML or CSV files
8. Disaster Recovery database restoration and other procedures
9. Using and adding to the Orixa Help System
1. Structural guide-lines: How to lay out Help Pages, and editor short-cut keys
10. Customizing the user interface
11. Reallocation of Child Data: Moving child records to link to a new master record
1. Background to Structured Query Language
2. Components of the SQL SELECT Statement
3. SQL SELECT extensions in Orixa
4. Useful websites for SQL language training or reference
1. CREATE STORE, DROP STORE, ALTER STORE
2. CREATE JOB, ALTER JOB, DROP JOB
3. CREATE FUNCTION, CREATE PROCEDURE
6. Basics of SQL Functions and Procedures
7. Configuration Tables in the database and the Database Catalog
4. Programmer Guide: Technical Details of Orixa
2. Creating a new App from scratch in the Orixa DB Utility
3. Third party components used
4. Making Changes to your App Running Change Scripts
5. Restoring a database from a backup file in the Orixa Server Program
5. Miscellaneous documents and FAQs
1. Adding Phone Numbers and Email Addresses
2. Orixa Automated Email Systems
3. System Reporting "XML" template conversions and "FR3" files
4. Using Windows "Quick Assist" to allow assistance by Orixa staff for installations
5. Data backup with Orixa from quick-and-dirty to automated off-site backup Jobs
6. How Data-Field Computation and Generation works in Orixa
7. Trainings System for Managing Staff Training
8. Using the Description field of a Types record to Generate a value
9. Orixa View-Grid Search features
11. Tasks Management Business Object
3. FarmFields and FieldCrops: Mechanisms to store details of Crops per farmer and per field
4. How the "Wages" Computation systems work
5. Extensions to the SocialIndicators system
6. Adding Professional Staff Wages
7. Tax, PAYE and SSNIT Computation in SerendiSys
8. Code for production of a Farmer List with Crop Hectares
9. SMS System Window: Bulk-send SMS Messages
10. QuickBooks data export - import process
1. Product "StatusID" programming
2. Using "ProductPrices" to monitor and update prices
3. Deleted Records Change-tracker
4. Issues with Adding Comments
1. Data model for the Contract Process and details of the WorkItems BusinessObject
1. Bougheys CSV Export Process
2. EESys Continuous Improvement System
4. EESys Stock Movements System
5. Cloning old data from FMSys into EESys
6. EESys Internet Order Confirmation
7. EESys: Use of the Sales Invoices "Dispatched Quantity" Grid
8. Assigning Stock to an Invoice
9. How prices and discounts are set in the SalesInvoices system for EESys
11. Importing Web-shop orders into EESys
12. Daily Activity Worksurface
13. Automated Email Settings for EESys
15. How to Clone Products From FMSys into the EESys database
1. Main Elements of FONSys "System Entities" screen
2. Adding and editing Farmer data
3. Viewing Farmer-lists and editing the data
4. The Inspections, Non-Conformities and Farm-Fields Entities
5. Stepping through the FON Business Process from Purchases to Shipping
6. FONSys: Continuous Improvement System (CIS)
7. Kuapa Kokoo KKSys: Help Files
1. KKSys Database Definition Documentation
1. Society related database elements
2. Farmer related database elements
3. Questionnaire related database elements
4. KKFU related database elements
5. Summaries and Conclusions about Database definitions
6. The cloud API, its standards and operation
1. The Inspection/Questionnaires data-entry system
2. Creating a new Questionnaire
3. KKSys Rapid Entry Grids and Forms
1. Societies Membership Update Form
2. Farmer Deliveries Rapid Entry Grid
4. Membership Updates Dashboard
5. KKFU System Installation and database management
3. KKSys Database Access: Frequent Issues Check-sheet
4. Managing AGIS Inspection Data Importation
5. Working with the "Import AGIS Data" and "Import Mapping" Screens
6. Save Local Updates Procedure
7. Higher Level Developer Guide
1. How the Orixa Subscription System works
2. Problem solving: Clearing / Removing Temporary Files created by the database
3. Programatic Manipulation of Excel Spreadsheets prior to Orixa Importation
4. How to add Pascal Scripts in your App
1. Pascal-Script language elements
2. Pascal-Script functions and procedures
3. More advanced Pascal Scripting
8. Batch insertion of multiple rows of data in a child table
9. Using "DebugView" to review event calls in Orixa Apps and track down difficult bugs
10. Exploring the "EditHistory" user-activity audit table
11. Altering Custom look-up lists in Edit Forms
8. Delphi IDE Help Documentation
1. Settings up GIT and opening EMB sample projects