- a Neo4j v4 server with
admin
orarchitect
access rights (minimum supported version: v4.2) - APOC procedures are enabled in Neo4j (more information here)
- a Linkurious Enterprise 3.0.4 or higher with
admin
access rights (getting started guide)
- 1. Importing the data in Neo4j
- 2. Adding the datasource in Linkurious Enterprise
- 3. Setting default styles
- 4. Setting default captions
- 5. Setting queries
- 6. Setting alerts
- 7. Setting custom actions
- 8. Setting the plugin
-
Login to Neo4j Browser with an user having read/write access
-
On the
Browser settings
panel, enable, if it's not, theEnable multi statement query editor
option -
Copy the whole content of the
scripts/import.cypher
file and paste it in the Neo4j query field -
Run the query and wait
-
(Optional) If you want to check the import results, run
:sysinfo
as a query and compare the number of nodes/edges in your database with the following table: -
Done!
- Login to Linkurious Enterpise with an user having admin access
- Go to
Admin
->Data-sources management
panel and click onADD A DATA SOURCE
- Fill these fields with the following values:
- GRAPH SERVER
- Name: AML
- Vendor: Neo4j
- URL: <url:port> (a stable idenfier for your Neo4j server)
- Username: <yourUsername> (your Neo4j read/write user)
- Password: <yourPassword> (your Neo4j read/write password)
- Other
- Alternative node ID: uid
- Alternative edge ID: uid
- SEARCH INDEX SERVER
- Vendor: Neo4j Search
- GRAPH SERVER
- Click on
SAVE CONFIGURATION
- Start the indexing process by pressing
START
and wait - Done!
- Go to
Admin
->Data-source settings
panel - Scroll to the
Default styles
field and replace the whole content with the content of thelke-configurations/default-styles.json
file - Click on
Save
- Done!
- Go to
Admin
->Data-source settings
panel - Scroll to the
Default captions
field and replace the whole content with the content of thelke-configurations/default-captions.json
file - Click on
Save
- Done!
All the Standard Queries and Query Templates are contained in the lke-configurations/queries.cypher
file
Repeat this procedure for every query in the file:
-
Open the query editor panel (more information here)
-
Copy the query from the file and paste it in the
Write a query or a template
field -
Click on
Save
-
Fill the
Name
andDescription
fields with the values provided in the file -
Click on
Save
againExample:
This is how the query should look like
NOTE:
Query ID
may be different in your case -
Done!
All the Alerts are contained in the lke-configurations/alerts.cypher
file
Repeat this procedure for every alert in the file:
-
On the Alert dashboard, click
CREATE NEW ALERT
(more information here). -
Fill the
Alert name
field with the value provided in the file -
Fill the
Description
field with the description provided in the file -
Turn on, if it's not, the
Enable
toggle -
Turn on the
Share alert
toggle and select if you want to share it with all the users or with specific groups -
Copy the query from the file and paste it in the
Query
field -
Copy the target value from the file and paste it in the
Target
field -
Click on
ADD A COLUMN
and fill the fields with the values provided in the fileNOTE: repeat this step if more columns are specified in the file
-
Click on
Save
-
Done!
All the Custom actions are contained in the lke-configurations/custom-actions.txt
file
Repeat this procedure for every custom action in the file:
-
Open the Custom action panel (more information here)
-
Click on
NEW CUSTOM ACTION
-
Fill the
Custom action name
,URL template
andDescription
fields with the values provided in the file -
If any, replace <xxx> with the id of the query indicated in the file (read How to retrieve the ID of a query section)
-
Click on
SAVE
Example:
This is how the custom action should look like
NOTE:
queryID
value may be different in your case -
Done!
-
Open the QUERIES panel (more information here)
-
Identify the desired query
-
Click on
More
and then onView details...
-
The
queryID
is now displayed
-
Download the data-table plugin available here (documentation available here).
-
Copy the
.lke
archive in the folder<lke-server>/data/plugins
-
On Linkurious Enterprise dashboard, go to
Admin
->Global configuration
-
Scroll to the
Plugin settings
field -
If there are no other plugins configured here, replace the whole content of the field with the content of the
lke-configurations/plugins.json
file and skip to step 8.Otherwise, go to step 6
-
Copy the whole content of the
lke-configurations/plugins.json
file except for the{
at the beginning and for the}
at the end of the file -
On the
Plugin settings
field, add an new empty line before the last}
, add in this line a comma (,
) and, after the comma, paste the content copied in the step 6 -
Click on
Save
-
On Linkurious Enterprise dashboard, go to
Admin
->Data-source Schema
-
Scroll to the end of
NODES CATEGORIES & EDGES TYPES
list and click onCreate new categories
-
Type
REALESTATE_TRANSACTION
and click onSAVE
-
Select the category you just created and, by clicking on
Create a new property
, create properties as following:Name Type Parameter address string avg_sqft_price currency symbol: $
; format:#.###,## [Symbol]
city string contract_id string price_range enum values: OVERPRICED
,UNDERPRICED
,NORMAL
purchase_price currency symbol: $
; format:#.###,## [Symbol]
sqft number sqft_price currency symbol: $
; format:#.###,## [Symbol]
transaction_date date format: yyyy-mm-dd
type string -
Done!