Setting up variables for dashboard queries, filtering data, and panel title values

As a tenant administrator or editor, configure variables, which work as placeholders for values that you can use in dashboard queries and panel titles. Instead of hard-coding details such as server name or application name, use variables in your queries so that the system picks up the details at run time.

You can see variables in dropdown lists at the top of a dashboard.


To add a variable

  1. On a dashboard, click Dashboard settings .
  2. On the left navigation bar, click Variables.
  3. On the Variables page, click New.
  4. Depending on the variable type that you select, add the remaining options. For more information about variable types, click  here Open link .
  5. Click Add.
  6. On the left navigation pane, click Save dashboard.

Important

For Service Management queries, when Query is selected as the Type, you need to specify the SQL query variable in a specified format. Here is an example of the SQL query variable format:

remedy,{"sql": "Select Distinct case when `CHG:Infrastructure Change`.`ASGRP` is not null then `CHG:Infrastructure Change`.`ASGRP` else 'Unknown' end from `CHG:Infrastructure Change` limit 500"}


To copy a variable

  1. On a dashboard, click Dashboard settings .
  2. On the left navigation bar, click Variables.
  3. On the Variables page, click Duplicate Variable  against a variable. You can see the variable copied on the same page.
  4. Click the copied variable and edit it as required.
  5. On the left navigation pane, click Save dashboard.


To edit a variable

  1. On a dashboard, click the Dashboard settings icon .
  2. On the left navigation bar, click Variables.
  3. On the Variables page, click a variable.
  4. Make your changes and click Update.
  5. On the left navigation pane, click Save dashboard.


To delete a variable

  1. On a dashboard, click Dashboard settings icon .
  2. On the left navigation bar, click Variables.
  3. On the Variables page, click Remove Variable  against the variable that you want to delete.
  4. On the left navigation pane, click Save dashboard.

To configure the variable for supported report formats

As a tenant administrator or editor, configure the supported report formats for any of the out-of-the-box BMC Helix ITSM Printable dashboards or any custom dashboard using the supported_report_types variable. After you specify the supported report formats by using this variable, users will only see those formats when they download or schedule reports:

  1. On a dashboard, click Dashboard settings .
    The General tab opens by default.
  2. On the navigation bar, click Variables.
  3. Click supported_report_types variable from the list of variables.
  4. From the Hide menu, select Variable.
  5. In the Values separated by comma field, specify the supported report types, separated by commas, and click Update. 
    For example, specify PDF,XLS,CSV to enable users to download dashboards or schedule reports in all three formats. 

Important

CSV report format will export only the table-type panels. 


To configure additional dashboard filters by using tags

As a tenant administrator or editor, configure additional filters by using various tags for custom dashboards. This feature is available with AWS (Amazon Web Services) and Azure knowledge modules. 

Let's say you are a tenant administrator who wants to filter devices based on location. You use the Variable feature to configure the location filter by using the available tags. 

  1. On a dashboard, click Dashboard settings .
  2. On the navigation bar, click Variables.
  3. Create a variable called TagKeys
    1. Click Add new variable and configure the following options:
      1. Name: Specify TagKeys
      2. Type: Select Query
      3. Label: Specify TagKeys
      4. Hide: Select Variable
      5. Data source: Select BMC Helix
      6. Query: Specify entity,get_tag_keys(entity)
      7. Refresh: Select On dashboard load
      8. Sort: Select Disabled
    2. Click Update.
      You can see the list of available tags under Preview of values.



  4. Create a variable for location:
    1. On the Variables page, click New and configure the following options:
      1. Name: Specify Location
      2. Type: Select Query
      3. Label: Specify Location
      4. Data source: Select BMC Helix
      5. Query: Specify entity,get_tag_values(entity,location)
      6. Refresh: Select On dashboard load
      7. Sort: Select Disabled
    2. Click Update.
      You can see the list of locations under Preview of values.



  5. Create a variable for device name:
    1. On the Variables page, click New and configure the following options:
      1. Name: Specify deviceName
      2. Type: Select Query
      3. Label: Specify deviceName
      4. Data source: Select BMC Helix
      5. Query: Specify entity,get_entity_ids(device,{"location":"$Location"})
      6. Refresh: Select On dashboard load
      7. Sort: Select Disabled
    2. Click Update.



  6. Filter the selected dashboard based on the location of the devices.


To configure additional date filters by using variables

As a tenant administrator or editor, add additional date filters to your dashboards. BMC Helix Dashboards allows you to filter data by using the default date filter. However, by using this option, you can filter data in your dashboards and panels by multiple date ranges.

  1. On a dashboard, click Dashboard settings .
  2. On the navigation bar, click Variables.
  3. Create a new variable and configure the following options:
    • Name—Specify a name for the variable.
      For example, let's specify DateRange as the name of the variable.
    • Type—Select Date Range.
    • Label—Specify a label for the additional date filter that will be visible on your dashboards screen. 
      For example, let's specify Date Range.
    • Select Time Range—Select the appropriate date/time range.
  4. Click Update.
  5. Now, modify the SQL query of your dashboard's panel to filter data based on the newly added additional date filter.
    For example, use the following query to filter the incident details:

    `HPD:Help Desk`.`Date Range` between '${DateRange:from}'  and '${DateRange:to}'

    where, HPD:Help Desk is the form name and ${DateRange:from} and ${DateRange:to} indicate the date range selected in the additional date filter. 

    The same query can be added to multiple panels within the same dashboard to filter their data based on the additional date range.

    You can repeat the above steps to create multiple date filters in the same dashboard. 


To filter the Service Dashboard by services

As a tenant administrator or editor, filter the Service Dashboard by services. By default, the Service Dashboard displays data for the business services that are present in your tenant. By using variables, you can choose to display the metrics either for business or for technical services. 

  1. On the Service Dashboard, click Dashboard settings .
  2. On the navigation bar, click Variables.
  3. Create a new variable and configure the following options:
    • Name—Specify a name for the variable.
      For example, let's specify serviceName as the name of the variable.
    • Type—Select Query.
    • Label—Specify a label. 
      For example, let's specify Service Name.
    • Query—Specify the following query to display the business services in your tenant:

      smartgraph,{"query":"search BusinessService show #id,name","displayName":"name"}
  4. Click Update.

Important

To build queries for filtering services, see Logical and arithmetic expressions in BMC Discovery documentation.

Examples

  • Specify the following query to display the list of business services that are mentioned in the query:

    smartgraph,{"query":"search BusinessService where name in ['KM Service', 'Windows Service'] show #id,name","displayName":"#id"}

    where the data is displayed for the KM and Windows services.

  • Specify the following query to display all the business services that contain Windows in their names:

    smartgraph,{"query":"search BusinessService where os_type has subword "Windows" show #id,name","displayName":"#id"}


To create cascading filters in dashboards

As a tenant administrator or editor, you can create cascading filters for a dashboard. In cascading filters, when the first filter is selected, the second filter displays values relevant to the first filter.

Let's say you are a tenant administrator who wants to view the incident details of an assigned group for a selected company. Additionally, you want to view the high priority incident details for a selected assigned group. You can create cascading filters for the company, assigned groups and priority to filter their data based on the selection of the other filters. 

  1. On a dashboard, click Dashboard settings .
  2. On the navigation bar, click Variables.
  3. Create a variable for company:
    • Specify a name for the variable.
      For example, let's specify company.
    • From the Type list, select Query.
    • Specify a label for the list of the companies. 
      For example, let's specify Company.
    • Specify the following query to display the list of the companies:

      remedy,{"sql": "SELECT DISTINCT `HPD:Help Desk`.`Company` FROM `HPD:Help Desk` LIMIT 500"}
    • Click Update.
  4. Create a variable for assigned groups:
    • Specify a name for the variable.
      For example, let's specify assignedGroup.
    • From the Type list, select Query.
    • Specify a label for the list of the assigned groups. 
      For example, let's specify Assigned Group.
    • Specify the following query to display the list of the assigned groups based on the company:

      remedy,{"sql": "SELECT DISTINCT `HPD:Help Desk`.`Assigned Group` FROM `HPD:Help Desk` WHERE `HPD:Help Desk`, `Company` = $company LIMIT 500"}

      where WHERE `HPD:Help Desk`, `Company` = $company retrieves the list of the assigned groups based on the selected company. 
      To select assigned groups against multiple companies, enable the Multi-value option and specify the following query:

      remedy,{"sql": "SELECT DISTINCT `HPD:Help Desk`.`Assigned Group` FROM `HPD:Help Desk` WHERE `HPD:Help Desk`, `Company` in ($company LIMIT 500"}
    • Click Update.
  5. Create a variable for priority:
    • Specify a name for the variable.
      For example, let's specify priority.
    • From the Type list, select Query.
    • Specify a label for the list of the priorities. 
      For example, let's specify Priority.
    • Specify the following query to display the list of the assigned groups based on the company:

      remedy,{"sql": "SELECT DISTINCT `HPD:Help Desk`.`Priority` FROM `HPD:Help Desk` WHERE `HPD:Help Desk`, `Assigned Group` = $assignedGroup LIMIT 500"}

      where WHERE `HPD:Help Desk`, `Assigned Group` = $assignedGroup retrieves the list of the priorities based on the assigned group.
      To select priorities against multiple assigned groups, enable the Multi-value option and specify the following query:

      remedy,{"sql": "SELECT DISTINCT `HPD:Help Desk`.`Priority` FROM `HPD:Help Desk` WHERE `HPD:Help Desk`, `Assigned Group` in ($assignedGroup) LIMIT 500"}
    • Click Update.

On the Variables page, click Show dependencies to display the cascading filter mapping.


Was this page helpful? Yes No Submitting... Thank you

Comments