Field Data Editor. User s guide & Technical manual

Transcription

1 5/8/2005 Field Data Editor User s guide & Technical manual Windows NT /2000 / XP Tmi LTV Forest Joensuu, Finland

2 2 Content 1. About application Installation Starting to use the software Main functions Menus Starting a new data entry project Opening database and editing Data saving, checking and error form Data removal Data to the clipboard Clearing of forms Technical specifications Databases Information about application... 21

3 3 1. About application Field Data Editor software is made for inventory data entry, checking and editing. The program is extremely customizable and appropriate for example in forest inventory projects. Field Data Editor 1.2 works currently in English or Portuguese. In a new inventory project, the user must first define the structure of input data. The program can create a new empty MS Access database file, which includes tables and fields for controlled data entry. The data structure is described in the program parameter file DataInputParameters.mdb. The program s interface is a collection of tally sheets (forms). On one form, there are usually single line data (e.g. plot description data or header data) and/or multiple line data (table, grid) with information about recorded objects (e.g. trees, seedlings, animals). Field Data Editor can handle all these types of forms: 1) Single line data only, 2) Multiple line (grid) data only, 3) Both single line data and multiple line data (grid). Each form belongs to certain level, numbers running from 1. The first number in table s name refers to the level, the second number (_1 or _2) refers to the form s (level s) type of information: _1 = Single line data and _2 = Multiple line data. Example 1 Form No 1. Single line data -> Level = 1_1 Multiple line data -> Level = 1_2 Example 2 Form No 5. Single line data -> Level = 5_1 Multiple line data -> Level = 5_2 The number of levels depends upon number of tally sheets. Missing level numbers are not allowed and level numbers must start from 1. The number and names of the forms are

4 4 written in the program parameter file (see chapter 2). The maximum number of forms is 20. In this paper, level 1 is called as highest (upper) level in the data structure. The field definitions (records) are written into the program parameter file. Before you start your new data entry, modify the parameter file and test it carefully! 2. Installation This program can be used in Windows NT, Windows 2000 and Windows XP. It has not been tested in Windows 95, 98 or ME yet. First, close all applications before installation and log in as Administrator. Then run FieldDataEditor.msi. Program can be installed to any local disk drive and folder, the default folder is C:\Program Files\FieldDataEditor. The main program file is FieldDataEditor.exe. You cannot directly copy the program from one computer to another, one installation is always needed. However, when updating the program version, you can just need to copy the application file. Windows settings: Decimal symbol must be dot. List separator should be comma (,) or semicolon (;). Minimum screen resolution is 1024 x 768. The program parameters file is DataInputParameters.mdb, located in the program folder (see chapter Technical specifications). The file format is MS Access2000. The default folder name for input data is written in DataInputParameters.mdb, table GENERALPARAMETERS, field DataFolder.

5 5 3. Starting to use the software Start the program from Start, Programs menu. The first thing is to create a new database or to open an existing one. A new database is created using menu command File, Create new database.. Select folder and write a new database file name. An existing database is opened with command File, Open database.. Select folder and database file. If the database is successfully opened, the file name appears to program status bar (Figure 1). Program title. Given in Program subtitle. Given in Name of form (Level) Table: GENERALDATA Table: GENERALDATA presented in the tab. Field: ProgramTitle Field: ProgramTitle Single line data (Level_2_1) Current database file name Multiple lines input data (Level_2_2) Cursor s row position in a grid Figure 1. Program s user-interface.

6 6 The names of forms appear into the sheet header in the program. The data field names appear as header texts in the grids. In single line data, the titles have yellow back color and multiple line data have gray back color (default). The current row of the cursor appears in the status bar, when focus in on multiple level data (grid). You can also resize column widths and save you settings using menu command Actions, Save columns widths. The program has two modes: 1) data input mode, and 2) grid editing mode. In the data input mode you can enter and edit data. In the grid editing mode you cannot directly enter and edit grid data, but you can delete rows (F5), add more rows to grid (F6 and F8) and clone records (F7). The key presses F5, F6 and F7 are effective only on the selected row of the grid. You can also copy an active cell data to the clipboard (Ctrl+C) and paste data from the clipboard (Ctrl+V or Shift+Ins). Figure 2. Key press command for grid editing. This Grid Info notice comes visible when pressing F1 key.

7 7 4. Main functions 4.1 Menus Program has three main menu commands: File, Actions and Options (see Figure 3). Figure 3a. Program s menu structure (English version). Figure 3b. Program s menu structure (Portuguese version).

8 8 In menu Options, Grid F-key info you can get information about the command keys for editing data in multiple level data grids. Figure 4. Grid info window. 4.2 Starting a new data entry project Before starting to enter new inventory data, create a new database using command File, Create new database. The program opens a dialog box and you must enter a new file name. The database is in MS Access2000 format. Figure 5. Warning when the database already exists. The structure of input data is defined in the program parameter file, see Technical Manual. Start enter a new data selecting Actions, Input new data.

9 9 Figure 6. New data entry. HINT The best way to enter new sample plot data is to do as follows: create a new database Actions, Input new data. Start enter new data. Best way to move from cell to cell is to use Enter key or direction keys. File, Save data (if data errors emerge, fix them and Save again) Actions, Clear sheets Actions, Input new data (next sample plot) And so on Opening database and editing An existing database can be open with menu command File, Open database. The program opens the selected database and the database name comes to the footnote bar of the program window. Enter new data is selecting Actions, Input new data. Existing data is opened for viewing or editing by selecting Actions, Retrieve and edit data.

10 10 Figure 7. The program s interface for data retrieving. If database is not open, there comes a message, see Fig. 8. Figure 8. Warning when database is not open.

11 Data saving, checking and error form The active data on the form can be saved with menu command File, Save data. If data with the same identification numbers already exists in the database, the program asks if it is replaced with the new data. Figure 9. Message box: replacing the data. The program writes the data directly into the database. If there are errors in the data, the error messages are collected into a special error form. Notice: If the master field data are correct, the program always saves the data, even if there are error cases. The program can carry out the following validity checks: 1) Item value is not found in the parameter database table. 2) Item value is more than minimum value. 3) Item value is less than maximum value. 4) Crosscheck. Item value is allowed in current data record. For instance, there can be a rule that commercial tree height can not exceed total tree height. Figure 10. The program s error message. If case of missing data value, the program writes zero (0) to a numeric field, blank ( ) to a text field.

12 Data removal Data on the form can be saved with menu command File, Save data. If the data with the same identification numbers already exists in the database, the program asks if that data is replaced with the new data. Figure 11. Data removal. 4.6 Data to the clipboard Data from the current active form can be copied to the clipboard with menu command File, Copy tables. The program copies the header texts and the data from the visible grids. The invisible, so-called Master Fields, are also copied. Figure 12. Form data copied via clipboard into MS Excel. You can also copy an active cell to the clipboard (Ctrl+C) and paste data from the clipboard (Ctrl+V or Shift+Ins).

13 Clearing of forms The forms can be cleared using menu command Actions, Clear sheets. The program gives a warning before clearing. Figure 13. The message box before clearing the forms.

14 14 4. Technical specifications 4.1 Databases The program parameters are in MS Access database DataInputParameters.mdb in program folder. This database includes the following tables (see Figure 14): 1) GENERALDATA, 2) FORMS, 3) tables for each data sublevel (Level_FormNo_SubNo) and 4) unlimited number of tables for categorical data. Figure 14. Example of parameter file with two forms (levels 1 and 2). In this case, Form 1 has only one sublevel (single line data); Form 2 has two sublevels (single line and multiple lines data). The maximum number of forms (levels) is 10. Each level can have 1-2 sublevels. Missing level numbers are not allowed and the numbering must start from 1 up. Level_1_1 must always exist and it must present single line data. This table must have 1 3 special field(s) called scroll field(s). A scroll field is equal to the identifier for the data. Scroll fields are repeated in each table (see definition for DataMasterField). The data type of a scroll field must be INTEGER. A scroll field can be for example sample plot number. Scroll field index(es) is/are defined in the table GENERALDATA. Scroll fields order must be successive (ascending) on Level_1_1. An example of data entry with three scroll fields in presented in Figure 15.

15 15 Figure 15. An application with 3 scroll fields (Job No, Map sheet no, Grid code). Scroll field names (master fields) are presented with red back color. In case of cluster sampling, there must be separate forms (levels) for each sample plot and subplot, and the cluster number must act as scroll field. Figure 16. Data structure of the table GENERALDATA

16 16 GENERALDATA, Fields explanation ProgramTitle - main title of the program (see Figure 1) ProgramSubTitle - subtitle of the program (see Figure 1) ScrollFieldIndex - main scroll field index(es) in Level_1_1 1 3 indexes, separator is comma (,) E.g. 1 st and 3 rd field: 1.1,1.3 List order must be successive (ascending) in Level_1_1. ParameterDatabase2 - optional. If categorical data is in Access another file, then this field is filled OrganizationName - (optional text) Editor - (optional text) DataFolder - default data folder Date - (optional text) Comments - (optional text) Table FORMS includes the names of the forms (levels), see Figure 17. Figure 17. Data structure in the table FORMS FORMS, Fields explanation FormNo - Form number, 1 10 FormName - Form name, cannot be empty Comments - (optional) Tables Level_FormNo_SubNo include the record definitions of each form and grid. SubNo refers to data type on the form: Example Form No 1. Single line data -> Level number is 1_1 Multiple line data -> Level number is 1_2 Level_1_1 must always exist. There may be only single line data, only multiple line data or both on each form. The table structure is presented in the Figure 18.

17 17 Figure 18. Data structure of the table Level_FormNo_SubNo Level_NN_nn, Fields explanation DataNo - running number 1 up DataHeader - header text in the grid Also field s title in the database if DatabaseHeader is null DatabaseHeader - field s title in input database. Can be null if DataHeader is used as field name SheetParameterTableName - table for codes and titles of categorical data (see next paragraphs). - if the first letter is exclamation mark (!), then the field is a comment SheetFieldSize - field s maximum data length (optional for numbers), In case of Text, this field defines maximum text length in the input database SheetMinimum - in case of number data type, minimum value (optional) SheetMaximum - in case of number data type, maximum value (optional) SheetCrossCheck - rule of crosschecking in a data record. See chapter Cross check rules. SheetColumnColorCode - (optional). Header text s back color. Valid with multiple rows data only (grids). Default color (0) is gray. Other color codes are: 1= Magenta, 2= Blue, 3= Cyan, 4=Green SheetColumnWidthCode - Column s width on screen (Unit: twips) DataType - Defines type of data: i=integer, l=long integer, s=single, d=double value, t=text if type is text, the text length is read from field SheetFieldSize DataMasterField - see explanation below this list

18 18 DataRequired - Yes / No DataFieldIndexed - Index in database. Yes/ No Comments - (optional). Any text comment. DataMasterField Field DataMasterField is filled only if 1. the same information is repeated in the latter forms or 2. if a constant value is entered into that specific field. The scroll fields are the keys to find data from the inventory database. Hence, these fields must be repeated in all sublevels, with same titles and data types as on Level_1_1. However, you do not need to fill these fields on each form, because they will be filled automatically. In this case, DataMasterField includes the column reference number (index) pointing to the upper level table. Notice: Index can only point to the single line data on previous (upper) level. However, you can read data from earlier (upper) levels both into single line grid or into multiple lines grid. Example of repeated field value In table Level_2_1, there is a field named PlotNumber. This information was earlier entered into the table Level_1_1, in the 3 rd field of it. So, write into DataMasterField index: 1.3 The second possible use for DataMasterField is that it can include constant data value that is entered into the field automatically. For example, Form Number might be given in the input data, but there is no reason to write it manually because it is a constant value on each form. The constant value is written following asterisk character (*). Example of constant field value Field includes always form number 4, hence write into DataMasterField: *4 Field includes always text Maputo, hence write into DataMasterField: *Maputo Notice: Column (=field) with information in DataMasterField is invisible on the screen. The right value will be read and saved into the database at the time of saving the data.

19 19 Categorical data User can have categorical data in tally sheets, such as coded districts or states. These codes can be checked when data is saved. The code tables can be in DataInputParameters.mdb or in another database file. In the second case, this file name must be written in the table GeneralData, field ParameterDatabase2. Figure 19. An example of table Level_1_1 with categorical data (information in field SheetParameterTableName) The user can add new tables into the parameter database simply by coping and renaming existing model tables (see table canopy_layer in Figure 20). The table name can be set freely. The table name related to certain field in the input data must be defined in the field SheetParameterTableName in the level where applicable. The program uses Code values in data entry checks: it checks that entered code is allowed. Figure 20. Data structure in a parameter table (categorical data) referring to column SheetParameterTableName. Notice that code is always as text.

20 20 Cross check rules User can build special cross check rules in order to check consistency in the data records. The program can do checks only in each data record, not between records or tables. The rules are written in to field SheetCrossCheck. Basically, there are two kinds of rules: 1) The value of the field should be relative to the value in the other field. The rule is expressed as logical equation. For example: Bole height must be less than Total tree height. 2) R-rules. The value in the field orders the value in another field, e.g. if Topography is plain, then Slope and Aspect must be zero. Rule type 1. For example, tree height (m) should be less than three times of diameter (cm). The rule is applied to field name Height and diameter if in the fifth column of the same table. Hence, the logical rule is as follows: [c]<3*[5] where [c] = current field value (Height) [5] = value in the 5 th field (diameter) In addition, if the user wants to add into the rule that tree height should be at least 1.3 meters, then the rule is as follows: AND([c]<3*[5],[c]<=1.3) or simply ([c]<3*[5],[c]>=1.3) Rule type 2. (R-rules) Start writing the rule with R. For example, if Topography is plain, then Slope and Aspect must be zero. Topography Current field [c], 0=code for plain Slope 7 th field Aspect 8 th field The rule is as follows: R[c]=0;AND([7]=0,[8]=0) For example, if Soil consistency=1 (current field), value in Soil texture (field 24) should be 4 or 5, if Soil consistency=2, value in Soil texture (field 24) should be 2 or 3, if Soil consistency=3, value in Soil texture (field 24) should be 1 or 2. The rule is as follows: R[c]=1;OR([24]=4,[24]=5) [c]=2;or([24]=2,[24]=3) [c]=3;or([24]=1,[24]=2) The program solves the logical expression. If the logical rule gets value FALSE, an error message is returned in the Error Form.

21 Information about application The program was coded by using Visual Basic TM 6.0 Professional (updated with Visual Studio Service Pack 6). Database structure was created with MS Access TM (version 2000). Database management uses ADODB connections and SQL (Structural Query Language) in the code. Feedback Any type of feedback is welcome and highly appreciated! Contact Mr Lauri Vesa New languages You can assist to create new language versions of Field Data Editor! Please download the list words and phrases from The file is in MS Excel format. Make your translation for a new language and send the file back to L. Vesa s mail box. You will soon get a copy of new language version. Copyright and liability Source code copyright owned and all rights reserved by. In no event shall Tmi LTV Forest be liable for any special, incidental, indirect, or consequential damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use the software product or the provision of or failure to provide support services, even if Tmi LTV Forest has been advised of the possibility of such damages.