Search tabs

Permission: Settings management

Search tabs setting is used to configure design of tabs in result at search page.

Configuration

  1. Left menu - settings

  2. In panel "Settings list" use icon "Update" for setting "SEARCH_TABS".

  3. Enter JSON configuration and confirm by pressing "Save" button.

Default configuration

Default configuration contains several default attributes to see how configuration should looks like. Probably this configuration doesn't match model of your data but can serve as example of short configuration.

  1. Left menu - settings

  2. In panel "Settings list" use icon "Update" for setting "SEARCH_TABS".

  3. Press button "Default" and store by pressing button "Save".

Automatic configuration

Automatic configuration is used to generate configuration which contains attributes of several random data nodes and several random relationships. Random nodes are selected as first 1000 nodes, random relationships are selected as first 1000 relationships. Generated JSON contains two tabs: one for nodes and all attributes of random nodes and second for relationships and all attributes of random relationships.

This automatically generated configuration can be used as good starting point to create own configuration.

  1. Left menu - settings

  2. In panel "Settings list" use icon "Update" for setting "SEARCH_TABS".

  3. Press button "Automatic", wait for generator to generate JSON and store by pressing button "Save".

Description of configuration

Configuration is entered as JSON. Example of JSON:

[
{
"label": "Nodes",
"group": "nodes",
"fields": [],
"columns": [
{"dataAttr": "_dbId"},
{"dataAttr": "title"}
]
},
{
"label": "All Person nodes",
"group": "nodes",
"fields": [
{"name": "type", "values": ["person"]}
  ],
"columns": [
{"dataAttr": "_dbId"},
{"dataAttr": "title"}
]
},
{
"label": "Only some Person nodes",
"group": "nodes",
"fields": [
{ "name": "type", "values": ["person"]},
{ "name": "subtype", "values": ["auditor", "manager"]}
],
"columns": [
{"dataAttr": "_dbId"},
{"dataAttr": "title"}
]
},
{
"label": "Companies by label",
"group": "nodes",
"fields": [],
"labels": ["CompanyBig", "CompanySmall"],
 "columns": [
{"dataAttr": "_dbId"},
{"dataAttr": "title"}
]
},
{
"label": "Relationships",
"group": "edges",
"fields": [],
"columns": [
{"dataAttr": "title"},
{"dataAttr": "source_title"},
{"dataAttr": "target_title"}
]
},
{
"label": "Relationships RELATED",
"group": "edges",
"fields": [],
"types": ["RELATED"],
 "columns": [
{"dataAttr": "title"},
{"dataAttr": "source_title"},
{"dataAttr": "target_title"}
]
}
]

Explanation of attributes:

  • "label" - tab title used in GUI. mandatory

  • "group" - "nodes" or "edges". If this is a tab for nodes or relationships. mandatory

  • "fields" - list of filter criteria. If used, this tab will show only data which fulfil this filter criteria. mandatory . Logical "AND" is between items in "fields" and logical "OR" is between items in "values". Final condition based on "fields" should be for example: "type"="person" AND ("subtype"="auditor" OR "subtype"="manager")

    • "name" - name of the database attribute to filter. This attribute should be indexed, which means it should be set in "properties" attribute of Node Index configuration or Relationship Index configuration. See Node index or Relationship index.

    • "values" - list of values of the database attribute. The exact value is matched only for one value.

  • "labels" - use if "group" has value "nodes". Defines search criteria for node labels. Logical "OR" is between items.

  • "types" - use if "group" has value "edges". Defines search criteria for relationship type. Logical "OR" is between items.

  • "columns" - list of attributes to show in this tabs. mandatory

    • "dataAttr" - name of the attribute should be equal to value "dataAttr" from DATA_SCHEMA. See Data schema. If "group" has value "edges" then "dataAttr" can reference also source node and target node attributes. Use "source_" and "target_" prefixes to reference source and target nodes. For example "source_title" will show "title" attribute of source node. You can use value "_dbId" to show database id, "_dbLabels" to show labels of node, "_dbRelType" to show relationship type.