Home | Using Katmandoo | Quick Start Guide | How-to | Task Menu | Table of Contents | See Also | Collapse All

Sub-system

Overview

Sub-system is used in Katmandoo to logically partition data in the database, typically this would correspond to functional work areas. It is also used to manage security of the data in the Sub-system.

Please read Security Framework for more information on how the Security is implemented in Katmandoo.

Detail

Sub-system Name

The name that can uniquely identify a subsystem, or functional work area, such as a group of trial types.

Following are some suggestions only.
Project Name Sub-system Names
Plant Agronomy Barley Agronomy, Canola Agronomy, Lupin Agronomy,
Wheat Agronomy, Wheat Chemistry etc
Biometric Consulting Pig Trial, Fruit Fly etc
Mango breeding mangoes, post_harvest_testing

Default System-group of Sub-system

The string value of the "DefaultSystemGroupNameSuffixes" key in the .config file is used to generate default system groups of new Sub-system. Please read important information before making any changes in the config file.

  <codeToDatabaseMappings>
    <add key="DefaultSystemGroupNameSuffixes" value="Admins,GenotypeAdmins,Breeders,TrialManagers,Biometricians,Users" />
 </codeToDatabaseMappings>
Example:
Sub-system Name: Lupin
Default System Group: Lupin Admins, Lupin GenotypeAdmins, Lupin Breeders, Lupin TrialManagers, Lupin Biometricians, Lupin Users  

Sub-system Options

The Sub-system Factor is used to set different options (settings) for each sub-system as described below:
Column Name Column Description
Analysis Folder The preferred folder to store the analysed results. While exporting analysed results, the export wizard uses it as the default folder to save the exported file. (1 in the illustrative snapshot).
Apply Default Filter To Current Year If true, the Site Year Main Form or Trial Main Form will display records for the "Site Year = Current Year of the Sub-system" when the form is loaded. 
Can Have Trial Operation If true, the trial in the sub-system can have trial operation and the trial navigator will have the Trial Operation node.
Current Year of the Sub-system Date value of the Sub-system can not be beyond the last day (ie 31 December) of the current year of the Sub-system. It is also used to apply default filter to current year in Site Year Main Form and Trial Main Form.

It's value should be updated every year as required.
Data Entry Folder The preferred folder to store the analysed results. While exporting analysed results, the export wizard uses it as the default folder to save the exported file. (1 in the illustrative snapshot).
Default Genus Name To Search Genotype The Genus that will be selected by default in the Genus combo-box of Search Genotype component. If the Genus does not already exist in the database, then use Manage Genus to add it.
Invalid Character for string Alternate Key (AK) value The characters/words that are not allowed to use the Alternate Key of string (varchar) data type. The characters/words are separated by pipe ( | ).
Invalid Character for string filter value The characters/words that are not allowed to use for the string filter value. The characters/words are separated by pipe ( | ).
Invalid Character for string value The characters/words that are not allowed to use for any string (varchar) data type. The characters/words are separated by pipe ( | ).
Report Folder The preferred folder to export reports. While exporting analysed results, the export wizard uses it as the default folder to save the exported file when the export option "Excel 95-2003 (for Report)" is selected.
Start Year of the Sub-system Date value can not be before the first day (ie 1 Jan) of the start year.
Trial Design Folder The preferred folder to store the trial design input and output files.

Table Structure

Column Name Description
SubSystemId (PK) Identity number that uniquely identifies a Sub-system
SubSystemName (AK) Name that uniquely identifies a Sub-system
SubSystemDescription Description of the Sub-system

Main Form

Use [ Task > System > Manage Sub-system ] to load Manage Sub-system Main Form with all the Manage Sub-systems in the database.
Illustrative snapshot:
Main Form of Sub-system (Click it to change its size)
  1. Main datagrid displaying all the Sub-system that are stored in the database.
    • Use [ View > Arrange columns in Main Form ] to change default order of displayed. Alternately it can be changed by editing the column list of the Misc Group SubSystemSetupDataGrid.
    • Click here for an illustration of the main form template.
  2. Genus with the granted role for the selected Sub-system (ie Lupin Agronomy in the snapshot).
    • Click here for more information on Authorised Genus.
  3. Authorised users of the selected Sub-system (ie Lupin Agronomy in the snapshot).
    • Click here for more information on Authorised Sub-system.
  4. Sites that can be used with the selected Sub-system (ie Lupin Agronomy in the snapshot).
  5. Options of the selected Sub-system (ie Lupin Agronomy in the snapshot).

Setup Form

To add/edit a Sub-system, follow the steps below : Important Note: If you would like to copy a Sub-system (eg clone a Template Sub-system) then select the Sub-system (that you want to clone) in the Main Datagrid and then use [ Record > Repeat Sub-system ].
Illustrative snapshot (Step 1):
 Setup Form (Step 1) of Sub-system (Click it to change its size)
  1. Sub-system name is disabled as it can not be changed after the Sub-system has dependant data. 
  2. Description of the Sub-system which is displayed as ToolTip of currently selected Sub-system in the Startup Form.
  3. Default System Groups of the Sub-system.
    • Default System Groups are added while adding a new Sub-system or when the Sub-system name is changed while editing.
    • It is disabled since since the Sub-system has dependant data.
    • When it is enabled, individual (suggested) System Group/s can be unchecked to exclude from adding in the database.
Illustrative snapshot (Step 2):
 Setup Form (Step 2) of Sub-system (Click it to change its size)
  1. Sub-system Option Name.
  2. Sub-system Option Value.
  3. Currently selected root data folder for the Sub-system.
  4. Click it to select a root data folder of the Sub-system being edited. When the folder is selected, it updates the  Analysis Folder, Data Entry Folder, Report Folder and Trial Design Folder.
Important Note: After the new Sub-system is saved, the Prepare Sub-system Form is loaded.

Cleanup all the data of Sub-system

To delete all the records of a Sub-system,
If the Sub-system does not have any dependant data, you will be prompted to simply delete the Sub-system. But if the Sub-system has any dependant records, then following "Cleanup Sub-system" windows will appear to let you decided what you want to delete.
 
Cleanup Trial Type
  1. Procedures you should follow.
  2. Selected Sub-system Name in the Sub-system main form
  3. Use slider to tick (select) the options to delete. In the snapshot, all the Trial Types, Trials, MET (Multi-environment Trial) Analysis, AOV (Analysis of Variance), Trial Design, Trial Operation and Sample Measurements of the selected Sub-system will be deleted. But the validation rules and Sub-system records will not be deleted as these options are not ticked.
  4. Authorisation Token that must be be entered exactly in the textbox below (5)
  5. Enter authorisation token to confirm deleting data (as explained in 3)
  6. Finally click it to delete records permanently from database ie the deleted records can be recovered.

Prepare Sub-system

Click here for more information on preparing a Sub-system.

Site List of Sub-system

Click here for more information on updating Site List of Sub-system (ie those site that can have trial records for the sub-system).

Alternately Katmandoo can rebuild the Site List. Click here for instruction.

Switching between Sub-systems

Switching between the Sub-systems can be done any time by selecting one of the Sub-system in the Sub-system list in the Startup Form. When a different Sub-system is selected, all the forms and navigators are closed and user permission on the selected sub-system is loaded.

See Also