Previous Topic: Create a Custom DashboardNext Topic: Edit Dashboard Page Properties


Edit Dashboard Pane Properties

You edit Dashboard pane properties on the Administration tab under Searches. Choose the System category and open the Dashboard section. To create a new pane, edit an existing pane and save it under a new name.

To edit the dashboard Pane properties:

  1. Click Action, Edit Properties on the Pane.
  2. Specify the date range.
    In Date Range:

    Set the date range for the dashboard. For example, choose 'This Month' if you want the dashboard to show results from the start of the current month up to today.

  3. Click the Pane Configuration tab to configure the dashboard pane.

    Example: You can set the pane type to Chart, and then the initial Chart Type to ‘Bar’; then you select Area and Grid as Allowed Types. This pane type configuration lets the users switch to Area or Grid visualization if the initial bar chart visualization is not suitable.

    Pane Type:

    Specifies whether the pane displays data as a Chart, List or Tree.

    Chart

    Chart panes visualize data as bar, pie, column, line, bubble, area, or grid chart. If you choose the chart pane type, you must also specify the initial Chart Type and Allowed Types. This selection allows users to visualize the data as alternative chart types.

    List

    List panes contain lists of metrics (summary totals, such as the total number of unreviewed incidents). You define the metrics that are displayed in this list pane by specifying a database stored procedure in the Search Settings step.

    Tree

    Similar to list panes, tree panes contain information (such as metrics) organized hierarchically in a tree structure. You define the contents of the tree pane by specifying a database stored procedure in the Search Settings step.

    Pane Attributes:

    Enter the attributes of the pane, for example, chart axis type. Specify one or more attributes, for example, you can specify a logarithmic x-axis for bar charts. The supported attributes are listed in the iConsole Search Definition Guide; search for 'pane attributes'. Use a semicolon separated list if you specify multiple attributes

  4. Click Search Settings.

    Note: To maintain consistency between Oracle and SQL Server databases, dashboards assume that all pane SP names adhere to the following convention: <Package>_<Procedure>. If you implement a custom SQL Server procedure, it must adhere to this convention and you must enter the <Package> element in the SQL Package field and the <Procedure> element in the Procedure Name field. CA DataMinder infers an underscore character between these two elements.

    SQL Package:

    Enter the name of an SQL package containing the stored procedure. The required input for this field depends on your CMS database engine:

    • Oracle CMSs: Enter the SQL package containing the database stored procedure (SP) for the current pane. For example, the SQL package name for the Incident Dashboard is DLPDASH.
    • SQL Server CMSs: Enter the 'package prefix' of the SP for the current pane. For example, if your procedure is named DASH_SEVERITYPIE, enter DASH in this field. See below for naming requirements for SQL Server SPs.
    Procedure Name:

    Enter the name of the stored procedure to run that populates the pane. The required input for this field depends on your CMS database engine:

    • Oracle CMSs: Enter the name of the SP for the current pane. This SP defines the underlying database search used to populate the pane.
    • SQL Server CMSs: Enter the 'procedure suffix' of the SP for the current pane. For example, if your procedure is named DASH_SEVERITYPIE, enter SEVERITYPIE in this field. See below for naming requirements for SQL Server SPs.
  5. (Optional) Specify Pane specific settings.
    Column Selector

    Select the columns that you want to display on the Search Results page. By default, all columns are displayed.

    Display Sort Order

    Select the columns to use when the result set is sorted. Specify whether you want to sort column content in ascending or descending order. Click the up and down arrows to specify the column's priority.

  6. Click Save to save this configuration. Click Save and Run to save this configuration and view the results. Click Run to view the results without saving the configuration.

    The page and pane definitions are saved as search definitions (XML files) on the CMS. If you customize an existing page definition and save it with a new name, a derived search is created.

  7. Click Save to save the Pane under the same, or a new name.
  8. Click Actions, Publish to make the pane available to users.