PrinterOn Central Print Services (CPS) Administrator Guide...PrinterOn Enterprise CPS Admin Guide |...

PrinterOn Central Print Services (CPS) Administrator Guide

Version 2.5 Doc Rev: 1.0

PrinterOn Enterprise CPS Admin Guide | 2

1. Administering your Central Printing Services ...............................................................................................4

1.1. Default Login Information .............................................................................................................................4

1.2. Status ...........................................................................................................................................................5

1.3. Basic .............................................................................................................................................................6

1.3.1. Authorization .........................................................................................................................................6

1.3.2. Printer Access Control ..........................................................................................................................6

1.3.3. User Interface Messaging .....................................................................................................................7

1.3.4. CPS Directory Search ...........................................................................................................................7

1.3.5. Proxy Server .........................................................................................................................................8

1.3.6. Discovery ..............................................................................................................................................8

1.4. Advanced .....................................................................................................................................................9

1.4.1. PrinterOn API Locations .......................................................................................................................9

1.4.2. Environment ....................................................................................................................................... 10

1.5. Authentication............................................................................................................................................ 12

1.5.1. No Login required .............................................................................................................................. 12

1.5.2. LDAP Login ........................................................................................................................................ 12

1.5.3. Guest Login ........................................................................................................................................ 13

1.5.4. Manage Guest LDAP Settings ........................................................................................................... 13

1.5.5. Manage Trusted Print Settings .......................................................................................................... 14

1.5.6. Managing LDAP Profiles .................................................................................................................... 15

1.5.7. Configuring LDAP Servers ................................................................................................................. 15

1.5.8. Custom User Authentication .............................................................................................................. 18

1.5.9. PrinterOn Access Control Authentication .......................................................................................... 18

1.5.10. Web Server Authentication ................................................................................................................ 19

1.6. User Rules and Printer Access ................................................................................................................. 20

1.6.1. Enable User Rules & Printer Access ................................................................................................. 20

1.7. Printers ...................................................................................................................................................... 23

1.7.1. Printers Details ................................................................................................................................... 23

1.7.2. Configurating Printer Departments .................................................................................................... 24

1.8. Admin ........................................................................................................................................................ 26

1.8.1. Administration .................................................................................................................................... 26

1.8.2. CPS API Management ....................................................................................................................... 26

2. How users print with CPS ............................................................................................................................. 27

3. Customizing the CPS web printing pages ................................................................................................... 31

3.1. Deployment Locations ............................................................................................................................... 31

3.2. Modifying Text ........................................................................................................................................... 32

3.3. Replacing Images ..................................................................................................................................... 33

3.4. Modifying Styles/Changing Colors ............................................................................................................ 34

3.5. Advanced Customization .......................................................................................................................... 34

3.6. CPS Customization and Software Upgrade Considerations ..................................................................... 34

4. Tomcat Customization and Configuration .................................................................................................. 35

4.1. Redirecting the Apache Tomcat Home Page ............................................................................................ 35

4.2. Modifying the Default Tomcat Listening Port ............................................................................................ 36

4.3. Modifying the Default Tomcat Listening Port ............................................................................................ 37

4.4. Enabling SSL Support in Tomcat .............................................................................................................. 38

4.5. Increasing Tomcat Memory ....................................................................................................................... 39


5. CPS Log .......................................................................................................................................................... 40

5.1. Log Basics ................................................................................................................................................. 40

5.2. Log Service Messages .............................................................................................................................. 40

5.3. CPS Log Banner ....................................................................................................................................... 40

5.4. Error and Exception Logging ..................................................................................................................... 41

Trademarks and Servicemarks ............................................................................................................................ 42

Other brands and their products are trademarks or registered trademarks of their respective holders. ................ 42

Copyright Notice .................................................................................................................................................... 42


1. Administering your Central Printing Services

This section provides an overview of the available options in the CPS Administration Console. The CPS

Administration Console allows you to configure all CPS settings, administer and synchronize printer settings and

change your admin password.

To open the CPS Administration Console pages:

1. Choose Start > All Programs > PrinterOn Corporation > Central Print Services > CPS Admin Page or go to http://localhost/cps/admin

2. On the Login Page, enter your Login Name and Password.

1.1. Default Login Information

The first time you log in, your Login Name is “cpsadmin” and your password “cps”. If you haven’t already changed the default password, you will be prompted to change it.

The Administration Console options are grouped under six tabs: Status, Basic, Advanced, Authentication, Printers

and Admin.

The Console also provides a Log Out link and a link to open the CPS web printing page.


1.2. Status The Status tab displays information on the CPS version and current CPS settings.

To refresh the Status tab information, click Re-initialize CPS (in the upper right corner).

Re-initializing CPS will read the CPS configuration file and print the CPS log banner in the log file. For details on

the log banner, see section CPS Log Banner.


1.3. Basic

Last Message: Messages about success or failure of configuration changes are displayed here.

Save Settings: Click to save any changes to the Basic settings.

1.3.1. Authorization

Service Name: Provide a custom name for your Printing Service here. This name will be displayed in all CPS

window titles.

Site Identifier (UID) & Site Authorization Code: These values are provided by PrinterOn and should not be

modified. These values identify the CPS installation when communicating with PrinterOn’s hosted services.

1.3.2. Printer Access Control

Email Address: This field displays your administrative e-mail address, which is the user ID for your PrinterOn

account at www.printeron.com. This is required to retrieve printer details from the PrinterOn Printer Directory.


1.3.3. User Interface Messaging

Presentation Style: Choose from Campus or Enterprise. This affects the text presented to end users while

submitting a print job.

Languages: CPS can be displayed in English, French, Spanish, Italian, German or Dutch. When one or more

languages are enabled, the user will be presented with an option.

1.3.4. CPS Directory Search

CPS provides search capabilities that allow client software, such as PrinterOn's mobile applications, to perform

PrinterOn Directory searches through your CPS service. The CPS search options allow you to customize how

clients using PrinterOn's Directory Search will interact with CPS while searching for printers.

By default, when enabled, CPS will return printers that are not hidden in the PrinterOn Directory to any user.

Printers that are hidden in the PrinterOn Directory are only visible to authenticated users.

Authenticate Search Using LDAP: When this option is enabled, clients will be required to provide credentials

including a username and password when performing search requests. The configured LDAP server will be used

to authenticate the user and if successfully authenticated, the client will be allowed to perform a search request.

Printers that are hidden in the PrinterOn Directory will be visible to authenticated users


Allow PrinterOn Directory Search: When enabled, CPS will include PrinterOn print locations in addition to your

CPS printers when returning search results. If the option is not enabled, only printers associated with your CPS

service are returned in search results.

Allow Guest Access to PrinterOn Directory Search: When enabled, CPS will allow guest users to receive

printers returned the PrinterOn’s Public Directory.

1.3.5. Proxy Server

These settings provide the ability to configure CPS to communicate on a network which requires communication

with a proxy server to successfully access the internet.

Enabled: To use a proxy server, check the Enabled option.

Proxy Address: Supply the URL or IP address of the proxy server to communicate with

Proxy Port: Supply the network port number for which the proxy server has been configured to communicate

with.

User Name: If your proxy server requires authentication to communicate on the network, enter the user name

required to authenticate against the proxy server.

Password: If your proxy server requires authentication to communicate on the network, enter the password

required to authenticate against the proxy server.

1.3.6. Discovery

Enable: When enabled, CPS will advertise itself and its printers on the local network.


1.4. Advanced


Save Settings: Click to save any changes to the Advanced settings.

1.4.1. PrinterOn API Locations

These two fields contain the URIs for your application programming interfaces (APIs).

PrintAnywhere API: PrintAnywhere API is the location of the PrintAnywhere Server API, which CPS uses to

send requests to the PrintAnywhere Server.

PrinterOn API: PrinterOn API is the location of the PrinterOn Services API. CPS uses this URI to look up printer

information from the PrinterOn Printer Directory.


1.4.2. Environment

Log Level: Sets the level of detail in the log file. Higher levels of logging are most useful when troubleshooting.

Output may be sent to tomcat7-stdout (standard output), although your Application Server may redirect the

output elsewhere. Log levels are inclusive; higher log levels include all messages from the lower levels.

Level Name Description

0 OFF All logging is disabled

1 ERROR Error messages (non-recoverable or fatal errors)

2 WARN Warning messages (recoverable errors or unexpected conditions)

3 INFO Informational messages (default)

4 DEBUG Debugging messages included

5 TRACE Detailed troubleshooting logs.

Use JSSE: Determines whether CPS uses the Java JSSE SSL implementation. This option is enabled by

default. This attribute is for advanced configuration only. PrinterOn does not support issues arising from the use

of any SSL implementation other than JSSE.

Disable Popups: If this option is checked, CPS shows print job status messages within the main browser

window. If this option is unchecked, status messages are shown in a popup window.


Include user e-mail addresses with jobs: When enabled, the user's e-mail address will be set as the job

owner.

Include user network login with jobs: When enabled, the user's login ID will be set as the job owner.

Include Cover Page Recipient: Enable this option to include email address or network login name data in the

"Deliver to" field on cover pages.

Cover Page Recipient Data: This option sets the desired field to populate in the "Deliver to" field on cover

pages.

Print Job Time Out: This option allows you to increase the time CPS will allow for a job to be processed. NOTE:

The rendering application timeout is set separately in the PrintAnywhere Config Tool.

Synchronization Schedule: You may configure your CPS server to automatically synchronize itself with the

PrinterOn Directory at regular intervals. This option allows you to configure how often, in hours, CPS will

synchronize itself. This is helpful when initially setting up your service.


1.5. Authentication


Save Settings: Click to save any changes to the Authentication settings.

1.5.1. No Login required

When No Login required is set, the login for the CPS web printing pages is disabled. Any user can access and

print to your printers. When enabled, all other authentication schemes are disabled.

Enabled: To disable the user login page, check the Enabled option. If Enabled is set, all other authentication

settings are ignored.

1.5.2. LDAP Login

These settings provide LDAP configuration settings that are used when LDAP is enabled. The CPS LDAP

configuration allows you to configure multiple LDAP servers for authentication.

CPS will search and validate user credentials by connecting to all configured LDAP simultaneously.

CPS will use the results of the first successfully located/authenticated user if multiple servers are

configured.

LDAP for Mobile Apps: When this checkbox is disabled, CPS will not utilize the credentials supplied from

mobile applications. This option should only be disabled if your service is configured to use aaaLogin redirection

for authentication. When aaaLogin is enabled, users are prompted for credentials during each print. If this

checkbox is enabled, CPS will utilize the credentials supplied in the mobile application to authenticate the user.


1.5.3. Guest Login

Enabled: When enabled, a guest login option will be provided on the CPS print page.

1.5.4. Manage Guest LDAP Settings

Do Nothing: When selected, all guest job submissions will have a set job owner name of

[email protected].

Supply a Default User ID for Guests: When selected, all guest job submissions will have a set job owner name

based on the value set in this field.

Prompt Guests for a User Identifier: When selected, guests will be prompted for a user identifier before

submission.

Add prefix to Guest User ID: When enabled, all guest job submissions will be prepended by the value set in this

field.

Ensure User ID is unique: When enabled, CPS will verify the user name supplied by the guest user does not

match any valid usernames within the LDAP/AD setup.

mailto:[email protected]


1.5.5. Manage Trusted Print Settings

The CPS Admin Utility Interface the administrator to enforce PrinterOn Enterprise Service rules and policies for the print jobs submitted to CPS by Google Cloud Print users.

Trusted Print: The ‘Trusted Print’ feature allows trusted applications to submit jobs to secure Enterprise printers

without requiring additional validation of users. It assumes that the trusted application has taken the steps required to authenticate the users on its behalf. The ‘Trusted Print’ setting value determines how the jobs retrieved by the PDG Connector (Trusted Print Application) from Google Cloud Print are to be handled. The default value is set to ‘Authenticated and Guest’.

Allow All – Accepts all print requests. Anyone who has been authenticated by the GCP service to print to the published queues will be able to submit jobs to the PrinterOn Enterprise printers.

Reject All – Rejects all print requests. The administrator can use this option setting to disable submission of print jobs through the Google infrastructure to PrinterOn Enterprise printers.

Authenticated – Accepts print requests submitted by print users who can be identified in the Active Directory. If the corporate/institution’s active directory is updated to include information pertaining to Google Cloud Accounts, then the administrator can control access to printers.

Authenticated and Guest – Accepts print requests submitted by print users who can be identified in the Active Directory or who are Guest users in the context of Printer.


1.5.6. Managing LDAP Profiles

CPS supports configuring and using multiple LDAP servers for user authentication. Each server is independently

configured and managed. The LDAP Server combo box provides the set of configured LDAP servers. Unique

labels can be configured for each server using the Name field.

To Add a new LDAP server, click the Add button. When adding a new LDAP server, CPS will copy the settings

from the currently selected LDAP server and add a timestamp to the Name field.

To Remove an LDAP server, select the server to remove and click the Remove button.

1.5.7. Configuring LDAP Servers

Each LDAP server is independently configured and managed by CPS. To configure an LDAP server select the

LDAP server to configure using the LDAP Server drop-down box and continue.

Type: Indicates whether to use CPS’ Basic or Lookup LDAP authentication process.

Enabling Advanced authentication causes the user's login/password to be validated against your LDAP server.

This style also allows CPS to lookup other user attributes such as a user’s email address or network login. This

method uses the supplied Bind DN and Bind Password to locate and authenticate users.

Basic LDAP authentication validates that user credentials exist and are valid against a given LDAP server.

Instead of retrieving the user's email address from the LDAP server, it is instead composed using their login ID

and a specified domain name. This authentication method binds the user to the LDAP server using simple

authentication, and assumes that your LDAP server uses (or extends) the standard schema. If you have a

custom LDAP deployment, this authentication may not work without further modification. NOTE: User Lookup

integration for email printing is not possible with Basic LDAP selected.

Active: Enables or disables the specified LDAP server profile.


URI: The IP or DNS name of the LDAP/AD server to be used for authentication.

Bind DN: The distinguished name (DN) representing the login used to bind the LDAP server for searches. If your

LDAP server allows anonymous searches, leave this entry blank.

Bind Password: The password for the login given in Bind DN, above. If your LDAP server allows anonymous

searches, leave this entry blank.

Search DN: The distinguished name (DN) representing the branch from which the search for the given user will

occur. When Advanced LDAP is selected, searches will look for users below this branch of the LDAP tree. You

can enter multiple Search DNs. Separate multiple DNs with a semi-colon.


User Email Attribute: The name of the attribute that contains the user's email address. This is appended to

your Base DN in order to fetch the user's email address once they are validated against the Directory. For

example, given 'mail' as the User Email Attribute, CPS will attempt to lookup user's email addresses in the

directory via the path mail,ou=People,dc=ldapdomain

Use SSL: Enable this option if your LDAP server requires SSL connections. In most cases, enabling SSL also

requires that your LDAP URI points to port 636.

Enable SSL Cert Verification: When SSL is enabled, enable the Enable SSL Cert Verification option to connect

only to sources that contain a trusted server certificate. This may require you to download and trust the LDAP

server's certificate.

User ID Attribute: The attribute containing user login IDs. This attribute is appended to the Base DN in order to

do user lookup in the Directory. For example, given 'cn' as the User Id Attribute, CPS will attempt to validate

users via the path cn=LoginName,ou=People,dc=ldapdomain.

Domain Name: The domain name used in conjunction with the user’s ID to create their email address. The

domain name is appended to the user's ID to make a valid email address. For example, if the user id is "jsmith"

and you set your domain name to "myorganization.com", then the constructed user’s email address will be

"[email protected]".

NOTE: This is used when Basic LDAP is selected, Lookup will utilize the User Email Attribute field.

NT Domain Name: Indicate a domain name or other qualifier that will be pre-pended to the user ID when

submitted with the print job. The user ID submitted will be transmitted throughout the workflow and

communicated with any third party print management systems to assist in reporting and user tracking.


Referral: Indicates whether LDAP Referrals should be ignored or followed when searching for users on an

LDAP/AD server. This option should generally be set to Follow unless specifically required by your LDAP/AD

server.

Email Lookup Wild Card: Indicates whether wild cards will be used in searching. When set to True, CPS will

allow wild card lookup.

Prepend “smtp:” to queries: Some LDAP/AD environments contain multiple user IDs for each user. When

performing a user lookup using a supplied email address, prepending “smtp:” to the user ID will assist

differentiating between users. This setting should be enabled when using user email lookup in an AD

environment.

1.5.8. Custom User Authentication

Enabling this authentication method enables user authentication to be performed by a web server/service. When

enabled, all other authentication is invalid. Integration with PrinterOn’s Job Accounting API is required.

User Authentication URL: Indicates the URL to which CPS will redirect users during login when the custom

user authentication is enabled. Please note that this authentication scheme must be configured in conjunction

with PrinterOn’s hosted configuration interface.

1.5.9. PrinterOn Access Control Authentication

Enabling this authentication method causes the user's login information to be authenticated against PrinterOn’s

user database during printing. When enabled, all other authentication is invalid.


Enable Guest Login: Allow users without PrinterOn credentials to submit print jobs.

1.5.10. Web Server Authentication

Enabling this authentication method causes the user's login information to be set based on authentication with a

web-server/service. This can be used to enable a Single Sign-On (SSO) with an existing authentication scheme.

Your Web Server must authenticate the user, and pass their identification to the CPS application via the

REMOTE-USER HTTP header.

Enabled: To use Web Server authentication, check the Enabled option. If Enabled is not set, all other options in

this section are ignored.


1.6. User Rules and Printer Access

User Rules and Printer Access allows printers to be organized in groups, referred to as “Printer Departments” and

present these printers to groups of users. Printer Departments are “linked” to users. Any user in a group will

have access to the printers in the department.

Printer access is based on the organization of an LDAP or Active Directory server. Individual Organization Units

(OUs) can be linked to one or more Printer Departments. Similarly LDAP Groups may be linked to one or more

Printer Departments. Multiple Rules may be created allowing for very flexible configuration.

NOTE: The only limitation imposed is that all rules must be based on either OUs or Groups, there cannot be a mix

of both.

User Rules apply to all workflows including print jobs submitted from the Web Printing Portal, Mobile Apps, Email

and PrinterOn PrintWhere. Email print jobs use the Email User Lookup feature to link User Rules to email

printing.

User Rules also apply to discovery and search capabilities from the various workflows including web and mobile

apps. When searching for printers using a PrinterOn mobile app, or automatically discovering devices using

PrinterOn Discovery, users are only presented with those printers to which they have been granted access.

User Rules also apply when using Apple’s iOS devices. Please note that due to its implementation constraints,

PrinterOn Enterprise cannot limit what printers are visible to iOS devices but it can limit their ability to print. Users

will be able to see all printers that have been enabled for iOS users but they these users will not be able to submit

print jobs without successfully authenticating.

1.6.1. Enable User Rules & Printer Access

Select whether to use OU-based or Group-based management and client, the “Manage User-Based Printer

Access”.


Create Rule/Select a Rule: Press “New” to create and configure a new rule, or select from a list of existing rules.

Delete: To delete an existing rule, select it from the list and click “Delete”.

Name of Rule: Displays the name of the current rule. Modify the value and click save to change the name of an

existing rule.

OU Configuration:

Organization Unit (OU): The Discovered list presents a list of the automatically located OUs in the

currently active LDAP configuration. You may use an existing OU to quickly configure a rule.

Optionally a fully qualified OU may be entered in the “Current” field.

Recursive: When NOT enabled, CPS will only allow users that are part of the current OU and not

members of its sub-units. When enabled, CPS will traverse the OU tree and match users that may be in

sub-units of the parent OU as well.

In the example below, if MainDept is configured, only User1 and User2 will be valid if Recursive is not

enabled. User3 and User4 will be valid if Recursive is enabled.

MainDept

o User1

o User2

o SubDept

User3

User4

Group Configuration:


Group: The Discovered list present a list of the automatically located Groups in the currently active LDAP

configuration. You may use an existing Group to quickly configure a rule.

Optionally a fully qualified Group/CN may be entered in the “Current” field.

Printer Departments: The Printer Departments section is used to link Printer Departments to the User Rule

created.

Select a Printer Department from the list of Available departments and use the arrow buttons to add them to the

Linked list. Any user who is part of the User Rule will be allowed to search for and print to the printers the linked

departments. Printer Departments may be linked to multiple User Rules.

Allow All Departments: Indicates that users in User Rule will be able to access all printers regardless of their

department. This may be used to provide a group of uses such as an administrator to access all printers.

Save: Saves the current configuration on the User Rule Configuration page.

Dismiss: Closes the User Rule Configuration page.


1.7. Printers


Save Settings: Click to save any changes to the Printers settings.

Synchronize with PrinterOn: If you have made any changes to your printer listings through your account at

printeron.com, synchronizing will update the printers in your Printers tab to match. It is important to synchronize

after modifying your printer listings.

1.7.1. Printers Details

The checkbox on the left of each printer listing can be used to configure whether a given printer is shown or

hidden to CPS users.

Search: To locate a specific printer, this search bar can be used. Select the field to search, enter a keyword and

click the Search button.

Printer Name: This is the name of the printer as it is shown to the user in the CPS Web Interface. You can

modify this field to identify your printer.

Click the Printer icon to load more detailed information about the printer and its configuration.

Printer Alias: The Printer Aliases are listed in PrinterOn’s Printer Directory; you cannot change these values

from the Admin Console. The Printer Alias corresponds to the PrinterOn Name value of the printer listing in the

PrinterOn Directory. Printer Numbers are randomly generated and do not change for the life of the printer listing.


Discover: Used to configure whether the printer should be available to users using their iOS devices. Only

printers that have “Discover” enabled will be shown in the iOS Print menu. Disabling this option does not disable

the printer.

Approval: When checked, your users will be asked to confirm their print jobs before sending them to the printer

when printing through CPS’ web upload page.

Guest: When enabled, the printer will be set as a guest printer and users without valid LDAP/Active Directory

credentials can submit documents though web upload or mobile app submission.

1.7.2. Configurating Printer Departments

PrinterOn Departments are configured using the PrinterOn Administrative Dashboard at

www.printeron.com/administrators.

After logging into the your Enterprise

administrative account select the Printers

configuration.

Select Printer Departments from the list

of Printer Options

Using the dialog presented create the

departments for your service.

Create as one or more

departments

Rename them as needed

Go back to the Printers list when

done creating departments.

Select a printer to add to a Department

and Browse to the “Required Settings”

configuration.

http://www.printeron.com/administrators


Select the desired Department from the

list of Departments and save the settings.

NOTE: This setting may be applied to

multiple printers at the same time using

the “Copy Printer Settings” from the

Printer page.


1.8. Admin

Save Settings: Click to save any changes to the Admin settings.

1.8.1. Administration

Login: This is your login name for your CPS Admin account. The default login name is “cpsadmin”.

New Password: If you wish to create a new password, enter it here and confirm it in the Re-Type New Password

field. Click Save Settings to save the changes.

Password Hint: The password hint can be used to supply a hint that will assist in remembering the supplied

password. This hint is shown on the CPS admin login page.

Password Expires On: After this date, you will need to set a new password.

1.8.2. CPS API Management

To provide access to the CPS User Lookup API, API accounts and access keys must first be created. When

enabling software to call the CPS APIs the combination of the username, password and API Access keys must be

supplied and configured in the PrintAnywhere Server configuration.

API Users: To allow access to the CPS APIs, an API user account must first be created. This includes a

username and password.

API Access Keys: API access keys are used to provide additional security when allowing access to the CPS APIs.


2. How users print with CPS

This web page provides a step-by-step wizard for printing a document or web page to the printers you have

configured in your Central Print Services.

The following section gives a brief overview of how to submit a print job.

1. Open the CPS Home Page by choosing Start > All Programs > PrinterOn Corporation > Central Print Services > CPS Home Page.

2. Click Print.


3. Enter your network login credentials and click Login.

4. Click on a printer name to choose a printer.

All printers that are available to your users are listed. Printers are listed in groups based on the Department

setting, which is located in the Using your printer with Web, PrintWhere and Email Printing section of each

printer listing at www.printeron.com. The departments are organized alphabetically except when a Default

department exists. Any printer not assigned to a department will be placed in a “Default” group.

http://www.printeron.com/


5. On the Document Information page, browse to the file or enter the web page URL to print.

6. If you want to print more than one copy, specify the number of copies. You can also specify a page range to print. The default is to print one copy and all pages.

7. Click Continue.

8. Specify any optional page settings. The Paper and Duplex fields display options available for this particular printer, as specified under Output Options section of each printer listing at www.printeron.com. Orientation options include As Saved, Best Fit, as well as standard Portrait and Landscape modes.

http://www.printeron.com/


9. Click Continue. CPS submits the print job to the printer. A job status window displays progress. If you have enabled Approval for this printer (default is enabled), then the status window will display the page count and/or cost information for the print job and will ask you to confirm before sending the job to the printer.

10. Click Submit Job To Printer. Once the job has been successfully sent, the job status will change to Complete.

At this point, you have the option to submit another job to the same printer or to another printer, or to log out of

the system.


3. Customizing the CPS web printing pages

You can customize the appearance and content of the CPS web printing pages. The web pages are comprised

of standard HTML, images, JSP and Java Servlet files, most of which can be edited using a text editor. The three

most popular custom changes are detailed below.

NOTE: PrinterOn strongly recommends backing up all files prior to modification. Please contact PrinterOn

customer support to inquire about having changes made for you as a business service.

Prior to modifying these pages, please review information on the CPS Administrative Console (see section,

Administering your Central Printing ), especially for non-cosmetic configuration items such as LDAP integration.

3.1. Deployment Locations

The following section will highlight the common installation locations of files required to customize CPS. The

locations shown assume a standard installation of CPS. These locations may vary depending on how CPS was

installed. The locations shown below will assume that CPS was installed on the Windows C: drive.

Description Typical Installation Directory

Root deployment path

<DeployPath>

32-bit: C:\Program Files\PrinterOn Corporation\Apache Tomcat\

64-bit: C:\Program Files(x86)\PrinterOn Corporation\Apache Tomcat\

Text resource bundle

<DeployPath>webapps\cps\WEB-INF\classes\com\printeron\cps\resources\

Education Messaging: EpsResourceBundle.properties

Corporate Messaging: CpsResourceBundle.properties

Language Specific Information:

Each supported language has a dedicated Text Resource Bundle.

English language resources are contained in the EpsResourceBundle/

CpsResourceBundle files.

All other languages may be identified by the 2 or 4 ISO language identifier in the file

name. For example:

o EpsResourceBundle_de.properties for German

o EpsResourceBundle_es.properties for Spanish

Images <DeployPath>webapps\cps\images

Style sheets <DeployPath>webapps\cps\images (contains legacy CSS within campus_styles.css)

<DeployPath>webapps\cps\images\css


3.2. Modifying Text

All messages presented to CPS users are stored in a single text resource bundle. The text resource bundle’s

location is identified in the table above. Text displayed on the user print portal may be modified by loading the

text resource bundle in a text editor, changing a message and restarting the Apache Tomcat service. The

messages stored in the text resource bundle are organized and grouped based on the name of the web page on

which they appear. For example, messages displayed on the Login.jsp page will be identified with the section title

“login.jsp text elements”.

The following illustration shows commonly modified messages on the Login page. The text presented in brackets

(i.e. [LoginBoxTitle]) identifies the text resource bundle identifiers used to populate the text.

The changes shown below may be used as a reference for modifying other messages in the print portal.


3.3. Replacing Images

All images displayed on the user print portal are stored in the images folder, the location of which is identified in

the table above. To minimize compatibility issues, replacement images must be the same file type and

dimensions. NOTE: It is possible to modify the dimensions and file types for images by also modifying the .jsp

and .html files that use them.

One of the most commonly replaced images is the brand_logo.gif. This is a 200x100 pixel GIF that is used as

the logo in the bottom-right hand corner of most CPS pages.


3.4. Modifying Styles/Changing Colors

Colour definitions, font sizes and font faces are stored and managed in a single style sheet file per Presentation

style (campus_styles.css and enterprise_styles.css). The style sheets file location is identified in the table above.

The text and colour scheme used by CPS can be modified using this file.

The following illustration shows commonly modified styles in CPS. The text presented in brackets (i.e. [.titlebar])

identifies the style used to modify the highlighted section.

3.5. Advanced Customization

The majority of the print portal user interface supplied by CPS is provided in source form. More advanced

customization of CPS may be accomplished by directly modifying the supplied .jsp and .html files. These files are

located in the root CPS deployment directory. By becoming familiar with these files, it is possible to build a highly

customized version of CPS that is beyond the scope of this document.

3.6. CPS Customization and Software Upgrade Considerations

Due to the mechanism used to install and deploy CPS, the CPS installation process is unable to maintain

customization changes during the upgrade process. When upgrading CPS, please ensure that all customization

changes are backed up. Any changes made will need to be re-applied to the upgraded version.


4. Tomcat Customization and Configuration

4.1. Redirecting the Apache Tomcat Home Page

In a typical CPS deployment, the CPS user website is accessed by navigating to a CPS user print portal URL

such as http://www.server.com/cps. In some scenarios, it is desirable to provide users with a simpler and direct

link to CPS, such as http://www.server.com. The following provides one possible solution to this requirement.

Please note that these steps should be considered as a reference only, if problems are encountered, consult the

Apache Tomcat user guide.

1. Copy the text in the following table into a text file named index.html

<html> <head> <TITLE></TITLE> <script language="JavaScript">  </script> <script language="JavaScript1.1">  </script> </head>

<body bgcolor="#FFFFFF" onLoad="doRedirect()">

</body>

</html>

2. Change the highlighted URL from http://myserver.com/cps to the default CPS print portal URL for your specific CPS installation. 3. Save the index.html file. 4. Copy the index.html file into the Apache Tomcat ROOT folder. In a typical CPS installation this is: <Deploy Path>\webapps\ROOT. 5. Restart the Apache Tomcat Services using the Windows Service Control Manager. 6. Users should now be able to access the CPS user page by visiting http://www.yourserver.com.

http://www.server.com/cps

http://www.server.com/

http://myserver.com/cps

http://www.yourserver.com/


4.2. Modifying the Default Tomcat Listening Port

By default, the version of Tomcat included with CPS is configured to communicate using the standard HTTP

communication port which is port 80. In some scenarios it may be desirable to change this to an alternate port.

The following steps illustrate how to change the default Tomcat listening port and how to update the CPS

configuration settings to use the new port.

Open the Tomcat configuration file (server.xml). In a typical CPS installation this is located in the

following directory: <Deploy Path>\conf

Locate the configuration settings for the default port.

<!--Define a non-SSL HTTP/1.1 Connector on port 80--!>

<Connector port="80" protocol="HTTP/1.1"

connectionTimeout="20000"

redirectPort="8443" />

Change the port="80" to the desired port, such as port="8080".

Save the changes and restart Tomcat using the Windows Services Control Panel.

Browse to the CPS Administration Console using a browser (http://localhost/cps/admin)

Select the Advanced tab in the CPS Administration Console.

Change the PrintAnywhere API value to reflect the network port changes made in the Tomcat

configuration file.

http://localhost/PasServlet/PasServlet -> http://localhost:8080/PasServlet/PasServlet

Click the Save Settings link in the CPS Administration Console to apply the changes.

http://localhost/cps/admin

http://localhost/PasServlet/PasServlet

http://localhost:8080/PasServlet/PasServlet


4.3. Modifying the Default Tomcat Listening Port

By default, the version of Tomcat included with CPS is configured to communicate using the standard HTTP

communication port which is port 80. In some scenarios it may be desirable to change this to an alternate port.

The following steps illustrate how to change the default Tomcat listening port and how to update the CPS

configuration settings to use the new port.

Open the Tomcat configuration file (server.xml). In a typical CPS installation this is located in the

following directory: <Deploy Path>\conf

Locate the configuration settings for the default port.

<!--Define a non-SSL HTTP/1.1 Connector on port 80--!>

<Connector port="80" protocol="HTTP/1.1"

connectionTimeout="20000"

redirectPort="8443" />

Change the port="80" to the desired port, such as port="8080".

Save the changes and restart Tomcat using the Windows Services Control Panel.

Browse to the CPS Administration Console using a browser (http://localhost/cps/admin)

Select the Advanced tab in the CPS Administration Console.

Change the PrintAnywhere API value to reflect the network port changes made in the Tomcat

configuration file.

http://localhost/PasServlet/PasServlet -> http://localhost:8080/PasServlet/PasServlet

Click the Save Settings link in the CPS Administration Console to apply the changes.

http://localhost/cps/admin


http://localhost:8080/PasServlet/PasServlet


4.4. Enabling SSL Support in Tomcat

Configuring SSL for your installation may vary slightly depending on your preferred criteria.

It is recommended that you review and follow the steps provided by Apache for completing the process. Detailed

instructions regarding the process can be found at: http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html

The steps below are used to create a self-signed certificate for use with your service. Many applications and

browsers will warn any user accessing your service that the site may not be secure if you deploy a self-signed

certificate. For best results receiving a valid signed certificate from a Certificate Authority is recommended.

1. Create the certificate

a. From Command Prompt, go to path: %JAVA_HOME%\bin

b. Run this command: keytool -genkey -alias tomcat -keyalg RSA

Notes:

JAVA_HOME is the directory in which your JRE is installed

Your keystore will be stored in the home directory of the user under which you run the command

2. Configure the certificate

a. Create a password and follow the prompts that follow. The information you enter here

will be displayed to users who access a secure page in your application. Make sure it matches

what users would expect to see.

Notes:

Your Private Key and Keystore passwords should be the same.

3. Configure Tomcat

a. Open server.xml from C:\Program Files (x86)\PrinterOn Corporation\Apache Tomcat\conf.

b. Remove the comment fields surrounding the Connector port and edit the below code to

modify/include the text in red.

SSL using JSSE

<!-- Define a SSL HTTP/1.1 Connector on port 8443

<Connector port=“8443” protocol=“org.apache.coyote.http11.Http11NioProtocol” SSLEnabled=“true”

maxThreads=“150” scheme=“https” secure=“true”

clientAuth=“false” sslProtocol=“TLS” keystoreFile=“C:\Path\to\keystore\.keystore”

keystorePass=“keystore password”/>

SSL using APR

This following configuration demonstrates a connector using APR. The connector should be using the OpenSSL

style configuration described in the APR documentation referenced in the link above.

<Connector port="8443" maxThreads="200" protocol="org.apache.coyote.http11.Http11AprProtocol" scheme="https" secure="true" SSLEnabled="true" SSLCertificateFile="C:\Path\to\certificate\server.crt" SSLCertificateKeyFile=" C:\Path\to\certificateKey\server.pem" SSLPassword=”changeit” clientAuth="optional" SSLProtocol="TLSv1"/>

http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html


4. Restart Tomcat

4.5. Increasing Tomcat Memory

If you expecting or are experiencing a high volume of printing using the CPS web printing portal, increasing the

memory allocated to the Tomcat Java VM may improve the application’s overall performance and

responsiveness. This modification should only be done if your web printing portal is exhibiting slow response

times under heavy usage.

By default Tomcat is configured with a memory allocation of 256MB and a maximum of 512MB. The

recommended values for heavy usage are 512MB and 1024MB.

Start the “Command Prompt”

Browse to the bin directory Tomcat installation directory.

‒ <Deploy Path>\bin

Type the following in the command prompt to launch the Apache Tomcat properties pane

‒ > tomcat7w.exe //ES/Tomcat7

Select the Java tab

Change the Initial memory pool and Maximum memory pool to 512 and 1024 respectively.

Click OK

Restart Tomcat to apply the changes.


5. CPS Log

5.1. Log Basics

The CPS software logs status, processing, and error information. By default the log data goes to tomcat7-

stdout, although your application server may redirect this output elsewhere. The log is useful for verifying that

CPS started up correctly and for determining the cause of any errors, failures, or other unexpected behavior. It is

particularly helpful for determining LDAP connection issues.

When you install CPS, the default log level is “Info”. This is suitable for day-to-day use of CPS. For

troubleshooting or debugging, PrinterOn recommends that you set the log level to “Debug” or higher.

Changing Log Levels

1. In the CPS Administration Console > Advanced tab > CPS Environment, select the required Log Level.

2. Click Save Settings at the top of the page to save the log setting and update CPS.

5.2. Log Service Messages

Each logged message contains important information. For example:

2011-03-27 15:54:03 (DEBUG) (BaseServlet.makePostRequest:174 ) Opening a connection

to: 'https://secure1.printeron.net/ProvMember' for POST

The above message can be broken down into the following information:

The date and time the message was logged. In the example, the message was logged at 2011-03-27

15:54:03

The log level of the message. In the example the message was logged at the DEBUG level.

The Java Code that generated the message. In the example, this was

BaseServlet.makePostRequest:174. This indicates that the Java method makePostRequest in class

BaseServlet generated the error. The ‘174’ indicates the line number in the source code where the error

occurred.

In this case, the message is Opening a connection to: 'https://secure1.printeron.net/ProvMember'

for POST. This indicates that the code is attempting to contact the URL

https://secure1.printeron.net/ProvMember, making a POST request.

5.3. CPS Log Banner

Each time CPS successfully starts, a banner is output to the log. An example of a CPS banner follows. It indicates

the CPS version, log level, API URL locations, and the SSL implementation being used. You should carefully

verify that these values are correct.

=========================================================

Central Print Services (CPS)

(c)2013 PrinterOn Corporation

CPS Version: 2.0.11

Output Log Level: 5

SSL Implementation is: JSSE

CPS Context Path: C:\Program Files(x86)\PrinterOn Corporation\Apache Tomcat\webapps\cps

Locale Configuration: 'en_US'

=========================================================

JDK Version: 1.7.0_17


JDK Vendor: Oracle Corporation

=========================================================

PON API URL is: https://secure1.printeron.net

PAS API URL is: http://localhost/PasServlet/PasServlet

=========================================================

CPS Config File Version: 1.6

CPS Printer DB Last Updated: 2013-Apr-16 11:45:19

=========================================================

Started CPS on: 2013-Apr-13 09:14:15

=========================================================

5.4. Error and Exception Logging

When CPS encounters a serious Error or Exception, it prints the entire stack trace to the log. This may be useful

to a Java Developer for determining the source of the error. Below is an example of a stack trace dump. Note

that the log message severity is STACK TRACE. These messages are output at the “ERROR” level and higher

and always follow an error message.

2011-03-27 14:00:48 (ERROR) (BaseServlet.makePostRequest:169 ) An exception occurred. Printing

stack trace.

2011-03-27 14:00:48 (STACK TRACE) (BaseServlet.makePostRequest:169 )

java.lang.NullPointerException

at com.printeron.hps.HpsPrintServlet.handleOptions(HpsPrintServlet.java:161)

at com.printeron.hps.HpsPrintServlet.doPost(HpsPrintServlet.java:65)

at javax.servlet.http.HttpServlet.service(HttpServlet.java)

at javax.servlet.http.HttpServlet.service(HttpServlet.java)

at org.apache.tomcat.facade.ServletHandler.doService(Unknown Source)

at org.apache.tomcat.core.Handler.invoke(Unknown Source)

at org.apache.tomcat.core.Handler.service(Unknown Source)

at org.apache.tomcat.facade.ServletHandler.service(Unknown Source)

at org.apache.tomcat.core.ContextManager.internalService(Unknown Source)

at org.apache.tomcat.core.ContextManager.service(Unknown Source)

at org.apache.tomcat.modules.server.Ajp13Interceptor.processConnection(Unknown Source)

at org.apache.tomcat.util.net.TcpWorkerThread.runIt(Unknown Source)

at org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(Unknown Source)

at java.lang.Thread.run(Thread.java:479)

https://secure1.printeron.net/



Trademarks and Servicemarks

The following are trademarks or registered trademarks of PrinterOn Corporation in Canada and other countries:

PrinterOn, PrintSpots, PrintWhere, PrintAnywhere, “Print Simply Anywhere”, the PrinterOn “bird”, the PrinterOn

Logotype and the PrinterOn Signature.

The following are trademarks or registered trademarks of other companies:

Windows, Internet Explorer, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, and Microsoft Visio are

trademarks or registered trademarks of Microsoft Corporation.

iPad, iPhone and AirPrint and OS X are trademarks or registered trademarks of Apple.

iOS is a trademark or registered trademark of Cisco in the U.S. and other countries and is used by Apple under

license.

Android, Chrome OS and Chromebook are trademarks or registered trademarks of Google Inc.

BlackBerry is a registered trademark of Research in Motion Limited.

Other brands and their products are trademarks or registered trademarks of their respective holders.

Copyright Notice

© Copyright 2014 by PrinterOn Inc.

All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in

any form or by any means, electronic, mechanical, photocopy, recording, or otherwise, without the prior written

permission of PrinterOn Inc.

Disclaimer:

PrinterOn Inc. makes no warranty with respect to the adequacy of this documentation, programs, or hardware,

which it describes for any particular purpose, or with respect to the adequacy to produce any particular result. In

no event shall PrinterOn Inc. be held liable for special, direct, indirect, or consequential damages, losses, costs,

charges, claims, demands, or claim for lost profits, fees, or expenses of any nature or kind.

Date post:	02-Oct-2020
Category:	Documents
Upload:	others
View:	9 times
Download:	0 times

PrinterOn Central Print Services (CPS) Administrator Guide...PrinterOn Enterprise CPS Admin Guide |...

Documents