HLU GIS Tool - Technical Guide Tips can help save time or provide shortcuts. Note: Notes explain things in more detail or highlight important points. Caution: Warnings where administrators

HLU GIS Tool - Technical GuideRelease 2.4.0

Andy Foy

Aug 08, 2017

Contents

List of Figures 1

1 Preface 31.1 Recommended Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Reading Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3 Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.4 Useful links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.5 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.6 Conventions used in this manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Installation 72.1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.2 Latest Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82.3 Installing the HLU Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3 Configuration 113.1 Database Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.2 GIS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.3 Configuring Lookup Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203.4 Configuring Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4 Linking Access to SQL Server 334.1 Linking a new Access database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344.2 Creating a new DSN file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394.3 Updating a linked table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

5 Database 475.1 Data Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475.2 Lookup Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565.3 Export Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605.4 Table Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

6 Database Updater 736.1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736.2 Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

7 Optimisation 75

i

7.1 GIS Optimisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757.2 Database Optimisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

8 Appendix 798.1 GNU Free Documentation License . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

ii

List of Figures

2.1 ArcMap Extensions dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.1 Connection Type dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123.2 OleDb Connection dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133.3 Data Link Properties Provider dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133.4 Data Link Properties Connection dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 143.5 SQL Server Connection dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153.6 Select GIS Application dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.7 Map Document selection dialog (ArcGIS) . . . . . . . . . . . . . . . . . . . . . . . . . 173.8 HLU layer selection dialog (ArcGIS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183.9 Save New Map Document dialog (ArcGIS) . . . . . . . . . . . . . . . . . . . . . . . . 193.10 Format of the lut_user table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203.11 Format of the lut_sources table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223.12 Format of the lut_process table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233.13 Format of the lut_habitat_class table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243.14 Format of the lut_habitat_type table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253.15 Format of the lut_ihs_habitat table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263.16 Format of the lut_legacy_habitat table . . . . . . . . . . . . . . . . . . . . . . . . . . . 273.17 Format of the exports table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283.18 Format of the exports_fields table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.1 External Data tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344.2 Get External Data - OBDC Database dialog . . . . . . . . . . . . . . . . . . . . . . . . 354.3 Select Data Source dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364.4 Select Link Tables dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374.5 Access Objects Navigation Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384.6 Create New Data Source - Select Driver dialog . . . . . . . . . . . . . . . . . . . . . . 394.7 Create New Data Source - Advanced DSN dialog . . . . . . . . . . . . . . . . . . . . . 404.8 Select Data Source dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414.9 ODBC Setup Summary dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414.10 Create New Data Source - Select Server dialog . . . . . . . . . . . . . . . . . . . . . . 424.11 Create New Data Source - Authentication dialog . . . . . . . . . . . . . . . . . . . . . . 434.12 Create New Data Source - Select Database dialog . . . . . . . . . . . . . . . . . . . . . 434.13 Create New Data Source - Summary dialog . . . . . . . . . . . . . . . . . . . . . . . . 444.14 External Data tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

1

HLU GIS Tool - Technical Guide, Release 2.4.0

4.15 Linked Table Manager dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454.16 Linked Table Manager selected tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 464.17 Linked Table Manager Success dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

5.1 User Interface Common Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485.2 User Interface Habitats Tab Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485.3 User Interface Details Tab Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495.4 User Interface Sources Tab Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505.5 Database Relationships - Data Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635.6 Database Relationships - IHS Lookup Tables . . . . . . . . . . . . . . . . . . . . . . . 655.7 Database Relationships - BAP Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665.8 Database Relationships - Habitat Tables . . . . . . . . . . . . . . . . . . . . . . . . . . 675.9 Database Relationships - Sources Tables . . . . . . . . . . . . . . . . . . . . . . . . . . 685.10 Database Relationships - History Tables . . . . . . . . . . . . . . . . . . . . . . . . . . 695.11 Database Relationships - Other Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

2 List of Figures


Permission is granted to copy, distribute and/or modify this document underthe terms of the GNU Free Documentation License, Version 1.3 or any laterversion published by the Free Software Foundation; with no Invariant→˓Sections,no Front-Cover Texts and no Back-Cover Texts. A copy of the license isincluded in the Appendix section.

List of Figures 3


4 List of Figures

CHAPTER 1

Preface

The most up to date version of this documentation can be found in html and PDF form on ReadTheDocs.

Recommended Knowledge

Administrators

We recommend that a person within each organisation should be designated as the tool and databaseadministrator. This person should:

• Have an understanding and experience of IT systems management.

• Understand relational database structures.

• Be an expert user of the chosen database system.

• Have qualifications, certified training or equivalent experience in managing databases using thatsystem.

• Have certified training or equivalent experience in advanced features of the relevant GIS software,including defining, joining and exporting layers and creating spatial and attribute indexes.

Users

A user guide is also available at HLUTool-UserGuide for those who will be regular users of the HLUTool but are not concerned with how to install or configure the tool or how to perform database admin-istration.

Reading Guide

This Preface explains a little about the HLU Tool, the community of people who develop and use it, andthe licensing conditions for using and distributing it and the associated guides.

5

https://readthedocs.org/projects/hlutool-technicalguide/

https://readthedocs.org/projects/hlugistool-userguide/


Installation (page 7) details the system requirements and describes how to install the HLU Tool.

Configuration (page 11) describes how to connect to a HLU Tool database and GIS application.

Linking Access to SQL Server (page 33) provides instructions on how to link an Access front-end to aSQL Server database.

Database (page 47) outlines the database structure and how to adapt the data for local requirements.

Database Updater (page 73) describes the mechanism for apply updates to the database structure andcontents.

Optimisation (page 75) introduces tips for optimising the performance of the tool.

Appendix (page 79) contains a copy of the GNU Free Documentation License v1.3 covering this guide.

Licensing

The code for the HLU Tool is ‘open source’ and is released under GNU General Public License (GPL)v3. Users are free to install it on as many computers as they like, and to redistribute it according to theGPLv3 license.

This guide is released under GNU Free Documentation License (FDL) v1.3. Permission is granted tocopy, distribute and/or modify this document under the terms of the license.

Please remember, however, that the tool cost a lot of money to develop and still requires further de-velopment and ongoing support. Hence any contributions towards costs would be gratefully received.Enquiries can be made via the ALERC forum.

Useful links

Related community links:

• Users - Announcements, bug reports, user Q&A and feature discussions.

• Administrators - Release notes and installers for ArcGIS and MapInfo systems.

• Developers - Tool source code.

• Issues - Known issues and existing change requests.

Acknowledgements

Many thanks are due to all the LRCs in the south-east of England and their staff who have, and continueto, fund and contribute to the HLU Tool. It takes a small army of developers, testers and users to build atruly useful tool (especially users who care enough to test new releases, report bugs and discuss featurerequests).

Conventions used in this manual

The following typographical conventions are used in this manual:

6 Chapter 1. Preface

http://www.gnu.org/licenses/gpl.html

http://www.gnu.org/licenses/gpl.html

http://www.gnu.org/licenses/fdl.html

http://forum.lrcs.org.uk/viewforum.php?id=24

http://forum.lrcs.org.uk/viewforum.php?id=24

https://github.com/HabitatFramework/HLUTool/releases

https://github.com/HabitatFramework/HLUTool

https://github.com/HabitatFramework/HLUTool/issues


Ctrl-A Indicates a key, or combination of keys, to press.

Commit Indicates a label, button or anything that appears in user interfaces.

Tools... –> About Indicates a menu choice, or a combination of menu choices, tab selections or GUIbuttons.

C:\Program Files\HLU Tool Indicates a filename or directory name.

Tip: Tips can help save time or provide shortcuts.

Note: Notes explain things in more detail or highlight important points.

Caution: Warnings where administrators should pay attention.

1.6. Conventions used in this manual 7


8 Chapter 1. Preface

CHAPTER 2

Installation

System Requirements

Hardware

System Requirements

Hard disk space requirements are given as a guideline. The actual amount of disk space required willdepend upon the size of the GIS layers and database files. In addition to these files space is requiredfor temporary files during processing.

Minimum specification:

• 3 GHz Pentium PC

• 2 Gb RAM

• 3 Gb available hard disk space

Recommended specification:

• 3 GHz Dual Core PC

• 3 Gb RAM

• 10 Gb available hard disk space

Tip: For increased performance a multiple core PC with as much RAM as possible is recommended.

Software

Minimum software specification:

9


• .NET framework 3.5 Service Pack 1

• Microsoft Access 2000

• ArcGIS 10.1 or MapInfo 8.0

Recommended software specification:

• .NET framework 3.5 Service Pack 1

• Microsoft Access 2000 or later

• Microsoft SQL Server 2008 R2 Express, OR

• Microsoft SQL Server 2008 R2 Service Pack 2 or later

• ArcGIS 10.1 or MapInfo 10.0.1 or later

Latest Release

The latest release of the tool can be downloaded from GitHub. Two versions of the tool are available:

• For ArcGIS or ArcGIS/MapInfo systems (e.g. v2.3.0). Use when ArcGIS is installed or whenArcGIS and MapInfo are both installed.

• For MapInfo only systems (e.g. v2.3.0m). Use when only MapInfo is installed.

10 Chapter 2. Installation

https://github.com/HabitatFramework/HLUTool/releases


Installing the HLU Tool

To install the HLU Tool double-click on the Setup.exe and follow the instructions. By default thiswill install the HLU Tool into the C:\Program Files\HLU\HLU GIS Tool\ directory and willoptionally display the ReadMe file. The installer will also create two shortcuts in the start menu:

• HLU GIT Tool - Launch - this will start the tool

• HLU GIT Tool - Reconfigure - this will start the tool using the /c switch parameter. See Config-uration (page 11) for details of how to connect to a HLU Tool database and GIS application.

Enable HLU Extension

Important: For ArcGIS users, the tool must be enabled in ArcGIS prior to use. Open ArcMap and goto the Tools menu and select Extensions. . . .

Fig. 2.1: ArcMap Extensions dialog

Tick the box next to ‘HLU ArcGIS Extension’ as shown in the figure ArcMap Extensions dialog (page 9)then click Close and exit ArcMap.

2.3. Installing the HLU Tool 11


12 Chapter 2. Installation

CHAPTER 3

Configuration

The first time the GIS tool is used you will need to configure the database and GIS connection details.Configuration settings are user specific so every user will have to set the database and GIS connectiondetails before they can use the tool.

The connection details, together will all the other user options configurable through the tool’s ‘Options’user interface, are stored in a user.config file within the user’s windows profile.

In Windows 7 the user.config file can be found in:

C:\Users\<username>\AppData\Roaming\HLU\<appname>_<eid>_<hash>\<ver>

For example:

C:\Users\Andy\AppData\Roaming\HLU\HluGisTool.exe_Url_lm5wjls4ajbe40rbxsgduz3nv1mqy1n0\2.3.3.0

Database Connection

In principle the HLU Tool will support connections with multiple relational database systems includingSQL Server, Oracle, PostgreSQL and Microsoft Access, although the connections with PostgreSQL andOracle have not been tested.

It is recommended that the database system used is SQL Server because it provides performance, relia-bility and volume benefits over Microsoft Access. Because PostgreSQL and Oracle use a client/server,as does SQL Server, they will provide similar benefits over Microsoft Access but this has not been testedwith the HLU Tool.

To configure the database connection:

1. Double-click on the link in the start menu or the desktop icon (HLU GIS Tool -Launch) to launch the application.

2. Once the tool is running a ‘Connection Type’ dialog will be displayed as shown in thefigure Connection Type dialog (page 12).

13


Fig. 3.1: Connection Type dialog

3. Select the appropriate connection type from the drop-down list and click OK. For eachdialog fields highlighted in red must be completed.

Tip:

• For SQL Server databases select SQLServer.

• For Access databases select OleDb.

14 Chapter 3. Configuration


Connecting to Microsoft Access

To connect the HLU Tool to a Microsoft Access database containing the HLU data:

1. Launch the HLU Tool and select OleDb from the drop-down list, then click OK. Adialog will be displayed as shown in the figure OleDb Connection dialog (page 13).

Fig. 3.2: OleDb Connection dialog

2. If you have an existing Microsoft Data Link (UDL) file, click UDL File. . . and browseto the appropriate directory.

3. Otherwise, click New to define a new connection. The Provider tab of the ‘Datalink properties’ dialog will be displayed as shown in the figure Data Link PropertiesProvider dialog (page 13).

Fig. 3.3: Data Link Properties Provider dialog

3.1. Database Connection 15


4. Select the relevant OLE DB Provider.

Tip:

• For .MDB databases choose ‘Microsoft Jet 4.0 OLE DB Provider’.

• For .ACCDB databases choose ‘Microsoft Office 12.0 AccessDatabase Engine OLE DB Provider’.

5. Click Next >> to display the ‘Connection’ tab of the ‘Data Link Properties’ dialog asshown in the figure Data Link Properties Connection dialog (page 14).

Fig. 3.4: Data Link Properties Connection dialog

6. Click to browse to an existing database. If user names and passwords are definedfor the database, untick Blank password and enter your user name and password.

7. Click OK, then click OK on the ‘OleDb Connection’ dialog.



Connecting to SQL Server

To connect the HLU Tool to a Microsoft SQL Server containing the HLU data:

1. First attach the database using SQL Server Management Studio and configure userpermissions.

2. Launch the HLU Tool and select SQLServer from the drop-down list, then click OK.

3. Select the correct instance of SQL Server from the drop-down list as shown in thefigure SQL Server Connection dialog (page 15).

Fig. 3.5: SQL Server Connection dialog

Tip: If the computer or server is listed but no services are listed e.g. P3000CA, you caneither:

• Select the computer or server, then press End or use the Arrow keys to move thecursor to the end, then type the name of the database service.

• Exit the HLU Tool, then open the SQL Server Configuration Manager. Right-click onSQL Server Browser and set the start mode as Automatic or Manual. Start the service,then re launch the HLU Tool and select the database service from the list.

4. Select whether you wish to use Windows or SQL Server authentication. This willdepend upon how your SQL Server database has been configured.

5. If you are using SQL Server authentication, enter the user name and password youuse to connect to SQL Server.

6. Select the HLU database from the ‘Database’ drop-down list.

7. The Default schema defaults to ‘dbo’. If you wish to use a different schema, select itfrom the drop-down list, then click OK.

3.1. Database Connection 17


Reconfiguring the Database Connection

To re-configure only the database connection the database configuration information must be reset bystarting the tool with a /d switch parameter. To reset the configuration:

1. In Windows, go to Start Menu > Run. . . .

2. If you have installed the HLU Tool in the default location, at the prompt type:

"C:\Program Files\HLU\HLU GIS Tool\HluGisTool.exe"/d

Note: If you have installed the tool in another location, enter the appropriate folder path indouble quotes followed by /d.

3. This will start the tool and prompt the user to enter new database connection details.

Tip: As part of the installation of the tool a shortcut to ‘Reconfigure’ the tool will automatically beadded to the Start menu (along with a shortcut to ‘Launch’ the tool). This shortcut uses a /c switch (in-stead of the /d switch above) which will reset both the database and the GIS configuration information.



GIS Connection

When the tool is first launched it will check your system to determine which GIS applications are in-stalled. If both ArcGIS and MapInfo are installed on your system a dialog will be displayed for you toselect which one to use as shown in the figure Select GIS Application dialog (page 17).

Fig. 3.6: Select GIS Application dialog

Connecting to ArcGIS/MapInfo

To connect the tool to ArcGIS or MapInfo:

1. A dialog will be displayed which allows you to open an existing ArcGIS map doc-ument or MapInfo workspace which contains the HLU layer as shown in the figureMap Document selection dialog (ArcGIS) (page 17).

Fig. 3.7: Map Document selection dialog (ArcGIS)

Note: For ArcGIS users this dialog may not be visible - hold Alt and press Tab on your

3.2. GIS Connection 19


keyboard to switch windows.

2. If you have an existing map document or workspace which contains the HLU layer,browse to the file and click Open. The HLU Tool will then be ready for use.

3. If you do not have an existing map document or workspace, click Cancel. A dialogwill then be displayed as shown in the figure HLU layer selection dialog (ArcGIS)(page 18) which allows you to select the HLU layer.

Fig. 3.8: HLU layer selection dialog (ArcGIS)

4. Browse to the HLU layer file and click Open. You will then be prompted to selecta location to save as a new map document or workspace as shown in the figure SaveNew Map Document dialog (ArcGIS) (page 19).

5. Browse to the location, enter a name for the map document or workspace and clickOK. The HLU Tool will then be ready for use.

Tip: The GIS connection details can also be reconfigured if necessary through the Tools menu.



Fig. 3.9: Save New Map Document dialog (ArcGIS)

Reconfiguring the GIS Connection

To re-configure only the GIS connection, the GIS configuration information must be reset by startingthe tool with a /g switch parameter. To reset the configuration:

1. In Windows, go to Start Menu > Run. . . .

2. If you have installed the HLU Tool in the default location, at the prompt type:

"C:\Program Files\HLU\HLU GIS Tool\HluGisTool.exe"/g

Note: If you have installed the tool in another location, enter the appropriate folder path indouble quotes followed by /g.

3. This will start the tool and prompt the user to enter new GIS connection details.

Tip: As part of the installation of the tool a shortcut to ‘Reconfigure’ the tool will automatically beadded to the Start menu (along with a shortcut to ‘Launch’ the tool). This shortcut uses a /c switch (in-stead of the /g switch above) which will reset both the database and the GIS configuration information.

3.2. GIS Connection 21


Configuring Lookup Tables

Tables in the database that are prefixed by ‘lut_’ are lookup tables and some of these can be tailored tothe requirements of each organisation. Examples of configuration include:

• Adding new users to enable edit capability.

• Adding new sources as reference datasets.

• Adding new legacy habitats.

• Hiding ‘non-local’ habitats, habitat classes and habitat types.

• Changing the order that the values appear in drop-down lists.

Note: Changes to the lookup tables won’t take effect for HLU Tool instances that are running. TheHLU Tool will need to be closed and re-started before any lookup table changes take effect.

See also:

See Lookup Tables (page 56) for more information on lookup tables.

Configuring Users

New users of the HLU Tool must be added to the ‘lut_user’ table if they wish to apply any updates. Theformat of the table is shown in the figure Format of the lut_user table (page 20).

Fig. 3.10: Format of the lut_user table

Note:

• Users will be able to use the tool even if their user details have not been entered into the lut_usertable. However, ‘[Read Only]’ will appear in the user interface title bar and they will not be ableto apply any changes.

• Users must also have edit access to the database and GIS feature layers in order to apply changesusing the tool.

• Existing user records cannot be removed from the ‘lut_user’ table if they are referenced by any ofthe data records (i.e. if they have applied any changes to the data). This is because data integritymust be retained.



Caution: Bulk update permission should only be assigned to expert users and should only be usedwith caution as mistakes can have major affects on the data.

3.3. Configuring Lookup Tables 23


Configuring Sources

Additional sources can be added to the ‘lut_sources’ table . The format of the table is shown in the figureFormat of the lut_sources table (page 22).

Fig. 3.11: Format of the lut_sources table

Note: Existing source records cannot be removed from the ‘lut_sources’ table if they are referencedby any of the data records (i.e. if they have been used in any incid data records). This is because dataintegrity must be retained.



Configuring Processes

New processes can be added to the ‘lut_process’ table. The format of the table is shown in the figureFormat of the lut_process table (page 23).

Fig. 3.12: Format of the lut_process table



Configuring Habitat Classes

Habitat Classes can be flagged as local or not in the ‘lut_habitat_class‘ table. The format of the table isshown in the figure Format of the lut_habitat_class table (page 24).

Fig. 3.13: Format of the lut_habitat_class table

Setting the local flag of a Habitat Class to ‘False’ (zero) in the ‘lut_habitat_class’ table will stop itappearing in the ‘Habitat Class’ drop-down list in the Habitats tab of the main window and in the ‘HabitatClass’ drop-down list in the Sources tab. This enables entire habitat classes that are not used by theorganisation to be hidden to keep the drop-down list as short as possible.

Note: Only Habitat Classes that are indirectly referenced by records in the‘lut_habitat_type_ihs_habitat’ translation table (by referencing one or more code_habitat_typevalues that relate to a habitat_class_code in the ‘lut_habitat_types’ table and subsequently a HabitatClass code in the ‘lut_habitat_class’ table) will appear in the ‘Habitat Class’ drop-down list in theHabitats tab of the main window, even if the is_local flag in the ‘lut_habitat_type’ table is set to ‘True’(minus one). This is because the ‘lut_habitat_type_ihs_habitat’ table controls the cross-referencebetween different Habitat Classes/Types and IHS Habitats.



Configuring Habitat Types

Habitat Types can be flagged as local in the ‘lut_habitat_type‘ table. The format of the table is shown inthe figure Format of the lut_habitat_type table (page 25).

Fig. 3.14: Format of the lut_habitat_type table

Setting the local flag of a Habitat Type to ‘False’ (zero) in the ‘lut_habitat_type’ table will stop itappearing in the ‘Habitat Type’ drop-down list in the Habitats tab of the main window and in the ‘HabitatType’ drop-down list in the Sources tab. This enables specific habitat types that are not used by theorganisation, or are not found in the local area, to be hidden to keep the drop-down list as short aspossible.

Note: Only Habitat Types that are directly referenced by records in the ‘lut_habitat_type_ihs_habitat’translation table (by referencing one or more code_habitat_type values that relate to a Habitat Typecode in the ‘lut_habitat_type’ table) will appear in the ‘Habitat Type’ drop-down list in the Habitats tabof the main window, even if the is_local flag in the ‘lut_habitat_type’ table is set to ‘True’ (minus one).This is because the ‘lut_habitat_type_ihs_habitat’ table controls the cross-reference between differentHabitat Classes/Types and IHS Habitats.



Configuring IHS Habitats

IHS Habitats can be flagged as local in the ‘lut_ihs_habitat‘ table. The format of the table is shown inthe figure Format of the lut_ihs_habitat table (page 26) (some columns have been hidden).

Fig. 3.15: Format of the lut_ihs_habitat table

Note: Only IHS Habitats flagged as local will appear in the ‘IHS Habitat’ drop-down list in the mainwindow. This enables habitats that are not found in the local area to be hidden to avoid being selected inerror (e.g. coastal habitats in land-locked counties.)



Configuring Legacy Habitats

Legacy habitats can be configured in the ‘lut_legacy_habitat‘ table. The format of the table is shown inthe figure Format of the lut_legacy_habitat table (page 27).

Fig. 3.16: Format of the lut_legacy_habitat table

Note: Existing legacy habitat records cannot be removed from the ‘lut_legacy_habitat’ table if theyare referenced by any of the data records (i.e. if they have been used in any incid data records). This isbecause data integrity must be retained.



Configuring Exports

Adding export formats

Export formats can be added or removed in the ‘exports’ table shown in the figure Format of the exportstable (page 28).

Fig. 3.17: Format of the exports table

Once a new export format has been added to the ‘exports’ table the fields to be included in the exportmust be added to the ‘exports_fields’ table.

Adding fields to an export format

The ‘exports_fields’ table shown in the figure Format of the exports_fields table (page 28) defines whichfields are exported for each export type in the ‘exports’ table.

Fig. 3.18: Format of the exports_fields table

Note: GIS controlled fields such as obj, shape, perimeter, area, x, y, etc. should not be included. Thesefields will be automatically added to the exported layer.



See also:

See Export Tables (page 60) for more information.

Field Formats

The format of some export fields can be modified in the output file.

Lookup related fields The format of all fields that relate to a lookup ‘lut_’ table record can be modifiedusing the following formats:

Table 3.1: Valid Export Field Formats for fields with related lookup tables

FieldFormat

Description Example

Code (orblank)

Outputs only the raw ‘code’ value of the specifiedfield.

‘GA0’.

Lookup Outputs only the ‘description’ field value from therelevant lookup table.

‘Acid Grassland’.

Both Outputs both the ‘code’ and ‘description’ valuesseparated by ‘ : ‘.

‘GA0 : AcidGrassland’.

Note:

• The above ‘field_format’ values (i.e. ‘Code,’ ‘Lookup’ and ‘Both’) are case sensitive.

• The ‘field_type’ must be ‘10’ (text) for the specified field.

• The ‘field_length’ must be long enough to contain the specified output format (up to 254 chars)or it will be truncated.

Source date fields The format of the ‘source_date_start’ and ‘source_date_end’ fields in the ‘in-cid_sources’ table can be modified using the following field formats:

3.4. Configuring Exports 31


Table 3.2: Valid Export Field Formats for source date fields

FieldFormat

Output Description Example

blank Start or End date in the format entered. ‘Jul 2008’ or ‘Nov 2009’‘v’ Both Start and End dates in the format

entered.‘Jul 2008 - Nov 2009’.

‘dd/MM/yyyy’Start or End date as ‘day/month/year’. ‘01/07/2008’ or‘01/11/2009’.

‘mmmyyyy’

Start or End date as ‘month year’. ‘Jul 2008’ or ‘Nov 2009’.

‘yyyy’ Start or End date as ‘year’ only. ‘2008’ or ‘2009’.‘D’ Start or End date in the vague ‘day’

format.‘01/07/2008’ or‘01/11/2009’.

‘O’ Start or End date in the vague ‘monthyear’ format.

‘Jul 2008’ or ‘Nov 2009’.

‘Y’ Start or End date in the vague ‘year’format.

‘2008’ or ‘2009’.

‘P’ Start or End date in the vague ‘seasonyear’ format.

‘Summer 2008’ or ‘Autumn2009’.

Note:

• The above ‘field_format’ values are case sensitive.

• The ‘field format’ value ‘v’ can be used with wither the ‘source_date_start’ or ‘source_date_end’fields.

• The ‘field_type’ must be ‘10’ (text) for the specified field.

• The ‘field_length’ must be long enough to contain the specified output format (up to 254 chars)or it will be truncated.

Caution:

• When using the field format ‘dd/MM/yyyy’ the month portion ‘MM’ must be in capitals(lower case ‘mm’ means ‘minutes’ not ‘Months’).

• Because of the way Source dates are stored in the database, dates entered as a single date (e.g.‘01/07/2008’ or ‘2008’) rather than a date range (e.g. ‘01/07/2008 - 30/11/2009’ or ‘- 2008’)will always have a ‘source_date_end’ of ‘Unknown’ or blank (depending on the chosen outputformat).

• Vague dates (e.g. ‘Jul 2008’ or ‘2008’) are stored based on the first day of the relevant period,so if output in a more precise format (e.g. entered as ‘2008’ but output as ‘mmm yyyy’) theday and/or month output will be the first day/month of the relevant period.

Date field specifiers The following table describes the valid date and time format specifiers.



Table 3.3: Valid date and time format specifiers

Specifier Description“d” The day of the month, from 1 through 31.“dd” The day of the month, from 01 through 31.“ddd” The abbreviated name of the day of the week.“dddd” The full name of the day of the week.“h” The hour, using a 12-hour clock from 1 to 12.“hh” The hour, using a 12-hour clock from 01 to 12.“H” The hour, using a 24-hour clock from 0 to 23.“HH” The hour, using a 24-hour clock from 00 to 23.“m” The minute, from 0 through 59.“mm” The minute, from 00 through 59.“M” The month, from 1 through 12.“MM” The month, from 01 through 12.“MMM” The abbreviated name of the month.“MMMM” The full name of the month.“s” The second, from 0 through 59.“ss” The second, from 00 through 59.“t” The first character of the AM/PM designator.“tt” The AM/PM designator.“y” The year, from 0 to 99.“yy” The year, from 00 to 99.“yyyy” The year as a four-digit number.”:” The time separator.“/” The date separator.space Date or time spacing character.

3.4. Configuring Exports 33



CHAPTER 4

Linking Access to SQL Server

Using SQL Server as the relational database system for the HLU Tool will provide performance, relia-bility and volume benefits over Microsoft Access. But if some of the users don’t have authority to useSQL Server’s Management Studio (SSMS), or aren’t familiar with using SSMS, then one solution is tocreate an Access database front-end and link it to the HLU Tool database in SQL Server.

Many users will be more familiar with Access, so linking Access to SQL Server in this way allows usersto view and edit the HLU Tool data without needing authority to use SSMS and without any risk ofaltering the database structure or settings. Using Access as a front-end to the database in this way alsoallows users to create and share Access queries, forms and reports specific to their needs.

Note: Database administrators need to ensure that users of the Access database have the necessarypermissions to view, add and edit the data tables on the target SQL Server database.

35


Linking a new Access database

The process of linking an Access database to a SQL Server database can be complex and necessitatesthat you know the connection settings for the target database. The following instructions describe howto link to an existing installation of the HLU Tool database running on SQL Server. It should not matterwhich version (i.e. SQL Server or SQL Server Express) is installed or which release, as long as it ismeets the System Requirements (page 7).

Note: It is also possible to link the exporter database to other relational databases, such as PostGIS, butinstructions for this are not provided in this guide.

Other Access versions

The steps in this procedure are based on using Microsoft Access 2012. Instructions for differentversions of Microsoft Access may vary.

The following instructions describe how to link an Access database to a SQL Server database:

1. Make sure your SQL Server service is running and the HLU Tool database is attached.

2. Open the destination Access database in which you wish to create the linked tables.

3. On the ‘External Data’ tab, in the ‘Import & Link’ group, click ODBC Database asshown in External Data tab (page 34).

Fig. 4.1: External Data tab

36 Chapter 4. Linking Access to SQL Server


4. Select Link to the data source by creating a linked table (as shown in Get ExternalData - OBDC Database dialog (page 35)) and then click OK.

Fig. 4.2: Get External Data - OBDC Database dialog

4.1. Linking a new Access database 37


5. In the ‘Select Data Source’ dialog box as shown in Select Data Source dialog(page 36), if the DSN file you want to use already exists, locate and select the DSNfile. If you haven’t yet created a DSN file for the target database skip to Creating anew DSN file (page 39) then continue from the next step.

Fig. 4.3: Select Data Source dialog

Note: If have haven’t already created a data source name (DSN) file for the HLU Tooldatabase see Creating a new DSN file (page 39).



6. Click OK. Access will display the ‘Link Tables’ dialog box as shown in Select LinkTables dialog (page 37).

Fig. 4.4: Select Link Tables dialog

7. Under ‘Tables’, click each table that you want to link to, and then click OK.

Note: Many of the tables in the list are internal SQL Server tables. Do not select these -only select the HLU Tool export, data and lookup tables.

8. If the ‘Select Unique Record Identifier’ dialog box appears, Access was unable todetermine which field or fields uniquely identify each row of the source data. In thiscase, select the field or combination of fields that is unique for each row, and then clickOK. If you are not sure, check with the SQL Server database administrator.

4.1. Linking a new Access database 39


9. If the link is successful Access will display the new linked tables in the Objects Navi-gation Pane as shown in Access Objects Navigation Pane (page 38).

Fig. 4.5: Access Objects Navigation Pane



Creating a new DSN file



The following instructions describe how to create a new .dsn file for the HLU Tool database:

1. Click New to create a new data source name (DSN) file. The ‘Create New Data Source’wizard will start.

2. Select SQL Server in the list of drivers (as shown in Create New Data Source - SelectDriver dialog (page 39)) and then click Next. If you are connecting to a differentdatabase then select the relevant driver.

Fig. 4.6: Create New Data Source - Select Driver dialog

4.2. Creating a new DSN file 41


3. If you wish to enter the ‘Server Name’ and ‘Database Name’ at this stage click onAdvanced... and enter them under the DRIVER keyword (see Create New Data Source- Advanced DSN dialog (page 40) for example). Then click OK to return to the ‘CreateNew Data Source’ wizard.

Fig. 4.7: Create New Data Source - Advanced DSN dialog

Note: If you don’t enter the ‘Server Name’ and ‘Database Name’ here youwill be prompted for them later.

4. Click Next and then choose a suitable file path and file name for your new DSN. Thenclick Save.



5. The file path and file name of the select DSN will be displayed (see Select Data Sourcedialog (page 41) for example). Click Next.

Fig. 4.8: Select Data Source dialog

6. A summary of the DSN settings will be shown (see ODBC Setup Summary dialog(page 41) for example). Click Finish.

Fig. 4.9: ODBC Setup Summary dialog



7. If you didn’t enter the server and database names earlier you will be prompted forthem now. Enter a description for the data source and then from the list choose whichserver you want to connect to (see Create New Data Source - Select Server dialog(page 42) for example). Then click Next.

Fig. 4.10: Create New Data Source - Select Server dialog

Tip: If the server doesn’t appear in the list then manually type the servername it into the Server field



8. Choose either Windows NT authentication or SQL Server authentication, asshown in see Create New Data Source - Authentication dialog (page 43), depend-ing on how the security settings have been defined in the SQL Server database thenclick Next. If you are not sure, check with the SQL Server database administrator.

Fig. 4.11: Create New Data Source - Authentication dialog

9. Select the ‘Change the default database to’ checkbox and then from the list selectwhich database to connect to (see Create New Data Source - Select Database dialog(page 43) for example). Then click Next.

Fig. 4.12: Create New Data Source - Select Database dialog

10. Leave all the settings as the default values and click Finish.



11. A summary of the ODBC Setup will be displayed (see Create New Data Source - Sum-mary dialog (page 44) for example). Click Test Data Source ... to ensure the settingsare correct and the connection works and then click OK to close the test window.

Fig. 4.13: Create New Data Source - Summary dialog

12. Click OK to save the DSN. You will then be returned to the ‘Select Data Source’window to continue linking a new database (see Linking a new Access database(page 34)).

Note: Once you have defined a DSN for your HLU Tool database you won’t need to repeat steps 6 to14 if you need to link another Access database in future.



Updating a linked table

Each time you open a linked table you will see the latest data displayed in it. However, structural changesmade to a SQL Server table are not automatically reflected in a linked table. In this case you will needto update the linked table by applying the latest SQL Server object structure.



The following instructions describe how to update the links from an Access database to a SQL Serverdatabase:

1. Make sure your SQL Server service is running and the HLU Tool database is attached.

2. Open the destination Access database in which you wish to create the linked tables.

3. On the ‘Database Tools’ menu click Linked Table Manager as shown in External Datatab (page 45).

Fig. 4.14: External Data tab

4. The ‘Linked Table Manager’ dialog will appear as shown in Linked Table Managerdialog (page 45).

Fig. 4.15: Linked Table Manager dialog

4.3. Updating a linked table 47


5. Select the Always prompt for new location check box.

6. Click the tables that you wish to update or click the Select All button (see Linked TableManager selected tables (page 46) for example) and then click OK.

Fig. 4.16: Linked Table Manager selected tables

7. If the update if successful Access will display a message to that effect as shown inLinked Table Manager Success dialog (page 46). Otherwise Access will display anerror message.

Fig. 4.17: Linked Table Manager Success dialog

8. Click OK to close the Linked Table Manager.


CHAPTER 5

Database

The database consists of 3 types of tables as follows:

1. Data tables

2. Lookup tables

3. Export tables

Data Tables

Tables in the database prefixed by ‘incid’ are data tables and hence contain all the attribute data relatingto the GIS features. The attributes have been separated into 8 tables to ‘normalise’ the data whichreduces storage space, improves performance and provides greater flexibility.

Key to Data Tables

1. incid

2. incid_ihs_matrix

3. incid_ihs_formation

4. incid_ihs_management

5. incid_ihs_complex

6. incid_bap

7. incid_sources

8. history

How the data tables relate to the fields in the user interface is demonstrated in the following figures:

49


Fig. 5.1: User Interface Common Fields

Fig. 5.2: User Interface Habitats Tab Fields

50 Chapter 5. Database


Fig. 5.3: User Interface Details Tab Fields

5.1. Data Tables 51


Fig. 5.4: User Interface Sources Tab Fields



incid

This is the main data table with one record per INCID. All the other data tables relate to this table viathe INCID field.

incid Char(12) - A unique Incremental identifier for each logical group of features.

legacy_habitat Char(50) - Foreign key to code in the ‘lut_legacy_habitat’ table represent-ing the legacy Habitat for the INCID.

site_ref Char(16) - A free-text field containing a reference for the location of the feature.

site_name Char(100) - A free-text field containing a name for the location of the feature.

boundary_base_map Char(2) - Foreign key to Code column in the ‘lut_boundary_map’table representing the data map used to identify the feature boundary.

digitisation_base_map Char(2) - Foreign key to Code column in the ‘lut_boundary_map’table representing the data map used to digitise the feature boundary.

ihs_version Char(20) - Foreign key to ihs_version in the ‘lut_ihs_version’ table storing theactive version of IHS when the INCID attributes were last updated.

ihs_habitat Char(8) - Foreign key to code in the ‘lut_ihs_habitat’ table representing themain IHS Habitat for the INCID.

general_comments Char(254) - A free-text field containing any general comments relatingto the INCID.

created_date DateTime - The date and time that the INCID was first created (either duringthe initial framework conversion or following a logical split).

created_user_id Char(40) - Foreign key to user_id in the ‘lut_user’ table representing theuser that created the INCID.

last_modified_date DateTime - The date and time that the INCID was last modified.

last_modified_user_id Char(40) - Foreign key to user_id in the ‘lut_user’ table represent-ing the user that last modified the INCID attributes or split or merged the INCID.

incid_ihs_matrix

This table contains any IHS Matrix codes recorded alongside an IHS Habitat code to refine the habitatdefinition for an INCID. There can be between 0 and 3 records for each INCID.

matrix_id Integer - A unique ID for each record.

incid Char(12) - Foreign key to incid in the ‘incid’ table.

matrix Char(8) - Foreign key to code in the ‘lut_ihs_matrix’ table representing an IHSMatrix type.

incid_ihs_formation

This table contains any IHS Formation codes recorded alongside an IHS Habitat code to refine the habitatdefinition for an INCID. There can be between 0 and 2 records for each INCID.

formation_id Integer - A unique ID for each record.

5.1. Data Tables 53



formation Char(8) - Foreign key to code in the ‘lut_ihs_formation’ table representing anIHS Formation type.

incid_ihs_management

This table contains any IHS Management codes recorded alongside an IHS Habitat code to refine thehabitat definition for an INCID. There can be between 0 and 2 records for each INCID.

management_id Integer - A unique ID for each record.


management Char(8) - Foreign key to code in the ‘lut_ihs_management’ table representingan IHS Management type.

incid_ihs_complex

This table contains any IHS Complex codes recorded alongside an IHS Habitat code to refine the habitatdefinition for an INCID. There can be between 0 and 2 records for each INCID.

complex_id Integer - A unique ID for each record.


complex Char(8) - Foreign key to code in the ‘lut_ihs_complex’ table representing an IHSComplex type.

incid_bap

This table contains details of the priority habitats and potential priority habitats for an INCID. There canbe between 0 and 3 records for each INCID.

bap_id Integer - A unique ID for each record.


bap_habitat Char(11) - Foreign key to code in the ‘lut_habitat_type’ table representing apriority habitat (or potential priority habitat).

quality_determination Char(2) - Foreign key to code in the‘lut_bap_quality_determination’ table representing the accuracy with which thepriority habitat has been determined.

quality_interpretation Char(2) - Foreign key to code in the‘lut_bap_quality_interpretation’ table representing how well the priority habitatwas interpreted from the source data.

interpretation_comments Char(254) - A free-text field containing any comments to ex-plain the reasoning behind the priority habitat determination and interpretation.



incid_sources

This table contains details of the source datasets for an INCID. There can be between 0 and 3 recordsfor each INCID.

incid_source_id Integer - A unique ID for each record.


source_id Integer - Foreign key to source_id in the ‘lut_sources’ table representing asource dataset.

source_date_start Integer - Start date of the data range covered by the source dataset rep-resented as the number of days since 01/01/1900.

source_date_end Integer - End date of the data range covered by the source dataset repre-sented as the number of days since 01/01/1900.

source_date_type Char(2) - String that describes the format of the date range covering thesource dataset.

Table 5.1: Vague date types

Date Type Description ExampleD Single day date 15/10/2010DD Day-to-date date range 15/10/2010 - 18/10/2010D- Day start with no end date 15/10/2010 --D Day end with no start date - 18/10/2010O Single month date Oct 2010OO Month-to-month date range Oct 2010 - Nov 2010O- Month start with no end date Oct 2010 --O Month end with no start date - Nov 2010Y Single year date 2010YY Year-to-year date range 2010 - 2011Y- Year start with no end date 2010 --Y Year end with no start date - 2011P Single season date Autumn 2010PP Season-to-season date range Autumn 2010 - Winter 2010P- Season start with no end date Autumn 2010 --P Season end with no start date - Winter 2010U Unknown date Unknown

source_habitat_class Char(5) - Foreign key to incid in the ‘lut_habitat_class’ table repre-senting the habitat classification of the source dataset.

source_habitat_type Char(11) - Foreign key to incid in the ‘lut_habitat_type’ table repre-senting the habitat type of the source dataset.

source_boundary_importance Char(1) - Foreign key to code in the ‘lut_important’ tablerepresenting the relative importance of the source when determining the boundarylocation of all the features in the INCID.

source_habitat_importance Char(1) - Foreign key to code in the ‘lut_important’ tablerepresenting the relative importance of the source when determining the IHS Habitatand associated multiplex codes of the INCID.

5.1. Data Tables 55


sort_order Integer - Determines the (ascending) order the sources for each INCID will bedisplayed in the ‘Sources’ tab of the main window.

incid_mm_polygons

This table is a local database copy of the attribute table for the GIS feature layer to improve performance.If the GIS features are split into separate GIS layers this table contains the attribute records for all thelayers combined. There can be any number of records for each INCID, depending upon how manyTOIDs and TOID fragments are associated with the INCID.


toid Char(20) - The unique Ordnance Survey topographical identifier of each feature.

toid_fragment_id Char(5) - An incremental number (prefixed with zeros) used as a uniquereference for each fragment of a single TOID.

ihs_category Char(2) - Foreign key to code in the ‘lut_ihs_category’ table representing thefirst 2 characters of the IHS Habitat code.

ihs_summary Char(50) - A concatenation of all the IHS habitat and multiplex codes fromthe INCID for this feature. This field is automatically maintained by the tool.

shape_length Float - A decimal value of variable precision representing the perimeterlength of the feature.

shape_area Float - A decimal value of variable precision representing the spatial area ofthe feature.

history

This table contains record of every change to every feature made using the HLU Tool.

history_id Integer - A unique ID for each record.


toid Char(20) - The unique Ordnance Survey topographical identifier of each feature.

toid_fragment_id Char(5) - An incremental number (prefixed with zeros) used as a uniquereference for each fragment of a single TOID.

modified_user_id Char(40) - Foreign key to user_id in the ‘lut_user’ table representingthe user that modified the feature.

modified_date DateTime - The date and time that the features was modified.

modified_process Char(3) - Foreign key to code in the lut_process table representing theactivity being undertaken when the feature was modified.

modified_reason Char(3) - Foreign key to code in the lut_reason table representing theunderlying explanation for the change to the feature.

modified_ihs_category Char(2) - Foreign key to code in the ‘lut_ihs_category’ table rep-resenting the first 2 characters of the IHS Habitat code prior to the changes to thefeature.



modified_ihs_summary Char(50) - A concatenation of all the IHS habitat and multiplexcodes from the INCID for this feature prior to the changes to the feature.

modified_operation Char(3) - Foreign key to code in the lut_operation table representingthe operation that undertaken to cause the change to the feature.

modified_incid Char(12) - The incid prior to the changes to the feature. In the event of alogical split or logical merge this value will be different to the current ‘incid’, other-wise it will be the same as the current ‘incid’.

modified_toid_fragment_id Char(12) - The toid_fragment_id prior to the changes to thefeature. In the event of a physical split or logical merge this value may be differ-ent to the current ‘toid_fragment_id’ otherwise it will be the same as the current‘toid_fragment_id’.

modified_length Float - A decimal value of variable precision representing the perimeterlength of the feature after the changes to the feature.

modified_area Float - A decimal value of variable precision representing the spatial areaof the feature after the changes to the feature.

5.1. Data Tables 57


Lookup Tables

Tables in the database prefixed by ‘lut_’ are lookup tables and are used in many drop-down lists in theuser interfaces to restrict choices to only valid or appropriate values for the organisation.

Some of the lookup tables contain records and settings that are generic to all HLU Tool installations andhence should be considered as ‘system’ records (indicated by the system_supplied attribute set to ‘True’(minus one). These records are configured centrally and updates are applied to HLU Tool installationsusing the HLUDbUpdater.exe tool (see Database Updater (page 73) for more details). The remaininglookup tables can be configured entirely for a given HLU Tool installation to tailor them to the specificrequirements of each organisation.

Note:

• Changes to the lookup tables won’t take effect for HLU Tool instances that are run-ning. The HLU Tool will need to be closed and re-started before any lookup tablechanges to take effect.

• Lookup table values are relevant to the whole database system and hence any changeswill affect all users of that database.

• All records in tables containing a ‘sort_order’ attribute must have a numerical valueset or they may not appear in the relevant drop-down lists.

The following lookup tables should be updated to tailor local requirements:

lut_users

This table contains details of all the users that have editing capability with the HLU Tool and indicatesif they are also able to perform ‘bulk’ updates.

user_id The user’s Windows login ID. If the user logs in to a domain then the login shouldbe entered in the format: [Domain]\[LoginID].1

user_name The name which will be displayed in the ‘By’ fields of the INCID section andthe History tab.

bulk_update Determines whether the user has permissions to run a bulk update to changeattributes for all selected records. Ticking this checkbox gives the user permission torun bulk updates.

sort_order Determines the order user names would be displayed in any relevant drop-down. This field is not currently used (as there are no drop-down lists that displayusers.)

Caution: Bulk update permission should only be assigned to expert users and shouldonly be used with caution as mistakes can have major affects on the data.

See also:

See Configuring Users (page 20) for more information.1 The ‘user_id’ of the current user is shown in the Tools... –> About window.



lut_sources

This table contains details of all the source datasets that can be referenced as a ‘Source’ by an INCID.

source_id A unique ID for each source.

source_name The name which appears in the ‘Name’ drop-down list in the ‘Sources’ tab.

source_date_default [Optional]. If a date is entered, the ‘Vague Date’ field in the‘Sources’ tab will be set to this value (if blank) when this source is selected. If thedate is left blank, the ‘Vague Date’ field will not be altered.

sort_order Determines the order source names are displayed in the ‘Name’ drop-down listin the ‘Sources’ tab.

See also:

See Configuring Sources (page 22) for more information.

lut_legacy_habitat

This table contains details of all the legacy habitats that can be referenced as a by an INCID.

code A unique 50 character field for each legacy habitat.

description A brief description or name that will appear in the ‘Legacy Habitat’ drop-downlist in the main window.

sort_order Determines the order legacy habitats are displayed in the ‘Legacy Habitat’drop-down list in the main window.

See also:

See Configuring Legacy Habitats (page 27) for more information.

lut_process

This table contains details of all the processes that can be referenced as the activity being undertakenwhen applying updates with the HLU Tool.

code A unique 3 character field for each source.

description A brief description or name that will appear in the ‘Process’ drop-down list inthe main window.

sort_order Determines the order processes are displayed in the ‘Process’ drop-down list inthe main window.

lut_reason

This table contains details of all the reasons that can be referenced as the underlying explanation forapplying updates with the HLU Tool.

code A unique 3 character field for each source.

description A brief description or name that will appear in the ‘Reason’ drop-down list inthe main window.

5.2. Lookup Tables 59


sort_order Determines the order processes are displayed in the ‘Reason’ drop-down list inthe main window.

Local Flags & Sort Orders

Regardless of whether records in a lookup table are ‘system’ supplied records or not, many can beconfigured to indicate if they are applicable to an organisation. For example, many lookup tables containa sort_order field that will determine the order that the values appear in any related drop-down lists.Some tables also have a is_local field that can be used to ‘hide’ values that are not applicable to the localarea or should not be used by the organisation.

is_local Set to ‘True’ (minus 1) to include in drop-down lists, or ‘False’ (zero) to excludefrom drop-down lists.

sort_order Set to a sequential, positive numeric whole number to indicate the order recordsshould appear in drop-down lists. Alternatively all records can be set to zero to usethe default sort order for that table.

Note:

• Changes to the lookup tables won’t take effect for HLU Tool instances that are run-ning. The HLU Tool will need to be closed and re-started before any lookup tablechanges to take effect.

• Lookup table values are relevant to the whole database system and hence any changeswill affect all users of that database.

• All records in tables containing a ‘sort_order’ attribute must have a numerical valueset or they may not appear in the relevant drop-down lists.

The following lookup tables can be updated to tailor their is_local and/or sort_order values:

lut_ihs_habitat Contains all the IHS Habitats that can be assigned to INCIDs using the‘Habitat’ field on the Habitats tab of the main window.

lut_habitat_class Contains all of the Habitat Classifications that can be assigned to sourcesusing the ‘Habitat Class’ field on the Sources tab of the main window.

lut_habitat_type Contains all of the Habitat Types that can be assigned to sources using the‘Habitat Type’ field on the Sources tab of the main window (for the selected ‘HabitatClass’).

lut_ihs_complex Contains all the IHS Complex codes that can be assigned using the ‘Com-plex’ fields on the Habitats tab of the main window. [sort_order only]

lut_ihs_formation Contains all the IHS Formation codes that can be assigned using the‘Formation’ fields on the Habitats tab of the main window. [sort_order only]

lut_ihs_management Contains all the IHS Management codes that can be assigned usingthe ‘Management’ fields on the Habitats tab of the main window. [sort_order only]

lut_ihs_matrix Contains all the IHS Matrix codes that can be assigned using the ‘Matrix’fields on the Habitats tab of the main window. [sort_order only]



lut_bap_quality_determination Contains the BAP determination quality types that canbe assigned to Priority Habitats and Potential Priority Habitats on the Details tab ofthe main window. [sort_order only]

lut_bap_quality_interpretation Contains the BAP interpretation quality types that can beassigned to Priority Habitats and Potential Priority Habitats on the Details tab of themain window. [sort_order only]

lut_boundary_map Contains the list of map types that can be assigned to the ‘Bound-ary Map’ and ‘Digitisation Map’ fields on the Details tab of the main window.[sort_order only]

lut_importance Contains the difference levels of Importance that can be assigned toSources using the ‘Boundary Imp.’ and ‘Habitat Imp.’ fields on the Sources tab ofthe main window. [sort_order only]

lut_legacy_habitat Contains the list of legacy habitats that can be assigned to the ‘LegacyHabitat’ field on the Habitats tab of the main window. [sort_order only]

lut_process Contains details of all the processes that can be referenced in the ‘Process’field of the main window to indicate the activity being undertaken when using theHLU Tool. See lut_process (page 57) for more details. [sort_order only]

lut_reason Contains details of all the reasons that can be referenced in the ‘Reason’ fieldof the main window to indicate the activity being undertaken when using the HLUTool. See lut_reason (page 57) for more details. [sort_order only]

lut_sources Contains details of all the source datasets that can be referenced as a ‘Source’on the Sources tab of the main window. See lut_sources (page 57) for more details.[sort_order only]

lut_user Contains details of all the users that have editing capability with the HLU Tooland indicates if they are also able to perform ‘bulk’ updates. See lut_users (page 56)for more details. [sort_order only]

5.2. Lookup Tables 61


Export Tables

Tables in the database prefixed by ‘export’ are export tables and are used to define different formats thatcan be used to export data from the HLU Tool database and GIS layers to a new ‘standalone’ GIS layer.

exports

This table lists all the export ‘formats’ that can be used when exporting data.

export_id A unique identifier used to determines which fields are selected from the ‘ex-ports_fields’ table.

export_name The name which will be displayed in the ‘Export Format’ drop-down list.

Once a new export format has been added to the ‘exports’ table the fields to be included in the exportmust be added to the ‘exports_fields’ table.

exports_fields

Excluded Fields

• GIS controlled fields such as obj, shape, perimeter, area, x, y, etc. should not be included. Thesefields will be automatically added to the exported layer.

• Fields already in the active GIS layer (e.g. toid, toid_fragment_id, ihs_category, ihs_summary)are automatically included in the exported layer and hence should not be added to the ex-ports_fields table.

This table defines which fields are to be exported for each export format in the ‘exports’ table. It alsodefines what the export fields will be called, the order they will appear in the new GIS layer and thenumber of occurrences of each field (where fields can appear in multiple table records.)

export_field_id A unique identifier for the field.

export_id The unique identifier for the export type in the ‘exports’ table (see exports(page 60)).

table_name The name of the source table in the database containing the column to beexported.

column_name The name of the column within the source table.

column_ordinal The number of the column within the source table starting from 1. Theexport function does not require this column to be completed.

field_name The name of the column in the exported GIS layer. The ‘field_name’ must be avalid ArcGIS/MapInfo column name (i.e. containing no spaces or special characters.)

Caution: When exporting to an ArcGIS shapefile field names must be less than 10characters or they will be truncated or renamed by ArcGIS.

field_ordinal Sets the order of the fields in the exported GIS layer.



field_count Allows users to set the number of child records to be exported. Fields from theincid table do not support field_count values as there is only ever one incid record foran incid.

field_type Allows users to set the data type of the field to be exported.

Table 5.2: Valid Export Field Types

FieldType

FieldDescription

Comment

3 Integer Standard number with no decimal places.6 Single Short number with decimal places.7 Double Long number with decimal places.8 Date/Time Date and Time stamp.

10 Text Text field up to 254 characters long.99 AutoNumber Integer field that automatically increments with

each row.

field_length Allows users to set the maximum length of text fields. Text input values longerthan this length will be truncated during the export without warning.

Note: field_length is only used where the field_type is ‘10’ (text), otherwise it isignored.

field_format Allows users to determine the format of the exported field. See Field Formats(page 29) for more details on which export fields can be formatted and how to formatthem.

See also:

See Configuring Exports (page 28) for more information.

5.3. Export Tables 63


Table Relationships

There are 37 tables in the HLU Tool relational database comprised of data tables, lookup tables andexport tables. The relationships between the tables are too numerous and complex to display in a singlediagram so the tables and relationships have therefore been separated into 7 logical groups, some ofwhich connect and overlap with one another.

Tip: Bespoke relationship diagrams between the various HLU Tool tables can be created using SQLServer Management Studio.



Data Tables

Fig. 5.5: Database Relationships - Data Tables

5.4. Table Relationships 65


IHS Lookup Tables



Fig. 5.6: Database Relationships - IHS Lookup Tables



BAP Tables

Fig. 5.7: Database Relationships - BAP Tables



Habitat Tables

Fig. 5.8: Database Relationships - Habitat Tables



Sources Tables

Fig. 5.9: Database Relationships - Sources Tables



History Tables

Fig. 5.10: Database Relationships - History Tables



Other Tables



Fig. 5.11: Database Relationships - Other Tables




CHAPTER 6

Database Updater

In order to apply structural and data changes to the HLU tool database you will need to use the HLUTool Database Updater HLUDbUpdater.exe. The HLU Tool Database Updater provides an automatedmechanism of applying changes to a target HLU Tool relational database. It will process one or morescript files and execute all the SQL commands in the files.

Source Code The source code for this program is open source and can be downloaded from <https://github.com/HabitatFramework/HLUTool-DatabaseUpdater>.

Latest Release The latest release of this program can be downloaded from <https://github.com/HabitatFramework/HLUTool-DatabaseUpdater/releases>.

Latest Scripts The latest scripts for this program can be downloaded from <https://github.com/HabitatFramework/HLUTool-DatabaseUpdater/archive/scripts.zip>.

System Requirements

The HLU Tool Database Updater requires the following to operate:

Hardware

• 2 GHz or higher processor

• 2 GB RAM

• 10 MB of free hard disk space

Software

• Microsoft Windows XP/2003/2008/Vista/Windows 7 or Windows 8

• Microsoft .NET Framework 3.5 SP1, 4.0, or 4.5 installed

75

https://github.com/HabitatFramework/HLUTool-DatabaseUpdater

https://github.com/HabitatFramework/HLUTool-DatabaseUpdater

https://github.com/HabitatFramework/HLUTool-DatabaseUpdater/releases

https://github.com/HabitatFramework/HLUTool-DatabaseUpdater/releases

https://github.com/HabitatFramework/HLUTool-DatabaseUpdater/archive/scripts.zip

https://github.com/HabitatFramework/HLUTool-DatabaseUpdater/archive/scripts.zip


Instructions

The program does not need to be installed - it can be run as a standalone program and will connect toany of the HLU Tool relation database formats, including Access, SQL Server, PostgreSQL and Oracle(although connections to PostgreSQL and Oracle have not been tested). However, it must be run by auser with sufficient database permissions to drop, create & alter tables and to delete, insert, update andselect data in the target relational database.

To run the program:

• Download and unpack the latest .zip release file (see Latest Release (page 73)).

• Download the latest scripts from GitHub (see Latest Scripts (page 73)).

• Ensure that any scripts to be processed are placed in the ‘Scripts’ folder directly under the programpath.

• Double-click the program to start it.

• Click Connect to connect to the target database to be updated.

• Follow the instructions to select the connection type and target database.

• Click Ok once the connection has been established.

• Click Proceed to process the script files found in the ‘Scripts’ folder.

• Progress bars and a text window will show the progress and success of the processing.

• Click Close once all scripts have been processed.

Tip: If you have more than one target HLU tool database, copy the script files from the ‘Scripts/Archive’folder back into the’Scripts’ folder and run the program again - connecting to the next database to beupdated.

76 Chapter 6. Database Updater

CHAPTER 7

Optimisation

The design of the HLU Tool has been optimised as far as possible and there are no known simpletechnological enhancements that can be made to significantly improve performance.

It is important therefore to ensure performance is optimised elsewhere wherever possible through userconfiguration and operation. The following suggestions show some simple approaches to improvingperformance.

GIS Optimisation

GIS Layer Indexing

Attribute indexes Certain functions in the HLU Tool will perform attribute searches on the GIS layer,typically using the INCID and/or TOID fields. It is, therefore, recommended that individualattribute indexes are created on both of these fields.

Spatial Indexes ArcGIS users that frequently zoom in and out using the GIS application whilst the GISlayer is visible, when reviewing or editing using the HLU Tool, then it may be advisable to createone or more spatial indexes on the GIS layer to improve performance when ArcGIS draws thelayer. The choice of scales will depend upon the number, size and density of the features in theGIS layer and the preferred working practices of the users (e.g. if they zoom in and out frequentlyrather than panning).

Creation of ArcGIS Map Document or MapInfo Workspace

An ArcGIS Map Document (.mxd) or MapInfo Workspace (.wor) must be created for use with the HLUTool. This should be optimised to ensure maximum performance, which should include the following:

• Ensure that the .mxd or .wor file only contains one copy of the HLU layer.

• Ensure that the .mxd or .wor is saved at a sensible view level such as 1:10,000 scalerather the full extent of the HLU dataset.

77


• Add zoom layering to datasets so that detailed datasets such as the HLU layer andaerial photography are not displayed at smaller scales. Recommended maximum ex-tents are shown in the table below):

Table 7.1: Recommended maximum GIS extents

GIS Application HLU layer Aerial PhotographyArcGIS (Do not display out beyond) 1:24,000 1:10,000MapInfo (Max Zoom) 7.5 km 3 km

Tips for ArcGIS and MapInfo users

It takes a significant length of time for ArcGIS or MapInfo to draw or query an entire HLU GIS layer,therefore care should be taken when using certain functions. The following tips may help avoid someperformance issues:

• ‘Zoom to Selection’ is useful for identifying the habitat polygons on the map, howeverif zoom layering is not used it may take a significant length of time to display the resultdepending upon the number of polygons selected and their geographical distribution.

• ‘Select by Attributes’ performs complex queries and selects the results in the GISwindow. If a large number of results are returned, it could take a long time to selectthe spatial polygons in the GIS.

• If the GIS layer is taking a long time to draw, pause or cancel the drawing using:

– ArcGIS - Click the Pause button in the bottom left corner of the map window

– MapInfo – Press the keyboard Esc key

• For ArcGIS users, if an ArcMap error occurs when the tool is used, check that theHLU ArcMap Extension is enabled in ArcGIS via Tools –> Extensions. See EnableHLU Extension (page 9) for more details.

• For ArcGIS users, we strongly recommend that the HLU layer is stored as a file geo-database or personal geodatabase.

Caution: The tool will be significantly slower if the HLU layer is stored as a shapefiledue to the limitations of the file format.

• For MapInfo users, ensure the Cosmetic layer is editable when digitising a polygonfor a split operation. The polygon will be added to the layer much faster than if theHLU layer was used and also removes the possibility that the polygon is not deletedafter the split.

78 Chapter 7. Optimisation


Database Optimisation

Database Type

The HLU Tool is designed to work with both Microsoft Access and SQL Server databases (otherdatabases are supported but have not been tested).

Microsoft Access is a versatile desktop database application, but does not have the same performanceas other database systems. Database management systems such as SQL Server are optimised to handlelarge data volumes and complex queries, and can be significantly faster.

It is therefore recommend that the HLU Tool is used with SQL Server or a similar database managementsystem as this will improve performance when filtering the database records and updating attribute data.

Local vs. Network Storage

It is important to remember that application performance will depend upon the data transfer speed. Datastored locally on a single computer will provide good performance, but will limit access to the data to asingle user. Data stored on a network drive is accessible to all users, but performance will be limited bythe speed that the data can be transferred across the network.

Data Management

Only one copy of the database and the GIS layer should be used to avoid data becoming corrupted.If multiple copies are used e.g. an ArcGIS layer and a MapInfo layer or an Access database and aSQL Server database, changes to one GIS layer or database will not be present on the other, causing amismatch between the attribute and spatial data.

Habitat data must not be edited directly in either the database or the GIS layer. Any modifications madeoutside the HLU Tool could cause data corruption particularly if unique identifiers are altered.

However, if additional entries are required in the lookup tables, these may be added to the databasedirectly. It is essential that the structure of these tables is not altered and we recommend that anyupdates to the data in these tables are carried out solely by the database administrator.

7.2. Database Optimisation 79


80 Chapter 7. Optimisation

CHAPTER 8

Appendix

GNU Free Documentation License

GNU Free Documentation LicenseVersion 1.3, 3 November 2008

Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.<http://fsf.org/>

Everyone is permitted to copy and distribute verbatim copiesof this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or otherfunctional and useful document "free" in the sense of freedom: toassure everyone the effective freedom to copy and redistribute it,with or without modifying it, either commercially or noncommercially.Secondarily, this License preserves for the author and publisher a wayto get credit for their work, while not being considered responsiblefor modifications made by others.

This License is a kind of "copyleft", which means that derivativeworks of the document must themselves be free in the same sense. Itcomplements the GNU General Public License, which is a copyleftlicense designed for free software.

We have designed this License in order to use it for manuals for freesoftware, because free software needs free documentation: a freeprogram should come with manuals providing the same freedoms that thesoftware does. But this License is not limited to software manuals;it can be used for any textual work, regardless of subject matter orwhether it is published as a printed book. We recommend this Licenseprincipally for works whose purpose is instruction or reference.

81


1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, thatcontains a notice placed by the copyright holder saying it can bedistributed under the terms of this License. Such a notice grants aworld-wide, royalty-free license, unlimited in duration, to use thatwork under the conditions stated herein. The "Document", below,refers to any such manual or work. Any member of the public is alicensee, and is addressed as "you". You accept the license if youcopy, modify or distribute the work in a way requiring permissionunder copyright law.

A "Modified Version" of the Document means any work containing theDocument or a portion of it, either copied verbatim, or withmodifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section ofthe Document that deals exclusively with the relationship of thepublishers or authors of the Document to the Document's overallsubject (or to related matters) and contains nothing that could falldirectly within that overall subject. (Thus, if the Document is inpart a textbook of mathematics, a Secondary Section may not explainany mathematics.) The relationship could be a matter of historicalconnection with the subject or with related matters, or of legal,commercial, philosophical, ethical or political position regardingthem.

The "Invariant Sections" are certain Secondary Sections whose titlesare designated, as being those of Invariant Sections, in the noticethat says that the Document is released under this License. If asection does not fit the above definition of Secondary then it is notallowed to be designated as Invariant. The Document may contain zeroInvariant Sections. If the Document does not identify any InvariantSections then there are none.

The "Cover Texts" are certain short passages of text that are listed,as Front-Cover Texts or Back-Cover Texts, in the notice that says thatthe Document is released under this License. A Front-Cover Text maybe at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy,represented in a format whose specification is available to thegeneral public, that is suitable for revising the documentstraightforwardly with generic text editors or (for images composed ofpixels) generic paint programs or (for drawings) some widely availabledrawing editor, and that is suitable for input to text formatters orfor automatic translation to a variety of formats suitable for inputto text formatters. A copy made in an otherwise Transparent fileformat whose markup, or absence of markup, has been arranged to thwartor discourage subsequent modification by readers is not Transparent.An image format is not Transparent if used for any substantial amountof text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plainASCII without markup, Texinfo input format, LaTeX input format, SGMLor XML using a publicly available DTD, and standard-conforming simple

82 Chapter 8. Appendix


HTML, PostScript or PDF designed for human modification. Examples oftransparent image formats include PNG, XCF and JPG. Opaque formatsinclude proprietary formats that can be read and edited only byproprietary word processors, SGML or XML for which the DTD and/orprocessing tools are not generally available, and themachine-generated HTML, PostScript or PDF produced by some wordprocessors for output purposes only.

The "Title Page" means, for a printed book, the title page itself,plus such following pages as are needed to hold, legibly, the materialthis License requires to appear in the title page. For works informats which do not have any title page as such, "Title Page" meansthe text near the most prominent appearance of the work's title,preceding the beginning of the body of the text.

The "publisher" means any person or entity that distributes copies ofthe Document to the public.

A section "Entitled XYZ" means a named subunit of the Document whosetitle either is precisely XYZ or contains XYZ in parentheses followingtext that translates XYZ in another language. (Here XYZ stands for aspecific section name mentioned below, such as "Acknowledgements","Dedications", "Endorsements", or "History".) To "Preserve the Title"of such a section when you modify the Document means that it remains asection "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice whichstates that this License applies to the Document. These WarrantyDisclaimers are considered to be included by reference in thisLicense, but only as regards disclaiming warranties: any otherimplication that these Warranty Disclaimers may have is void and hasno effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, eithercommercially or noncommercially, provided that this License, thecopyright notices, and the license notice saying this License appliesto the Document are reproduced in all copies, and that you add noother conditions whatsoever to those of this License. You may not usetechnical measures to obstruct or control the reading or furthercopying of the copies you make or distribute. However, you may acceptcompensation in exchange for copies. If you distribute a large enoughnumber of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, andyou may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly haveprinted covers) of the Document, numbering more than 100, and theDocument's license notice requires Cover Texts, you must enclose thecopies in covers that carry, clearly and legibly, all these CoverTexts: Front-Cover Texts on the front cover, and Back-Cover Texts onthe back cover. Both covers must also clearly and legibly identify

8.1. GNU Free Documentation License 83


you as the publisher of these copies. The front cover must presentthe full title with all words of the title equally prominent andvisible. You may add other material on the covers in addition.Copying with changes limited to the covers, as long as they preservethe title of the Document and satisfy these conditions, can be treatedas verbatim copying in other respects.

If the required texts for either cover are too voluminous to fitlegibly, you should put the first ones listed (as many as fitreasonably) on the actual cover, and continue the rest onto adjacentpages.

If you publish or distribute Opaque copies of the Document numberingmore than 100, you must either include a machine-readable Transparentcopy along with each Opaque copy, or state in or with each Opaque copya computer-network location from which the general network-usingpublic has access to download using public-standard network protocolsa complete Transparent copy of the Document, free of added material.If you use the latter option, you must take reasonably prudent steps,when you begin distribution of Opaque copies in quantity, to ensurethat this Transparent copy will remain thus accessible at the statedlocation until at least one year after the last time you distribute anOpaque copy (directly or through your agents or retailers) of thatedition to the public.

It is requested, but not required, that you contact the authors of theDocument well before redistributing any large number of copies, togive them a chance to provide you with an updated version of theDocument.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document underthe conditions of sections 2 and 3 above, provided that you releasethe Modified Version under precisely this License, with the ModifiedVersion filling the role of the Document, thus licensing distributionand modification of the Modified Version to whoever possesses a copyof it. In addition, you must do these things in the Modified Version:

A. Use in the Title Page (and on the covers, if any) a title distinctfrom that of the Document, and from those of previous versions(which should, if there were any, be listed in the History sectionof the Document). You may use the same title as a previous versionif the original publisher of that version gives permission.

B. List on the Title Page, as authors, one or more persons or entitiesresponsible for authorship of the modifications in the ModifiedVersion, together with at least five of the principal authors of theDocument (all of its principal authors, if it has fewer than five),unless they release you from this requirement.

C. State on the Title page the name of the publisher of theModified Version, as the publisher.

D. Preserve all the copyright notices of the Document.E. Add an appropriate copyright notice for your modifications

adjacent to the other copyright notices.F. Include, immediately after the copyright notices, a license notice

giving the public permission to use the Modified Version under the



terms of this License, in the form shown in the Addendum below.G. Preserve in that license notice the full lists of Invariant Sections

and required Cover Texts given in the Document's license notice.H. Include an unaltered copy of this License.I. Preserve the section Entitled "History", Preserve its Title, and add

to it an item stating at least the title, year, new authors, andpublisher of the Modified Version as given on the Title Page. Ifthere is no section Entitled "History" in the Document, create onestating the title, year, authors, and publisher of the Document asgiven on its Title Page, then add an item describing the ModifiedVersion as stated in the previous sentence.

J. Preserve the network location, if any, given in the Document forpublic access to a Transparent copy of the Document, and likewisethe network locations given in the Document for previous versionsit was based on. These may be placed in the "History" section.You may omit a network location for a work that was published atleast four years before the Document itself, or if the originalpublisher of the version it refers to gives permission.

K. For any section Entitled "Acknowledgements" or "Dedications",Preserve the Title of the section, and preserve in the section allthe substance and tone of each of the contributor acknowledgementsand/or dedications given therein.

L. Preserve all the Invariant Sections of the Document,unaltered in their text and in their titles. Section numbersor the equivalent are not considered part of the section titles.

M. Delete any section Entitled "Endorsements". Such a sectionmay not be included in the Modified Version.

N. Do not retitle any existing section to be Entitled "Endorsements"or to conflict in title with any Invariant Section.

O. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections orappendices that qualify as Secondary Sections and contain no materialcopied from the Document, you may at your option designate some or allof these sections as invariant. To do this, add their titles to thelist of Invariant Sections in the Modified Version's license notice.These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it containsnothing but endorsements of your Modified Version by variousparties--for example, statements of peer review or that the text hasbeen approved by an organization as the authoritative definition of astandard.

You may add a passage of up to five words as a Front-Cover Text, and apassage of up to 25 words as a Back-Cover Text, to the end of the listof Cover Texts in the Modified Version. Only one passage ofFront-Cover Text and one of Back-Cover Text may be added by (orthrough arrangements made by) any one entity. If the Document alreadyincludes a cover text for the same cover, previously added by you orby arrangement made by the same entity you are acting on behalf of,you may not add another; but you may replace the old one, on explicitpermission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this Licensegive permission to use their names for publicity for or to assert orimply endorsement of any Modified Version.



5. COMBINING DOCUMENTS

You may combine the Document with other documents released under thisLicense, under the terms defined in section 4 above for modifiedversions, provided that you include in the combination all of theInvariant Sections of all of the original documents, unmodified, andlist them all as Invariant Sections of your combined work in itslicense notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, andmultiple identical Invariant Sections may be replaced with a singlecopy. If there are multiple Invariant Sections with the same name butdifferent contents, make the title of each such section unique byadding at the end of it, in parentheses, the name of the originalauthor or publisher of that section if known, or else a unique number.Make the same adjustment to the section titles in the list ofInvariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History"in the various original documents, forming one section Entitled"History"; likewise combine any sections Entitled "Acknowledgements",and any sections Entitled "Dedications". You must delete all sectionsEntitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and otherdocuments released under this License, and replace the individualcopies of this License in the various documents with a single copythat is included in the collection, provided that you follow the rulesof this License for verbatim copying of each of the documents in allother respects.

You may extract a single document from such a collection, anddistribute it individually under this License, provided you insert acopy of this License into the extracted document, and follow thisLicense in all other respects regarding verbatim copying of thatdocument.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separateand independent documents or works, in or on a volume of a storage ordistribution medium, is called an "aggregate" if the copyrightresulting from the compilation is not used to limit the legal rightsof the compilation's users beyond what the individual works permit.When the Document is included in an aggregate, this License does notapply to the other works in the aggregate which are not themselvesderivative works of the Document.

If the Cover Text requirement of section 3 is applicable to thesecopies of the Document, then if the Document is less than one half ofthe entire aggregate, the Document's Cover Texts may be placed on



covers that bracket the Document within the aggregate, or theelectronic equivalent of covers if the Document is in electronic form.Otherwise they must appear on printed covers that bracket the wholeaggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you maydistribute translations of the Document under the terms of section 4.Replacing Invariant Sections with translations requires specialpermission from their copyright holders, but you may includetranslations of some or all Invariant Sections in addition to theoriginal versions of these Invariant Sections. You may include atranslation of this License, and all the license notices in theDocument, and any Warranty Disclaimers, provided that you also includethe original English version of this License and the original versionsof those notices and disclaimers. In case of a disagreement betweenthe translation and the original version of this License or a noticeor disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements","Dedications", or "History", the requirement (section 4) to Preserveits Title (section 1) will typically require changing the actualtitle.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Documentexcept as expressly provided under this License. Any attemptotherwise to copy, modify, sublicense, or distribute it is void, andwill automatically terminate your rights under this License.

However, if you cease all violation of this License, then your licensefrom a particular copyright holder is reinstated (a) provisionally,unless and until the copyright holder explicitly and finallyterminates your license, and (b) permanently, if the copyright holderfails to notify you of the violation by some reasonable means prior to60 days after the cessation.

Moreover, your license from a particular copyright holder isreinstated permanently if the copyright holder notifies you of theviolation by some reasonable means, this is the first time you havereceived notice of violation of this License (for any work) from thatcopyright holder, and you cure the violation prior to 30 days afteryour receipt of the notice.

Termination of your rights under this section does not terminate thelicenses of parties who have received copies or rights from you underthis License. If your rights have been terminated and not permanentlyreinstated, receipt of a copy of some or all of the same material doesnot give you any rights to use it.

10. FUTURE REVISIONS OF THIS LICENSE



The Free Software Foundation may publish new, revised versions of theGNU Free Documentation License from time to time. Such new versionswill be similar in spirit to the present version, but may differ indetail to address new problems or concerns. Seehttp://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number.If the Document specifies that a particular numbered version of thisLicense "or any later version" applies to it, you have the option offollowing the terms and conditions either of that specified version orof any later version that has been published (not as a draft) by theFree Software Foundation. If the Document does not specify a versionnumber of this License, you may choose any version ever published (notas a draft) by the Free Software Foundation. If the Documentspecifies that a proxy can decide which future versions of thisLicense can be used, that proxy's public statement of acceptance of aversion permanently authorizes you to choose that version for theDocument.

11. RELICENSING

"Massive Multiauthor Collaboration Site" (or "MMC Site") means anyWorld Wide Web server that publishes copyrightable works and alsoprovides prominent facilities for anybody to edit those works. Apublic wiki that anybody can edit is an example of such a server. A"Massive Multiauthor Collaboration" (or "MMC") contained in the sitemeans any set of copyrightable works thus published on the MMC site.

"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0license published by Creative Commons Corporation, a not-for-profitcorporation with a principal place of business in San Francisco,California, as well as future copyleft versions of that licensepublished by that same organization.

"Incorporate" means to publish or republish a Document, in whole or inpart, as part of another Document.

An MMC is "eligible for relicensing" if it is licensed under thisLicense, and if all works that were first published under this Licensesomewhere other than this MMC, and subsequently incorporated in whole orin part into the MMC, (1) had no cover texts or invariant sections, and(2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the siteunder CC-BY-SA on the same site at any time before August 1, 2009,provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy ofthe License in the document and put the following copyright andlicense notices just after the title page:

Copyright (c) YEAR YOUR NAME.Permission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.3



or any later version published by the Free Software Foundation;with no Invariant Sections, no Front-Cover Texts, and no Back-Cover

→˓Texts.A copy of the license is included in the section entitled "GNUFree Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,replace the "with...Texts." line with this:

with the Invariant Sections being LIST THEIR TITLES, with theFront-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some othercombination of the three, merge those two alternatives to suit thesituation.

If your document contains nontrivial examples of program code, werecommend releasing these examples in parallel under your choice offree software license, such as the GNU General Public License,to permit their use in free software.




Index

AAcknowledgements, 4

CConfiguration

Database Connection, 11Exports, 28GIS Connection, 17Habitat Class, 24Habitat Type, 25IHS Habitats, 26Legacy Habitats, 27Processes, 23Sources, 22Users, 20

DData Tables, 47

History, 54Incid, 51Incid_BAP, 52Incid_IHS_Complex, 52Incid_IHS_Formation, 51Incid_IHS_Management, 52Incid_IHS_Matrix, 51Incid_MM_Polygons, 54Incid_Sources, 52Relationships, 62

Database Updater, 73Instructions, 73Requirements, 73

EExport Tables

exports, 60exports_fields, 60

ExportsExport Fields, 28Export Formats, 28

Field Formats, 29

IInstallation, 9

LLicensing, 4Linking Access to SQL, 34

Creating a DSN, 39Updating Linked Tables, 45

Lookup Tables, 56Local Flags, 58Lut_Legacy_Habitat, 57Lut_Process, 57Lut_Reason, 57Lut_Sources, 56Lut_Users, 56Sort Order, 58

OOptimisation

Database, 77GIS, 75

SSystem Requirements, 7

UUseful Links, 4

91