Utility locator file setup
To store a point at the measured elevation of an underground asset, the job must use a feature library FXL file that contains a code with at least one Number or Text attribute that matches the name of one of the attributes defined in the ULD file. Connecting the FXL file to the ULD file in this way causes the Depth value to appear in the Measure screen when measurement information is received from the underground locator.
Add additional attributes to the code in the FXL file to store other attribute information received from the utility locator that you want to store with the point, for example frequency, gain, phase, current and signal.
In addition the ULD file includes examples and tips for pairing with and using that locator.
Template ULD files
Use the appropriate ULD file provided in the Spectra Geospatial Data\System Files folder on the controller.
Alternatively, download the ULD file from the Configuration files page.
Structure of the ULD file
The format of each ULD file provided with Origin is shown below, and the following table describes each parameter.
The structure of the RD8100.uld file is:
<?xml version="1.0" encoding="UTF-8"?>
<ExternalDeviceProtocol version="1.0" >
<Device name="Radiodetection RD8100 & RD8200" >
<Protocol type="Delimited" delimiter="2C" startsWith="$RD8" >
<Field name="Depth" fieldNumber="8" type="Number" multiplier="1.0" attribute="Depth" />
<Field name="Frequency" fieldNumber="5" type="Number" multiplier="1.0" attribute="Frequency" />
<Field name="Gain" fieldNumber="13" type="Number" multiplier="1.0" attribute="Gain" />
<Field name="Phase" fieldNumber="11" type="Number" multiplier="1.0" attribute="Phase" />
<Field name=Current" fieldNumber="10" type="Number" multiplier="1.0" attribute="Current" />
<Field name="Signal" fieldNumber="12" type="Number" multiplier="1.0" attribute="Signal" />
</Protocol>
</Device>
</ExternalDeviceProtocol>
The structure of the vLoc3.uld file is:
<?xml version="1.0" encoding="UTF-8"?>
<ExternalDeviceProtocol version="1.0" >
<Device name="Vivax vLoc3" >
<Protocol type="Delimited" delimiter="2C" startsWith="LOG" >
<Field name="Depth" fieldNumber="5" type="Number" multiplier="0.001" attribute="Depth"/>
<Field name="Frequency" fieldNumber="4" type="Number" multiplier="1.0" attribute="Frequency"/>
<Field name="Gain" fieldNumber="9" type="Number" multiplier="1.0" attribute="Gain"/>
<Field name="Current" fieldNumber="6" type="Number" multiplier="1.0" attribute="Current"/>
</Protocol>
</Device>
</ExternalDeviceProtocol>
| Parameter | Notes |
|---|---|
|
Protocol |
|
|
type="Delimited" or "FixedWidth" |
Specifies if the ULD data is output as a data string separated by an ASCII character such as a space or a comma (delimited), or if each field has a fixed number of characters (fixed width). |
|
delimiter="2C" |
Specifies the delimiter as two hex digits which specify the ASCII delimiter character (field separator). For example, space="20", comma="2C", tab="09". |
|
startsWith="" |
An optional string that can be used to specify the text that identifies the start of a line. This string can be left blank. For this string, any leading, trailing, and double spaces are trimmed by XML. Use underscore ("_") as a substitute for space characters. For example, startsWith="_A". |
|
Fields |
|
|
name="" |
Specifies the name for the data in that field. Do not edit this name. To change the attribute name stored with the point, edit the attribute name at the end of the line. |
|
fieldNumber="" |
Specifies the number of the field in the data string that contains the data for this field. Specify the fieldNumber as a decimal number, starting at 0. For example, fieldNumber="1". |
|
type="Number" or "Text" |
Specifies the type of data in this field. If the type in the ULD file does not match the type in the FXL file, Origin will automatically convert the attribute type received from the ULD file to match the attribute type specified in the FXL file. |
|
multiplier="" |
Usually you can leave the multiplier set to "1.0" because you will have set the utility locator to use the same units of measurement as set in the Origin job. If for some reason the utility locator is using different units, enter the appropriate multiplier value to convert the measurement value from the locator units to the units used in the job. |
|
attribute="" |
The name of the attribute that is stored with the point in Origin. You can modify this name if you wish, for example to translate the name to your preferred language. Make sure the attribute name for this attribute in the FXL file matches the attribute name. |
The provided ULD files are designed specifically to work with the Radio Detection RD8100 locator or the Vivax Metrotech vLoc3-Pro receiver. You may be able to use the Origin software with a different model of utility locator, provided that the communications protocols are similar to the protocols supported by the RD8100 or the vLoc3-Pro. You will need to find out the format for your utility locator and modify one of the provided ULD files to meet your requirements. The utility locator:
-
must provide a single measurement NMEA string rather than a NMEA stream containing multiple measurements.
-
must be connected using Bluetooth.
Editing the ULD file
To edit the ULD file, open the ULD file in an ASCII text editor such as Notepad++.
If you edit any attribute name (the text after attribute=), for example to translate it to your preferred language, make sure attribute name assigned in the FXL file matches the new name.
Attribute names are case sensitive, so make sure the case used for each attribute name in the ULD file matches the case used in the FXL file.
Usually you can leave the multiplier set to "1.0" because you will have set the utility locator to use the same units of measurement as set in the Origin job. If the utility locator is using different units to those used in the Origin job, enter the appropriate multiplier value to convert measurement value from the locator units to the units used in the job.
Setting up the FXL file for ULD attributes
You can set up the FXL file using the Feature Definition Manager in Survey Office. Create a feature code for each utility type you will locate, and add attributes for each of the attribute values received from the utility locator you wish to store with that utility feature code.
For an example, refer to the UtilityLocator feature code in the GlobalFeatures.fxl example feature library file that you can install with the Origin software using Spectra Geospatial Installation Manager. See Example feature library file for installation.
You will need to create your own FXL file and set up feature codes and attributes as required. For example, you might create a feature code ELC with a number attribute named "Depth" to match the line in the ULD file where attribute="Depth":
<Field name="Depth" fieldNumber="8" type="Number" multiplier="1.0" attribute="Depth"/>
To record more than just depth, add extra attributes to the code in the FXL file as required. For example, you could add Frequency and Gain by referring to the appropriate lines in the ULD file:
<Field name="Frequency" fieldNumber="5" type="Number" multiplier="1.0" attribute="Frequency"/>
<Field name="Gain" fieldNumber="13" type="Number" multiplier="1.0" attribute="Gain"/>
To use the FXL file in Origin, transfer the FXL file to the System Files folder on the controller.
