.. DNRGPS documentation master file, created by sphinx-quickstart on Sat Dec 17 20:44:03 2011. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. SYSTEM ADMINISTRATOR GUIDE ================================== .. toctree:: :maxdepth: 2 System Administrators are responsible for installing and managing DNRGPS on enterprise computers. This section is meant to give tips on smooth roll outs to many computers. Installation ------------------- Since DNRGPS is a self-contained program, it can be deployed anywhere. At the Minnesota DNR, we have deployed to a central server that all users can see. A shortcut to *dnrgps.exe* is placed on the desktop. The advantage of this is that new versions can be integrated by simply replacing the *one* copy of the application on the server instead of dozens or hundreds of individual copies on users' PCs. User Properties ------------------------ The first time DNRGPS is run on a PC, it tries to create a DNRGRPS folder at: * Windows XP: ``C:\Documents and Settings\\AppData\DNRGPS`` * Windows 7: ``C:\Users\\AppData\Roaming\DNRGPS`` If users are restricted from writing to this location, then it tries writing to: * Windows XP: ``C:\Documents and Settings\\My Documents\DNRGPS`` * Windows 7: ``C:\Users\\My Documents\DNRGPS`` The DNRGPS folder may contain these files: * dnrgps_temp.gpx - A scratch space that DNRGPS uses for processing * dnrgps_properties.xml - User customizations. This file is first generated from a master copy located in DNRGPS\documents. For more go to the description of the dnrgps_properties.xml * DNRGPS_log.txt - Error log file When deploying, modify the main dnrgps_properties.xml file to include customizations of your choice such as field aliases, visible file types, favorite projections, etc. These customizations will then be used by the end user. **Note:** If the end user has previously opened DNRGPS they will already have a local copy of dnrgps_properties.xml. This file will need to be deleted or replaced for them to see the updated customizations. dnrgps_properties.xml File Structure ------------------------------------ Below is a list of the properties that can be modified within the dnrgps_properties.xml prior to deployment: * **time** - Timestamp from the last time DNRGPS modified this xml file. * **checkVersion** - Boolean that determines whether, each time DNRGPS opens, it checks whether there is a newer version available for download. Set this to false to prevent your users from seeing this message for each update. :: true * **GpsBabelExecutable** - Path to GPD Babel application used by DNR GPS :: C:\dnrgps\gpsbabel\gpsbabel.exe * **xImageExecutable** - Path to xImage application used by DNR GPS :: C:\Program Files (x86)\Garmin\xImage\xImage.exe * *GPS Model and Connections* - **gpsMake**, **gpsPort**, **gpsBaudRate**, **gpsNoAck** :: 9600 True .. hard end code block * *Field Definitions* - Field definitions for each field are similar across the different data types (**waypointFields**, **trackFields**, **routeFields**, **realtimeFields**). Possible field tags include: * **gpxtag** - The tag used for a gpx file (if applicable) * **required** - Whether the field is required for that data type * **visible** - Whether the field defaults to being displayed for that data type * **precision** - For numerical fields, the precision of the value, the 0 is ignored for other values. * **length** - Field length * **type** - Field data type * **name** - Field name * **alias** - Field alias (if applicable) **Note:** If a tag is missing, it is not applicable to that field. Example field definitions (these default definitions can be changed by the user in DNRGPS properties) :: .. Units not yet implemented * *Real-Time Tracking properties* - Set the defaults for the Real Time Window (all of these options can still be changed by the user in the dialog box) * **rtAutoPanEnabled** - Boolean enabling / disabling pan capability * **rtAutoPanWindowPercent** - Sets default percentage for how close to the edge of the screen you can get before re-centering the map display. This percentage defines a box as a percentage of the map window for which, if you move outside of it, the map display automatically recenters. * **rtGraphicsEnabled** - Boolean enabling / disabling marking the trail in the active mapping window if ArcMap is open * **rtToleranceDistanceEnabled** - Boolean enabling / disabling the use of a tolerance distance * **rtToleranceDistanceValue** - If tolerance distance is enabled, the minimum distance between point collections (in meters) * **rtToleranceTimeEnabled** - Boolean enabling / disabling the use of a tolerance time * **rtToleranceTimeValue** - If tolerance time is enabled, the minimum time between point collections (in seconds) * **rtTrackUp** - Boolean setting for whether ArcMap displays North as up, or the track direction as up * **rtNMEA** - Sets whether NMEA tags are collected and the default file to record them :: True 75 True False 5 True 3 False .. hard end code block * *Hotlinking* - Set the defaults for the Image Linking window (thesee options can still be changed by the user in the dialog box) * **hotlinkCalibration** - Estimated offset between picture timestamp and GPS data point timestamp * **hotlinkThreshold** - Maximum offset allowed for a match :: -00:00:34 00:06:00 .. hard end code block * *Projections* - Set the defaults for the Image Linking window (thesee options can still be changed by the user in the dialog box) * **projections[viewonlyfavorites]** - If set to true, only projections that have previously been used or been set as favorites will appear in the long list of projections. If set to false, all projections will appear by default. There is a checkbox for the user to toggle this on and off. * **projection** - This is the list of projections (defined by **posc**, **datum**, **projname**, and **projdescription**) that are currently in the user's favorites, so prior to deployment the system administrator can set up default projections. See :doc:`set_projection` for more information on the projection parameters. :: .. hard end code block * *File Types* - List of file types to diplay in *Load From File* and *Save To File*. Each **fileType** tag has the following parameters: * **gdaltype** (all but text files) - Data type keyword used by GDAL * **delimiter** (text files only) - Delimiter used in the input / output text file * **suffix** - Suffix of the file type's filename * **description** - Description used in the *Load From File* and *Save To File* file navigation dialog boxes * **visible** - Boolean determining whether the checkbox in *File Properties* is checked ("true" = checked). Set to "false" to hide by default the file types that your users will not be using. * **default** - The default option in the *Load From* and *Save To* menus. Only one type can be set to default. :: .. hard end code block * *Database Types* - Each database **fileType** tag has the following parameters (actual databases have more parameters than the psuedo-databases, i.e. file geodatabases and KML files): * **gdaltype** - Database type keyword for GDAL * **prefix** (databases only) - Connection string prefix for the given database * **dbname** (databases only) - Boolean determining whether *DB Name* is visible in the connection dialog box * **host** (databases only) - Boolean determining whether *Host* is visible in the connection dialog box * **port** (databases only) - Boolean determining whether *Port* is visible in the connection dialog box * **user** (databases only) - Boolean determining whether *User* is visible in the connection dialog box * **password** (databases only) - Boolean determining whether *Password* is visible in the connection dialog box * **description** - Text description to be shown in the dropdown menu for selecting the type of database connection to be used * **visible** - Boolean determining whether the desciption shows up as an option in the dropdown menu * **folderPath** (Esri File Geodatabases only) - Boolean determining whether *Folder Path* is visible in the connection dialog box * **filePath** (KML only) - Boolean determining whether *File Path* is visible in the connection dialog box :: .. hard end code block * *Database Connections* - Stores the database connections set up by the user. The system administrator can set these up before deployment so they are available to all users. **databaseConnection** tags include: * **gdaltype** - Database type keyword for GDAL * **connectionName** - Name for the geodatabase that will show up in the list of connections * **connectionString** - Connection string used to connect to the database * **default** - Boolean indicating which database is highlighted when the list of connections is opened. Only one connection can be set as the default. ::