Communities Tutorial

In this tutorial you will learn how to setup communities and associated Community Type KEE using Squirro’s user interface. We also provide a quick introduction to how you can visualize the communities on a dashboard.

Communities is the feature which allows end-users to follow entities or topics of their interest.

We assume that you are familiar with the basics of project creation, dashboard editing and data loading.

To start this tutorial, create a new project.

Create a Community Type

To create the community type navigate to Communities under the DATA tab and click the plus icon.

  • Name: Our first community type will be named Company.

  • Choose a facet top map to: Communities are linked (mapped) to a facet. To setup this community type, we first want to create the facet to which we link the communities. Under Choose a facet top map to select the option Create facet…. In the appearing Add Facet window, enter the Title Company and Name company and click SAVE. This selects the just created facet Company.

  • Upload file: Select Upload file and upload the provided Excel file (download ).

  • Content labeling (Known Entity Extraction): Check the option Automatically label ingested data with these communities and select Company names: optimized model to detect company names.

../../../_images/communities_tutorial_setup.png

Click NEXT. Now you might need to refresh the browser window or click the IMPORT button to see the communities.

Load Data

During the setup of the community type we specified the option to create a KEE. This Community Type KEE is automatically added to all the pipeline workflows and will label incoming data with the facet value specified in the uploaded Excel file and map the communities accordingly.

Load the provided data (download).

Visualize

Lets now create a simple dashboard to visualize the communities. Under VISUALISATION edit the Default Dashboard. You can change the dashboard title to Communities and add a Right section to the dashboard.

Delete the widget in the left section and add the Communities widget. You can change the widget properties, for example, check the options Show following tab and Show number of items for each community.

In the center section of the dashboard, delete the existing widgets and add a Communities Headlines widget.

In the right section of the dashboard, add the Tabs widget and select the option Show user Communities.

Save the dashboard and view it. Your dashboard should look similar to the one shown below.

../../../_images/communities_tutorial_dashboard.png

On the dashboard, you can click the plus icon on any of the displayed communities to follow them. Following a community will show its headlines in the Communities Headlines widget in the center of the dashboard. To filter ot a specific community you can use the Tabs widget on the right.

Add a Second Community Type

Let us add another community type. Add the Person community type using the Add manual option and create a KEE for the community type with the following input:

name,facet_value
Donald Trump,Donald Trump
../../../_images/communities_tutorial_setup2.png

Now you might need to refresh the browser window or click the IMPORT button to see the community. Manually add a second community by clicking the ADD button (next to the magnifier icon top right):

../../../_images/communities_tutorial_add.png

To map the communities to existing data, you need to rerun the KEE that was created when we setup the communities. Navigate to the PIPELINE and rerun the Community Type Person KEE step.

On your dashboard, go and check for the newly added Person community (the mapping after the KEE rerun might take a moment).