This article walks the reader through how to use / create Charts in ClearQuery.
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 (Insights Canvas, Dashboards, and Chart Management) to select the “Get embed code” button (>_).
- 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: This is meant for internal use cases as the chart window will need to be logged into periodically. The user logging in with require permissions to that chart.
Assigning Owner Rights to Charts and Dashboards
When creating certain items within ClearQuery, such as Charts & Dashboards, the system will require the user to assign "Owners" to those items. Any user that is assigned as an Owner to an object will have permissions to modify and delete that object. Simply click within the Owner window and select the users that should have those permissions. Make sure to periodically review ownership access to objects to ensure they are appropriate. Note: any object with permissions assigned to "everyone" includes newly added or invited users.
If you have additional questions regarding this topic, please reach out to your Account Manager or contact ClearQuery Support (support@clearquery.io).