KIM core based PCL driver customization

Transcription

GMSSC-SS-PN-112-0017
Issued: November 4th, 2011
KIM core based PCL driver
customization
Document Version 1.2
Solution Support Department
Service and Support Center
Global Marketing Group
Notice:
THIS DOCUMENT MAY NOT BE REPRODUCED OR DISTRIBUTED IN WHOLE OR IN PART, FOR ANY
PURPOSE OR IN ANY FASHION WITHOUT THE PRIOR WRITTEN CONSENT OF RICOH COMPANY
LIMITED. RICOH COMPANY LIMITED RETAINS THE SOLE DISCRETION TO GRANT OR DENY
CONSENT TO ANY PERSON OR PARTY.
Copyright
© 2011 by Ricoh Company Ltd.
All product names, domain names or product illustrations, including desktop images, used in this document
are trademarks, registered trademarks or the property of their respective companies. They are used
throughout this document in an informational or editorial fashion only. Ricoh Company, Ltd. does not grant or
intend to grant hereby any right to such trademarks or property to any third parties. The use of any trade
name or web site is not intended to convey endorsement or any other affiliation with Ricoh products.
Although best efforts were made in preparation of this document, Ricoh Company Limited makes no
representation or warranties of any kind with regards to the completeness or accuracy of the contents and
accepts no liability of any kind including but not limited to performance, merchantability, fitness for any
particular purpose, or any losses or damages of any kind caused or alleged to be caused directly or indirectly
from this document.
2/46
Ricoh Company, Ltd.
Version history:
Version
Issue Date
Revised item
1.0
Aug. 8, 2008
1st release
1.1
Feb. 6, 2009
-
Updated supported drivers in section 3.
-
Changed the title of section 5-3.
-
Changed the section 5-3-2 (Format 2.)
-
Added a new “AttValue1” to Table 5-2 in section 5-4.
-
Updated the PSD file lists in section 6-2.
-
Inserted a new section: 7 (Section numbers in the document
were adjusted.)
-
Made changes to section 5-2, 6-3 and 8.
-
Added information about YAPD core drivers to section 9-2.
-
Minor changes and corrections to the entire document.
-
Added note2 to the end of section 5-2.
-
Added a description of the semi-lock function to section 5-3.
This includes the addition of formats 3 and 4. (The format
numbers in the document were adjusted.)
-
Added a note to section 5-3-2 (format 2).
-
Added “Toner Saving” and “Economy Color” to Table 5-1 in
section 5-3.
-
Table 5-1 (section 5-3): Indicated which versions of PCL6
driver for Universal Print that can use the AttValue1
1.2
Nov. 4, 2011
“loginusername”.
-
Added note3 to the end of section 5-3.
-
Added a note to section 5-4-3 (format 7).
-
Table 5-2 (section 5-4): Indicated which versions of PCL6
driver for Universal Print that can popup the Authentication
and Authentication (Single Sign-On) dialogs.
-
Updated the PSD file lists in section 6-2.
-
Added new sections: 7-2, 7-3.
-
Added Windows 7/2008R2 to the notes in section 8.
-
Added information about YAPD2.0 core drivers to section 9-2.
-
Minor changes and corrections to the entire document.
3/46
Ricoh Company, Ltd.
Index
1. Introduction ........................................................................................ 5
2. Target readers .................................................................................... 6
3. Requirements..................................................................................... 6
4. Introduction to XML ............................................................................ 7
4-1. General explanation ...................................................................................... 7
4-2. Example elements and attributes used for driver customization ................... 9
5. Modifying the RCF file...................................................................... 10
5-1. Before and after the modification................................................................. 10
5-2. Changing the default driver settings ............................................................ 12
5-3. Locking/Limiting driver settings ................................................................... 15
5-4. Displaying popup dialogs ............................................................................ 22
5-5. Combining different types of customization................................................. 27
6. Modifying the PSD file...................................................................... 28
6-1. Before and after the modification................................................................. 28
6-2. The PCL6 driver for Universal Print’s PSD files........................................... 32
6-3. Extending the maximum length of the User ID ............................................ 35
7. Customizing PCL6 driver for Universal Print .................................... 36
7-1. Changing the default UI............................................................................... 36
7-2. Performing bidirectional communication when a logical printer is created .. 39
7-3. Disabling automatic bidirectional communication by default ....................... 40
8. Installing the customized driver........................................................ 42
9. Appendix .......................................................................................... 44
9-1. Distinguishing whether a driver has been customized or not ...................... 44
9-2. Determining which core is used by a PCL driver ......................................... 45
4/46
Ricoh Company, Ltd.
1.
Introduction
This document describes how to customize the KIM core based PCL driver. Printer Driver Editor has limited
functionality. The customization methods in this document can be used to customize the KIM core based
drivers in ways that are not possible using only Printer Driver Editor.
The procedures contained in this document can be used to do the following:
General customizations:
- Change the default driver settings
- Lock/Limit driver settings
- Popup a dialog before printing that prompts users to enter information such as User ID or Password.
- Extend the max. length of the User ID
Customizations that only apply to the PCL6 driver for Universal Print:
- Change the default UI
- Perform automatic bidirectional communication when a logical printer (queue) is created
- Disable automatic bidirectional communication by default
These customizations can be done by manually editing an RCF file (.rcf), a PSD file (.psd) or an XML file
(.xml) in a driver package. The contents of these files are XML (Extensible Markup Language) formatted.
However, only a limited understanding of XML is required. Section 4 “Introduction to XML” is a basic
introduction to XML. It should provide enough information for the customizations in this document.
Note1: Customized drivers are to be released at your own risk. Please test them thoroughly and keep track of
where you have deployed the customized drivers. If a problem happens using a customized driver, please
test the standard driver. If the problem also affects the standard driver, please report it as a standard driver
problem.
Note2: The customization will cause the driver to lose its Microsoft logo certification. Therefore, an alert
message might be displayed during installation.
WHQL certification requirement: In order to gain Microsoft logo certification (WHQL certification), drivers are
submitted to Microsoft for inspection. Microsoft tests the driver and grants certification if it is found to work
correctly with Windows. The certification is granted in the form of a digital signature created using the
contents of the driver package. If anything within the driver package is changed, the digital signature will no
longer match the driver contents and the certification will be seen by Windows as invalid.
5/46
Ricoh Company, Ltd.
2.
Target readers
This document is intended for the support staff of Ricoh family group companies and their subsidiaries. Do
not distribute to anyone else.
3.
Requirements
Printer Driver:
This document applies only to KIM core drivers. Currently available KIM core based PCL drivers (as of
November 4th, 2011):
- PCL6 driver for 08S or 08A models
- PCL6 driver for Universal Print
Others:
- A text editor or an XML editor.
6/46
Ricoh Company, Ltd.
4.
4-1.
Introduction to XML
General explanation
Overview:
XML (Extensible Markup Language) defines a general text-based method of organizing data. A data object in
the XML specification is called an XML document. XML does not specifically define how an application should
process XML documents.
XML is standardized by the World Wide Web Consortium (W3C).
W3C web site: http://www.w3.org/XML/
Official XML specifications are available at the W3C site, but there are plenty of other easy to follow XML
tutorials on the Internet. To follow are some terms that will be used throughout this document. Please
familiarize yourself with them.
Element and tags:
An XML document is composed of a basic unit called an element. To distinguish each element, HTML-like
tags are used:
Start-tag: <element>
End-tag: </element>
Element contents are contained between these tags.
Example:
<memo>This is a pen.</memo>
Hierarchy:
One of the main features of XML is that data is organized into a hierarchical tree structure.
Example of an XML document:
<memo>
<date> 4/21/2008 </date>
<author>
<id> 0001 </id>
<name> John Doe </name>
</author>
<titile> Pen </title>
<text> This is a pen.</text>
</memo>
Note: Spaces or tabs input in front of the start-tags are not mandatory, but are sometimes inserted
7/46
Ricoh Company, Ltd.
automatically by XML editors or manually by authors to make the file easy to read in a text editor.
Tree structure of the above example:
content
content
content
id
name
date
content
author
title
memo
content
text
root element
The element at the root of the tree is called the root element. There is only 1 root element in an XML
document. In this example, “memo” is the root element. All other elements are children of “memo” and
“memo” is the parent of all elements. “author” is both a child of “memo” and a parent of “id” and “name”.
Attribute:
Attributes are additional information about elements. Elements can have multiple attributes in the start-tag.
Example:
<memo security="low"> This is a pen.</memo>
In this example, “security” is the attribute of the element “memo”. “low” is the value of the attribute.
Empty element:
In XML documents, there can be elements that do not have any content or child elements. Such an element is
called an empty element. The start-tag and end-tag are not necessary for empty elements. A special tag
called an empty-element tag such as below can be used:
Empty-element tag: <element/>
Example:
<memo/>
8/46
Ricoh Company, Ltd.
4-2.
Example elements and attributes used for driver customization
To accomplish our driver customizations, we will edit some of the driver’s XML elements and attributes. This
will be explained in greater detail in section 5 “Modifying the RCF file”, section 6 “Modifying the PSD file” and
section 7 “Customizing PCL6 driver for Universal Print” To follow is an example of an edited RCF file.
Example:
Job Type is locked to “Locked Print”:
<?xml version="1.0" encoding="utf-8"?>
<rcf version="1.0">
<featurelock>
<item name="jobtype" fixvalue="lockedprint"/>
</featurelock>
</rcf>
Gray text: Original contents of the RCF file.
Black text: Added manually.
The first line is an XML declaration which specifies the version of XML being used.
“featurelock” is the main element used for locking a driver setting. “item” is a child element of “featurelock”.
Because “item” is an empty element, the empty-element tag is used.
This particular element has 2 attributes: “name” and “fixvalue”. These attributes can be used to lock various
kinds of driver settings.
9/46
Ricoh Company, Ltd.
5.
Modifying the RCF file
Modification of an RCF file can be used to perform the following customizations:
- Change the default driver settings
- Lock/Limit driver settings to certain values
- Popup a dialog before printing that prompts users to enter information such as User ID or Password.
The XML syntax used to perform the customizations will be any of 7 basic types. These are described as
“Format 1 – 7” in later sections.
Note: Contents of the RCF file are case-sensitive.
5-1.
Before and after the modification
This section does not apply to section 5-2 “Changing the default driver settings”.
Before the modification:
Prepare a set of driver files and locate the file with the extension “.rcf”. There will only be one of these files.
This file needs to be modified.
Contents of the RCF file:
10/46
Ricoh Company, Ltd.
The root element is “rcf”. To customize the driver, we insert some lines between the start and end tags of
“rcf”.
If you modify an RCF file, please add a comment to the file. This will serve as a reminder to you or others that
the file was modified, and what the purpose of the modification was.
Comments can be added under the XML declaration using the following syntax:

RCF file with comments:
Note: Do not use a series of hyphens (--) in the body of the comment.
After the modification:
Save the modified file back to its original location.
For information about the installation of the customized driver, refer to section 8 “Installing the customized
driver”.
11/46
Ricoh Company, Ltd.
5-2.
Changing the default driver settings
This customization changes the default values of driver settings. The values that are restored by the Restore
Defaults buttons are also changed.
Manual editing of the RCF file is not necessary for this customization. The customization uses a function built
into the driver to create a customized RCF file. Follow the steps below.
Note: The default UI used by the PCL6 driver for Universal Print when bi-directional communication cannot
be established is SI-P1. In order to make customizations for another model, the default UI must be changed
first using the procedure described in section 7-1 “Changing the default UI”.
Procedure:
Step 1. Install a driver that needs to be customized.
To avoid bi-directional communication being established, choose a port that is not connected to any device
(such as “LPT1:”).
Step 2. Configure the driver settings that you want to make default in Printer Properties and Printing
Preferences. After configuring the default settings, be sure to press “OK” or “Apply” to save the changes.
Step 3. Press the “Save” button in the Setup tab.
Step 4. Select a folder in which to save the RCF file. Then, press “Save”.
12/46
Ricoh Company, Ltd.
Note: Do not change the file name.
Step 5. Copy the RCF file you created in step 4, to the folder that contains the original driver files (the files
that were used to install the driver on the PC).
Step 6. Press “Yes” in the confirmation dialog.
The customization is now complete. For information about the installation of the customized driver, refer to
section 8 “Installing the customized driver”.
13/46
Ricoh Company, Ltd.
Notes on the customization “Changing the default driver settings”:
Note1: The following settings cannot be customized:
- “Measurement Unit” in the “Custom Paper Size” dialog.
- All settings in the Watermark tab.
- User ID, Password and User Name in the “Details” dialog of any Job type
- Login User Name, Login Password, Driver Encryption Key
- User Code, Classification Code
Note2: Even if the default Job Type (Normal Print) is changed to another Job Type, all jobs will continue to be
processed as Normal Print jobs until credentials needed for that job type (e.g. User ID and Password for
Locked Print) are input.
14/46
Ricoh Company, Ltd.
5-3.
Locking/Limiting driver settings
This customization locks driver settings to specific values or limits which settings are available.
Example: Job type is locked to “Locked Print”
Example: “Off” has been removed from the Duplex drop-down menu
As of PCL6 driver for Universal Print v3.7.0.0, locked/restricted settings can be configured to automatically
become unlocked/unrestricted it if Printing Preferences is accessed from within an application. This will give
users access to the driver settings they want to use, but prevent them from changing the default settings
shown when an application is opened. This has been named the “semi-lock” function.
The following screenshots are an example of the semi-lock function:
- “Off” has been removed from the 2 sided drop-down list.
15/46
Ricoh Company, Ltd.
- The color setting is locked to “Black and White”.
These become unlocked/unrestricted if accessed from within an application.
Printing Preferences opened via the Printers menu in the control panel:
Printing Preferences opened via an application:
Note: The semi-lock function does not work on Windows 2000.
16/46
Ricoh Company, Ltd.
5-3-1. Format 1: Locking a driver setting to a specific value
<rcf version="1.0">
<featurelock>
<item name="AttValue1" fixvalue="AttValue2"/>
</featurelock>
</rcf>
Refer to Table 5-1 for a list of AttValues that can be used with this format.
5-3-2. Format 2: Selecting specific items to include in a drop-down list
<rcf version="1.0">
<featurelock>
<item name="AttValue1">
<pickone name="AttValue2"/>
:
</item>
</featurelock>
</rcf>
Settings (AttValue2) that are not specified using the “pickone” element will be removed from the drop-down
list of “AttValue1”.
Note: To remove the factory default value from a drop-down list, the default must be changed to another
value. Otherwise pressing the Restore Default button will have no effect on the drop-down list. A combination
of the “Changing the default driver settings” and “Locking/Limiting driver settings” customizations should be
performed. For an example of this, refer to section 5-5 “Combining different types of customization”.
5-3-3. Format 3: Locking a driver setting to a specific value, but unlocking it if Printing
Preferences is accessed from within an application
<rcf version="1.0">
<featurelock>
<item name="AttValue1" fixvalue="AttValue2" except="application"/>
</featurelock>
</rcf>
This format can be used with PCL6 driver for Universal Print v3.7.0.0 or later only.
17/46
Ricoh Company, Ltd.
5-3-4. Format 4: Selecting specific items to be included in a drop-down list, but displaying all
possible items if Printing Preferences is accessed from within an application
<rcf version="1.0">
<featurelock>
<item name="AttValue1" except="application"/>
:
</featurelock>
</rcf>
This format can be used with PCL6 driver for Universal Print v3.7.0.0 or later only.
Note: To remove the factory default value from a drop-down list, the default must be changed to another
value. Otherwise pressing the Restore Default button will have no effect on the drop-down list. A combination
of the “Changing the default driver settings” and “Locking/Limiting driver settings” customizations should be
performed. For an example of this, refer to section 5-5 “Combining different types of customization”.
Table 5-1.
AttValue1 and AttValue2 (Formats 1, 2, 3, 4)
Setting
AttValue2
Job Type
(AttValue1 = "jobtype")
(Only for Formats 1 and 2)
Normal Print
normalprint
Locked Print
lockedprint
Hold Print
holdprint
Stored Print
storedprint
Stored Print (Shared)
storedprintshared
Store and Print
storeandprint
Store and Print (Shared)
storeandprintshared
Document Server
documentserver
Layout
(AttValue1 = "layout")
1 Page per Sheet
1pagepersheet
2 Pages per Sheet
2pagespersheet
4 Pages per Sheet
4pagespersheet
6 Pages per Sheet
6pagespersheet
18/46
Ricoh Company, Ltd.
9 Pages per Sheet
9pagespersheet
16 Pages per Sheet
16pagespersheet
Color / Black and White
(AttValue1 = "colorbw")
Color
color
Black and White
blackandwhite
Duplex (2 sided)
(AttValue1 = "duplex")
Off
off
Open to Left
opentoleft
Open to Top
opentotop
Booklet
booklet
Toner Saving
(AttValue1 = "tonersaving")
Off
off
On
on
Economy Color
(AttValue1 = "economycolormode")
Off
off
On
on
Paper Selection
(AttValue1 = "paperselection")
(Only for Format 1)
Same Paper for All Pages
samepaperforallpages
Input Tray
(AttValue1 = "standardpages_inputtray")
(Only for Formats 1 and 2)
Tray 1
tray1
Tray 2
tray2
Tray 3
tray3
Tray 3 (LCT)
tray3lct
Tray 4
tray4
Tray 5
tray5
Tray 6
tray6
Tray 7
tray7
Bypass Tray
bypasstray
One Sheet Tray
onesheettray
Front Bypass Tray
frontbypasstray
Large Capacity Tray
largecapacitytray
19/46
Ricoh Company, Ltd.
Login User Name *
(AttValue1 = "loginusername")
(Only for Format 1)
Locked to Windows login name.
@loginname
Users will not be able to change
the Login User Name.
* This customization is not applicable to PCL6 driver for Universal Print v1.3.0.0 or earlier.
Note: Settings differ by model.
Example of the standard locking/restricting function:
- Job Type is locked to “Locked Print”.
- “Off” has been removed from the Duplex drop-down list.
<rcf version="1.0">
<featurelock>
<item name="jobtype" fixvalue="lockedprint"/>
<item name="duplex">
<pickone name="opentoleft"/>
<pickone name="opentotop"/>
<pickone name="booklet"/>
</item>
<item name="colorbw" fixvalue="blackandwhite"/>
</featurelock>
</rcf>
Example of the semi-lock function:
- “Off” is removed from the 2 sided drop-down list.
- Neither of these changes have any effect if Printing Preferences is accessed from within an application.
<rcf version="1.0">
<featurelock>
<item name="colorbw" fixvalue="blackandwhite" except="application"/>
<item name="duplex" except="application">
<pickone name="opentoleft"/>
<pickone name="opentotop"/>
</item>
20/46
Ricoh Company, Ltd.
</featurelock>
</rcf>
Notes on the customization “Locking/Limiting driver settings”:
Note1: Some settings require that specific accessories be configured. For example, a hard disk unit is
required to use Locked Print. If you are customizing a driver of a model that has a hard disk unit as an option,
and if you want the Job Type setting be locked to “Locked Print” by default, you have to customize the driver
so that the hard disk unit is installed by default and the Job Type setting is locked to “Locked Print”.
To perform this customization, a combination of the “Changing the default driver settings” and
“Locking/Limiting driver settings” customizations should be performed. For an example of this, refer to section
5-5 “Combining different types of customization”.
Note2: Due to incompatibilities between settings, it is necessary that some settings have priority over others.
For example, the Duplex setting cannot be used with some paper types. The Type (paper type) setting has
higher priority than the Duplex setting. Therefore, even if the Duplex setting is locked on, it will be
automatically set to “Off” for certain paper types (e.g. “Transparency”). These kinds of priorities are often
related to hardware accessories, such as trays, the duplex unit and hard disk unit.
Note3: Even if the default Job Type (Normal Print) is changed to another Job Type, all jobs will continue to be
processed as Normal Print jobs until credentials needed for that job type (e.g. User ID and Password for
Locked Print) are input.
21/46
Ricoh Company, Ltd.
5-4.
Displaying popup dialogs
The following dialogs can be popped up before printing:
- Job Type “Details” dialog
- User Code dialog
- Authentication dialog
- Classification Code dialog (Model-specific drivers only)
Such a customization can be used, for example, to force users to enter their User ID.
Job Type dialog (Locked Print):
User Code dialog:
Authentication dialog:
Classification Code dialog:
22/46
Ricoh Company, Ltd.
5-4-1. Format 5: Popping up a dialog before printing
<rcf version="1.0">
<popupbeforeprint type="AttValue1"/>
</rcf>
The popup dialogs display the values that are registered in Printing Preferences. With the exception of
“Authentication (Single Sign-On)” (Refer to Table 5-2), none of the information entered into the pop-up when
a job is submitted will be remembered for future jobs. However, this can be changed. Refer to sections 5-4-2
(Format 6) and 5-4-3 (Format 7) below.
5-4-2. Format 6: Popping up a dialog with pre-populated fields
<rcf version="1.0">
<popupbeforeprint type="AttValue1">
<item name="AttValue2" defaultstring="AttValue3"/>
</popupbeforeprint>
</rcf>
Refer to Table 5-2, 5-3, 5-4 and 5-5 for a list of AttValues that can be used with this format.
5-4-3. Format 7: Popping up a dialog and retaining user input in that dialog
<rcf version="1.0">
<popupbeforeprint type="AttValue1">
<item name="AttValue2" store="yes"/>
</popupbeforeprint>
</rcf>
Refer to Table 5-2, 5-3 and 5-5 for a list of AttValues that can be used with this format.
Note: If Internet Explorer is in "Protected Mode" (available in Windows Vista or later and enabled by default)
and a job is printed from IE, user input will not be retained for other applications (and vice versa).
23/46
Ricoh Company, Ltd.
Table 5-2. AttValue1 (Formats 5, 6, 7)
Dialog to be popped up
Job Type Details
(applies to all Job Types)
AttValue1
jobtype
User Code
usercode
Authentication *
authentications
Authentication (Single Sign-On**)
authentications single sign-on
Classification Code ***
billingcode
* This customization is not applicable to PCL6 driver for Universal Print v2.1.0.0 or earlier.
** Single Sign-On:
This is only possible with PCL6 drivers for 08A or later models, or PCL6 driver for Universal Print v2.3.0.0 or
later. At the first pop-up of the authentication dialog, a user must input their login user name and password.
These are the same as those used to login to Windows. If authentication fails, users will be prompted to try
again. Values input in the dialog are stored in Printing Preferences. The authentication dialog will not be
popped-up again as long as the user name and password are not changed in Printing Preferences or
Windows.
*** Cannot be customized for the PCL6 driver for Universal Print.
Note: In order for the Authentication dialog to be popped up by default, the driver must be customized so that
the “User Authentication” checkbox in the Advanced Options tab is checked by default. Additionally, if the
model has an optional hard disk unit, it must be installed by default. To perform this customization, a
combination of the “Changing the default driver settings” and “Displaying popup dialogs” customizations
should be performed. For an example of this, refer to section 5-5 “Combining different types of
customization”.
Table 5-3. AttValue2 (Formats 6 and 7)
Setting
AttValue2
User ID
userid
Password
password
User Name
username
Login User Name
loginusername
24/46
Ricoh Company, Ltd.
Table 5-4. AttValue3 (Format 6)
Behavior
AttValue3
Setting specified by AttValue2 will always be blank in the
popup dialog. The setting will have to be entered each
blank
time a job is submitted.
The setting specified by AttValue2 will always be
populated with the Windows Login Name of the currently
logged in user. Users can change this in the popup
loginname
dialog.
Table 5-5. Valid combinations of AttValue2 with the “defaultstring” and “store” attributes (Formats 6
and 7)
defaultstring (format 6)
AttValue2
store (format 7)
blank (AttValue3)
loginname (AttValue3)
yes
userid (User ID)

password (Password)

-

username (User Name)

-

loginusername (Login User Name)
-

-
‘ ‘ = valid, ‘-‘ = invalid
Notes on AttValue2 and AttValue3 (Formats 6 and 7):
Note1: Each of the four AttValue2 values can only be used once in an RCF file.
Note2: Even if AttValue2 and AttValue3 are used, users are able to configure the setting via Printing
Preferences. However, the default value in the popup dialog will always be the value specified by AttValue3.
Note3: If a Windows Login Name exceeds the maximum User ID or Login User Name length, extra
characters will be truncated.
Note4: If the Windows Login Name contains characters that are not supported in the User ID, the popup
dialog will not use the Windows Login Name. Instead, the User ID that is registered in Printing Preferences
will be displayed.
Note5: There is no AttValue2 for User Code, Classification Code and Login Password for user authentication.
However, “Reenter the confirmation password” field in the Authentication dialog will always be blank.
Therefore, users have to enter their Login Password manually each time the dialog is popped up.
Example:
Popup the “Details” dialog of a Job Type. The User ID field will always be the Windows Login Name and the
Password field will always be blank:
25/46
Ricoh Company, Ltd.
<rcf version="1.0">
<popupbeforeprint type="jobtype">
<item name="userid" defaultstring="loginname"/>
<item name="password" defaultstring="blank"/>
</popupbeforeprint>
</rcf>
Example:
Popup the “Details” dialog of a Job Type. The User ID entered in the dialog will be saved for subsequent jobs:
<rcf version="1.0">
<popupbeforeprint type="jobtype">
<item name="userid" store="yes"/>
</popupbeforeprint>
</rcf>
26/46
Ricoh Company, Ltd.
5-5.
Combining different types of customization
The 3 types of customization from section 5-2 to 5-4 can be used in any combination:
1) 5-2 and 5-3 (default and locked/limited)
2) 5-2 and 5-4 (default and popup)
3) 5-3 and 5-4 (locked/limited and popup)
4) 5-2, 5-3, and 5-4 (default, locked/limited and popup)
Case 3 is the simplest as it only requires using the “featurelock” and “popupbeforeprint” elements in the
existing RCF file. However, the other cases configure default settings and therefore, an RCF must be created
after configuring driver defaults. After that the RCF file can be edited.
Note: The RCF file created in section 5-2 does not have a CR (Carriage Return) between tags. This makes it
difficult to read the RCF file in simple text editors such as Notepad. An editor that formats text to make it more
readable, might be preferable. For example, XML Marker is available at http://symbolclick.com/.
Example:
3 types of the customization combined:
<!-This file was modified by John Doe, RCL.
April 1, 2008
Comment
Customer Name: Ricoh
Purpose: …
-->
<rcf version="1.0">
<devicesettings ……>
……
……
Changing the default driver settings (section 5-2)
</devicesettings>
<featurelock>
……
……
Locking/Limiting driver settings (section 5-3)
</featurelock>
<popupbeforeprint ……>
……
……
Displaying popup dialogs (section 5-4)
</popupbeforeprint>
</rcf>
Note: If different values of the same setting are specified as the default and locked value, the locked value will
have precedence over the value specified as default.
27/46
Ricoh Company, Ltd.
6.
Modifying the PSD file
Modification of a PSD file can be used to perform the following customization:
- Extend the max. length of the User ID
6-1.
Before and after the modification
Before the modification:
Prepare a set of driver files and locate the file with the extension “.psz”. There will only be one of these files.
The PSZ file is compressed using the zip format and must be decompressed in order to get the PSD file.
Some decompression utilities might require that you change the extension to “zip”.
Decompress this file.
The decompression will result in the creation of several PSD files. There will typically be 3 files:
“innerdata.psd”, “RicohGeneric.psd” and another. It is this other PSD file that needs to be edited.
Note: If you are customizing the PCL6 driver for Universal Print, the decompressed files will be different.
Please refer to section 6-2 “The PCL6 driver for Universal Print’s PSD files” for more information.
Files extracted from the PSZ file:
28/46
Ricoh Company, Ltd.
Contents of the PSD file:
Before modifying the PSD file, please add a comment to the file. This will serve as a reminder to you or others
that the file was modified, and what the purpose of the modification was.
Comments can be added under the XML declaration using the following format:

PSD file with comments:
29/46
Ricoh Company, Ltd.
Note: Do not use a series of hyphens (--) in the body of the comment.
After the modification:
After the modification is finished, the PSD file must be compressed again in ZIP format.
Compress the PSD file with the other files that were extracted before the modification. The name and
extension of the compressed file must be the same as the PSZ file that was decompressed previously.
Replace the PSZ file in the drive package with the new PSZ file. If a folder containing decompressed files
exists in the driver package, delete it.
Note: Be sure to compress only the files back into the PSZ archive. If you have created a folder in which to
store the contents of the decompressed PSZ, please make sure that it is not accidentally compressed back
into the archive.
Zip these files.
Replace the existing PSZ file.
Delete this folder if it exists.
The operation is now complete.
30/46
Ricoh Company, Ltd.
driver”.
31/46
Ricoh Company, Ltd.
6-2.
The PCL6 driver for Universal Print’s PSD files
PCL6 driver for Universal Print contains a lot of PSD files. This is because the driver is intended for multiple
models. Each PSD file will list the model(s) for which it is intended. This can be seen in the “model”
element(s).
“model” element:
If you want to customize the PCL6 driver for Universal Print by modifying a PSD file, you have to find and
modify the PSD file of the model for which the driver is to be used. The following tables show which PSD file
is for which model.
In the tables, ‘ X ‘indicates a letter that represents the brand name:
G - Gestetner
I or i - infotec or InfoPrint
L - Lanier
N - NRG
R - Ricoh
S - Savin
One PSD file is sometimes used by several brands.
Examples: “MP6000_G_N_I.psd” (Gestetner, NRG, infotec), “SPC420_GN.psd” (Gestetner, NRG)
Table 6-1.
PSD file list - MFP (PCL6 driver for Universal Print v3.7.0.0)
Model
PSD file name
A-C4
3035_X.psd
A-C4.5
MP3500_X.psd
AL-C1
MP4000_X.psd
AL-C1.5
MP4001_X.psd
AP-C1
MPC350_X.psd
AP-C2
MPC4000_X.psd
AP-C2.5
MPC4501_X.psd
AT-C1
MPC250_X.psd
32/46
Ricoh Company, Ltd.
AT-C2
MP C2800_X.psd
AT-C2.5
MPC3001_X.psd
B-C3
MP9000_X.psd
B-C3.5
906EX_X.psd
DI-C1
MPC2050_X.psd
DI-C1.5
MPC2051_X.psd
DI-C1L
MPC2030_X.psd
J-C2
3235C_X.psd
K-C3
MP2000_X.psd
Katana-C2
Pro907EX_X.psd
MT-C2
2051_X.psd
MT-C3
MP5500_X.psd
MT-C3.5
MP6000_X.psd
MT-C4
AficioMP6001_X.psd
PG-C1
MPC1500_X.psd
PR-C1
MP2500_X.psd
R-C4
3025_X.psd
R-C4.5
MP2510_X.psd
R-C5
MP225_X.psd
R-C5.5
MP2851_X.psd
S-C3
MP161_X.psd
S-C4
MP171_X.psd
S-C4.5
MP201_X.psd
TH-C1
3224C_X.psd
V-C1
3260C_X.psd
V-C2
MPC6000_X.psd
V-C3
MPC6501_X.psd
Z-C1
MPC300_X.psd
Table 6-2.
PSD file list - LP (PCL6 driver for Universal Print v3.7.0.0)
Model
PSD file name
A-P4
SP8100_X.psd
AL-P1
SP8200_X.psd
AP-P1
SPC811_X.psd
AP-P2
SPC820DN_X.psd
AR-P2
CL3500N_X.psd
C-P2b/c
AP410N_X.psd
G-P1
CL4000DN_X.psd
G-P2
SPC410_X.psd
G-P2L
SPC400_X.psd
G-P3
SPC420_X.psd
J-P4
CL7200_X.psd
33/46
Ricoh Company, Ltd.
K-P4
AP610N_X.psd
Kr-P2
SP6330N_X.psd
MD-P2
SPC320DN_X.psd
MT-P1
AficioAP900_X.psd
MT-P2
SP9100_X.psd
SI-P1
SP4100_X.psd
SI-P1L
SP4100L_X.psd
SI-P2
SP4210N_X.psd
SI-P3
SP4310N_X.psd
Z-P1
SPC430DN_X.psd
Table 6-3.
PSD file list - Generic Model (PCL6 driver for Universal Print v3.7.0.0)
Model
PSD file name
Generic Model
RicohGeneric.psd
Note: Using the PCL6 driver for Universal Print, the wrong (unedited) PSD file could be applied to the driver.
This could happen in the following cases:
- The driver uses bi-directional communication and decides that the connected printer is not the model that
the customizations were made for.
- A model that the driver was not customized for is manually selected from the model drop-down list in the
driver’s Accessories tab.
Model drop-down list in the PCL6 driver for Universal Print:
34/46
Ricoh Company, Ltd.
6-3.
Extending the maximum length of the User ID
This customization extends the max. length of the User ID from 8 to 13 characters.
This is intended for use with SDK applications, such as Enhanced Locked Print (ELP), that accept User IDs of
more than 8 characters.
In the PSD file, the max. length of the User ID is defined as 8 by default. This can be changed to anything
from 9 to 13. This needs to be changed in 2 different places for each model supported by the PSD file.
Example:
The length of the User ID is extended to 13 characters for “Aficio SP C820DN”:
<psd version="1.0">
<model id="Aficio SP C820DN">
:
:
<item category="feature" name="userid" default="" type="string">
<string min="0" max="13" chartype="alphanumeric" required="no">
<constraint>
<condition expression="jobtype != normalprint"/>
</constraint>
</string>
<string min="1" max="13" chartype="alphanumeric" required="yes">
<constraint>
<condition expression="jobtype == normalprint"/>
</constraint>
</string>
</item>
:
:
</model>
<model id="Aficio SP C821DN">
:
:
Note: This will not change the message in the Details dialog: [Up to 8 alphanumeric…].
35/46
Ricoh Company, Ltd.
7.
Customizing PCL6 driver for Universal Print
The customizations described in section 5 “Modifying the RCF file” and section 6 “Modifying the PSD file”,
can also be performed on a PCL6 driver for Universal Print.
This section describes customizations that are exclusively for PCL6 driver for Universal Print:
- Change the default UI
- Perform automatic bidirectional communication when a logical printer (queue) is created
- Disable automatic bidirectional communication by default
7-1.
Changing the default UI
PCL6 driver for Universal Print changes its UI based on bi-directional communication with a device. If
bi-directional communication has not been established since the driver was first installed, the driver shows
the Model SI-P1 UI by default. The default UI can be changed by manually editing the file “ricaz0is.xml” in a
driver package.
Procedure:
Step 1. Prepare a set of driver files and locate “ricaz0is.xml”.
Step 2. Open “ricaz0is.xml” and add a comment to the file. This will serve as a reminder to you or others that
the file was modified, and what the purpose of the modification was. Comments can be added under the XML
declaration using the following format: 
“ricaz0is.xml” with comments:
36/46
Ricoh Company, Ltd.
Step 3. Change the name of the default model:
:
:
<registry key="UI_PRINTER_MODEL_NAME" value="Aficio SP 4110N" type="REG_SZ"/>
:
:
Example:
Make the UI of “Aficio MP 5000” default:
:
:
<registry key="UI_PRINTER_MODEL_NAME" value="Aficio MP 5000" type="REG_SZ"/>
:
:
Note1: There might be more than one line that contains “Aficio SP 4110N”. However, do not change any lines
other than the one shown above.
Note2: Model names in “ricaz0is.xml” should be exactly the same as one of those in the model drop-down list
in the Accessories tab, or in the PSD file (refer to section 6-2 “The PCL6 driver for Universal Print’s PSD
files”). Please note that some model names that start with ‘ I ‘, include a space before their names.
Model drop-down list in the PCL6 driver for Universal Print:
37/46
Ricoh Company, Ltd.
Model name in a PSD file (“model” element):
Step 4. Save the modified file back to its original location.
The customization is now complete.
If the default driver settings also need to be changed, please perform the customization described in section
5-2 “Changing the default driver settings” using the driver customized in this section.
driver”.
38/46
Ricoh Company, Ltd.
7-2.
Performing bidirectional communication when a logical printer is created
This customization makes the PCL6 driver for Universal Print try to establish bidirectional communication
when a logical printer (queue) is created. This can only be done with v2.3.0.0 or later. The customization is
accomplished by applying format 8 below to the RCF file in the driver package. It can be used in combination
with any of the customizations described in section 5 “Modifying the RCF file”.
7-2-1. Format 8: Performing automatic bidirectional communication when a logical printer is
created
<rcf version="1.0">
<updatewithbidi timing="install" value="on"/>
</rcf>
39/46
Ricoh Company, Ltd.
7-3.
Disabling automatic bidirectional communication by default
PCL6 driver for Universal Print v3.3.0.0 or later have a setting called “Automatically Update Printer
Information” in Printer Properties. This setting can be used to enable (default) or disable automatic
bidirectional communication. By default, automatic bidirectional communication is performed each time the
printer's properties or Printing Preferences are open.
“Automatically Update Printer Information” setting:
By modifying the RCF file in the driver package, the “Automatically Update Printer Information” setting can be
unchecked by default. Please follow the procedure written in section 5-2 “Changing the default driver
settings”. Or, manually use format 9 below. This customization can be used in combination with any of the
customizations described in section 5 “Modifying the RCF file”.
7-3-1. Format 9: Disabling “Automatically Update Printer Information” by default
<rcf version="1.0">
<devicesettings drivername="any" independent="yes">
<item name="autoupdateprinterinfo" value="off"/>
</devicesettings>
</rcf>
Note1: PrinterSwitcher is designed based on the assumption that the universal drivers perform automatic
bidirectional communication. If a customer uses PrinterSwitcher, do not disable automatic bidirectional
40/46
Ricoh Company, Ltd.
communication.
Note2: The “Automatically Update Printer Information” checkbox cannot be locked to either state (checked or
unchecked).
41/46
Ricoh Company, Ltd.
8.
Installing the customized driver
There are no special requirements. The customized driver can be installed as would an ordinary driver.
However, because the customization will cause the driver to lose its Microsoft logo certification, an alert
message might be displayed during installation.
Note: On Windows Vista/7/2008/2008R2, if a driver of the same model and PDL as the customized driver has
already been installed, it must be uninstalled before the customized driver is installed.
If there is a syntax error in any of the RCF, PSD or XML files, the following will happen:
RCF:
If an XML element, attribute, or setting is mistyped, the driver will be installed but settings affected by the
typing mistake will not be customized. If the file does not conform to the XML format, all modifications will be
ignored and the driver will be installed as a standard driver.
PSD, XML:
If there is any sort of syntax error caused by the modification, an error will be thrown during the creation of a
logical printer. If this happens, no logical printer will be created.
Tip: Creating multiple logical printers (queues) with different default/customized settings
Multiple logical printers of the same model and PDL but different default/customized settings, can coexist on
Windows 2000/XP/2003. This can be useful, for example, in the following situation:
A customer wants 2 logical printers of the same model to reside on the same server. One is a logical
printer that has standard settings. The other is a logical printer whose color mode is locked to “Black and
White”.
This is done for Point and Print. They want to use the Windows ACL to restrict users who can print in color.
To do this, prepare multiple drivers of the same model and PDL with different default/customized settings.
Then, create logical printers using them. There are 2 points to remember.
1. When the second logical printer is created, choose “Replace existing driver” during installation. If using
printui.dll, do not use the “/u” option.
42/46
Ricoh Company, Ltd.
2. The order in which multiple logical printers are created must be considered. If a logical printer is created
and then another is created using a driver with an RCF, PSD or XML file that has an earlier “modified” date
than that of the first driver, the second logical printer will inherit the settings of the first one. To avoid this
problem, be sure to always use a driver with RCF, PSD and XML files that have a later “modified” date than
the driver that was installed before. If necessary, update the “modified” date of the RCF, PSD or XML files.
Note: On Windows Vista/7/2008/2008R2, logical printers of the same model and PDL with different
default/customized settings cannot coexist. The second logical printer will inherit the settings of the first one.
43/46
Ricoh Company, Ltd.
9.
9-1.
Appendix
Distinguishing whether a driver has been customized or not
If either the RCF or PSD file was modified, it can be seen in the About window:
Note: Modification of the XML file will not change the contents of the About window.
Another way to tell is the location to which the driver is installed. When a KIM core based PCL driver is
installed, the RCF and XML files will be written to the following folder.
x86 Windows:
%SYSTEMROOT%\system32\spool\drivers\w32x86\3
x64 Windows:
%SYSTEMROOT%\system32\spool\drivers\x64\3
If the RCF or XML files in the above folder are different from the original RCF and XML files, the driver might
have been customized. The PSD file will also be copied to the above folder. However, it is compressed as the
PSZ file. To check if the PSD file was modified, it must be extracted from the PSZ file using a ZIP utility.
44/46
Ricoh Company, Ltd.
9-2.
Determining which core is used by a PCL driver
The About window shows which core is used by a PCL driver.
KIM core (the basis of this document):
UI CORE Version: Less than 2.0.0.0
GR CORE Version: Less than 2.0.0.0
Exception: The PCL6 driver for Universal Print v2.0.0.0 shows the UI CORE and GR CORE versions as
“2.0.0.0”, but the core is KIM.
This document does not apply to any of the following cores:
SWI core:
MTI core:
45/46
Ricoh Company, Ltd.
YAPD1.0 core:
YAPD2.0 core:
UI CORE Version: 2.0.0.0 or later
UI CORE Version: 3.0.0.0 or later
GR CORE Version: 2.0.0.0 or later
GR CORE Version: 3.0.0.0 or later
Exception: The PCL6 driver for Universal Print v2.0.0.0 shows the UI CORE and GR CORE versions as
“2.0.0.0”, but the core is KIM.
Note: The About windows of KIM and YAPD1.0/2.0 core drivers are very similar. The biggest difference
between these drivers is that a YAPD1.0/2.0 core driver has a new UI called “AIRFace”.
YAPD1.0/2.0 core driver (AIRFace):
46/46
Ricoh Company, Ltd.