This documentation supports the 9.1 version of Remedy IT Service Management Suite.

To view the latest version, select the version from the Product version menu.

Embedding report content in external pages

(From BMC Remedy Smart Reporting version 9.1.03) Using the Javascript API, BMC Remedy Smart Reporting reports and dashboards can be embedded into external webpages, which can be hosted on a separate web server to BMC Remedy Smart Reporting. The browser that you are using should be able to access the BMC Remedy Smart Reporting server.

The HTML page can include multiple reports; however each separate report may only be displayed once on each page.

Note

Multiple dashboards on a single page are not currently supported.

Interactive elements such as Drill Through, Drill Down, User Prompt Filters, Series Selection, and Export to PDF are available.

The following topics explain more about the embedding report option:

Displaying reports and dashboards

This section explains the features related to displaying reports and dashboards.

Report

The embedded report contains a title bar and the report itself. The title bar contains the name of the report, as well as buttons to control any interactive elements used on the report. The interactive features include:

Description

Displays basic report information including Name, Description, Last Modified Date, Category, Sub Category, and Current User.

Displays the Javascript used to embed the report.

Allows you to toggle to Chart view if the Table and Chart display is used.

Allows you to toggle to Table view if the Table and Chart display is used.

Opens the panel of User Prompt Filters that are enabled on the report.

Opens a Series Selection panel, if the Visible Series Selection option is enabled.

Opens a Unit Selection panel, if the Visible Units Selection option is enabled.

Opens a Page Navigation panel, if the report contains multiple pages.

Opens a Section Navigation panel, if the report contains sections.

Opens the GIS Map Navigation panel, if the map has Hover Navigation enabled.

Opens the Export panel, allowing the user to export the report to various formats, including:

  •  CSV
  •  DOC
  •  PDF
  •  Rich Text Format
  •  Text
  •  XLS

Dashboard

The embedded dashboard contains a title bar for the entire dashboard. Each of the dashboard reports (displayed the same as embedded reports), are laid out the same way as they are when viewed through the Smart Reporting front end.

Note

Dashboard filters and KPI dashboards are supported.

Description

Displays the basic dashboard information including Name, Description, Last Modified Date, and Current User.

Displays the Javascript used to embed the dashboard.

Opens a panel of User Prompt Filters enabled on the dashboard.

Opens the Export panel, allowing the user to export the dashboard to various formats, including:

  •  CSV
  •  DOC
  •  PDF
  •  Rich Text Format
  •  XLS

Embedding a report

Follow the steps given below to create the Javascript code, which identifies the report to load, for use in your HTML page, wiki, or blog.

  1. Log in to BMC Remedy Smart Reporting.
  2. Open the report that you want to embed.
  3. From the report URL, copy the report UUID and the clientOrg (highlighted in bold in the following example).
    For example, http://<Smart Reporting server name>:<port>/RunReport.i4;b9669409-3cf8-4290-b914-e742778e0ab1=58455c98-7b84-4c20-9ffb-fc0ba6dd8c00?reportUUID=eb363c0e-71bf-47b1-898b-dc5068dd0ff6&primaryOrg=1&clientOrg=bmc&width=500&height=500.
  4. On the HTML page where you want to embed the report, in the following standard script tag, replace the existing report UUID and the clientOrg with the copied report UUID and the clientOrg name respectively:

    <script src="http://reporting.example.com/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&clientOrg=abc&width=500&height=500" type="text/javascript"></script>

Where to go from here

Set the required parameters and see the examples documented in the Basic usage of reports and dashboards section. 

User access

Authentication details can be passed to the API when the dashboard or report is loaded, either by passing a username and password, or authenticating via web services and passing the login token o the API. This allows you to use a specific user to load content rather than requiring the user to enter their details. For more information, see Basic usage of reports and dashboards.

When a report or dashboard is requested through the Javascript API, the following process is used to authenticate the user:

  • If the user authentication details are passed to the API when a dashboard or report is loaded, they will be used to log the user in.
  • If the user is already logged in to the Javascript API on the page, the existing login session is used.
  • If the user has previously logged in to the Javascript API, they are automatically logged in with the same account.

When the above process is complete, there are several cases that will not result in the user immediately loading the requested content:

  • If none of the above conditions are met, the user cannot be logged in, and they will be prompted to enter their Smart Reporting username and password manually.
  • If the above process results in the user logging in with the Guest account, but the requested report or dashboard is not available to guest users, they will be prompted to enter their Smart Reporting username and password.
  • If the above process results in the user being authenticated with a non-guest account, but the account does not have access to the requested content, an appropriate error message will be displayed.

When you, as a user, enter your Smart Reporting username and password to log in to the Javascript API, a cookie is stored in your browser to remember your login information. The next time you visit a page that includes a report or dashboard embedded using the Javascript API, you will automatically be logged in again using the same user. This ensures that you will not need to enter your details every time you request a report or dashboard. By default, the cookie is valid for seven days from the last time you log in. This period can be changed by setting the External API cookie timeout value through Administration > Configuration > System > General Settings. To disable the cookie altogether, set the value to 0.

Note

The cookie value is stored in the browser is encrypted. When Smart Reporting is restarted, all users will be required to log in again.

Limitations

The following are the limitations of the embed option:

  • You can add multiple reports to a single HTML page. However, each report can only be included once per page.
  • Only one dashboard is supported per HTML page.
  • The calendar selector for date filters is not available.
  • The Drill Anywhere option is not available.
  • The Saved Filter Sets option is not available.
  • The Chart Animation option is not available.
  • The Chart level summaries are not display correctly.
Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Neha Patel

    Hi BMC Team,

    Is this feature already enabled? I upgraded to 9.1.03 already but could not see this option along with Distribute and Email   within SHARE? . Please check and confirm

    Jun 27, 2017 07:23
    1. Sirisha Dabiru

       Hi Neha Patel,

       

      This feature is available but works through javascripts and not from the UI. I am updating this topic. Will let you know after making the changes.

       

      Regards,

      Sirisha

      Jun 28, 2017 04:31
      1. Paul Stanfa

        Ok.  So how is this done.  The share option doesn't have an Embed choice.  This feature was promised in SP3.

        Jul 18, 2017 08:30
        1. Surabhee Kulkarni

          Hello Paul,

          Thank you for your comment.

          We are updating the topic for the Embed feature that works through Javascripts (and not the UI). We will let you know as soon as we make the changes.

          Thanks and regards,
          Surabhee

          Jul 18, 2017 09:57
    1. Surabhee Kulkarni

      Hello Neha,

      Sorry for the delay in responding. We have updated the content on this page for the embed feature.

      Thanks and regards,
      Surabhee

      Sep 19, 2017 07:05
  2. Giancarlo Soares

    Hi BMC Team,

    When we make a report available on a 3rd party Portal, does the user still needs an ITSM license to view the report?

    Regards,

    Giancarlo

    Jul 11, 2017 08:49
    1. Surabhee Kulkarni

       Hello Giancarlo,

      Thank you for your comment. I will discuss this with the concerned SME and will let you know accordingly.

      Thanks and regards,
      Surabhee 

      Jul 12, 2017 02:14
  3. Nyssa Charles

    Are there any updates on this not showing up as an option under share?

    Sep 14, 2017 12:52
    1. Surabhee Kulkarni

      Hello Charles,

      Sorry for the delay in responding. We have updated the content on this page for the embed feature.

      Thanks and regards,
      Surabhee

      Sep 19, 2017 07:03
  4. Paul Stanfa

    Agreed. Where is this information or sample? It is great that it works and all but we need the information to be able use it.

    Sep 14, 2017 01:04
    1. Surabhee Kulkarni

      Hello Paul,

      Sorry for the delay in responding. We have updated the content on this page for the embed feature.

      Thanks and regards,
      Surabhee

      Sep 19, 2017 07:03
  5. Angie Schwingel

    Has this content been updated!?? I am unable to embed a LINK where it works properly. It requests my login & then says that login information is incorrect.

    Nov 07, 2018 09:45