Co-Branding PaperCut

KB Home   |   Co-Branding PaperCut

This article is designed for approved resellers or distributors of PaperCut NG or PaperCut MF wanting to add their own branding, identity, or logos to the application. The branding will be displayed in addition to (or in some cases, instead of) PaperCut logos. It is important to note that this is co-branding support rather than “Blind OEM” or “Private Label”; the feature is designed to support putting your brand alongside PaperCut’s, rather than entirely replacing the PaperCut brand.

This is reflected in the “Branding” options offered by PaperCut NG and PaperCut MF in versions 17.2 and beyond, which can be found on the “General” subtab of the “Options” tab in the Admin web interface. If the logo is replaced for the login page or Admin web interface using these controls, PaperCut logos will also be displayed in other areas of these pages, to ensure that co-branding requirements are adhered to.

By comparison, specialised co-branding provided with PaperCut’s assistance is only offered when PaperCut NG or PaperCut MF is sold with other services or solutions (often integrated). Organizations distributing a co-branded version must also meet selected sales, marketing, and support requirements.

Important: Any organization co-branding PaperCut and in turn distributing or on-selling the co-branded version must apply for permission to redistribute. See below for details.

Branding options include:

  • Add your logo on the top left-hand corner of the admin interface (a “powered by PaperCut” logo will remain).
  • Replacing the login screen logo (a PaperCut logo will remain).
  • Change the default logo on reports.
  • Style changes to the end-user web pages.
  • Change the logo on the client software and copier embedded software (where models support this).
  • Change “purchase” and “contact us” links within the application (on negotiation).
  • Rights to redistribute our PDF manual and other marketing material edited to contain your logo and brand on the introduction page.
  • Access to marketing material in an editable format.

The Co-Branding Process

The PaperCut development team is able to conduct or assist with the co-branding process, or you may undertake this yourself with the steps outlined below.

The PaperCut NG and PaperCut MF installers for Windows provide support for bundling additional images and files that will be installed along with the application. This enables a reseller to bundle the installer along with their branding content to customers such that the branding will take place automatically when the customer installs the application.

After applying in writing to PaperCut for permission, the bundle may be distributed as a ZIP file, on a USB drive or on CD, to provide some examples.

To make use of this feature create a folder called extensions alongside the installer. E.g. the contents of the parent folder will look like this:

extensions
pcng-setup.exe

Content under the extensions folder will be automatically copied to the installation location. E.g.

extensions/server/custom/web/client-logo.png

could be copied to

C:\Program Files\PaperCut NG\server\custom\web\client-logo.png

after installation.

The following sections provide information about customizing the different components of PaperCut and how these can be bundled with the installer via the extensions folder.

Multi-Functional Advanced Device Properties Configuration

PaperCut MF supports advanced device branding properties to be edited manually once the device is registered with the system. When you add new devices to PaperCut MF, the device advanced properties are loaded with system default values. You can however define the system default values so that whenever you add additional devices, you won’t need to manually edit their advanced properties.

You can achieve this through two methods:

- Advanced Default Device Settings at Install Time: Provide an install-time properties file with all your devices’ specific advanced properties, where you define the system defaults for your device types;

- Advanced Default Device Settings After Install: You can add/edit a properties file after PaperCut MF Application Server has been installed.

Note: This feature is available starting from PaperCut MF 14.3 (Build 30238).

Advanced Default Device Settings at Install time

Create a file named device-defaults.properties and add it to extensions/server/data/conf/ directory structure, which should sit alongside PaperCut MF installer.

Add device advanced default settings to this file. An example for a Sharp MFP to customize the header color and text color is:

ext-device.sharp_osa.header.color = #ff0000
ext-device.sharp_osa.header.textcolor = #ffffff

Note: Check your specific PaperCut device embedded manual for the list of available properties.

Once you finish PaperCut MF installation, the file device-defaults.properties will be moved to:

<papercut-install-dir>/server/data/conf/device-defaults.properties

You can add or edit properties at any time after the install. Note that if you have already added devices and change their specific advanced properties in the file, you’ll have to change the existing device advanced properties manually as the file will only be used as the system defaults when new devices are added.

Advanced Default Device Settings after Install

You can override system advanced device settings after PaperCut MF is installed and running. This will only apply to devices you register after you have provided the overriding properties.

Create a file named device-defaults.properties and add it to <papercut-install-dir>/server/data/conf/ directory structure.

Add device advanced default settings to this file. An example for a Sharp MFP to customize the header color and text color is:

ext-device.sharp_osa.header.color = #ff0000
ext-device.sharp_osa.header.textcolor = #ffffff

Note: Check your specific PaperCut device embedded manual for the list of available properties.

The User Client

Information about customizing the client tool is covered in the user manual chapter Advanced customization -> Customize the User Client.

As discussed, the logo on the User Client tool can be replaced by supplying a client-logo.png file. To supply a client logo with the installer that will be used for all User Client platforms (Windows, Mac and Linux) place your client-logo.png file in:

extensions/server/custom/web/client-logo.png

PaperCut User Clients offer a number of other customizable properties that can be found at:

<papercut-install-dir>/client/<platform>/config.properties

These properties can be overridden and supplied at install time, so that User Clients can be provided with your customizations which override system defaults.

To achieve this, place a file named client-defaults.properties under the directory extensions/client alongside the PaperCut NG or PaperCut MF installer. After the installation, the properties you have added in the client-defaults.properties will be copied over the file <papercut-install-dir>/client/<platform>/config.properties.

The User Web Interface

Information about customizing the User web interface is covered in the user manual chapter Advanced customization -> Customizing the User web pages.

As discussed, custom content is placed in the [app-path]/server/custom/web folder. Placing the custom content in extensions/server/custom/web alongside the installer will ensure that the content is copied at installation time.

For example the bundled content might include:

extensions/server/custom/web/footer2.inc
extensions/server/custom/web/header2.inc
extensions/server/custom/web/user2.css
extensions/server/custom/web/login-logo.png
extensions/server/custom/web/user-ui-logo.png

Report Headers

Information about customizing report headers is covered in the user manual chapter Advanced customization -> Customize report headers.

As discussed, a custom report header image can be placed at [app-path]/server/custom/web/report-header.png. To include the report header image with the installer, bundle the image at:

extensions/server/custom/web/report-header.png

As of version 17.3 of PaperCut NG and PaperCut MF, the logo used in report headers can also be customized via the Admin web interface, using the Customize report header controls found under the General subtab of the Options tab, amongst the Branding options.

Applying for re-distribution permissions

Due to copyright/licensing reasons all organizations redistributing PaperCut in a co-branded form must apply for permission. Permission is only granted to approved resellers/partners that support the co-branding initiative via an appropriate sales, support, and marketing strategy approved by PaperCut. The co-branded version must be distributed with other services or integrations that justify the reason for a co-brand, i.e. it’s not just a pretty image, but a service that offers benefit to the customer.

Please contact PaperCut in writing to apply before attempting to co-brand the software. Please include a brief description of your business and market strategy and a time we can contact you to discuss further.

After final sign-off of the co-branded visual design and the marketing and business strategy, you’ll be granted the rights to redistribute the co-branded version to third parties. You will also be required to keep any co-branded downloads in phase with standard PaperCut releases with no more than a 14 day delay.


Categories: Resellers


Keywords: rebrand, unbranded, conversion, add logos, change logos, redistributing, oem

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.

Article last modified on September 12, 2017, at 01:24 AM
Printable View   |   Article History   |   Edit Article