Setting Up Dashboards in the Visualizer

The Visualizer leverages index patterns to display visualizations and dashboards.

Visualization widgets are used to explore or explain items in the index using charts or graphs. These visualizations can then be grouped in a dashboard.

Dashboards can be used to present a specific explanatory or exploratory theme to stakeholders. They can help team members and project stakeholders connect results to business objectives.

While it is possible to create visualizations and dashboards net new in the Visualizer, default visualizations and dashboards are available to import as part of Shinydocs™ Review.

Two steps in the Visualizer are required to start making use of dashboards:

1. Create an index pattern

2. Import a dashboard

Prerequisite

The Analytics Engine is installed. If it is not, please refer to Installing the Analytics Engine.

Creating an index pattern

The Shinydocs Visualizer draws from index patterns to display results in visualizations.

1. Log into the Visualizer

2. Navigate to the Management menu

3. Select Index Patterns

4. Click Create index pattern

5. Define the Index pattern that matches your indices

   1. If you have one index, enter the name of the index in Index pattern

   2. If you have multiple indices with similar names, you can use a wildcard to include them all (for example, “automation*”)

6. Click Next step

7. Toggle the Time Filter field name dropdown on the Configure settings panel and select “I don’t want to use the Time Filter”

8. Click Create index pattern

Creating the index pattern for the Accuracy Analytics Dashboard

You will need access to the AnalyticsIndexName value in the appsettings-review.json file (located in C:\inetpub\Review). The default is “automator-event-log”. This value can be changed.

1. Log into the Visualizer

2. Navigate to the Management menu

3. Select Index Patterns

4. Click Create index pattern

5. Enter the name of the AnalyticsIndexName value in the appsettings-review.json file in the Index pattern field on the Define index pattern panel

6. Click Next step

7. Toggle the Time Filter field name dropdown on the Configure settings panel and select “I don’t want to use the Time Filter”

8. Click Create index pattern

Create a custom dashboard from this Index Pattern.

Index Pattern Tips

Updating some fields can help dashboard readability.

1. From the Index Patterns page, select the index pattern you are setting up for your dashboard

2. Click the edit icon of the field you are updating

3. Update the format of the length field to Bytes

Importing dashboards

Shinydocs Review ships with dashboard templates (for example, the Review Dashboard). Look in C:\Program Files\Shinydocs\Automation Workflow\External Resources\Sample Visualizations for the complete list of dashboard templates.

1. While in the Management menu, select Saved Objects

2. Click Import

3. Click Import to browse for the dashboard template JSON file in C:\Program Files\Shinydocs\Automation Workflow\External Resources\Sample Visualizations

4. Select the file and click Import

5. Select the dropdown under the New index pattern column

6. Select the index pattern you want to connect the dashboard to

7. Click Confirm all changes

Now that you have imported the dashboard, you are ready to start tracking trends and changes to your data.