Skip to content

Choose your language

  • No results

Choose your login

  • No results
Support
Search

Web widgets

This page applies to:

PaperCut NG/MF provides web widgets that you can easily embed within pages on your intranet site. All that is required is to paste a few lines of HTML/JavaScript on your pages.

There are two built-in web widgets that offer balance and environmental impact. However, if the built-in widgets do not suit your needs you can always create your own that better suit your site.

To run web widgets on your intranet you require:

  • edit access to the intranet pages to add the required HTML/JavaScript

  • the username of the logged so the web widget knows whose details to load.

    This usually requires that users log in to the intranet. When using a Microsoft Active Directory domain and Microsoft IIS web server, the user can be automatically detected if using NTLM or Kerberos authentication, which provides a transparent login process via the web browser.

The simplest way to get started with web widgets is to look at some examples. There are detailed and well commented examples available on the PaperCut NG/MF server in the directory [app- path]/server/examples/webwidgets/examples.html. Use these examples as a starting point to implement web widgets on your site.

To add a web widget to a page:

  1. Add a <div> element to your page. The widget is drawn within this tag. The div element must be given a unique ID.
  2. Include scripts into your page to load the widget and user data from the PaperCut NG/MF.
  3. Edit the included script to set pcUsername to the logged in user.
  4. Edit the included script to set pcServerURL to base URL of the PaperCut NG/MF server.
  5. Add some script to draw the built-in widgets to the page. You can use one of the built-in widgets, or create your own.

[Legacy info] Embedding PaperCut Web Pages in your own organization’s site

PaperCut web pages can be embedded using iframes . Link to admin, user or reports pages via the following URL’s:

TARGET URL
User web pages [papercut server]/user
Admin web pages [papercut server]/admin
Central reports [papercut server]/central-reports
Release Station [papercut server]/release
Web Cashier [papercut server]/webcashier

The 14.3 release provides a configuration key auth.allow-iframe-embed to control whether IFrame embedding is permitted. Set this value to Y to enable IFrame embedding.

If the configuration key auth.allow-iframe-embed is set otherwise, PaperCut will disable IFrame embedding. The configuration key can be set using the Config Editor

We recommend embedding pages with caution, as the use of iframes may cause security vulnerabilities.

Comments