Chapter 16. Advanced Customization

Table of Contents

Customizing the User Client Tool window
Limiting the list of interface languages/translations
Customizing the User web pages
Look & Feel
Login Instructions
Custom Printer Maps for Web Print
Customizing the administration web interface
Customizing Report Headers
Data Access and Custom Reports
Plain Text Print Log
Automation and Scripting
Custom User Directory Information Providers

PaperCut NG is an important part of network infrastructure at many thousands of organizations. Having the ability to seamlessly integrate PaperCut into an existing network is important. There are a number of ways to ensure end-users see the system as part of the network rather than an add-on. These include:

This section covers some of the customization options available within PaperCut NG. For general information about the user client, see the section called “User Client”.

Customizing the User Client Tool window

The pc-client.exe program displays a small window highlighting the current logged in user's current account balance. This window contains two links. One called Details that takes the user to the User Pages login. The other defaults to the PaperCut Software website. The link to the PaperCut Software website can be replaced. Some suggestions include linking to your organization's website or intranet site, or linking to a page containing your organization's network usage policy. The logo used on the window can also be customized.

To change the link on the User Client window:

  1. Login to the system as an administrator (e.g. the built-in admin account).

  2. Navigate to the Options section.

  3. Click on the Config editor link in the list of actions.

  4. In the quick find are enter client.config and press GO.

  5. Locate the key titled config.client.link-url and enter a new value pointing to your new destination. The link should be a complete URL including the http:// component. e.g. http://www.myorganization.com/printpolicy.htm.

  6. Press the Update button to the right to apply the change.

  7. Locate the key titled config.client.link-text and enter the text that should be displayed. e.g. Print Policy.

  8. Press the Update button to the right to apply the change.

  9. The next time the client tool is started on one of the workstations, the new link will be displayed.

Customized user client link

Figure 16.1. Customized user client link

There are other configuration keys that allow an administrator to customize the user client for their organization. The table below outlines all of the client customization keys available. These values are updated by following a similar process as described above.

Config nameDescription

client.config.link-text

The text to appear on the link at the top of the user client.

client.config.link-url

The destination URL of the link displayed at the top of the user client. For example, this can be point to the internal intranet page describing printing policies.

client.config.show-link

Indicates whether the link at the top of the user client should be displayed. To display set the value to Y, to hide set the value to N.

client.config.show-details-link

Indicates whether the "Details" link that points to the user web interface is displayed. To display the link set the value to Y, to hide set the value to N.

client.config.show-document-cost

Determines whether to show the document cost to the user in print popup notifications. To show the cost set the value to Y, to hide set the value to N.

Table 16.1. User Client Customization Config Keys

The logo used on the User Client balance window and the account selection dialog can also be customized by placing a file called client-logo.png in the directory [app-path]/client/[platform] - the same directory as the executable. The image must satisfy the following requirements:

  • Comply to the PNG (Portable network graphic) format.

  • A size of 64px by 64px.

  • Display correctly on different background colors (make use of transparencies or alpha channels).

On the Apple Mac platform the process is a little more involved. The image needs to be placed inside the App package at: PCClient.app/Content/Resources. To access this directory, Option-click on the PCClient icon and select Show package contents....

The user client can also be configured by passing command-line parameters to the program. This is described in the section called “User Client Options”.