Collaboration Features

This articles walks users through how to use the various collaboration features ClearQuery offers.

Collaboration features are ones that users can share permissions of an object with other members of their teams, this includes Charts, Dashboards, and Insights Canvases. Below is information on each. To start let's discuss permissions:

Charts:

ClearQuery provides users with the ability to save charts and use them in across multiple features.

Once the user has filtered a chart to show the desired view, the user can save it and add it to a Dashboard. Every time the data updates the chart does too, allowing users to quickly view and take any necessary actions.

To save a chart select the "Save" button (💾) in the top right corner of the chart display. The user will be prompted with the following:

• • Name - Give the chart a name that describes the purpose of the chart, this will allow other users to understand the value it provides.
  • Owners - Provide ownership to other users - this permission allows other users the ability to view, modify, and / or delete it.
  • Dashboards - Immediately assign this chart to a dashboard by selecting the desired one.
  • Save to Home checkbox - Assign this chart to your customizable Home Page

Chart Management

Once a chart has been saved, users can view the saved charts by navigating to either the Dashboard / Insights Canvas home page and clicking the “Chart” tab. Here the user will see a full list of all the charts they have created or that have been shared with them. To view the chart and information pertaining to it, click the chart name.

This is the chart management screen, here you can see:

• The chart graphic.
• All the inputs that are used to create the chart.
• Which features are currently utilizing this chart.
• Who is watching the chart.
• All the comments associated with it (described in the next section).

The user can edit and delete the chart from this screen if they have ownership rights.

Chart Creator

Additionally, ClearQuery allows users to create charts from scratch. From the Charts Tab, users can select the “New Chart” button which will display the chart creation wizard. By completing the required fields, the user can generate a chart from scratch, showing specifically what the user wants.

Chart Commenting

Once a chart is saved, users can comment on the chart and collaborate with their team members by tagging them via their username. To leave a comment on a chart, click on the chat bubble icon at the bottom of the chart window (💬). To tag a team member insert the “@” symbol and search for the corresponding username. A tagged comment will result in an e-mail notification being sent to the user. Charts can be commented on within any feature that utilizes saved charts (Home Page, Insights Canvas, Dashboards, and Chart Management).

Embed Charts

ClearQuery allows users to display saved charts outside of ClearQuery by utilizing embedded code. To do this, the user can navigate to any feature that utilizes a saved chart and select the “Get embed code” button (>_).

• Insights Canvas and Dashboards – located within the chart in the menu (top right)
• Chart Tab (either in Insights Canvas or Dashboards) – “Action” drop down > “Copy Embedded Code.”

By clicking this button, the embedded code is automatically copied to the user’s clipboard and can be pasted as needed outside of ClearQuery. The embedded code is a JavaScript snippet that is intended to be included into an existing HTML page or application. It will create an i-frame that reaches out directly to ClearQuery on every page load and enables the user to include charts outside of ClearQuery in your existing web applications.

Note: The desired location must have access to the public internet for the chart to display.

---

 

Dashboards:

ClearQuery offers two different Dashboarding options based on deployment types:

1. User Dashboard:

This option spans across all the datasets users have access to and allows for customization and collaboration at the user level. To view this type of dashboard click the line graph icon (📈) within the Navigation Menu.

Welcome to the Dashboard homepage - this is where the user's dashboards will be listed, the following actions can be performed on this page:

• Create New Dashboards
• Delete Dashboards / Charts
• Rename Dashboards / Charts
• View Dashboards

To create a new dashboard:

• Click "New Dashboard" on the top right of the screen.
• Name the Dashboard.
• Select the Owners of the Dashboard - this permission allows other users the ability to view, modify, and / or delete it.
• Click "Create".

To add Charts to Dashboards:

• Click "+ Add Chart," located in the top right of the screen.
• Select the applicable Chart.
• Click "Add".

The chart will now be displayed within your dashboard. Repeat this process until you have the desired number of charts within your dashboard.

Note: if the user does not have any saved charts, check out the "ClearQuery Charts" article to learn how to save / create charts.

Dashboard Tool Kit:

Each of the displayed charts within a dashboard is accompanied by a tool kit that both provides information as well as chart functionality, see the graphic below:

Setting a default dashboard:

When viewing a dashboard, select the star (⭐️) next to the dashboard dropdown to make it your default dashboard.

• Note: once a default has been selected, the user must click "Dashboard" with-in the in-feature menu bar to navigate to the Dashboard Home Page where all dashboards are listed and to access the chart tab. (See below)

2. Organization-wide Dashboards:

This dashboard is configured by the Administrator, is dataset specific, and is identical for all users. To make changes to a Global Dashboard or to create one for a new dataset, the user must contact the Administrator. Changes to this dashboard type requires the Administrator to configure the dashboard using JSON. Reach out to your account manager for additional details on configuring global dashboards.

---

Insights Canvas:

Insights Canvas is a built-in presentation tool which allows users to quickly incorporate analytical findings into a presentation.

To get started creating your presentation, click on the paint palette icon (🎨) within the Navigation menu. Similar to creating a Dashboard, this feature loads into the Insights Canvas Home Page where the user can create new presentations, as-well-as manage all presentations that have been created previously. (the user can also view the charts tab from this page)

To create a new Insights Canvas, click the "New Insights Canvas" button in the top right of the screen and complete the following information:

• Name - Provide a name for the presentation.
• Owners - Provide ownership to other users. This permission allows other users the ability to view, modify, and / or delete the object.
• Click "Create".

Select the Canvas that was created and you will see the following:

Much like with datasets and dashboards, the user can select the star icon (⭐️) next to the name of the Insights Canvas to set a particular presentation as the default. Remember after doing this the user will have to click on "Insights Canvas" link to the left of the dropdown to navigate back to the Insights Canvas Homepage.

Insights Canvas Menu Bar:

The menu bar consists of four (4) main tools:

Start: Begins the presentation

+ Add Slide: This is how users build out the presentation.

To start building the presentation follow the steps below:

1. Select "+ Add Slide" - A prompt requesting the user to select a chart will appear.
2. Select the appropriate chart for that slide and click "Add".
3. Repeat this process as many times as necessary to build out the presentation.

 

Once the slide is created, the user can add a title and descriptive text:

• To add a title, click the blue pen icon at the top center of the slide.
• To add descriptive text, click on "Description..."
  • Note: when in the text box, a menu will appear allowing the user to change font type, orientation, etc... see image below:

Within the chart itself, ClearQuery provides the user with several pieces of information and settings for the user to manipulate the chart:

Note: item 4 - if the user shrinks the chart, the user is effectively minimizing it and can bring the chart back by selecting the two arrows pointing inward within the text box menu located on the far-right.

Note 2: To create a Title Slide, the user can shrink (minimize) a chart and use the now blank slide for an introduction slide.

Deck Options: allows the users to customize the overall presentation.

• Theme - change the background across the presentation.
• Branding - toggle on / off the ClearQuery Branding.
• Print - save as PDF or print a hardcopy.

Slide Options:

• Remove Slide - delete the current slide.
• Move Slide Forward - shift the current slide one position forward in the presentation.
• Move Slide Back - shift the current slide one position backward in the presentation.

---

If you have additional questions regarding this topic, please reach out to your Account Manager or contact ClearQuery Support (support@clearquery.io).