Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 4.25 KB

README.md

File metadata and controls

125 lines (80 loc) · 4.25 KB
Raw

CSV Importer Plugin for Linkurious Enterprise

Description

The CSV importer is an official plugin maintained by the Linkurious team that allows you to import external data from a CSV file into Linkurious Enterprise. It makes it possible to transform tabular data into rich graph visualizations quickly.

Prerequisites

  • Linkurious Enterprise 2.9.x or above
  • A connected Neo4j data-source in Linkurious
  • CSV files containing nodes or edges structured as follows:

For nodes

For edges

Two sample CSV files, for nodes and edges, are available here:

  • person.csv contains information about person entities (a node);
  • ping.csv contains information about relationships between two person nodes (a relationship).

Set up the Plugin

Make sure to have write access to the folder of Linkurious Enterprise as well as a Linkurious admin account.

  1. Download the lke-plugin-csv-importer-{version number}.lke plugin available here.

  2. Copy lke-plugin-csv-importer-{version number}.lke file to the following path <linkurious>/data/plugins

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

  4. Scroll to the Plugin settings field

  5. On the Plugin settings section, modify the content as follows:

    {
  "csv-importer": {
    "basePath": "importer"
  }
}

  6. Click on Save

Access the plugin

To access the plugin it's recommended to create a custom action that will appear in right-click context menu within the Linkurious Enterprise UI.

In order to do so:

  1. Open the Custom action panel (more information here)
  2. Click on NEW CUSTOM ACTION
  3. Give a title within the Custom action name field
  4. Fill the URL template field with the following URL: {{baseurl}}plugins/importer/index.html?sourceKey={{sourcekey}}
  5. (Optional) Share the Custom Action with all users
  6. Click on SAVE

If you prefer to access the plugin directly via URL, you need to retrieve the sourceKey and replace it within the link: https://{{baseurl}}/plugins/csv-importer/index.html?sourceKey={{sourceKey}}

Use the plugin

Make sure you are logged in as an Admin user, and the Linkurious Enterprise schema is not in the strict mode.

  1. Choose your CSV file and click the Upload button. You can get one of the following errors:

    a. No source key defined in URL

    b. No headers provided: Your CSV file starts with an empty line

    c. Header has an empty value: One or more header values have no content

    d. Missing values: Record/s 1, 4, 9, ...: Some records have less columns than the headers

    e. Too many values: Record/s 1, 4, 9, ...: Some records have more columns than the headers

  2. Specify if you are uploading nodes or edges

  1. Confirm the category name/edge type and the list of properties

  1. For edges, specify the categories for the source and destination nodes
  2. Click import
  3. Check if data has been imported successfully

Import status

After the import, you will get one of the following results:

  1. Successful: All nodes / edges have been imported

  2. Failed: Nothing has been imported

  3. Incomplete: Some nodes/edges failed to be imported due to one of the following reasons:

    a. Source or target node not found

    b. Data-source is not available

    c. Unauthorized access to the data-source

    d. Unexpected error, check the logs: Default message if error is unknown. You can download the logs following [these steps] (https://doc.linkurio.us/admin-manual/latest/support/)

Limitations

The maximum file size currently supported is 3.5MB.

Licensing

The Linkurious CSV importer plugin is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.