Overview
The Flare Studio is your main control panel to configure how you want to display your data in the various Zendesk app locations within Zendesk.
In this article, we will walk you through the different features of Flare Studio.
Prerequisites
In order to access Flare Studio, you will need to have completed the steps described in this guide.
Table of Contents
2. Hyperlinks
4. Adding a New Display Object
1. Main screen overview
1. Once your Flare App is installed in Zendesk, following the steps in this guide, click on the cog wheel to enter Flare Studio.
2. A pop-up window will appear on your screen with the main page of Flare Studio, as shown in the below screenshot.
The elements you will find on this page are listed below:
1) Choose Profile/ New Profile, downwards arrow/+ icon - You can either choose the desired profile by clicking on the downwards arrow next to the Profile name or create a new profile for showing display objects.
Note: 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.
2) Edit, pen icon - Edits the name of the profile that you are currently on.
3) Remove, bin - Delete/remove the profile that you are currently on.
4) Palette icon - edit color display
5) Location Bar - this is where you can choose where on your Zendesk Instance you would like to see this profile. Currently, there are 4 locations: Organization Sidebar, Ticket Sidebar, New Ticket Sidebar, and User Sidebar. You can read more about the locations below.
6) Hyperlink -
7) Sidebar Tabs
2. Hyperlinks
In this section, you can enter a clickable URL and mask it. Just enter the Link Button Name and the Base URL.
3. Adding new Sidebar Tabs
Besides profiles, tabs are another way in which Flare allows you to structure your data. Within the selected profile, tabs can be added to organize your display objects thematically.
1. Click on Add New Sidebar Tab. give your sidebar a name. Then click on Add.
2. Give your sidebar a name. Then click on Add.
3. The new sidebar will show in the sidebar list, as shown below.
Note: The display order of the sidebars can be changed by dragging and dropping them on top or below each other.
4. Adding a New Display Object
Display objects are any form in which Flare is visualizing your external data in the Zendesk sidebar.
1. In order to add a new display object to a tab, first click on the dropdown arrow of your tab and then on Add New Display Object.
2. On the next page, you can decide the details for the newly created object, starting with the type: Table or Custom.
Note: Choose Table, unless you have a custom solution implemented by Faye.
3. Now give the table a Name.
4. A preview of your new object will show on the right-hand side.
5. Choose the table styling and the default number of rows to display. If you make your table searchable, an input field will appear above your table in which you can enter search terms that limit the displayed results.
6. Pick a Dataset to define from where Flare is pulling the information that you'd like your display object to contain.
7. Add new columns to your object by clicking on Add.
8. Depending on which dataset you've picked, you've now got different attributes available in the Column dropdown. Use a Label to name your column header, and select the Type of data you're expecting from the source dataset to format it properly. Then, click on the save icon (floppy disk).
9. (OPTIONAL): Now, you can define filters that reduce the returned data in the sidebar by matching attributes from the currently viewed Zendesk record to the external data. Only records which meet the conditions will then be shown in the sidebar. First, select a comparator to configure how multiple filter conditions work together. Then click on Add New to add the filter.
10. Now choose the filter you wish to set and click on Save. On the left side, you can see the attributes from your source data set. On the right, you see attributes of the Zendesk record where the display object is located. In the middle, you can define how these attributes relate to each other so the filter considers them a match.
5. Color Settings
Within Flare Studio, you can configure the color scheme of your Flare App.
1. To do so, first, click on the color palette on the right of the top bar.
2. You can now decide the Background, Text, and Brand colors by clicking on the dropdown arrow of each item.
3. A preview of the tab colors is shown on the right-hand side of the screen. Once you are happy with your choice, click Save.
Congratulations! You have now set up all the information you need in Flare Studio.
Should you still have unanswered questions, do not hesitate to contact us at support@fayebsg.com.
Comments
0 comments
Please sign in to leave a comment.