Cisco Unified Intelligence Center Report Customization Guide, Release 10.0(1)
Permalinks
Downloads: This chapterpdf (PDF - 1.26MB) The complete bookPDF (PDF - 2.57MB) | The complete bookePub (ePub - 294.0KB) | The complete bookMobi (Mobi - 384.0KB) | Feedback

Permalinks

Permalinks

Permalinks

Permalinks in Cisco Unified Intelligence Center are permanent hyperlinks.

Unified Intelligence Center supports the following types of permalinks for reports:

  • Excel Link: This permalink is generated only for grid view.

  • Html Link: This permalink is generated for grid view, gauge view, and chart view.

  • XML Link: This permalink is generated only for the grid view. It is used where the data is required in XML format.


Note


For Live Data reports, you will only have the Html permalink. Html permalink for Live Data reports always require authentication.



Note


Due to security reasons, permalinks from one Unified Intelligence Center cannot be displayed in the dashboard of another Unified Intelligence Center instance.


Create a Permalink for a Dashboard


Note


Dashboard permalink can be accessed only from a web browser. It cannot be accessed by an application like Microsoft Excel to pull data or display a dashboard.


The permalink to a dashboard is created when you create the dashboard. To retrieve the permalink to a dashboard, follow these steps:

Procedure
    Step 1   Click the Dashboards in the left pane.
    Step 2   Navigate to a dashboard.
    Step 3   Right-click the dashboard, and select Html Link.
    Step 4   Copy the Html Link. This is the permalink to the dashboard.
    Note   

    Check the Enable Unauthenticated Access check box if you want the permalink to be accessible without authentication.

    Note   

    Permalinks will work in the unauthenticated mode when the Enable Unauthenticated Access check box is checked.

    Note   

    For dashboards that contain Live Data report, the check box for Enable Unauthenticated Access should not be selected.

    Step 5   Click OK.

    Create a Permalink to a Report

    To retrieve the permalink to a report, follow these steps.

    Before You Begin

    The permalink to a report is created when you create a view for that report.

    Procedure
      Step 1   Click Reports drawer in the left pane.
      Step 2   Navigate to a particular report.
      Step 3   Right-click the report, and select Edit Views.
      Step 4   Select a view, and click Links.
      Step 5   Check the Enable Unauthenticated Access check box if you want the permalink to be accessible without authentication.
      Note   
      • Permalinks will work in the unauthenticated mode when the Enable Unauthenticated Access check box is checked.

      • For Live Data reports, the Enable Unauthenticated Access check box is disabled. All live data report permalinks require authentication.

      Step 6   Copy the permalink that you want and paste it on the desired browser.

      Variable Parameters in a Permalink

      You can apply variable parameters on the fields or on the display name of a field, and on the parameters.


      Note


      You must not include both fields and parameters at the same time in a permalink.


      You can explicitly specify the filtering criteria by using either fields or parameters in a permalink to display the changed report data.

      Format of the Parameters and Fields in a Permalink

      You can include variable parameters to the default permalink using the following format:

      <variable_param_name> or <field name>=<operator><space><value><space><value>

      <variable_param_name> can be either the field name or parameter name as configured in the report definition of the report.

      <value> is any valid value for the configured field.

      To include multiple variable parameters in a permalink URL, use an & (ampersand) between two variable parameters.


      Note


      The permalink with the variable parameter is one single URL. Do not break it into different lines. In this example, the URL is broken to explain the concept of variable parameters. You can have a space only between an operator and a value.


      Parameters

      You can apply the variable parameters only on the parameter name for anonymous-block-based and stored-procedure-based reports.

      Parameters are created from a stored procedure or an anonymous block.

      Example: Permalink with parameters

      This example shows how you can include @start_date, @end_date, and @agent_list parameters to change the report data shown by a default permalink based of the values that are passed to these parameters.

      Default permalink

      //localhost:8444/cuic/permalink/PermalinkViewer.htmx?

      //localhost:8444/cuic/permalink/PermalinkViewer.htmx?

      viewId=5BC22D1C1000013C61E3571D0A4E5AF5&linkType=htmlType&viewType=Grid

      Parameter name 1:

      &@start_date=ABSDATE 11-01-2012 00:00:00

      Parameter name 2:

      &@end_date=ABSDATE 01-21-2013 23:59:59

      Parameter name 3:

      &@agent_list=14527,14537

      Fields

      You can apply the variable parameters on a field name or its display name for a database-query-based report.

      Fields are created from a database query.

      Example: Permalink with fields

      This example shows how you can include variable parameters to a permalink URL based on the fields EventTime and User to change the report data shown by a default permalink based of the values that are passed to these fields.

      Default permalink

      //localhost:8444/cuic/permalink/PermalinkViewer.htmx?

      //localhost:8444/cuic/permalink/PermalinkViewer.htmx?

      viewId=5BC22D1C1000013C61E3571D0A4E5AF5&linkType=htmlType&viewType=Grid

      Field name 1:

      &EventTime=ABSDATE 11-01-2012 01-21-2013 00:00:00-23:59:59 MON,WED

      Field name 2:

      &User=VL CUIC\\administrator

      The EventTime field retrieves the report data based on the absolute date value ABSDATE 11-01-2012 01-21-2013 00:00:00-23:59:59 MON,WED.

      The User field retrieves the report data based on the value &User=VL CUIC\\administrator.


      Note


      In User=VL CUIC\\administrator, you must use two backslashes (\\)so that the Internet browser interprets the value correctly as CUIC\administrator and does not misinterpret the backslash (\) as the beginning of an escape sequence.
      • & is the separator that separates two variable parameters.

      • User is the second field.

      • VL is the second operator that works on the values CUIC\\administrator.

      • CUIC\\administrator is the value that is passed to the User field.

      Supported Operators for Fields

      This section describes the supported operators for fields in a permalink:

      For all data types, after an operator, specify the field ID as the value. For example, if the ID of IPCC_1.2000001 filter field is 1000, specify this ID in the variable permalink as &SkillTargetID=LIKE 1000.

      Note


      Do not specify the field name as the value.


      Data Type Supported Operators Example

      DECIMAL

      EQ

      Equal to

      NEQ

      Not equal to

      LT

      Less than

      LEQ

      Less than or equal to

      GT

      Greater than

      GEQ

      Greater than or equal to

      BTWN

      Between

      &agents_logged_on=LEQ 9.0

      STRING

      EQ

      Equal to

      NEQ

      Not equal to

      %

      Matches the pattern

      &agent_team_name=LIKE %IPCC_1%

      DATETIME

      RELATIVE DATE

      ABSOLUTE DATE

      Relative Date

      &EventTime=RELDATE THISMONTH 09:00:00-23:59:00 MON,TUE,WED,THU,FRI

      Absolute Date

      &DateTime=ABSDATE 12-31-2008 12-06-2012 09:00:00-23:59:00 MON,TUE,WED,THU,FRI

      For all other operators

      The following other operators can take more than two parameters depending on what you want to configure:

      Format:

      <date_type_param_name>=

      <date_op><space><value_1>

      <space><value_2><space><value_3>

      RELDATE

      Relative date values: Today, Yesterday, This Week, Last Week, This Month, Last Month, Year to Date, and Last Year

      <Relative_Date>

      Can be any one of these: TODAY, YESTERDAY, THISWEEK, LASTWEEK, THISMONTH, LASTMONTH, THISYEAR, and LAST YEAR.

      <from_timestamp>-<to_timestamp>

      Timestamp in 24 hour format indicating both start time and end time separated by a hyphen (-) hh:mm:ss-hh:mm:ss

      <weekdays>

      Comma separated values indicating days of a week based on which the report data is retrieved. For example, MON,TUE,WED, and so on.

      For example:

      EventTime=RELDATE LASTMONTH 00:00:00-23:59:59 TUE,THU,SAT


      Note


      You can have <Weekdays> only when you have <from_timestamp>-<to_timestamp>. When you configure days, you must always configure the timestamp. Example: EventTime=RELDATE LASTMONTH 00:00:00-23:59:59 TUE,THU,SAT

      In case of RELDATE and ABSDATE, if weekdays are not provided to the <weekdays> parameter then the default value is used, that is, MON, TUE, WED, THU,FRI, SAT, and SUN.


      ABSDATE

      Absolute date requires the following parameters:

      <from_date>

      Date in the format: MM-DD-YYY

      <to_date>

      Date in the format: MM-DD-YYY

      <from_timestamp>-<to_timestamp>

      Timestamp in 24 hour format indicating both start time and end time separated by a hyphen (-) hh:mm:ss-hh:mm:ss

      <weekdays>

      Comma separated values indicating days of a week based on which the report data is retrieved. For example, MON,TUE,WED, and so on.

      For example:

      EventTime=ABSDATE 12-21-2012 01-07-2013 00:00:00-23:59:59 MON,TUE,WED


      Note


      <from_date> and <to_date> are mandatory.

      <from_timestamp> and <to_timestamp> are optional.



      Note


      For all parameters that take boolean values, TRUE and FALSE are the valid values.


      Supported Operators for Parameters

      This section describes only the additional operators supported for parameters in a permalink:

      Parameters also support the same set of operators as supported for the fields. The only difference is in the Date time operators, which is as explained below:

      Format: <date_type_param_name>=<date_op><space><value_1><space><value_2>

      All the values are mandatory.

      Operators Values Description Example

      RELDATE

       

      It is the Relative date.

       

      <value_1>

      <value_1> can be any of the following:

      TODAY, YESTERDAY, THISWEEK, LASTWEEK, THISMONTH, LASTMONTH, THISYEAR, LAST YEAR

       

      <value_2>

      Timestamp in hh:mm:ss format

      For example:

      @startDate=RELDATE TODAY 00:00:00

      ABSDATE

       

      It is the Absolute date.

       
       

      <value_1>

      date in the format: MM-DD-YYYY

       
       

      <value_2>

      Timestamp in hh:mm:ss format.

      For example:

      @endDate=ABSDATE 12-21-2012 01-07-2013 00:00:00-23:59:59 MON,TUE,WED

      Collections as Variables in Report Permalinks

      You can use collection names as a variable parameter in a permalink provided you have the right permissions to the collections.

      The format of the Permalink URL with collections is as follows : Permalink URL&<field name>=CL<white space>Collection 1,Collection 2.

      Example Permalink URL with Collections

      https://localhost:8444/cuic/permalink/PermalinkViewer.htmx? viewId=65FB26481000013F000000250A8E79F3&linkType=htmlType&viewType=Grid &EventTime=RELDATE%20TODAY%2009:00:00-23:59:00&User=CL TestColl_FF_15201,TestColl_FF_7066

      Int the above URL, &User is the name of the field and TestColl_FF_15201 and TestColl_FF_7066 are collection names separated by commas.


      Note


      Permalinks with variable parameters are always authenticated irrespective of the check box Enable Unauthenticated Access being checked or not.



      Note


      If you do not provide specific collection names after the =CL keyword, the report will be filtered using all the collections that the user has permissions for. The user in this case is the person using the permalink.