Defining file enrichment rules

A file enrichment rule matches a specified resource identifier (the token) to the longitude and latitude (the geographical location) of the resource. Resources that have been enriched with a geographical location can be displayed on the topology resource map.

Before you begin

Create a file that contains the location information for your resources.
File format
The file you use must be in the TSV (tab-separated values) format.
The values on each line are 'token', 'latitude' and 'longitude':
token	latitude	longitude
See the following file enrichment rule example for more information.

About this task

Tip: CLLI (Common Language Location Identifiers) are supported and can be used as tokens.
Remember: To enrich your resource records with geolocation data, you can use a file enrichment rule as described here, or you can load resource data with geolocation properties included.

Procedure

Details

On the Details section of the New file enrichment rule (or Edit file enrichment rule) page, you define the name, status, tokens and file to be used for the rule.

  1. Enter a name, which must be unique within the context of the tenant.
    You cannot change the name of an existing rule. If you want a rule to have a different name, create a new rule, then delete the old one.
  2. Toggle the rule status to be either Enabled or Disabled
    Observers will only apply rules which are in an enabled state.
  3. Define a token for the rule, then click Add+.

    The token is used to uniquely identify the resource to which the rule is applied, against which a location is mapped using the data contained in the rule file. Only a single token is used to map a location, but you can construct it using variable substitutions, which lets you combine more than one property value if required.

  4. Specify the file containing the resource location values.
    Under File mode, select one of the following options:
    Upload local file
    Either drag-and-drop or click and browse to choose a file.
    Use server file
    Specify the name of the file to be loaded.
    The file must have been uploaded previously.
    Do not specify a path.

Conditions

  1. Select observers to which this rule applies from the Observer name drop-down.
    Leave empty to apply the rule to all observers.
  2. Select providers to which this rule applies from the Provider name drop-down.
    Leave empty to apply the rule to all providers.
  3. Select resource types to which this rule applies from the Resource type drop-down.
    Leave empty to apply the rule to all resource types.
  4. Set the Token filter mode to either Exclude or Include, then define a filter in the format of a regular expression. You can set more than one filter.
    Exclude
    Tokens which match any one of the expressions will not be applied to resources.
    Include
    Only tokens which match one of the expressions will be applied to the applicable resources.
  5. Validate your filters using the Validate token filters button.
  6. Click Save.

Example

Example file enrichment rules:
A file enrichment rule allows the value of a token to be used to map that resource to its location on a map.
Example TSV file
LONDON-CTR-01	51.509287	-0.120226
LONDON-CTR-02	51.485100	-0.108514
MCHSTR-CTR-01	53.482641	-2.248665
LVERPL-CTR-01	53.403925	-2.996455
Example rule
name = serverBuildingLocations
enabled = true
token = buildingCode
file = server-buildings.tsv
Example resource
{
  "uniqueId": "server-001",
  "name": "server-001",
  "entityTypes": [
    "server"
  ],
  "buildingCode": "LONDON-CTR-01"
}