1. Preface¶

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

1.1. Recommended User Knowledge¶

1.1.1. Users¶

This user guide assumes that users of the Data Searches tool have:

General IT experience including use of Microsoft Windows.
Experience in the use of a relevant GIS application supported by the tool (currently ArcGIS or MapInfo), including selecting and querying features and attributes.
An understanding of the data layers (species, designated sites and other relevant datasets) that are used by the Data Searches tool.

1.1.2. Administrators¶

It is recommended that a person within each organisation is designated as the tool and database administrator. This person should:

Have an understanding and experience of IT systems management.
Understand relational database structures.
Have qualifications, certified training or equivalent experience in managing databases using that system.
Have certified training or equivalent experience in advanced features of the relevant GIS software.
Become familiar with how the Data Searches tool has been configured within the organisation.
Have a good understanding of XML.

1.2. Reading Guide¶

This Preface explains a little about the Data Searches tool, the community of people who develop and use it, and the licensing conditions for using and distributing it. It also explains how to read this user guide.

Introduction explains why the Data Searches tool is needed, what it does and where it comes from.

Anatomy of a data search is a brief outline of the key stages of a data search, and how the Data Searches tool addresses these.

Setting up the tool describes how to install and set up the Data Searches tool.

Running the tool describes how to run the Data Searches tool.

FAQs has a list of commonly asked questions and their answers.

Appendix contains examples of the XML configuration files for MapInfo and ArcGIS, lists known issues with the tool and contains a copy of the GNU Free Documentation License v1.3 covering this guide.

1.3. Licensing¶

The code for the Data Searches tool is ‘open source’ and is released under the 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 the GPLv3 license.

This guide is released under the GNU Free Documentation License (FDL) v1.3. Permission is granted to copy, 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 development and ongoing support. Hence any contributions towards costs would be gratefully received. Enquiries can be made via email to either Hester or Andy.

1.4. Useful links¶

1.5. Acknowledgements¶

Many thanks are due to all the LERCs in the south-east of England and their staff who have, and continue to, fund and contribute to the Data Searches tool. It takes many developers, testers and users to build a truly useful tool (especially users who care enough to test new releases, report bugs and discuss feature requests).

1.6. Conventions used in this user guide¶

The following typographical conventions are used in this manual:

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 GUI buttons.
C:\Program Files (x86)\MapInfo\Professional: 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 users should pay attention.