Tile Editor
The tile editor is the interface that lets you retrieve, filter, shape and visualize your data. You use the tile editor whenever you want to add or edit a data tile, or when when using the data explorer to experiment with your data streams.
You can add a title and description for your tile at the top of editor.
Configuration flow
The steps for configuring a data tile may vary depending on which data stream you select, however the configuration flow usually remains similar.
To configure a tile, you work down the tabs of the tile editor to retrieve, filter and shape the data you want and then use the panel on the right-hand side of the page to configure the Visualization, Monitoring and KPI settings.
The steps to configuring a tile can include:
- Selecting a data stream
- Selecting objects
- Configuring parameters
- Specifying a timeframe
- Shaping data
- Formatting data columns
Data stream
The first step to visualizing your data is to choose the data stream you want to use. Therefore, when you add a new data tile to a dashboard, you are presented with the data stream splash screen.
From here, you can quickly select recent data stream to display data streams for. If the data stream you need isn't immediately presented, then click either the Data Stream tab on the left or the Browse all data streams button to expand the data stream tab.
Data streams list
The Data Stream tab displays a list containing all of data streams for your currently indexed data sources and can be filtered using the search and dropdowns.
For each data stream in the list you will see:
- The Name of the data stream. You you can sort data by streams A-Z or Z-A by clicking thiscolumn.
- A Description of the data stream.
- The Type of object that the data stream is available for (matches).
- Featured data streams, indicated by the flame icon , which contextually include data streams which might be the most important or most useful.
- Recently used data streams, indicated by a clock icon , are floated to the top of the list for easy access.
Many data streams related to each other as pre-configurations of an encompassing data stream.
For example, the Workflow Runs / In Progress Worklows
data stream is a pre-configuration of the Workflow Runs
data stream, where the Status parameter has automatically been pre-selected.
To reflect this, pre-configured data streams follow the naming convention of <Primary data stream> / <pre-configuration>
.
For help with configuring the data streams specific to your data source, refer to the corresponding data source article:
List of documentation for data source plugins available
Objects
Use the Objects tab of the tile editor to specify a collection of objects to display data for. You only need to complete this tab if you have selected a Scoped data stream.
Selecting a collection
Do the following to choose the objects for the collection:
- Search the list for the objects for those you want to add. By default, every object you have access to is presented with the total selected / available displaying below.
- Use the the Search objects box to directly search for objects by their name.
- Use the Filter pane on the left-hand side to select the Data source(s),Types and / or Collections to filter the object list by.
- Click Add filter at the bottom of the Filter pane to add additional properties to the filter list.
When you add a filter it also adds that property as a column in the object list so you can see the values.
You can also achieve this by clicking the Add column button at the top right.
- Click Add filter at the bottom of the Filter pane to add additional properties to the filter list.
To select the objects you wish to be in the collection you can either tick the objects, or toggle the Dynamic selection button.
- Fixed selection: Returns the specific objects that you manually pick by ticking them. Objects in a fixed scope never change, except when you edit the collection.
- Dynamic selection: Enabled by selecting the Dynamic selection toggle this returns all the objects that match the criteria specified in the Filter panel and search. When objects that match are added to or removed from SquaredUp, the objects in the selection will change. Dynamically scoped tiles check which objects match the filter whenever they refresh.
- Click Next.
Saving a collection
The collection of objects you specify on this tab can be saved for future use in your workspace by clicking Add collection
in the Filter panel. This opens the Add collection window, pre-populated with the objects you selected.Collections can also be created and saved via the Objects page, accessed via the left-hand menu. See Collections.
Parameters
Use the Parameters tab of the tile editor to configure your data streams. Not every data stream has parameters to configure (for example, a data stream might simply retrieve a specific set of data), and those that are can vary widely depending on the data stream itself.
For instructions of configuring the parameters for a data stream, refer to the Data streams section for the corresponding plugin.
Timeframe
Use the Timeframe tab to choose the timeframe that a tile displays data for. For example, by default a tile's timeframe is set to the dashboard timeframe but you could instead choose to display data from the last 30 days.
No timeframe option
There are many data streams where specifying a timeframe is optional, such as ones which scope to a specific collection and thus don't necessarily need to return results from a specific period.
In these circumstances, the timeframe picker displays the None option, allowing you to return results without considering the tile / dashboard timeframe.
If None is the selected option for the timeframe:
- The Timeframe tab in the tile editor shows
None
. - No tile timeframe pill displays on the tile.
- When enabling monitoring or KPI, no timeframe is enforced on the tile (such as when using dashboard timeframe).
Mandatory timeframes
Many data streams, particularly those that accept a query input such as KQL, require you to specify a timeframe. In such cases, the Timeframe tab is not shown and the timeframe must be declared in on the Parameters tab.
Timeframe not supported
In circumstances where specifying a timeframe for a data stream is not supported, the Timeframe tab is not shown.
Shaping
Data shaping lets you transform and structure your raw data to improve clarity and usability before visualizing it. This process involves:
- Filtering, which extracts relevant subsets by applying conditions.
- Grouping, which aggregates data based on common attributes.
- Sorting, which arranges data in ascending or descending order.
Filtering
Data can be filtered according to whether data in a column meets or does not meet specified text or numerical value conditions.
Multiple filters
You are able to add multiple filter conditions using the following operators:
- AND: All conditions must be satisfied (e.g.
Status-Equals-Closed
ANDType-Equals-Question
). - OR: Any condition can be satisfied (e.g.
Status-Equals-Pending
ORStatus-Equals-Closed
).
Available filters
The following options are available when filtering data, which ones display depends on the column type.
Grouping
Use the grouping section to group and aggregate data columns.
For example, for AWS cost data you might configure the following settings to display a table or bar chart of cost per label:
- Group by:
label
- Aggregation type:
Total
- Aggregation column:
Amount
Which columns are available depends on the data stream you chose.
Configuring grouping enables different visualizations to be displayed, such as bar chart and donut. For example, grouping tickets by channel allows you to show a donut of how many tickets were logged by email vs web form.
Bucket by
If you group by a time column, and further grouping is possible, the Bucket by dropdown appears. Use this field to control how the time data is grouped, for example by hour
, day
, month
etc.
Aggregation
To aggregate your data, you must select an Aggregation type and a target Aggregation column. For example, if creating bar chart for an Azure Resource Group cost, you could configure the following settings:
- Group by:
Timestamp
- Bucket by:
Day
- Aggregation type:
Total
- Aggregate column:
Cost
The following lists the available aggregation types.
Sorting
The Sort section allows you to select one or more columns to sort your date by, in either ascending or descending order.
While this sets the default sort order of data, but you can always click on a column heading to sort the data table on the fly.
To sort by multiple columns, click Add sort by to add a new row of sort fields to the list. This allows you perform more complex sorts, such as sorting data by the data it was created, then sorting those results alphabetically.
Enabling the Top toggle allows you to specify the top n rows of data to display.
Columns
Use the Columns tab of the tile editor to format the columns of the table on the Data tab.
For example, when retrieving data using the Web API plugin, scripting, or custom query data streams (such as Splunk Enterprise plugin), the assigned data type may not be quite correct or as you expect.
Formatting columns
Use the following options to format your columns.
Comparison columns
Comparison columns are used to compare two values, for example you may want to compare the number of tickets raised this month to the number of tickets raised last month. You can choose to show the value as an absolute change (for example, 12 more tickets) or as a percentage change (for example, a 28% increase).
When a column has a Type of Number, the Add comparison
button displays at the end of the row, which you can click to open the Add comparison window.- Column A:
Select the first column to compare against. Automatically populated with the column of which you clicked Add comparison. - Column B:
Select the second column to compare against. - Output:
Select how to display the comparison value. This value is displayed in the Preview field. Choose from:- Absolute: Show the numerical value of Column A - Column B.
- Percentage: Show the ratio of Column B to Column A as a percent.
- Click Add to create the comparison.
Additional options
Some data types have advanced settings that can be configured in the options section, which is displayed whenever you change the data Type or by clicking expand
next to the column Name.Visualization
Visualization settings are configured on the Visualization tab of the right-hand panel in the tile editor.
Which visualizations are offered to you depends on the data available, for example Line Graph will only be offered if there is time series data in your dataset.
For detailed information on configuring each visualization type, see Visualizations.
These steps describe the simple tile editor. Advanced users might like to try the SQL Analytics editor see SQL Analytics (Beta).
Monitoring
You can enable and create monitors for your data tiles on the Monitoring tab of the tile editor.
These monitors let you watch for changes to your configured data and trigger notifications and status rollups whenever a state, threshold or scripted condition is met.
For detailed information on configuring monitoring, see Monitors.
KPI
KPIs can publish key metrics within a workspace and also aggregate at a higher level for complete oversight.
Defining, monitoring and evaluating KPIs is a practice followed by virtually every organization. In your organization there may be KPIs such as DORA metrics, Service Level Objectives or Cloud costs. SquaredUp allows you to visualize, monitor, and roll-up these values - giving you complete oversight of your key metrics.
KPIs are enabled and configured on the KPI tab of the tile editor.
For detailed information on configuring KPIs, see KPIs.