Add Geo-Spatial Index

Adding a geo-spatial index to the load definition file in the Load Definition File editor consists of the following steps:

Step 1

The first step is to select the Geo-Spatial Index task in the INDEXES task bar along the left side of the load definition file editor to activate the GEO-SPATIAL INDEXES page if it isn't already activated. If the Geo-Spatial Index task is not enabled, be sure there is at least one longitudinal data field and one latitudinal data field defined and has been mapped in the data parsing information of a data file section and/or the data parsing information of a document scanning section. A longitudinal data field is a numeric data field with process longitude special processing applied in the data parsing information. A latitudinal data file is a numeric data field with process latitude special processing applied in the data parsing information. To learn how to add a data field see the Add Data Field topic. To learn how to add data parsing information to a data file section see the Add Data Parsing Information topic. To learn how to add data parsing information to a documents scanning section see the Add Data Parsing Information topic.

Step 2

The second step is to select the Add Index task in the GEO-SPATIAL task bar along the right side of the GEO-SPATIAL INDEXES page:

The Edit Geo-Spatial Index dialog box will appear:

Step 3

The third step is to specify the Index Name for the geo-spatial index being added:

The Index Name drop-down list contains a list of unique index names. Either select an index name from the list or enter your own name. Preceeding index names with an underscore ( _ ) is not required, but recommended because it allows for easy recognition when building logic templates and display templates. Proceeding the index name with an index type identifier also helps for this same reason.

The Index Name uniquely identifies each index.

Step 4

The fourth step is to enter the Resource ID for the geo-spatial index being added:

A unique resource id for the index is automatically assigned when the Edit Geo-Spatial Index dialog box appears. If you would like to assign your own resource id for the index, change this value. Note: The resource ids that are automatically assigned are based on the maxtableid in the SocketSearch configuration file set to at least 1000. If the resource id that has been assigned exceeds this value, either change the resource id so it is less than the maxtableid or increase the maximum number of resources. If you would like to learn how to change the maxtableid in a SocketSearch configuration file, see the Editing a SocketSearch Configuration File topic of this documentation.

The Resource ID is used internally to uniquely identify the index.

Step 5

The fifth step is to define the Index Rules for the geo-spatial index being added:

Click the (add) button to open the Add Geo-Spatial Index Rules dialog box. Select and index rule from the Index Rules list and click the (delete) button to remove and index rule from the list. Double-click on an index rule or select and index rule from the Index Rules list and click the (edit) button to open the Edit Geo-Spatial Index Rules dialog box.

The Geo-Spatial Index Rules allows you to specify the package and data field for which this index will be create over.

Use the Package drop-down list to select the package across which this index will be created over.

Use the Long. Data Field drop-down list to select the longitudinal data field across which the longitudes for this index will be created over. The Long. Data Field drop-down list will only contain longitudianl data fields defined in the data parsing information of the data file sections or the data parsing information of the document scanning sections defined in the package selected in the Package drop-down list.

Use the Lat. Data Field drop-down list to select the latitudinal data field across which the latitudes for this index will be created over. The Lat. Data Field drop-down list will only contain latitudinal data fields defined in the data parsing information of the data file sections or the data parsing information of the document scanning sections defined in the package selected in the Package drop-down list.

Click the ellipse(...) button adjacent to the Processing edit box to open the Edit Processing dialog box. Use the Edit Processing dialog box to define conditional processing necessary for the index rule. Simply enter the conditional processing in the text area provided and click the OK button to add the conditional processing.

Use the Apply button of the Add Geo-Spatial Index Rule dialog box to add an index rule without closing the dialog box. Click the OK button to close the dialog box and add the index rule.

Step 6

The sixth step is to enter the Longitudinal Coordinates for the geo-spatial index being added. The Longitudinal Coordinates include the longitudinal minimum coordinate, longitudinal cell distance and the east-west cell count:

The Minimum Coord identifies the smallest longitude mapped by the grid.

The Cell Distance identifies the longitudinal distance in fractional degrees mapped by an individual grid cell.

The E-W Cell Count identifies the number of cells in a single east-west row of the grid.

Step 7

The seventh step is to enter the Latitudinal Coordinates for the geo-spatial index being added. The Latitudinal Coordinates include the latitudinal minimum value, latitudinal cell distance and north-south cell count:

The Minimum Coord identifies the smallest latitude mapped by the grid.

The Cell Distance identifies the latitudinal distance in fractional degrees mapped by an individual grid cell.

The N-S Cell Count identifies the number of cells in a single north-south column of the grid.

Step 8

The eighth step is to select the Decimal Places for the geo-spatial index being added:

The Decimal Places identifies the number of implied decimal places for the longitudinal minimum coordinate, latitudinal minimum coordinate, longitudinal cell distance and the latitudinal cell distance. For any geo-spatial grid this value must be nonzero.

Step 9

The ninth step is to select the Boundary Flag for the geo-spatial index being added:

The Boundary Flag determines how values that fall outside the grid limits are handled.

Step 10

The tenth step is to enter the Weight for the geo-spatial index being added:

The Weighting value is the weight to be applied to results returned using this index. A value of either 0 or 1 gives the index equal weight with all other indexes.

Step 11

The eleventh step is determine if the index being added will serve as a primary index. If the index is a primary index be sure the Primary Index check-box is checked. If a primary index is already assigned to the package or packages which this index is defined across, you will be prompted with a message to confirm that you would like to change the primary index. In some cases, such as if a sliding timeline index or a package index is the primary index for the package, and you choose to change the primary index, those indexes will be disabled since they must be a primary index.

Step 12

The twelfth step is to click the OK button to add the index to the geo-spatial index list:

The geo-spatial index is added to the list. Use the check-box to the left of each index to enable and disable the index. If the check-box is checked, the index is enabled and will be processed. If the check-box is unchecked, the index is disabled and will not be processed.


Editing the Indexes

Saving a File