Cisco Unified Intelligence Center Report Customization Guide, Release 10.5(1)
Data Customizations
Downloads: This chapterpdf (PDF - 1.21MB) The complete bookPDF (PDF - 2.45MB) | The complete bookePub (ePub - 235.0KB) | The complete bookMobi (Mobi - 386.0KB) | Feedback

Data Customizations

Data Customizations

Create a Report Definition of Type Database Query

To create a report definition using a database query, follow the steps below.

Procedure
    Step 1   Click the Report Definitions drawer in the left pane.
    Step 2   Navigate to the category where you want to create the report definition.
    Note   

    To create a sub category, navigate to the appropriate category, right click on the category, and select Create Sub-category.

    Step 3   Right-click the category, and select Create Report Definition.
    Step 4   In the Name field, enter a name for the report definition.
    Step 5   In the Description field, enter a description of the report definition.
    Step 6   Assign the appropriate permissions, and click OK.
    Step 7   From the Query Type drop-down list, select Database Query.
    Step 8   From the Data Source drop-down list, select the appropriate data source.
    Note   

    Ensure that the Data Source Status for the selected data source shows as Online.

    Step 9   In the Query field, enter the database query.
    Note   

    Maximum length supported for database query type is 25000 characters (including whitespace).

    Step 10   Click Create Fields to validate the query and fetch the fields from the database.
    Step 11   In the Fields tab, configure the existing fields or add new fields to the report definition.
    Step 12   Click Properties.
    Step 13   Enter the Version number and the Author name.
    Step 14   From the Key Criteria Field drop-down list, select a field to act as the key criteria.
    Note   

    For real-time reports, skip steps 15 and 16.

    Step 15   Check the Historical check box to maintain a refresh rate of above 900 seconds.
    Step 16   From the Historical Key Field drop-down list, select a field to act as the historical key field.
    Note   

    This field is available only if the Historical check box is checked.

    Step 17   Click Save.

    Create a Report Definition of Type Stored Procedure

    To create a report definition using the query type Stored Procedure, ensure that the location of the stored procedure is accessible by Unified Intelligence Center.

    To create a report definition using a stored procedure, follow the steps below.

    Procedure
      Step 1   Click the Report Definitions drawer in the left pane.
      Step 2   Navigate to the category where you want to create the report definition.
      Note   

      To create a subcategory, navigate to the appropriate category, right-click on the category, and select Create Sub-category.

      Step 3   Right-click the category, and select Create Report Definition.
      Step 4   In the Name field, enter a name for the report definition.
      Step 5   In the Description field, enter a description of the report definition.
      Step 6   Assign the appropriate permissions, and click OK.
      Step 7   From the Query Type drop-down list, select Stored Procedure.
      Step 8   From the Data Source drop-down list, select the appropriate data source.
      Note   

      Ensure that the Data Source Status for the selected data source shows as Online.

      Step 9   In the Stored Procedure field, enter the name of the stored procedure.
      Step 10   Click Create Parameters to display the list of parameters.
      Step 11   In the Value column, enter a value for each parameter which will be substituted for the parameter variable in the query.
      Step 12   Click Create Fields to validate the query and fetch the fields from the database.
      Note   

      To edit the properties of any of the parameters, click the Parameters tab.

      Step 13   In the Fields tab, configure the existing fields or add new fields to the report definition.
      Step 14   Click Properties.
      Step 15   Enter the Version number and the Author name.
      Step 16   From the Key Criteria Field drop-down list, select a field to act as the key criteria.
      Note   

      For real-time reports, skip steps 17 and 18.

      Step 17   Check the Historical check box to maintain a refresh rate of above 900 seconds.
      Step 18   From the Historical Key Field drop-down list, select a field to act as the historical key field.
      Note   

      This field is available only if the Historical check box is checked.

      Step 19   Click Save.

      Create a Report Definition of Type Anonymous Block

      To create a report definition using an anonymous block, follow the steps below.

      Procedure
        Step 1   Click the Report Definitions drawer in the left pane.
        Step 2   Navigate to the category where you want to create the report definition.
        Note   

        To create a subcategory, navigate to the appropriate category, right-click on the category, and select Create Sub-category.

        Step 3   Right-click the category, and select Create Report Definition.
        Step 4   In the Name field, enter a name for the report definition.
        Step 5   In the Description field, enter a description of the report definition.
        Step 6   Assign the appropriate permissions, and click OK.
        Step 7   From the Query Type drop-down list, select Anonymous Block.
        Step 8   From the Data Source drop-down list, select the appropriate data source.
        Note   

        Ensure that the Data Source Status for the selected data source shows as Online.

        Step 9   In the Anonymous Block field, enter the database query incorporating a parameter.
        Note   

        Maximum length supported for anonymous block query type is 25000 characters (including whitespace).

        Note   

        Parameter names in the anonymous block must have a colon followed by the parameter name; for example :paramName. The colon at the beginning of the parameter name is substituted with the at sign (@) by the Unified Intelligence Center.

        Step 10   Click Create Parameters to display the list of parameters.
        Step 11   In the Parameters section, in the Value column, enter a value for each parameter which will be substituted for the parameter variable in the query.
        Step 12   Click Create Fields to validate the query and fetch the fields from the database.
        Note   

        To edit the properties of any of the parameters, click the Parameters tab.

        Step 13   In the Fields tab, configure the existing fields or add new fields to the report definition.
        Step 14   Click Properties.
        Step 15   Enter the Version number and the Author name.
        Note    For real-time reports, skip steps 16 and 17.
        Step 16   Check the Historical check box to maintain a refresh rate of above 900 seconds.
        Step 17   From the Historical Key Field drop-down list, select a field to act as the historical key field.
        Note   

        This field is available only if the Historical check box is checked.

        Step 18   Click Save.

        Create a Report Definition of Type Real Time Streaming

        To create a report definition of query type Real Time Streaming, a Java Message Service (JMS)-based data source should already be configured in Unified Intelligence Center.

        To create a report definition using a JMS-based data source, follow the steps below.

        Procedure
          Step 1   Click the Report Definitions drawer in the left pane.
          Step 2   Navigate to the category where you want to create the report definition.
          Note   

          To create a subcategory, navigate to the appropriate category, right-click on the category, and select Create Sub-category.

          Step 3   Right-click the category, and select Create Report Definition.
          Step 4   In the Name field, enter a name for the report definition.
          Step 5   In the Description field, enter a description of the report definition.
          Step 6   Assign the appropriate permissions, and click OK.
          Step 7   From the Query Type drop-down list, select Real Time Streaming.
          Step 8   From the Data Source drop-down list, select a JMS-based data source.
          Note   

          Ensure that the Data Source Status for the selected data source shows as Online.

          Step 9   Click Fetch Topic to display the list of fields.
          Step 10   Select the desired topic and the associated fields.
          Note    Only one topic can be selected for the report definition.
          Note   

          An asterisk (*) against a field indicates the topic key field.

          A plus sign (+) against a field indicates the object key field.

          Step 11   In the Fields tab, configure the existing fields or add new fields to the report definition.
          Note    For Live Data reports, the filter field is not available.
          Step 12   Click Properties.
          Step 13   Enter the Version number and the Author name.
          Step 14   Click Save.

          Create or Edit a Value List

          Value Lists are used to fetch data in addition to the data that is received from the Report Definition query. To associate a value list with a report, see Associate Value List With a Report.

          Follow the steps below to create a value list.

          Procedure
            Step 1   Select the Value Lists drawer in the left pane.
            Step 2   Click Create.
            Note   

            To edit a value list, select the value list, and click Edit.

            Step 3   Enter the following information.
            1. Value List Name—Enter a name for the value list.
            2. Version—Enter a version number for the value list.
            3. Type—This field is generated automatically. For all value lists that you create, this field will contain the value CUSTOM.
            4. Data Source—Select the data source from the drop-down list.
            5. Description—Enter a description for the value list.
            6. Value List Query—Enter the database query to fetch the values for the value list. Click Validate to check the validity of the query right away. Maximum length of the value list query is 15000.
              Note   

              Order by clause is not supported in a Value List SQL query.

            7. Collection Query—Enter a query to fetch a data from the list of values generated by the value list query. This query is required only if you are going to create a collection of type Identifier. Maximum length of the collection query is 15000. For more information about Collections, see Create or Edit Collections.
            Step 4   Select the appropriate permissions.
            Step 5   Click Save.

            Associate Value List With a Report

            You can associate a Value List with a field and a parameter of a report.


            Note


            Only fields of type string and decimal can be associated with a value list.
            Procedure
              Step 1   Select the field that you want to associate with a Value List if the Report Definition is based on a query.
              Step 2   To associate a field with a value list, on the Fields tab, select the field name and click Edit Properties.
              Step 3   From the Value List drop-down list, select a value list and click Update Field.
              Step 4   Select the parameter that you want to associate with a value list if the Report Definition is based on an Anonymous Block or a Stored Procedure.
              Step 5   To associate a parameter with a value list, on the Parameters tab, select the parameter name, click Edit.
              Step 6   From the Value List drop-down list, select a value list and click Update Field.
              Note   

              In stock report templates, this field is populated with the stock value list for the Report Definition.

              Once you have associated the field or the parameter with a value list, Unified Intelligence Center displays the value lists or collections on the Basic Filters tab provided that user has Execute permission for the value lists or collections.


              Create or Edit Collections

              A collection is a subset of the data fetched by a value list. You can create a collection for any existing value list and each value list can have multiple collections.

              Procedure
                Step 1   Click the Value Lists drawer in the left pane.
                Step 2   Select the value list for which you want to create or edit a collection.
                Step 3   Click Collections.
                Step 4   Under All Collections, click create.
                Note   

                To edit an existing collection, under All Collections, select a collection, and click Edit.

                Step 5   In the Collection Name field, enter a name for the collection.
                Step 6   In the Description field, enter a description for the collection.
                Step 7   From the Collection Type drop-down list, select the type of collection. The different types are described here.
                • Identifier—Enter the identifier to be used in the collection query that was defined in the associated value list.
                • Wildcard—Enter a string with wildcards to search for data among the values generated by the value list.
                  Note   

                  Wildcard collections use Java regular expressions.

                • Values—You can select a subset from the list of values generated by the value list.
                Step 8   Select the appropriate permissions.
                Step 9   Click Save.

                Create or Edit a Drilldown

                Procedure
                  Step 1   Click the Report Definitions drawer in the left pane.
                  Step 2   Open the Report Definition for the report in which you want to create a drilldown.
                  Step 3   Click the Fields tab and select the field from which you want to create a drilldown.
                  Step 4   Click Drilldowns. This displays the All Drilldowns panel. It shows any drilldowns that already exist for that field.
                  Note    To edit an existing drilldown, select a drilldown and click Edit.
                  Step 5   Click Create.
                  Step 6   Enter a name for the drilldown.
                  Note   

                  You cannot drilldown to a report based on an Anonymous Block or a Stored Procedure.

                  You cannot drilldown to or from a report based on Real Time Streaming.

                  Step 7   Select a report by clicking the radio button next to the report name. This opens a panel showing all the fields in that report.
                  Step 8   Highlight a field and click Edit.
                  Step 9   Edit the filter values and click OK.