All versions of this manual
X
Welcome to Linkurious administration manual v4.2.4. Use the menu to access other documentations.
  1. Introduction
  2. FAQ
  3. Getting started
    1. Version support policy
    2. Release notes
    3. Client requirements
    4. Graph DB Feature Map
  4. Deploying on premise
    1. Technical requirements
    2. Downloading
    3. Installing
    4. Starting Linkurious
    5. Stopping Linkurious
    6. Cluster mode
  5. Configuring
  6. Troubleshooting
    1. Checking Linkurious status
    2. Reading the logs
    3. Getting support
    4. Managing licenses
    5. Vulnerabilities
  7. Importing graph data
    1. Neo4j
    2. Memgraph
    3. Amazon Neptune
    4. Cosmos DB
    5. Spanner Graph
    6. Updating your graph data
  8. Updating Linkurious
    1. Checking for updates
    2. Backing up your data
    3. Update procedure
  9. Configuring data-sources
    1. Neo4j
    2. Amazon Neptune
    3. Memgraph
    4. Google Spanner
    5. Cosmos DB
    6. Alternative IDs
    7. Merging data-sources
    8. Advanced settings
  10. Resource management
    1. Managing spaces
    2. Managing tags
  11. Search index
    1. Search Option Comparison
    2. Neo4j Search
    3. Elasticsearch
    4. Neptune Search
    5. Azure Search
    6. Incremental Indexing
    7. Numerical/Date search
  12. User-data store
    1. Migrating to an external database
    2. Backing-up your store
  13. Web server
  14. Authentication
    1. Getting started
    2. LDAP / Active Directory
    3. SSO with Azure
    4. SSO with Google
    5. SSO with OpenID Connect
    6. SSO with SAML2 / ADFS
    7. Configuration
  15. Access control
    1. Managing users
    2. Managing groups
    3. Standard access-rights
    4. Property-key access-rights
  16. Guest mode
    1. Guest mode
  17. Data Schema
    1. Property types
    2. Hiding data
    3. Strict mode
  18. Alerts
    1. Configuration
  19. Entity resolution
    1. Requirements
    2. Installing
    3. Configuring
    4. Accessing Entity Resolution
    5. Managing mappings
    6. Running Entity Resolution
    7. Viewing Results and explanations
    8. Node Grouping and Collapsing
    9. Managing the license
    10. Troubleshooting tips
  20. Email Notifications
    1. Configuration
  21. Visualizations appearance
    1. Default styles
    2. Default captions
    3. Default properties order
    4. Geographic tiles
  22. Audit trail
    1. Log format
  23. Webhooks
  24. Observability
  25. Plugins
  26. Deep link
 

Configuring data-sources: Advanced settings

The following advanced settings apply to all data-sources.

To change them, see how to configure Linkurious Enterprise.

General settings

  • dataSourceConnectionTimeout (default: 30): The maximum number of seconds before the connection attempt to a data-source times out.
  • dataSourceAutoReconnectInterval (default: 300): Number of seconds after which Linkurious will try to reconnect automatically to all offline data-sources. This value is internally converted into minutes; if it is not a multiple of 60, it will be rounded to the nearest number of minutes. Explicitly setting this parameter to 0 will disable the offline data-sources auto-reconnection feature.
  • pollInterval (default: 10): Check if the data-sources and search engine are connected at each interval (in seconds).

Search engine settings

  • indexingChunkSize (default: 5000): The number of nodes and edges retrieved at each batch when indexing the graph database.
  • searchAddAllThreshold (default: 500): The maximum number of search results that the user can add to a Visualization at once.
  • minSearchQueryLength (default: 3): The number of characters needed to trigger a search query. Set 1 to provide live results from the first character typed by the user.
  • searchPrefixExpansion (default: true): Whether Linkurious should return nodes and edges that contain the search query as a prefix, e.g.: Searching Link will return node Linkurious.
  • searchRetryMultiplier (default: 5): During search, if some search results are missing from the graph, will re-run the search query with a page size searchRetryMultiplier times larger than the originally requested size (larger values can make search slower).
  • defaultFuzziness (default: 0.1): Default value to search fuzziness between 0 and 1. A value of 0 means exact matching of the search query.

Graph exploration settings

  • supernodeThreshold (default: 10000): Number of adjacent edges after which a node is considered a supernode.
  • edgesBetweenSupernodes (default: false): Whether Linkurious should retrieve edges between 2 supernodes. Note: Linkurious always return edges between a supernode and a regular node.
  • rawQueryTimeout (default: 60000): Milliseconds after which a query to the database will time out.
  • rawQueryLimit (default: 500): The maximum number of results returned by Linkurious Enterprise when executing a query or query template.
  • expandThreshold (default: 50): When the user expands a node with too many neighbors, Linkurious Enterprise will ask to refine the query so that fewer neighbors are returned.
  • showBuiltinQueries (default: true): Whether built-in queries like Shortest Path should appear in the list of graph queries.
  • slowQueryThreshold (default: 500): Milliseconds after which a query is logged in the log file as a slow query.
  • defaultLayout (default: { "algorithm": "force", "mode": "best" }): The default layout to be applied to visualizations.
    • defaultLayout.algorithm (default: force): Can be force or hierarchical.
    • defaultLayout.mode (default: best): (best|fast) for force algorithm and (LR | RL | TB | BT) for hierarchical algorithm. See the layout section in the user manual for more information.

Schema sampling settings

  • sampledItemsPerType (default: 1000): The number of nodes/edges per category/type to read from the graph for the schema sampling
  • sampledVisualizationItems (default: 1000): Number of nodes/edges to read from existing visualizations for the schema sampling

Worker pool settings

The worker pool is an internal thread pool used to offload computational tasks from the main thread of the Linkurious Enterprise process. It is used to run alerts, custom queries and compute server-side visualization layouts, so that these do not affect the application responsiveness.

  • workerPool (default: { "enabled": true, "size": 1, "memoryLimitMb": 1024}):
    • workerPool.enabled (default: true): Whether to enable this feature. When disabled, any task that would have been executed by the worker pool is executed directly by the main thread.
    • workerPool.size (default: 1): The fixed number of threads to spawn in the worker pool. We recommend this setting to be at least 2 if alerts are enabled. The maximum value for this setting should be the number of available CPU cores on the server running Linkurious Enterprise, minus one.
    • workerPool.memoryLimitMb (default: 512): The maximum size of the main heap in megabytes, for each thread in the worker pool.

ℹ️ If the worker pool is disabled, all the tasks will be executed by the main thread of the Linkurious Enterprise process.

Additional Certificate Authorities

  • extraCertificateAuthorities: The relative or absolute path to a single PEM file. When set, the well known "root" CAs (like LetsEncrypt) will be extended with the extra certificates in the file. The file should consist of one trusted certificate or multiple ones concatenated one after the other in the PEM format. If in your chain of certificates you have some Intermediate certificates, adding the Root CA will be enough to trust the whole chain. If the path is relative, the file should be located within the linkurious/data folder.

If Linkurious Enterprise is installed as a service, the service needs to be uninstalled and re-installed for the change to be taken into account.

If Linkurious Enterprise is installed using Docker, then extraCertificateAuthorities will not work and the NODE_EXTRA_CA_CERTS environment variable should be used instead. The variable must contain the absolute path to a PEM file (see details on the Node.js documentation).

Password obfuscation

  • obfuscation (default: false): Set to true if you want all the passwords in the configuration to be obfuscated at the next restart of Linkurious Enterprise.