Global parameters tab

Applies to NAM 2018

Use the Global parameters tab to select or create parameters to manage the state of the report.

Tip: Skip straight to the examples below to see how we use global parameters in our reports.

Settings

  • ID
    The ID string of the parameter. You can use a predefined ID (corresponding to one of the dataview IDs) or create your own.

    • Example 1: You are searching for the predefined global parameter for server bytes, so you type "server" in the ID field and then select the correct ID and label pair (for example, Server bytes - sByte) from the autocomplete list of dimensions to automatically complete the ID and Label fields with the values sByte and Server bytes.
    • Example 2: You already know the exact ID string (sByte) of a predefined global parameter you want (Server bytes), so you type sByte (this is case-sensitive, so use a capital B in this example) and then select the correct ID and label pair (for example, Server bytes - sByte) from the autocomplete list to complete the ID and Label fields just as in Example 1.
    • Example 3: You are creating your own custom global parameter, one that does not directly correspond to anything in the dataview list. Type a simple alphanumeric string (MyReportStateID) with no spaces, then go on to the Label field (below).
  • Label
    The human-friendly name of the parameter, but also the name used in conditional expressions and filters.
    If you choose to show the value of the parameter in the report header, the label provided here will be used.
    You could, for example, have three different global parameters with three different ID strings but the same label.

  • User filter
    The initial value of the global parameter.

  • Editable
    Whether the value can be changed while we are interacting with the report (read only, read write) or by selecting the [x] mark next to the filter (read write).

  • Display target
    Whether to show the global parameter's value as a filter in the report header.

    Tip: If you set this to Report header, you will see a filter of the form:
    Label = [value]
    displayed just under the report header. (The value is the value of User filter if you have not otherwise changed it.) Displaying these values can be useful when developing and debugging reports.

  • Delete
    Deletes the selected global parameter.

Example 1: Breadcrumbs

Let's have a look at the Health dashboard report on the NAM Server. In the NAM Server search box, enter "open Health dashboard" to open the report.

  • The breadcrumbs at the top of the report are Home > Applications
  • When you select the Show health details button in the Application health trend over time section, we want to redraw the report and show Home > Applications > Details in the breadcrumbs row.

To add Details to the breadcrumbs if we call the report from that Show health details button:

  1. Open the report for editing (select Edit report in the ... menu in the upper right).

  2. Select the Global parameters tab.
    For this report, we created a global parameter called View (see the Label column).

  3. Select the Breadcrumbs tab.
    For this report, we added some conditional breadcrumbs, one of which are Details. In the Visible column for the Details breadcrumb, select edit to see the conditions under which this breadcrumb is visible. The conditional expression for the Details breadcrumb (the condition under which we will append this breadcrumb to the row of breadcrumbs) is <View> == 'details'. This means "show this breadcrumb (Details) if View is details". So now we just need a way to assign the value details to the global parameter View when we press that button.

  4. Open the Application health trend over time section of this report for editing.
    (Remember that we selected the Show health details button from within this section.)

  5. Select the Section list & buttons tab for that section.
    We can see two button definitions corresponding to the two buttons at the bottom of the Application health trend over time section.

  6. Open the Show health details button for editing (select in the Edit column).

  7. In the Custom rules section, we have:

    • Action = Set
    • Filter = View
    • Section = all sections
    • Value = details

    That's how we set global parameter View to the value details when we select that button. And the value of View (because it's global) can be checked in all report sections, so you can hide or display other report components, not just the breadcrumb in this example, depending on the value of View.

Example 2: Perspective

Let's stay on the Health dashboard report we were using in example 1.

When you select the Show most affected button in the Application health trend over time section, it displays the Home > Applications > Details > Most affected.

The Performance trend section has four possible perspectives: health, operation time, usage, and availability. Depending on which of these you choose in the list, we want to show the same Performance trend section but with a different selection of metrics.

  1. Open the Performance trend section for editing and select the Result display tab.
    In the Show column, a number of metrics are set to Conditional.

  2. Select edit for any of these metrics to see the conditional expression.
    The Aborts row, for example, shows <Most affected perspective> in ['Health', ''] This means that this metric is displayed if (and only if) <Most affected perspective> is one of the listed values: Health or empty.

  3. Select the Section list & buttons tab.
    Now you can see that we have defined a list called for [Name] where [Name], as you can see in the Name column, is one of four values: health, operation time, usage, or availability.

  4. Open the health row for editing (select in the Edit column).

  5. In the Custom rules section, we have:

    • Action = Set
    • Filter = Most affected perspective
    • Section = all sections
    • Value = Health
      And the other three entries have similar settings, so they can set Most affected perspective to operation time, usage, or availability.

    That's how we set the value of global parameter Most affected perspective when we select an item on this section's menu, and how we use that setting to determine what appears on this section.