Parameters are variables that let you filter data or display specific values in your dashboards. For example, by adding the User ID parameter to your query, each employee will only see their data in the dashboard. This allows you to filter information without creating new dashboards or separate charts.

This article explains what parameters are in BI Builder dashboards and how to use them.

Select the scope and dashboard parameters

Configure parameters and select Bitrix24 areas for new and existing dashboards:

1. Go to the BI Builder section.
2. To create a dashboard, click New dashboard.
3-4. To edit an existing dashboard, open the Menu (≡) and select Settings.

When creating a dashboard, enter its name, select the sections to show it, and specify the required parameters.

After specifying the parameters, add them to your dataset. Charts are based on the dataset, so you need to include the parameters in your query. If not, they won't work. Check the Parameter IDs section and note the IDs you need for the dataset.

Create a dataset

After saving the dashboard, it will appear in the list in a draft status, visible only to the creator. You can modify the data or structure of the dashboard, and no one will see the changes until it's published. To open the BI Builder and create a dataset, click Edit.

1. In the BI Builder, go to SQL > SQL Lab.
2. Select the bitrix24 schema.
3. Enter your SQL query and click Run.

You can use a Jinja template in your query to change parameters dynamically. For example, set a condition: if the Current user parameter is missing, the query displays all the data. If the link includes the Current user parameter, it will only show data for the employee who opened the dashboard. This allows you to save the dataset immediately and use it in dashboards.
Using Jinja Templates in BI Builder

WHERE
    true
    {% if url_param('current_user') is not none %}
    AND crm_deal.ASSIGNED_BY_ID = {{ url_param('current_user') }}
    {% endif %}

When creating a dataset with specific values in the query, avoid adding parameters initially, as they won't work. Instead, add parameters when editing the completed dataset.

If you're creating a dataset for the first time, refer to the sample query.

SELECT
    crm_deal.ID AS "Deal ID",
    crm_deal.TITLE AS "Deal name",
    crm_deal.ASSIGNED_BY AS "Responsible user"
FROM
    crm_deal
WHERE
    crm_deal.ASSIGNED_BY_ID = 11
    AND YEAR(crm_deal.DATE_CREATE) = YEAR(CURRENT_DATE)

Save the results as a dataset and create a chart for the dashboard.
Create a chart based on a virtual dataset

Edit the dataset

To add a parameter, open the Datasets tab, select the dataset you created, and click Edit.

Modify the SQL query by adding this parameter: WHERE crm_deal.ASSIGNED_BY_ID = {{ url_param('current_user') }}. Then, save the changes. When employees open the dashboard in Bitrix24, the parameter will automatically insert the correct ID, allowing each user to see only their data.

Check how it works

Open the dashboard in Bitrix24 and ensure the charts display the information for each specific user. If the parameter is set up correctly, the dashboard creator will see only their deals.

To make the dashboard available to others, open the Menu (≡) and click Publish.

Once published, ask employees to confirm they see only their information.