Where Orixa Saves Configuration Settings for different parts of an Application
When users open and close different parts of an Orixa App the size, shape and position of different items are stored, and reused. The ensures that as a user adapts an App for their use it re-opens with items in an expected configuration.
Some settings are saved at the level of the App, so all users see the same thing, other settings are saved per-user.
Occasionally a setting may be saved incorrectly or may need to be reset, in such cases an Orixa Developer can find the Configuration Settings data in an Orixa system-data-table and manually update it. To do this, the Developer needs to know where to look, so details of where settings are stored is provided in this document.
All Orixa "forms" (or windows)
Every window that opens in Orixa descends from a programmatic object which saves its size and position. All these settings are saved in the ConfigurationSettings data-table in the SystemDB.
Accessing the Orixa ConfigSettings |
The view-grid for the ConfigurationSettings data-table will open, with all records visible. |
Finding "FormSettings" in the Configuration Settings data-table |
|
Reviewing the values of the saved-settings for the "PeopleEF" |
|
Updating a ConfigSetting for an Orixa Form |
You cannot edit the ConfigSettings system-data-table directly in your Orixa App. Once you have found the value you want to update, you have to update it using a SQL script. This is done make it impossible to accidentally update data. It also means that when the SQL script is written it can be drafted to change more than one row if needed. Many Configuration Settings have different values per user. In this case a SQL script can update dozens or hundreds of records with a single statement. Example SQL Statement: UPDATE SystemDB.ConfigurationSettings The above statement updates the "StockCounts" BusinessObject's FormSettings. |
All Orixa View-Grids: Settings are saved in the "Searches" system-data-table.
Example Orixa View-grid, showing "All Records" Search
- An Orixa App with a "People" grid active
- The user has opened the grid using the "All records" search.
Developers can extend Orixa by adding Searches which allow users to view specifically chosen data stored for their App's BusinessObjects.
Details of the Searches System-data-table can be reviewed here:
As users work with a view-grid they have many options to adapt / design it. They can change the visibility, width and order of columns, add "group" columns, and filter-conditions.
If the user wishes to save the set-up of a view-grid, they select "Save Settings" from the tools menu.
When this is done, the resulting settings are saved to the ObjectProperties of the Searches system-data-table. The data is saved in human-readable format, but is quite lengthy. It is rarely useful to try to edit this data or reset it using SQL.
If a Developer wishes to reset these saved settings they can do so by deleting the data saved in this field.
Orixa Resources: Settings are saved in the "ObjectProperties" of the table.
Many parts of an Orixa App are generated using data from the "Resources" system-data-table.
Details of the Resources System-data-table can be reviewed here:
Using the "Resources" system-table to create reports ...
The Resources system-data-table also uses an ObjectProperties field to store data about the design and layout of the item it creates. The Developer can access and edit the ObjectProperties if they need to reset or change the settings.
Orixa BusinessObjects: Settings are saved in the "Settings" of the table.
Farmer Deliveries edit form
All Orixa Business Objects display their data using a "data-layout" which deterimes the position and visibility of the data-fields. Developers can edit / design these layouts. Details of how to do this are provided here:
Customizing the User Interface "Layout Controls"
Once a data-layout has been re-designed, the settings for this design are saved in the "Settings" field of the BusinessObjects system-data-table.
Settings field of the BusinessObject system-data-table
- BusinessObjects edit window.
- The user is reviewing the "People" BusinessObject.
- The "Settings" field contains the details of the settings for the data-layout of the People Edit Form.
As with the settings that are saved for Orixa View-grids it is seldom useful to try to manually update the settings data. It is usually easier to delete the existing data and repeat the data-layout design step.
It can be useful to edit the setting data when the name of a field in a data-table has been changed. In this case it can be useful to work through the Settings data and find references to the old name, and change it to the new name. This can either be done manually or using a SQL script.