| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
The parameters provides a user an opportunity during a custom metric creating to have the flexibility to add values that allow for more tailored analysis. There are three types of parameters that can be added: Drop-down list, Date, and Input. With these parameters, users can configure specific values for the custom metric to better fit their needs.
In the dashboard view, users can easily filter a metric with the set parameters. This real-time adjustment of parameters allows the metric to be recalculated on the fly, which enhances the analysis process.
Create Parameter
Before using parameters with a custom metric on a dashboard it is necessary to add Parameters and configure them via PerfQL.
Step 1: Add Parameter
At the Data Selection step of the ‘Create New Metric’ or ‘Edit Metric’ custom metric stepper click on the plus button at the Parameters option.
...
| Warning |
|---|
Parameter name must be unique within one metric. |
Select a Type
| Info |
|---|
There are three types of parameters are possible to use:
|
Set Default value
| Info |
|---|
For the Date fieldtype set a date you would like to use as a default one. Based on this date a metric will be calculated for default view. There is one date is possible to set within one field. The Single select type allows to select the only one Default Value from the entities created in the Values field(s). Based on selected Default Value a metric will be calculated for default view. After setting value(s) for the Dropdown list Multiple select type click on the default field and select the value(s) you would like to set as a default. Based on selected values a metric will be calculated for default view. It is possible to select several values. For the Input field type specify a custom value based on which you would like the default metric to be calculated on. It is possible to use text, numeric, order formats. |
...
| Tip |
|---|
The system automatically applies the '$' symbol to a name to make parameters distinctive. |
Step 2: Configure Parameter
At this step it is necessary to configure added parameters as variables with set values using PerfQL.
For the Multiple select type use ‘in’ operator, for the Single select type use '='.
Example:
A metric shows top-N tickets creators with a specific ticket type, created after a certain date and set limit of output data.
For the metric we have to create 3 types of parameters:
for the ticket type (Dropdown list Multiple or Single select type) - $type$
for created after (Date field type) - $created_after$
for limit (Input field type) - $n$
PerfQL:
select reported_by, count(*)
from Ticket
where type in $type$ (or ‘where type = $type$’ for single select option)
and created > $created_after$
group by reported_by
order by count desc
limit $n$
...
Edit Parameter
The added/configured parameters are possible to Edit on the ‘Create New Metric’ or ‘Edit Metric’ custom metric stepper.
...
| Note |
|---|
Please do not forget to update PerfQL for the changed parameter if necessary. |
Delete Parameter
The added/configured parameters are possible to Delete on the ‘Create New Metric’ or ‘Edit Metric’ custom metric stepper.
...
| Note |
|---|
Please do not forget to update PerfQL for the deleted parameter if necessary. |
...
Filter a metric via Parameters
After Parameter(s) was added and configured successfully it becomes possible to filter a metric on a dashboard. By default the metric is calculated based on default values that were entered during parameters creation.
...
The system recalculates the metric based on the updated Parameters.
...
| Info |
|---|
You can see the configured parameters at a metric via the hovering on the parameters button. |
Special cases
The examples of potential tricky cases with the solutions:
Description | Solution |
|---|---|
For showing <entities> for the last <number of days> days | Put the ‘days’ word in the Values/Default value field(s).   'Multiple select' type   |
Copyright © 2024 EPAM Systems, Inc. |
All Rights Reserved. All information contained herein is, and remains the property of EPAM Systems, Inc. and/or its suppliers and is protected by international intellectual property law. Dissemination of this information or reproduction of this material is strictly forbidden, unless prior written permission is obtained from EPAM Systems, Inc. |