The term 'Flare App' describes the sum of Flare's functionalities within the Zendesk platform. It can generally be separated into the displays in Zendesk's different app locations and Flare Studio.
Flare Studio lets you configure how you want to display the data you store in Zendesk Sunshine within the side- and top bar locations of Zendesk Support and Sell. You can choose to display your data in tables, cards, charts, and info components.
A selection of components is called a profile and can be configured for each Zendesk location individually. For each location, users can switch through different profiles.
This guide is aimed at the Flare administrator looking to become familiar with Flare in general. It provides a comprehensive overview of the Flare App's features. If you are looking for more process-oriented instructions, check out our 'How to...' guides in the Flare in Zendesk section.
Table of Contents
1. Flare Studio
1.1 Accessing Flare Studio
When installed, the Flare App is shown as in the below picture. If you have already created profiles you may see more items in the dropdown menu as well as in the area below the dropdown.
1.2 Opening Flare Studio
In order to open Flare Studio you need to click on the 1) Settings icon. As you can see in the image below.
1.3 Flare Studio Main Screen
The Flare Studio Main Screen is your main control panel to configure how you want to display your data in the various Zendesk app locations. If you want to learn more about how to create display objects, check our article How to display data in the Zendesk sidebar.
1) New - Creates a new profile for showing Components.
2) Remove - Deletes/removes the profile that you are currently on.
3) Duplicate - Create a new profile copying everything from the profile you are currently on.
4) Load - Choose another existing profile to load and configure.
5) Text Field - Set or change the name of the profile you are viewing.
6) Save - After any change you make, click this button to save your changes.
7) Global profile - If this option is turned on, it enables other people in your Zendesk Instance to use this profile, otherwise, you are the only one that can use it.
8) In the Location Bar, you can choose where on your Zendesk Instance you would like to see this profile. Currently, there are 5 locations: Ticket Sidebar, New Ticket Sidebar, Organization Sidebar, User Sidebar, and Top Bar, as well as the Zendesk Sell Deal and Contact Sidebars. You can read more about the locations below.
9) Add new Display Object: Adds a new component to the profile, which can then be configured to be a Table, Chart, Card, or Info object. For more detailed info on how each object can be configured, check How to display data in the Zendesk sidebar.
10) Copy Configuration From...: This allows you to copy the entire object configuration from one to another Zendesk Locations. Doing this will replace the objects in the location you are copying to!
11) If you have multiple components in the profile you can click this icon and drag and drop components to set the desired display order of the components.
12) The name of the object, followed by the tab is displayed here. You can have multiple tabs on a single profile, and you can circle through them in the Flare App.
13) Type of the component is displayed here: Table, Chart, Card, or Info.
14) Edit icon: if you want to edit previously added components click here.
15) Delete icon: if you want to delete previously added components click here.
16) Here you can see a live preview of the profile/tabs and components that you add.
Filters are a very powerful tool in Flare Studio and help you to narrow down and contextualize your data to always be relevant to the record it is viewed on. For example, if you've got a table object in the sidebar showing all your invoices, a filter can help you to only show those invoices that match the client your agent is currently looking at.
Here's how you apply them to your display objects when creating or editing them:
1) Selector Comparator - Set if ALL (=AND) or ANY (=OR) of the filters have to apply to return data.
2) Add Filter Condition - Click here to set a new filter.
3) Select Left Condition - Here you can choose a field from your external dataset or a Fixed value which will allow you to input a string to filter by.
4) String Comparator - Select how the left condition relates to the right condition in order to return a value. The three options are: It equals, meaning a value is only returned if the left and right values match. It doesn't equal, meaning a value is only returned when the left and right values do not match. Or it contains, meaning the left value can be a part of the right string, but doesn't have to match completely to return a result.
5) Select the Right Condition - Here you can choose a field from the Zendesk record data that your external data relates to. Again, you've got a Fixed value option.
Currently, the filters cannot be displayed in the preview window on the right. If you want to confirm that your filters are working correctly, save your object and check in the sidebar.
3. Zendesk Locations
You can configure the Flare App individually for all 7 different locations across Zendesk Support and Sell. Each location can show different profiles with different components. Those locations are:
- Ticket Sidebar: Appears in the right-hand app sidebar when looking at an existing ticket in Zendesk Support.
- New Ticket Sidebar: Appears in the right-hand app sidebar when creating a new ticket in Zendesk Support.
- Organization Sidebar: Appears in the right-hand app sidebar when looking at an Organization in Zendesk Support.
- User Sidebar: Appears in the right-hand app sidebar when looking at a user record (End-user or agent) in Zendesk Support.
- Top Bar: Available from the Flare icon in the navigation bar in the top right in Zendesk Support and Sell.
- Sell Deal Sidebar: Appears in the right-hand app sidebar when looking at a Deal record in Zendesk Sell.
- Sell Contact Sidebar: appears in the right-hand app sidebar when looking at a Contact person or Contact company record in Zendesk Sell.
Flare allows you to conveniently populate the Zendesk-native record fields with a simple click. Just right-click on the string of information in the Flare Sidebar that you want to use to populate. You will see a 1) List of fields of your currently viewed record (e.g. ticket, user, deal...) and can then choose which will be populated with the selected value.