Install the Neo4j plugin

Install the Neo4j plugin following these instructions.

Configure the Neo4j plugin

1. At the bottom of the menu, click on the 'Settings' icon:

2. Make sure the following settings are properly set:

• Neo4j Host should be localhost or the address where your Neo4j instance is running

• Neo4j Port should be the port where your Neo4j instance is running (7687 by default)

3. When running Neo4j Community Edition, set the Neo4j Single Project value. In community edition, the Neo4j DBMS is restricted to a single database. Since Datashare supports multiple projects, you must set the Neo4j Single Project with the name of the project which will use Neo4j plugin. Other projects won't be able to use the Neo4j plugin.

4. Restart Datashare to apply the changes. Check how for , or .

5. Go to 'Projects' > your project's page > the Graph tab. You should see the Neo4j widget. After a little while, its status should be RUNNING:

You can now .

Create the graph

1. Go to 'All projects' and click on your project's name:

1. Go to the Graph tab and in the first step 'Import', click on the 'Import' button:

You will then see a new import task running.

When the graph creation is complete, 'Graph statistics' will reflect the number of documents and entities nodes found in the graph:

Update the graph

If new documents or entities are added or modified in Datashare, you will need to update the Neo4j graph to reflect these changes.

Go to 'All projects' > one project's page > the 'Graph' tab. In the first step, click on the 'Update graph' button:

To detect whether a graph update is needed, go to the 'Projects' page and open your project:

Compare the number of documents and entities found in Datashare in 'Projects' > 'Your project' > 'Insights'...

...with the numbers found in your project in the 'Graph' tab. Run an update in case of mismatch:

The update will always add missing nodes and relationships, update existing ones if they were modified, but will never delete graph nodes or relationships.

You can now using your favorite visualization tool.

Prerequisites

Get Neo4j up and running

Follow the instructions of the to get Neo4j up and running.

We recommend using a recent release of Datashare (>= 14.0.0) to use this feature, click on the 'Other platforms and versions' button when downloading to access versions if necessary.

Add entities

If it's not done yet and extract names of people, organizations and locations as well as email addresses.

If your project contains emails, make sure to also extract email addresses.

Next step

You can now .