Ensure that you have the dependencies installed. Since subsequent tutorials will have some software development involved, we recommend that you have a Java IDE like Intellij. For this tutorial, you should be somewhat familiar with the command line and maven. That being said, we will do our best to make the instructions as clear as possible for someone who isn't adept with either of those.
One of the major components of Visallo is the system of Graph Property Workers that enhance and do analytics on top of the data. Since most organizations will have different use-cases for their own data, the graph property workers are designed to be as extensible as possible. For more information on graph property workers, we recommend reading the documentation about Graph Property Workers before beginning this tutorial, but it is not required.
We will be using maven archetypes to do most of the bootstrapping of Visallo so that we can focus on developing our graph property worker.
- Run the following command from the Visallo repository:
The project will be generated and will ask you a couple of questions before it finishes:
- for groupId, put in
- for artifactId, put in
- hit enter to accept the defaults for version, package, and ontologyBaseIri
Great! You have your project set up for development. At this point, cd into the directory
mvn package to download all required Visallo dependencies.
Now run the command
./run.sh Congratulations! Visallo is running and you can work with the app.
Point your browser to
https://localhost:8443 and Visallo will load the login page. Use username:
admin and password:
admin to log in and you will be presented with your Visallo Dashboard.
Working with the app
You should definitely spend some time looking around Visallo. When you download the archetype and artifacts it comes prebundled with:
- An example authentication plugin that logs you in as long as your user name and password are the same
- An example graph property worker that extracts person names from a csv that is imported
- An web app plugin which adds the ability to google a person concept's name from the Inspector of that entity inside of Visallo
Since we are already logged in as admin with the password of admin, we know that the authentication module works and the source code can be found inside of your project in the
Example Graph Property Worker
The graph property worker that is inside of your project is inside of the
./worker folder. It is designed to pull names outside of csv files, add the entities inside as people, then show the results in your case.
- Switch to the graph view by clicking the graph button on the left hand side of your screen.
- Drag and drop the file at
./worker/src/test/resources/contacts.csvin your project onto the graph.
- Click Import on the dialog that pops up.
The file was imported into Visallo and run through the graph property work queue inside of your server. It pulled out Bruce Wayne and Clark Kent from inside of the csv and added them to your graph.
Example Web Plugin
Now that we have some people in our system, we can use the example web plugin to google their names. To see the code that makes up this plugin, look inside of the
./web folder in your project. Click on "Bruce Wayne" in the graph and the Inspector will open. In the Inspector you can view the information that you are allowed to see about Bruce Wayne. Click the "Google" button at the top menu bar of the Inspector to open a new window that automatically opens the search results page for "Bruce Wayne" in Google.
Example Command Line Tool
Alternativly you can look at the command line tool example. This example will import two people and link them together with an edge. To see the code that makes up this plugin, look inside of the
./plugins/cli folder in your project.
In our next tutorial, we will work through Visallo's version of Hello World by creating a custom Hello World Graph Property Worker