Configuring the Graph Browser

Quick start: To quickly get going with the graph browser configuration, press the "Add all available lenses and contextual scripts" button in the Script auto configuration section. This is typically sufficient for a good default configuration.

The other parameters are described in detail below:

Big nodes threshold

If a node would expand into more than this configured number of nodes it will be considered a big node and the user will be given a choice to proceed or to select a sample.

Big Nodes Handling

Relations

You can configure the ontology relations you want to use in this visualization. If no relation gets set, they will all be used.

Scripts

The Graph Browser supports the following types of scripts:

  • Contextual: Displayed in the contextual menu (shown with a RIGHT CLICK). Enable you to perform operations on the graph. Provided contextual scripts:

    • Expand by relation: Opens a popup that enables you to choose one or more of the available relations and expands the selected elements using only the selected ones. This does not override the graph browser configuration. You will see only the configured relations (if available for the selected nodes).

    • Expand by top comention: For use with company nodes from the Siren demonstration data. This script expands the selected nodes using an Elasticsearch aggregation to get the top comentioned company nodes.

    • Replace investment with edge: For use with the Siren demonstration data. This script replaces the investment nodes with a direct link between the company nodes and the investor nodes.

    • Select - All: Select all the elements (equivalent to Ctrl+A).

    • Select - By edge count: Select nodes based on their link count. You can specify the count through the popup that appears.

    • Select - By type: Select nodes based on their type. You can specify the type through the popup that appears.

    • Select - Extend: Extends the current selection to the sibling elements.

    • Select - Invert: Inverts the current selection.

    • Shortest Path: Calculates the shortest path between two selected nodes by fetching the connected elements. See here.

    • Show nodes count by type: Shows a popup with information about how many nodes per type are currently displayed.

  • Expansion: Used to customize the expansion policy. The provided one (Default Expansion Policy) will retrieve the first level connected elements to the expanded nodes

  • Lens: Lenses mutate the visual appearance of graph nodes and edges, can be cascaded as well as switched on and off at will during investigation. Provided lens scripts:

    • Size lens: Set the size for all nodes using an expression.

    • Color lens: Define color for all nodes using a field.

    • Conditional lens: Set node properties using expressions.

    • Label lens: Set the label for all nodes using an expression.

    • Associate records based on ontology lens: Replaces a node with associated records based on ontology.

    • Time and location lens: Set time and location properties.

  • Cards: Used to show additional data about the graph content. The Histogram card displays a histogram of data points that represent the currently-selected nodes.

  • On Graph update: Modify the graph when new nodes are inserted. They can be cascaded. Provided on update scripts:

    • Add time fields: Adds the time field used by the timebar mode.

    • Add geo-locations for map visualization: Adds the geographic field used by the map mode.

    • Signal dead companies: Colors all the company nodes that have a deadpooled_date black.

  • Sampling: Controls how many records can be imported into a graph from a dashboard. For more information, see Sampling data in the graph.

To create a new script go to ManagementScripts. Here, you can configure new scripts or modify the saved ones.

Scripts Management

Fields to exclude

You can configure a set of fields for each entity that you do not want to retrieve. Typically, you will exclude large fields that do not contribute to the link analysis (for example large textual blobs, technical metadata)for extra performance.

Other settings that are not in the configuration panel

There are other settings that affect the graph behaviour and performance which can be found in 'management/settings/advanced settings' such as the siren:graphExpansionLimit which is the default limit value of nodes suggested when dropping a large amounts of nodes, and also affects the max number of nodes before a warning on expansion is triggered.

You can see all the graph configurations on the Advanced Settings page.

Saving the Graph Browser configuration

The Graph Browser panel allows the user to change configurations through the sidebar on the right. In the three tabs of the sidebar, the user can change Lenses, Expansions, and Selections.

In the Lenses tab, you can add lenses, change the selected lens, remove one or more lenses, and modify lens settings.

In the Expansions tab, you can check/uncheck the dashboard filters, check/uncheck the simple and the aggregated relations filters, and change aggregated relations options.

In the Selection tab, the selected graph items are shown in a grid; you can hide columns, sort rows in a different order, by type and so on.

When a configuration is modified, a Save button appears in the top right of the sidebar.

image

image

image

If you do not save the changes, they will be lost when the session is closed. The graph browser configuration is saved as part of the object configuration which can be seen in management/saved objects - in the uiStateJSON of the graph browser visualization.

image

The structure of the saved JSON enables different configurations for the Graph Browser in different dashboards. All of the configurations are stored under an id related to the dashboard id.

Cloning a Graph Browser dashboard

On the Graph Browser dashboard, click the Clone button in the top right. A dialog appears that allows you to choose the title of the new cloned dashboard.

image

Type a name and click the Confirm Clone button. This creates a new Dashboard with all the same configurations.

image

The same happens if you click the Edit button (top right) and then save the dashboard as new. It is possible to change the new dashboard configurations and save it; the original Graph Browser configurations will not change.