Integrations

Integrations in the sense of this article are different ways how to use Graphlytic Server API or Graphlytic frontend application in a machine-to-machine communication or activity invocation in order to achieve a higher business goal or to perform a part of a business process.

images/download/attachments/44499248/gl_ecosystem.png

Integration type

Description

REST API

Every operation that can be done in the frontend can be done with our REST API, meaning that you can automatize pretty much everything from user provisioning, exporting of audit logs for analysis in your DWH, transporting application settings between Graphlytic instances, starting Jobs, reading their status and much more.

ETL jobs (Data Integration)

The typical Extract Transform Load jobs. Graphlytic's ETL module can provide exactly this. Look at the docs and examples for more information: ETL jobs.

Email Server Integration

The Email Server integration is used in two situations in Graphlytic:

  • User invitations, Forgot password workflow, and forced password reset is handled by Graphlytic's SMTP integration.

  • Situations, where an external system or person needs to be notified, can be also handled by the ETL jobs module. Take a look at the ETL: Mail2 driver or use Groovy scripts to run an external script that will take care of the job.

Geo Map Server Integration

Geographical maps are an essential part of Graphlytic's visualization. It's easy to turn on the feature and start using it but you need to have an internet connection because it's using the OpenStreetMap free geo data servers. In case of running in a closed network, it's possible to integrate Graphlytic with a local Geo Map Server.

Single sign-on (SSO)

Graphlytic supports SAML2 protocol integration with external Identity Providers. Read more in Single sign-on.

Creating a new graph visualization with URL parameters

It's possible to construct a URL that will open a blank graph visualization and visualize some nodes and relationships or add nodes to an existing visualization based on the URL parameters. Below is a whole chapter "Create a Visualization with URL Parameters" with all the options and examples.

Custom integrations

Custom actions like opening a predefined report in a third-party system, or loading data from external sources dynamically in the visualization can be performed in custom implemented Widgets (visualization extension). There are a couple of Widgets packaged with the Graphlytic installation, these are just basic examples to show what can be achieved.

Create a Visualization with URL Parameters

There are several URL parameters that can be passed to a blank graph visualization created with the /visualization service. The parameters are used to load the initial set of nodes and relationships into the visualization. After that, the user can explore the graph as needed.

The URL consist of several parts:

  • the base path of the Graphlytic instance, e.g. https://graphlytic.instance

  • the visualization service /visualization

  • URL parameters, e.g. ?vis=14&nodes=23

Parameter

Description

Example

nodes

Adds nodes defined by internal ID to the graph visualization. Values are separated with commas (","). Can be combined with the "vis" parameter to add nodes to an existing visualization.

https://graphlytic.instance/visualization?nodes=23,653,9713

vis

Open existing visualization identified by the ID passed in this parameter. Can be combined with the "nodes" parameter to add nodes to an existing visualization.

https://graphlytic.instance/visualization?vis=14

https://graphlytic.instance/visualization?vis=14&nodes=23,69,420

cq

Cypher Query passed with the "cq" parameter will be requested from the server right after a blank visualization is created. Pass any cypher query (URL encoded) but don't forget that the URL length limit is around 2000 characters.

https://graphlytic.instance/visualization?cq=MATCH%28n%3ALabel%29RETURN%20n%20LIMIT%2025