Create and Assign the Data Source for a Widget

In order for widgets to display data, assign a data source. First create a data source, then drag-and-drop the data source onto widgets.
uims
In order for widgets to display data, assign a data source. First create a data source, then drag-and-drop the data source onto widgets.
The tutorial
Assign Data Sources to Widgets
in How To Videos shows how to define a data source and then assign it to a widget.
Once created, data sources are available to any of the widgets on the dashboard, and a single data source can be assigned to multiple widgets.
Data sources are specific to a dashboard and must be created for each new dashboard. However, a dashboard with data sources that is saved with another name retains the data sources.
Available data source types are:
  • Alarm
  • Dashboard
  • Metric
  • SLA/SLO
Other advanced data sources that require special knowledge, such as familiarity with your environment or with creating database queries. Advanced data sources are:
  • Probe
  • QoS
  • SQL
Not all widgets support all data sources. When you drag a data source onto a widget, the widget border turns green if the widget supports the type of data source and turns red if it does not.
Contents
Create an Alarm Data Source
Create an alarm data source to display the highest data severity condition.
To specify alarm criteria, create a filter that defines which alarms to include. This filter is separate from alarm filters that are defined for the user's access control list (ACL) in the Account Admin portlet.
For example, if an account contact user is restricted in their ACL to seeing only alarms from a particular hub, only these alarms are included in alarm data that are displayed by Dashboard widgets. In the Dashboard portlet, the administrator creating the dashboard can further limit the alarm data that are displayed for particular widgets, such as including only alarms from a particular subsystem. This selection is done by defining a filter when you create an alarm data source.
Alarm filters for ACLs might also be defined in Infrastructure Manager, but these filters are not applied in the Dashboard portlet. We recommend using the Account Admin portlet to manage accounts, users, and ACLs.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. Click
    Alarm
    , then click the
    Add
    icon.
  3. Enter information in the fields of the dialog to create the filter:
    • Name
      Enter a name for the data source.
    • (blank) or not
      Choose
      not
      to search for all systems except those systems that meet this row of the filter definition. Otherwise, leave this field blank.
    • Select a field for filtering
      Choose the criterion to filter on, such as Hostname, Source, and Message.
    • Select operator
      Choose the appropriate operator, such as
      is
      ,
      contains
      ,
      starts with
      ,
      ends with
      , or
      matches
      .
    • Text field
      Enter the appropriate text for the criterion you chose. You can enter regular expressions in this field.
      Alarm filters use the Java RexEx pattern format. For a full list of supported constructs, see the Java documentation.
    • Plus/Minus Sign
      Click to add or remove rows for the filter definition.
  4. Click
    Test Filter
    . Alarms that match the filter are listed. Verify that the results are as expected and adjust the filter if necessary.
  5. Click
    Create
    .
Create a Dashboard Data Source
You can use a dashboard with alarm data sources as a data source for another dashboard. Create this type of data source if you want to drill down from one dashboard to another. The parent dashboard displays the highest severity alarm from the child dashboard.
The dashboard data source is supported only for dashboards with alarm data sources.
Use this functionality to logically group elements together, emphasizing the geographical, topographical, structural, or organizational placements of monitored systems.
For example, you have a dashboard named Regions with widgets that show the alarm status for North America, Asia, Europe, Africa, and Latin America. You create a child dashboard named North America that shows the alarm status for West Coast, Midwest, and East Coast. In the Regions dashboard, you assign the North America dashboard as a data source for the North America widget. When you see an alarm status of major for North America in the Regions dashboard, hover over the North America widget and click the link to the North America dashboard in the tooltip. This opens the North America dashboard, where you can see which area of North America generated the major alarm.
The tooltip with the drill-down link for a dashboard data source is displayed only in Live View or in a published dashboard. It is not displayed in Edit mode.
Publish the parent and child dashboards with the same visibility setting (private, public, or account). For example, if you publish the parent dashboard as an account dashboard and the child dashboard as private, account contact users cannot drill down from the parent to the child because they do not have permission to view the child dashboard. Publish the child dashboard again and change the visibility setting to match the parent dashboard.
You must republish a dashboard for a new visibility setting to take effect.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. Click
    Dashboard
    .
Your dashboards are listed as data sources.
Create a Metric Data Source
Create a Metric data source if you want widgets to display the current metrics being monitored on a system.
Metric sources are listed in a hierarchical tree. Data is grouped under either the
Groups
or
Other
nodes in the tree and
Accounts
under the
Groups
node.
  1. Groups
    • Accounts
      - List of systems that belong to specific accounts.
    • All
      - List of systems that belong to all accounts.
  2. Other
    List of systems that do not belong to a group.
    Groups and Accounts are defined by an administrator through the Unified Service Manager. If you do not find the group or account of interest in the dropdown menus, contact the system administrator to create them.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. Click
    Metric
    to expand the menu.
  3. Click to navigate through the lists and display the systems with metrics available.
  4. When you find the desired system name, click to select it.
Create an SLA or SLO Data Source
You can use a Service Level Agreement (SLA) or Service Level Objective (SLO) as a data source. Create this type of data source if you want widgets to display the compliance percentage of the SLA or SLO.
For more information about SLAs and SLOs, see the help for the SLA Reports portlet.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. Click
    SLA/SLO
    . Your SLAs and SLOs are listed as data sources.
 
SLAs and SLOs are defined by the system administrator through the Service Level Manager (SLM) portlet. If the SLA or SLO of interest is not in the list, contact the administrator to create it.
Create a QoS Data Source
Create a quality-of-service (QoS) data source if you want widgets to display the current value for a QoS metric.
You can display QoS metrics stored in the UIM database or in any database with a connection configured in the Java database connectivity driver (jdbc) tab of the Web Application Server Probe (wasp) configuration file.
Wasp is a probe that is distributed to the system during the unified management portal (UMP) installation, and afterward appears as a probe in UMP or the Admin Console. For more information about configuring a database for wasp, see the wasp probe guide.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. If
    QoS
    is not listed as a data source, click the
    Options
    (2255944.PNG) icon and select
    Show advanced data sources
    .
  3. Click
    QoS
    , then click the
    Add
    icon.
  4. Enter information in the fields of the dialog:
    • Name
      Name for the data source.
    • QoS
      Select the QoS.
    • Source
      Select the source for the QoS metric. Typically the source is the system where the probe is running.
      For example, for a CPU usage metric the source is the system where the cdm probe is installed.
    • Target
      Select the target for the QoS metric. Typically the target is the system being monitored.
      For example, for a CPU usage metric the target is the source where CPU usage is measured. For a URL response metric the target is the endpoint of the measurement.
  5. Click
    Test QoS (Single)
    to view the latest value for the QoS, or
    Test QoS (Multi)
    to view values for the last hour.
    Test QoS (Multi)
    is useful to preview data for the line chart widget.
    After clicking the
    Test QoS
    button, you see the value and date for the metric.
  6. Click
    Create
    .
Create a Probe Data Source
Create a probe data source if you want widgets to display data from a specific probe. Each probe has a set of commands you can execute by creating a probe data source.
For example, use the get_info command for the cdm probe to return various information about the system, including OS, uptime, and CPU usage.
The probe data source is an advanced data source and requires knowledge of the probe command set and parameters. The probe command set can be explored using the Probe Utility. For more information about the Probe Utility, see Use the Probe Utility.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. If
    Probe
    is not listed as a data source, click the
    Options
    (2255944.PNG) icon and select
    Show advanced data sources
    .
  3. Click
    Probe
    , then click the
    Add
    icon.
  4. Enter information in the fields of the dialog:
    • Name
      Enter a name for the data source.
    • Hub
      Choose the hub for the probe.
    • Robot
      Choose the robot where the probe is installed.
    • Probe
      Choose the probe.
    • Command
      Choose the probe command to collect the data you want to display. For example, if you want to display CPU status information from the cdm probe, select
      cpu_status
      . The cpu_status command collects metrics related to CPU status, such as cpu idle, processor queue length, and cpu wait.
    • Parameters
      If the probe command has parameters, enter them here.
    • Results
      Ignore this field until after the next step.
  5. Click
    Test Probe
    .
    The metrics collected by the command you selected are listed in the Results table.
  6. In the Results table, select the metric that you want widgets to display.
    Only results with a single value are supported. Results that return multiple objects are not supported by the probe data source.
  7. Click
    Create
    .
Create an SQL Data Source
Create an SQL data source if you want widgets to display a metric from a database.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. If
    SQL
    is not listed as a data source, click the
    Options
    (2255944.PNG) icon and select
    Show advanced data sources
    .
  3. Click
    SQL
    , then click the
    Plus Sign
    (2255968.PNG) icon next to the database you want to query.
  4. Enter information in the fields of the dialog:
    • Name
      Enter a name for the data source.
    • Database
      Accept the default (the database that is created at installation) or click on the name of another database.
    • Type
      Choose
      SQL Statement
      to enter an SQL query or
      Stored Procedure
      to execute a stored procedure.
    • Query
      Enter the SQL query or stored procedure call.
      For a stored procedure call, use the following syntax:
      exec <storedProcedureName> <parameter1> <parameter2>
      For example, for a stored procedure named getMetrics with two parameters the syntax is:
      exec getMetrics version_param increment_param
      Substitution parameters are available to dashboard SQL data sources, including ${username}, ${accountName}, ${origins}, and ${originsSqlList}. In this way, dashboards can support multi-tenancy: values for SQL parameters are substituted at runtime for the dashboard account user. The ${origins} value is a comma-separated list of the user account origins. The ${originsSqlList} value is a comma-separated list of the user account origins with single quotes ready to use in a SQL IN list.
      For bus (not account contact) users, ${accountName} becomes the empty string and ${originsSqlList} becomes the string value of two apostrophes ('').
      To create an SQL data source for a line chart, the query must be structured so that the first column is the timestamp for the parameter of interest
      in ISO 8601 format
      and the second column is the resulting value. Each data series requires a separate SQL data source with that two-column result.
  5. Click
    Test Query
    .
    Results of the query are displayed. Verify the results and adjust the query if necessary.
  6. Click
    Create
    .
Add a Database Connection for SQL Data Sources
By default the UIM database is available for creating SQL data sources. You can add other SQL databases to display data that are stored there.
Follow these steps:
  1. IIn the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. If
    SQL
    is not listed as a data source, click the
    Options
    (2255944.PNG) icon and select
    Show advanced data sources
    .
  3. Click
    SQL
    , then click
    Add
    Icon above the list of databases.
    The Create Database Connection dialog is displayed.
  4. Enter information in these fields:
    • Name
      Name for the database connection.
    • Driver Class
      Defines the type of driver to use to access the database. For example, here are some possible settings:
      com.microsoft.sqlserver.jdbc.SQLServerDriver
      oracle.jdbc.driver.OracleDriver
      com.mysql.jdbc.Driver
    • JDBC URL
      JDBC connection URL. For example, here are some possible settings:
      jdbc:sqlserver://<dbserver>;DatabaseName=<dbname>
      jdbc:oracle:thin:@<dbserver>:CA Portal:<service name>
      jdbc:mysql://<dbserver>:CA Portal/<dbname>
    • User
      User name to access the database.
    • Password
      Password to access the database.
  5. Click
    Create
    .
  6. Restart the wasp probe.
Delete a Database Connection for for SQL Data Sources
In the event that a database connection is no longer needed for SQL queries, you can delete it.
Deleting a database connection will affect any widgets that depend on the connection. Be sure that a connection is not used before deleting it.
To remove the connection, navigate to the wasp.cfg file in the system files and delete the database information there.
You can view the dashboard database connections in the wasp configuration GUI but not delete it there.
Follow these steps:
  1. Navigate to the wasp.cfg file.
    The default location of the file is <uim_install>\nimsoft\probes\service\wasp.
  2. Open the wasp.cfg file in a text editor.
  3. Scroll to the
    webapps
    section for
    dashboard
    .
  4. Locate the database information under the appropriate <jdbc> tag and delete the database information.
  5. Save the file.
  6. Restart the wasp probe.
Assign a Data Source
Assign a data source to a widget to display the current value for that data source.
Not all widgets support all data sources. When you drag a data source onto a widget, the border around the widget turns green if the widget supports the type of data source and turns red if it does not.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
    Widgets that do not have a data source assigned to them are gray and have a missing data source icon overlaid on them, such as this text widget:
    2275992.PNG
  2. Drag a data source from the right pane and drop it onto a widget.
    The data source is now assigned to the widget.
  3. (Optional) Choose
    Live view
    from the
    Dashboard
    menu to view the widget with current data.
  4. (Optional) To change the data source, drag a different data source onto the widget.
You can also view or assign a data source for a widget under the
Data Source
menu in the
Widget Properties
tab.
Unassign a Data Source
You can unassign a data source if you want no data source assigned to the widget.
To change the data source assigned to a widget to another data source, assign a different data source. You do not need to unassign the current data source first.
Follow these steps:
  1. Click the widget to select it.
  2. Click the
    Widget Properties
    tab.
  3. Click
    Data Source
    to expand the menu.
  4. Click the
    Remove data source
    (2275980.PNG) icon.
    No data source is assigned to the widget. The data source that you removed is still available to assign to other widgets.
Delete a Data Source
Delete a data source if you no longer want it to be available to assign to widgets.
You cannot delete a data source that is in use. First verify the data source is not assigned to any widgets, then delete the data source.
Follow these steps:
  1. In the right pane, click the
    Data Sources
    (2260946.PNG) tab.
  2. Click on the header for the type of data source to expand the data source list.
  3. Locate the data source of interest in the list. For an SQL query, click the checkbox beside a data source to select it.
  4. Click the
    Delete Selected Data Sources
    (2262161.PNG) icon
    The data source is deleted and is no longer listed in your data sources
How to Use Parameters
You can create dashboard parameters (variables) for use in multiple widgets. This allows you to reuse widgets or data sources, updating them simply by changing parameter definitions.
The dashboard portlet uses both global and local parameters.
For example, you have a dashboard with three widgets displaying information about a computer system. You create a parameter named System1 and enter the host name as the value. You enter ${System1} in the
Label
field in the Widget Properties tab for each widget. If the host name changes, or if you want to use the same dashboard for another customer, you can update the parameter value and the host name is updated in all three widget labels.
You can also use parameters when defining data sources. For example, if you have a parameter named 'Robot1' and the value is the path to the robot, you can enter ${Robot1} as the parameter in the
Robot
field for the probe data source. If the data source changes, you can redefine it in the parameter list rather than the data source for the widget.
The text widget also supports the use of parameters.
Follow these steps:
  1. Click the
    Parameters
    (DashboardParameters.png) tab.
  2. Click in the
    Global
    or
    Local
    header to expand the list of parameters.
  3. Click the
    Add
    (DashboardAddDataSource.png) icon.
    A dialog box appears.
  4. Click the
    Name
    field and enter a name for the parameter.
  5. Click the
    Value
    field and enter the value for the parameter. The value can be any text, such as a host name or path to a system.
  6. Click the
    Create
    button.
  7. Go to
    Dashboard
    ,
    Save
    to save the parameters that you have created.
  8. In the data field where you want to use the parameter, enter the parameter name preceded by a dollar sign and enclosed in curly brackets:
    ${parameter}