User Manual¶
Installation¶
NOFAInsert plugin is not a part of the official QGIS repository. However, it still can be installed the same way as other plugins. All you need to do is to add a NINA repository.
Note
Your QGIS and plugin might look different from
the screenshots in this manual. All screenshots presented here were taken
in QGIS with Cleanlooks
style.
You can change your QGIS style
in Settings Options…
General.
First open Plugins Manage and Install Plugins….
In Settings tab activate option Show also experimental plugins.
By clicking on Add… button add a NINA repository:
Name: NINA
URL: http://vm-srv-finstad.vm.ntnu.no/NOFA_plugins/plugins.xml
In All or Not installed tab search for NOFAInsert
.
Select NOFAInsert plugin and click on Install plugin.
After a successful installation plugin’s icon will appear in Plugins Toolbar. You can start NOFAInsert plugin by clicking on its icon or by selecting Plugins NOFAInsert NOFAInsert.
Connection Setup¶
Before inserting data into NOFA database it is necessary to set up connection parameters.
- Element 1:
- Line edits for connection parameters.
- Element 2:
- Button that tests and saves connection parameters.
- Element 3:
- Button that closes the dialog.
First enter all connection parameters (element 1) and then test the connection (element 2). After successful connection test close the dialog (element 3).
Connection parameters can be later accessed by Plugins NOFAInsert Connection Parameters.
Graphical User Interface¶
Graphical user interface of the main window contains two tabs - Main and History. In Main tab you can insert data and History tab serves as an overview of data insertion.
- Element 1:
You can switch between two tabs:
- Main – to insert data. More information.
- History – to view history of data insertion. More information.
- Element 2:
- Database Name – displays name of a database the plugin is connected to.
The whole graphical user interface is customizable meaning that you can resize sections or hide it completely. Widgets that are mandatory and have not been filled or selected yet are displayed with reddish background.
Main¶
Main tab is used for inserting data.
- Element 1:
- Metadata Tool Box – to set metadata. More information.
- Element 2:
Occurrence Table is an overview of all entered occurrences. Data can not be edited directly in the table. To edit data select a row you want to adjust and set data in Occurrence Widgets (element 4). There are several buttons that let you work with the table rows:
- Select row up.
- Select row down.
- Add row.
- Delete selected row.
- Reset selected row.
- Reset all rows.
- Delete all rows except selected one.
- Element 3:
- In Taxonomic Coverage Tree you can select whole families or individual species.
- Element 4:
- Occurrence Widgets show data in a current row in the Occurrence Table (element 2). Any change is immediately written to the table.
- Element 5:
- Reset – to reset the whole plugin to its original state.
- Element 6:
- Insert to NOFA – to insert data into database.
In order to insert data into database all mandatory fields have to filled or selected. You can do that in any order. If you think you have entered everything don’t be afraid and try to click on Insert to NOFA (element 6). Plugin will inform you in case something is missing.
Metadata Tool Box¶
Metadata tool box consists of five sections. All except Reference are mandatory.
- Location – more information.
- Event – more information.
- Dataset – more information.
- Project – more information.
- Reference – more information.
Location¶
In Location section user can set location.
- Element 1:
You can switch between three tabs:
- Search – to search for existing location(s) and add it to the location table. More information.
- Edit – to edit one specific row in Location Table (element 2). More information.
- Manual – to add multiple locations by text. More information.
- Element 2:
Location Table is an overview of all entered locations. Data can not be edited directly in the table. In order to edit data select a row you want to edit and switch to Edit tab. There are several buttons that let you work with the table rows:
- Select row up.
- Select row down.
- Add row.
- Delete selected row.
- Reset selected row.
- Reset all rows.
- Delete all rows except selected one.
- Element 3:
- Preview Button – to add layer(s) to map canvas.
When there is at least one existing/new location in
Location Table, then layer
preview_location-new
/preview_location-existing
is added.
Search¶
Search tab lets you search for existing locations in database and add them to the Location Table.
- Element 1:
- Line edit for searching for water body by name.
- Element 2:
- Combo boxes that narrows search result.
- Element 3:
- Button that performs search based on filters (elements 1 and 2).
- Element 4:
- Button that loads search results to map canvas as a separate layer.
- Element 5:
- Button that adds locationID(s) of selected feature(s) in active layer to the location table.
- Element 6:
- Button that adds OpenStreetMap basemap layer to map canvas.
First, enter filters (elements 1 and 2) and then validate your search (element 3). When at least one location is found you can load a layer containing the result to map canvas (element 4). Finally add selected features in the layer (element 5) to the Location Table. You can also load OpenStreetMap basemap (element 6) to map canvas to make it easier to orientate.
Edit¶
In Edit tab you can edit currently selected row in the location table. Any change is immediately written to the table.
- Element 1:
Combo box with location methods:
- locationID – to enter/edit locationID.
- coordinates – to enter/edit coordinates.
- Norwegian VatLnr – to enter/edit Norwegian VatLnr.
- Element 2:
- Area that changes according to the current method (element 1).
Select method in combo box at the top (element 1). Area below (element 2) changes accordingly and displays widgets where you can enter/edit data. There is only one line edit for locationID and Norwegian VatLnr methods. Method coordinates offers few more widgets and lets you enter coordinates by mouse click on map canvas.
Manual¶
Manual tab allows you to add location(s) to Location Table by text.
- Element 1:
Combo box with location methods:
- locationID – to enter locationID.
- coordinates – to enter coordinates.
- Norwegian VatLnr – to enter Norwegian VatLnr.
- Element 2:
- Area that changes according to the current method (element 1).
- Element 3:
- Button that adds location(s) from text (element 2) to Location Table.
Select method in combo box at the top (element 1). Area below (element 2) changes accordingly and displays widgets where you can enter/edit data. When everything is set add location(s) (element 3) to Location Table.
- Text format with examples:
locationID – “<UUID>” separated by commas.
0001b8f3-65fb-4877-8808-ca67094e1cbb, 0002bdc7-b232-4c5b-bd4d-3d4f21da24b6
coordinates – “<X> <Y> <verbatimLocality (optional)>” separated by commas.
601404.85 6644928.24 Hovinbk, 580033.12 6633807.99 Drengsrudbk
Norwegian VatLnr – “<Norwegian VatLnr>” separated by commas.
3067, 5616, 5627
Dataset, Project, Reference¶
Dataset Project and Reference sections are all basically the same therefore only example for Dataset is present in this manual.
- Element 1:
- Combo box with existing datasets.
- Element 2:
- Button that opens a windows for adding new dataset.
- Element 3:
- List with information about currently selected dataset.
You can select one of existing datasets (element 1) or you can add a new dataset (element 2). List (element 3) displays information about selected dataset.
History¶
In History tab user can view history of data insertion.
- Element 1:
You can switch between tabs:
- Occurrence
- Location
- Event
- Dataset
- Project
- Reference
- Element 2:
- Table that is different for each tab.
- Element 3:
- Insert date filters.
- Element 4:
- Update date filters.
- Element 5:
- User filter.
You can browse data insertion history of different tables (element 1). Change filters (elements 2, 3, 4) to narrow or widen displayed data.