Giter Club home page Giter Club logo

dataset-aml's Introduction

AML Dataset implementation guide

Prerequisites:

  • a Neo4j v4 server with admin or architect 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)

Topics:

1. Importing the data in Neo4j

  1. Login to Neo4j Browser with an user having read/write access

  2. On the Browser settings panel, enable, if it's not, the Enable multi statement query editor option

    Neo4j Browser

  3. Copy the whole content of the scripts/import.cypher file and paste it in the Neo4j query field

  4. Run the query and wait

  5. (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:

    ID Allocation

  6. Done!

2. Adding the datasource in Linkurious Enterprise

  1. Login to Linkurious Enterpise with an user having admin access
  2. Go to Admin -> Data-sources management panel and click on ADD A DATA SOURCE
  3. 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
  4. Click on SAVE CONFIGURATION
  5. Start the indexing process by pressing START and wait
  6. Done!

3. Setting default styles

  1. Go to Admin -> Data-source settings panel
  2. Scroll to the Default styles field and replace the whole content with the content of the lke-configurations/default-styles.json file
  3. Click on Save
  4. Done!

4. Setting default captions

  1. Go to Admin -> Data-source settings panel
  2. Scroll to the Default captions field and replace the whole content with the content of the lke-configurations/default-captions.json file
  3. Click on Save
  4. Done!

5. Setting queries

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:

  1. Open the query editor panel (more information here)

  2. Copy the query from the file and paste it in the Write a query or a template field

  3. Click on Save

  4. Fill the Name and Description fields with the values provided in the file

  5. Click on Save again

    Example:

    This is how the query should look like

    Query Details

    NOTE: Query ID may be different in your case

  6. Done!

6. Setting alerts

All the Alerts are contained in the lke-configurations/alerts.cypher file

Repeat this procedure for every alert in the file:

  1. On the Alert dashboard, click CREATE NEW ALERT (more information here).

  2. Fill the Alert name field with the value provided in the file

  3. Fill the Description field with the description provided in the file

  4. Turn on, if it's not, the Enable toggle

    Alert settings

  5. Turn on the Share alert toggle and select if you want to share it with all the users or with specific groups

  6. Copy the query from the file and paste it in the Query field

  7. Copy the target value from the file and paste it in the Target field

  8. Click on ADD A COLUMN and fill the fields with the values provided in the file

    NOTE: repeat this step if more columns are specified in the file Alert configuration

  9. Click on Save

  10. Done!

7. Setting custom actions

All the Custom actions are contained in the lke-configurations/custom-actions.txt file

Repeat this procedure for every custom action in the file:

  1. Open the Custom action panel (more information here)

  2. Click on NEW CUSTOM ACTION

  3. Fill the Custom action name, URL template and Description fields with the values provided in the file

  4. If any, replace <xxx> with the id of the query indicated in the file (read How to retrieve the ID of a query section)

  5. Click on SAVE

    Example:

    This is how the custom action should look like

    Custom Action Details

    NOTE: queryID value may be different in your case

  6. Done!

How to retrieve the ID of a query

  1. Open the QUERIES panel (more information here)

  2. Identify the desired query

  3. Click on More and then on View details...

  4. The queryID is now displayed

    Query Details

8. Setting the plugin

  1. Download the data-table plugin available here (documentation available here).

  2. Copy the .lke archive in the folder <lke-server>/data/plugins

  3. On Linkurious Enterprise dashboard, go to Admin -> Global configuration

  4. Scroll to the Plugin settings field

  5. 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

  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

  7. 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

  8. Click on Save

  9. On Linkurious Enterprise dashboard, go to Admin -> Data-source Schema

  10. Scroll to the end of NODES CATEGORIES & EDGES TYPES list and click on Create new categories

  11. Type REALESTATE_TRANSACTION and click on SAVE

  12. 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
  13. Done!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.