Map Template

In order to define a map widget, set the render type to map and add a template key. This will be a single dictionary.

Defining a map widget

If a connector adds items like the following to the CommandResult:

{
  "latitude": 37.4487,
  "longitude": -122.1181,
  "address": "1.2.3.4",
  "description": "A nice place to live"
}

Then generate a map with map markers describing each location with the following template:

{
  "name"    : "Connector Name",
  ...
  "commands": [
    {
      "provides": "find locations",
      ...
      "render": {
        "type": "map",
        "width": 4,
        "height": 5,
        "title": "IP Geolocation"
      },
      "output": [
        {
          "data_path": "action_result.data.*.longitude",
          "data_type": "numeric",
          "map_info": "longitude"
        },
        {
          "data_path": "action_result.data.*.latitude",
          "data_type": "numeric",
          "map_info": "latitude"
        },
        {
          "data_path": "action_result.data.*.address",
          "data_type": "string",
          "contains": [ "ip" ],
          "map_info": "name"
        },
        {
          "data_path": "action_result.data.*.description",
          "data_type": "string",
          "map_info": "Description"
        }
      ]
    }
  ]
}

The template dictionary has the following members:

Member	Required?	Description
data_path	Required	Specifies the Data Path of this field. Data Paths are a method of indexing into the JSON in an abstract fashion that allows others who want to access that data to do so by specifying the appropriate path. The Data Path specified here must be populated by the connector code that creates and returns this field. This string value can start with command_data, command_summary or summary for accessing the CommandResult data or the summary data for the entire connector run. See Use data paths to present data to the Splunk Phantom web interface for more information about data paths.
data_type	Required	The type of variable. Supported types are: string, password, numeric, boolean.
contains	Optional	Specifies what kind of content this field contains. The types listed here tell the UI what kind of context sensitive actions can be run on this value when it is displayed. For example an ip geolocation action is something that can be applied to any IP address that appears in a column which lists ip as a type. In the previous example, on the first column you can run file based actions such as a file reputation lookup. On the second column, you can run a terminate process. This is because there are apps that support those Actions that take a hash and pid as input. No actions are available for the 3rd column.
map_info	Required	The parameters required to render a data point on the map. One map_info value must be provided for each of longitude, latitude, and name.

Inputting a Google API Key

To input a Google API Key, complete the following steps in Splunk Phantom:

1. From the main menu, select Administration.
2. Select Administration Settings > Google Maps.
3. From there, insert the API key.