7. FAQ¶
7.1. Frequently Asked Questions¶
This is a list of Frequently Asked Questions about the HLU Tool. Feel free to suggest new entries!
How do I get a copy of the tool?
The source code can be downloaded from GitHub at github.com/HabitatFramework/HLUTool and the latest installer set-ups for ArcGIS/MapInfo and MapInfo only can be downloaded from GitHub at github.com/HabitatFramework/HLUTool/releases.
Do I have to use IHS with the tool?
Yes, IHS is an integral part of the tool and data structure. It is likely that your existing habitat data can be translated into IHS and, once in IHS, it can easily be exported as IHS habitats, Broad habitats or Priority habitats.
Why does the tool title bar show [READ ONLY]?
This shows that the data cannot currently be edited. This is either because your userid has not been added to the database or has been added incorrectly (see ‘Lookup Tables’ in the HLU Tool Technical Guide at readthedocs.org/projects/hlutool-technicalguide for details), or the active GIS layer is not in an active edit state. Once both of these conditions have been met click on the main window and the [READ ONLY] status should disappear.
Can I use data that isn’t snapped to OS MasterMap?
Technically you could but only by providing dummy unique TOID values to every feature in your data. This is because the tool is designed to use the TOID to determine when a physical split or merge is to be performed and to manage the TOID_Fragment_IDs. Without dummy unique TOIDs the tool would assume all the features in your data are fragments of the same ‘blank’ TOID which would heavily impact on performance. However, integrating habitat data with OS MasterMap also brings other benefits such as providing spatial accuracy to your data and providing a framework within which more recent or comprehensive habitat and land use data can be applied. See Habitat Framework for more details.
How do I convert my existing data into the required format?
The conversion of one or more existing habitat layers into a state that can be used with the HLU Tool is not simple, but the process brings all the benefits of having an OS MasterMap framework, and once completed the benefits of using the HLU Tool. There are up to 4 steps required to convert existing habitat layer(s) so that it can be used by the HLU Tool:
Translate the habitat code(s) to IHS.
Create an OS MasterMap framework for your regional extent and load with the IHS habitat data.
Assign the OS MasterMap framework the required attributes to format them to match the required standards.
Load the attribute data into the target relational database and save the spatial and minimum attribute data in a valid HLU GIS layer format.
It is recommended that the conversion is performed by someone familiar with IHS and the OS MasterMap framework, expert in the configuration of the HLU Tool, experienced in advanced GIS geospatial processing, and ideally expert in SQL Server and developing data conversion routines. Enquiries can be made via the ALERC forum at forum.lrcs.org.uk/viewforum.php?id=24.
Can I hide IHS habitats that don’t occur in my region from the drop-down lists?
You can currently hide IHS habitats from the Habitat list on the IHS tab in the main window (see ‘Lookup Tables’ in the HLU Tool Technical Guide at readthedocs.org/projects/hlutool-technicalguide for details). There is also a planned change request to enable non-local IHS Habitats to be hidden from the Habitat Type list on the Sources tab in the main window.
Can several people use the tool at the same time?
Any number of users can use the tool for read-only access if they have a copy of the tool installed on their PC. Multiple users can also use the tool in edit mode but only within the limits of the database system and GIS application used by the tool. So the GIS layer and database would also have to be configured to support multiple users.
Does the tool work with QGIS?
Currently only ArcGIS and MapInfo are supported with the tool. However, if funding was available the tool could be adapted to also support QGIS.
How do I report a new bug or propose a change in the tool?
Please check the existing known issues and change requests on GitHub at github.com/HabitatFramework/HLUTool/issues before reporting/proposing new issues or changes. New issues or proposed changes can be posted on the Knowledge Hub forum at khub.net/group/association-of-local-environmental-records-centres/group-forum
7.2. What Happened?¶
ArcGIS generates a ‘hard error’ when the HLU Tool is used.
Solution 1: The HLU ArcMap extension has not been enabled. Close and relaunch the tool, then enable the extension in ArcMap before using the tool.
Solution 2: ArcGIS has been closed while the tool was running. Close and relaunch the tool.
The HLU Tool stops responding to GIS requests.
Solution 1: The HLU GIS layer is no longer active in the map or MapInfo has been closed while the tool was running. Close and relaunch the tool.
The HLU Tool communicates with the wrong instance of the GIS software.
Close all GIS instances except the one associated with the HLU Tool. To avoid this issue, ensure all instances of ArcGIS or MapInfo are closed before launching the tool and do not open any additional instances whilst the tool is running.
The Bulk Update tool errors and fails to create history if the bulk update is applied to database records which do not have corresponding polygons in the HLU layer.
Ensure that the database and map layer are kept in sync so this situation does not occur.
7.3. DO’s and DON’T’s¶
It is essential that the following guidelines are followed to ensure that the tool runs smoothly:
DO’s:
DO close all instances of MapInfo before launching the tool as the tool may try and communicate with the wrong instance of MapInfo.
DO close all instances of ArcGIS before launching the tool. Unlike with MapInfo, the tool will automatically communicate with the correct instance of ArcGIS, however multiple instances will require more memory and may therefore affect tool performance.
DO use a file geodatabase or personal geodatabase to store spatial information (ArcGIS users only).
DO NOT’s:
DO NOT remove the HLU layer from the map while the tool is running.
DO NOT close the associated GIS while the tool is running, otherwise the tool will display an error message.
DO NOT create or open another map document or workspace in the associated GIS window while the tool is running.
DO NOT use a shapefile as this affects performance (ArcGIS users only).
Note
New in version 1.0.7:
It is now possible to use a HLU GIS layer containing only a subset of all the INCIDs in the HLU database.
It is also possible to switch between different HLU GIS layers present in the open document or workspace using the Switch GIS layer function.
