When you connect a third-party system to Gtmhub, you usually synchronize big amounts of data. Building insights that cover all this data is a way to stay on top of things, but you often need to drill down and focus on a specific area.
The Insightboard parameters are a useful way to filter data in various ways. You can create only one insight and filter its information to get specific information, based on time period, owner, region, etc. You do this by defining insightboard parameters that you use as filters.
To create and manage insightboard parameters, you must be administrator or have permissions to manage the account settings.
To create a new insightboard parameter, perform the following:
- In the bottom of the navigation pane, click Settings.
- On the Configuration tab, click Insightboard parameters.
There are the three predefined parameters.
- Click ADD NEW PARAMETER.
- In Title, enter a name for the filter.
This is the name that is displayed on the insightboard.
- In Key, enter the key that you will use in the insight algorithm.
The is used in your SQL placeholder syntax. You can enter only lowercase Latin letters and underscore.
- In the Selector dropdown box, select the type of selector that will be used for the filter.
Select one of the following: Free text field, Date picker, Date-range picker, List, Multi-select dropdown.
Depending on your choice, use one of the following procedures:
Free text field
This creates a filter that you can apply to a string entity field. You have to manually enter the input that you want to filter by.
For example, if you want to track the completed stories in Jira, categorized with a certain label, you can use the Free text field to enter the label.
By default, there is no predefined value.
If you have selected Free text field and you want to use a predefined value for the field, in case no value is provided in the insight, switch the Use default value toggle button and enter the Default value.
List and Multi-select dropdown
You can select only one value from the List and multiple values from the Multi-select dropdown.
After choosing either of the selector, to configure them, perform the following:
- To manually create the options for the filter, under Predefined set of values, click + (Add new predefined value).
Enter the value and click + to add more values.
- To manually create the options for the filter, under Dynamic values, move the toggle switch to Use connected entity values.
- In Entity type, select the entity which holds the values for the list.
You can select from a list of all entities from all connectors that you have synced in Gtmhub.
NOTE: If your entity does not directly expose the field that you want to use as a filter, you can use a virtual data sources to create a filter.
For more information, see Create virtual data sources.
- In Title field, select the name of the field from this entity that you want to us to display as choices for the filter.
The values of this field will be passed as the parameter for the choices of the filter in the UI.
- In Value field, select the name of the field from this entity that you want to use as parameters for the filter.
The values of this field will be passed as the parameters for the filter in the SQL syntax.
- If you want to use a preselected value for the selectors, move the toggle switch to Use default value.
- Enter the Default value.
This value will be used, if no value is provided in the insight filter.
For the Multi-select dropdown, you can enter many predefined values, separated by commas.
This creates a filter that allows you to filter data based on a specific date. For example, you want to track all your projects that are due on May 17th, 2020.
The default value for this filter is today's date.
NOTE: The date is in your current time zone.
If you want to use another default value for the selector, move the toggle switch to Use default value and select the Default date.
This value will be used, instead of today’s date, if no value is provided in the insight filter.
This creates a filter that allows you to filter based on a time period. The default value for this filter is the period from today to one month later.
NOTE: The dates are in your current time zone.
If you want to use another default date range, enter the predefined dates.
The values will be used instead of the default date range.
When finished, click Create insightboard parameter.