background image

Xerox PrinterMap

 

Enterprise Printer Platform

 

 

Version 1.3

 

User Guide for Windows NT and Windows 
95/98 

Summary of Contents for DocuPrint N4025

Page 1: ...Xerox PrinterMap Enterprise Printer Platform Version 1 3 User Guide for Windows NT and Windows 95 98...

Page 2: ...displayed on the screen such as styles templates icons screen displays looks etc XEROX The Document Company the stylized X and CentreWare DP are trademarks of Xerox Corporation or its subsidiaries Lex...

Page 3: ...s Guide xi Conventions Guide xi Mouse Conventions xii Related Reading xii Workstation Requirements xii Hardware xii Software xii Memory Requirements xii Projecting Hard Disk Requirements xii Projectin...

Page 4: ...arm 14 Status 16 Application Paths 16 Reporting 18 PrinterMap Shutdown 20 Chapter 3 Discover Process 2 1 Overview 22 Discover Configuration 22 IP 23 IPX 24 Community Strings 25 Operation 27 Advanced C...

Page 5: ...d Reporting 5 6 Service Overview 57 Memory Requirements 57 Stopping and Re starting Polling Tasks 57 Status Function 59 Overview 59 Operation 59 Icon Colors 60 Reporting Function 60 Reporting Service...

Page 6: ...g Received in Alarm Log Window 81 Alarm Reads Invalid Alarm Value from Printer 81 No Pop ups or Application Launches Occurring 81 Reporting Problems 82 Standard Reporting Reports 82 Error Messages 82...

Page 7: ...rogress window 29 Figure 18 Discover Complete dialog 29 Figure 19 PrinterMap Topology window 35 Figure 20 Add Printer window 37 Figure 21 Update Printer Information window 38 Figure 22 Create Group wi...

Page 8: ...viii Figure 41 Impending Loss of Information window 70 Figure 42 Upcoming Loss of Information Details window 70 Figure 43 Individual Printer Alarms window 73 Figure 44 Alarm Log window 75 Figure 45 A...

Page 9: ...e 3 Default SNMP Time out Values 33 Table 4 Toolbar Icons 43 Table 5 Attribute List 44 Table 6 Predefined Groups 46 Table 7 Printer Icons 47 Table 8 Printer Status to Icon Color Mapping 48 Table 9 Pri...

Page 10: ...user guide details the installation configuration administration and operation of Xerox PrinterMap Working knowledge of your network environment infrastructure and the operating system of the client w...

Page 11: ...uide is designed as a tool for the following personnel System Administrators Network Technical Support Personnel Conventions Guide The following table explains the typographic conventions used in this...

Page 12: ...rox CentreWare DP 2 HP JetAdmin 3 Lexmark MarkVision 4 Tektronix PhaserShare 5 Olivetti Workstation Requirements Hardware 1 Pentium or higher processor 2 9 Mb of Hard Disk for program files 3 32 Mb of...

Page 13: ...an example of Discover process time The System Administrator chooses to discover network printers through a local range of IP addresses This range contains 35 entries of which 6 are printers Discover...

Page 14: ...for hrDeviceType MIB value 154 additional queries for SysObjID to determine devices are not printers Step 2 Poll Who makes this printer 100 SNMP queries for SysObjID MIB value for printer s SysObjID S...

Page 15: ...er traffic totals 3 548 queries X 400 bytes 1 419 200 bytes 1 4mb 100 SNMP queries for hrDeviceStatus MIB value Device Status per hour 100 SNMP queries for prtMarkerLifeCount MIB value Lifetime Impres...

Page 16: ...ls you can expect approximately 640 kb of traffic per hour on your network from PrinterMap This traffic can be more than offset by proactively fixing parameters before several users send multiple jobs...

Page 17: ...ss to status and report information for every SNMP enabled enterprise network printer PrinterMap provides Single View Topology Single focal point for managing SNMP MIB printers in local and remote net...

Page 18: ...as Microsoft Excel or Lotus 1 2 3 Printer Management Application Launch Launch Hewlett Packard s JetAdmin Lexmark s MarkVision Tektronix PhaserShare and Xerox CentreWare DP Launch printer embedded we...

Page 19: ...ate information Once PrinterMap is installed these processes run in the background gathering printer information whether the PrinterMap Topology window is active or inactive Both processes display on...

Page 20: ...on database This database is used by PrinterMap for displaying printers and printer status in the main topology window PrinterMap s Report function configures how often printer report data is collecte...

Page 21: ...nt application PrinterMap s Status function allows configuration of how often printer status and alarm information is collected It also polls printers for status and alarm information at the configure...

Page 22: ...e 6 Chapter 2 Getting Started This chapter covers the following topics Installing PrinterMap Starting PrinterMap Configuring PrinterMap Running the PrinterMap discover process for the first time Shutt...

Page 23: ...ess progress A welcome screen is displayed when the process is complete During the installation process select Back at any time to go to the previous screen 4 The welcome screen gives opportunity to c...

Page 24: ...ying PrinterMap files During this time the Xerox PrinterMap program group is created and populated with PrinterMap PrinterMap Reporting PrinterMap Services PrinterMap Status PrinterMap Readme Uninstal...

Page 25: ...e all PrinterMap processes including the Status and Reporting services Refer to PrinterMap Shutdown in Chapter 2 for more information on shutting down PrinterMap PrinterMap Uninstall To uninstall Prin...

Page 26: ...w box is unchecked Select the OK button to continue The PrinterMap Configuration window is displayed At minimum PrinterMap requires the user to define discover parameters The discover parameters speci...

Page 27: ...Discovery Required window Running the Discover process is a prerequisite to managing network printers Figure 3 Discovery Required window Selecting the Yes button automatically starts the PrinterMap D...

Page 28: ...certain functions PrinterMap s Configuration window provides an intuitive interface for setting these parameters To access the PrinterMap Configuration window select File Configuration from the main m...

Page 29: ...Discover process does not run nor is it able to discover network printers without user configuration Figure 4 PrinterMap Configuration window Configuration Window Panels This section contains Configu...

Page 30: ...s rule One is when the PrinterMap graphical user interface topology is restarted The other is when the Status Service is restarted In both cases all detected alarm conditions takes the configured acti...

Page 31: ...printer issued the alarm and the alarm type Select the OK button to close this window NOTE When configuring PrinterMap be certain to generate alarm pop up notifications Each Pop up window uses system...

Page 32: ...status polling frequency in the Configuration window Status panel assures change takes place immediately Any change triggers a new status poll and the new polling interval becomes active Application...

Page 33: ...erMap only searches for these applications in a default installation location If the application is installed in a directory other than default the Browse button manually locates and fills in the path...

Page 34: ...n window This allows enabling or disabling of PrinterMap s Reporting functionality The disable function may be deleted if PrinterMap is used solely as a status manager for printers or if it cannot mee...

Page 35: ...12 00 a m and 12 00 p m all reports generated between 12 00 a m and 12 00 p m relies on the 12 00 a m poll for information If a report is generated for 1 00 a m to 3 00 a m and then from 4 00 a m to 1...

Page 36: ...95 98 service tray An icon appears if the particular service is currently active 2 Right click the icon for the PrinterMap service being terminated and select the Stop Status Service or Stop Reportin...

Page 37: ...his chapter describes PrinterMap s discover process in detail The discover process collects information from the SNMP enabled network printer s on the user s network This chapter covers configuring th...

Page 38: ...ate icon Depending on the support level of the discovered printer PrinterMap associates the printer with an icon indicating its status vendor and model type Discover Configuration NOTE PrinterMap is o...

Page 39: ...k values the discover process systematically checks all IP addresses within the specified subnet For example if there is a class C network and the local machine s IP address is 12 13 12 67 with a subn...

Page 40: ...allowed to re build In some networks this arp cache purge occurs every few seconds To use the arp cache to discover networked printers ensure that the target router is configured with a reasonable am...

Page 41: ...d If the Ignore Hops check box is selected the Hops value is ignored All network printers known by the currently configured NetWare server are discovered regardless of the network where the printers r...

Page 42: ...hrough the Community Strings window Valid community strings are required by the Status and Reporting services in order to communicate and retrieve information from managed printers The discover proces...

Page 43: ...e amount of disk space available This window also indicates the total number of printers currently managed by PrinterMap and the amount of disk space consumed by the reporting data files Figure 15 Ava...

Page 44: ...displays an activity meter as well as the current state of the discover such as the IP address range it is currently querying The discover process may be cancelled at any time The application window...

Page 45: ...n representing that object changes colors This occurs at the time of the next status poll to reflect the change in status If PrinterMap is unable to determine the status of a network printer the print...

Page 46: ...ed printer manufacturers or vendors The set of supported vendors cannot be extended by the user Future PrinterMap versions will support an ever increasing number of printer vendors PrinterMap is shipp...

Page 47: ...owser to view the printer s MIB II System values Using a text editor find the vendor portion of the Mib ini file to be modified Next update the number entry under the vendor block identifier field wit...

Page 48: ...xer_n24_normal ico xer_n24_green ico xer _n24_blue ico xer_n24_yell ico xer_n24_red ico DocuPrint N32 model5 1 3 6 1 4 1 253 8 62 1 3 2 1 1 xer_n32_normal ico xer_n32_green ico xer _n32_blue ico xer_n...

Page 49: ...stituted Using a text editor find the xerox_models section of the Pmap ini file Next update the number entry under the xerox_models section header with the total number of model statements after the P...

Page 50: ...PrinterMap s user interface The PrinterMap Topology window provides a graphical representation of the user s network printers and access to a variety of useful information for managing those printers...

Page 51: ...inter s display name This can be changed so a printer s IP host name is used Please refer to item 10 of this list Default Display Name for more information on changing the default display name setting...

Page 52: ...display name selection controls which value PrinterMap displays for the name of a managed printer The possible values for default display names are System Name and Host Name System name refers to the...

Page 53: ...ure 20 Add Printer window To add a printer select Topology Add Printer from the main menu and enter the printer s IP or IPX address in the Add Printer text box After selecting the OK button PrinterMap...

Page 54: ...a PrinterMap upgrade installation For example PrinterMap v1 0 only maintained information on the first five media input sources paper trays PrinterMap v1 1 maintains up to ten media input sources Run...

Page 55: ...x and continuing with the update causes PrinterMap to update the host name value stored for each printer In an environment where one or more Domain Name Servers DNS are used for IP address to host nam...

Page 56: ...deleted This menu item is grayed out when the focus if the printers cannot be added to a user defined group To copy the selected printer to an existing group highlight the printer or printers then sel...

Page 57: ...intending to remove it completely from PrinterMap Printers may not be removed from any pre defined vendor groups The Remove Printer s from Group menu item is grayed out if Topology is currently focuse...

Page 58: ...rinter management applications Supported vendors and their default management application products is listed as follows These are only the defaults The default management application for each vendor m...

Page 59: ...rinterMap s About window Toolbar PrinterMap functionality can be accessed via the Toolbar located directly under the main menu Table 4 Toolbar Icons Change Configuration Selecting this button summons...

Page 60: ...utes when sorting is enabled highlight the printer s by selecting them before changing attributes This provides a visual cue about the new topological printer location The Attributes list box allows p...

Page 61: ...nters with multiple cartridges an average toner percentage is determined Values of and some are given a percentage of 0 and 1 Paper Level Paper amount remaining in printer s input sources paper trays...

Page 62: ...n causes the operating system to display more truncated information Use the Printer Properties window to view all attributes for each printer The Groups listing area contains all predefined and user d...

Page 63: ...rox Printers Printers manufactured by Xerox are represented by a model specific icon image if PrinterMap has an icon for that model If not a generic Xerox icon is used The DocuPrint N32 icon is shown...

Page 64: ...ce requested are all printer alarm examples detected by PrinterMap A printer can have multiple alarm conditions set at any given time In the event of several alarm conditions the printer icon s color...

Page 65: ...licking on a particular printer or by selecting the Show Properties menu item on the printer icon s right click menu Figure 27 Printer Properties window The first section of the Properties window list...

Page 66: ...this manner cannot be canceled by canceling the Properties window Select Cancel to dismiss the window without making any changes NOTE Serial numbers and serial number manipulation are available only...

Page 67: ...from the All Printers group it is removed from all printer groups and all the printer s associated data attribute information and reporting data files are deleted Generate reports before deleting a p...

Page 68: ...iewing Alarms in Chapter 6 for more information on viewing printer alarms Selecting this menu item displays the Printer Properties window for the selected printer Refer to Printer Properties Window in...

Page 69: ...t application is configured for the printer s vendor If so PrinterMap adds the appropriate management application path to the printer s management applications list if the printer is not HTTP enabled...

Page 70: ...any other pre defined groups it belongs to If however a printer is removed from the All Printer group the printer is removed from all printer groups where it is a member and all its associated data at...

Page 71: ...at group accesses its Group Right Click menu Figure 34 Group Right Click menu Selecting this menu option deletes the selected group Selecting this menu option creates a new group containing the select...

Page 72: ...d selection mode Multiple printers are selected in any of the following ways Holding down the Ctrl key left click on several printers one at a time until all desired printers are selected Holding down...

Page 73: ...ring PrinterMap in Chapter 2 for more information on configuring the Status and Reporting services Memory Requirements The Status and Reporting Service occupy approximately 2 5MB of RAM each Stopping...

Page 74: ...rvice button to restart service 3 Select the Exit button to close the Service Control window The following steps terminate the Status and Reporting services on Windows 95 98 1 Right click on the Print...

Page 75: ...printer window The Status Service detects and records printer alarms and takes action on alarms as defined in the Configuration window Alarm panel Refer to Alarms in Cahpter 6 for alarm information a...

Page 76: ...operating during hard drive updates If this occurs temporarily stop the Reporting and Status services until defragmenting is completed Icon Colors In the Topology window each printer is represented by...

Page 77: ...enerate reports NOTE PrinterMap services write printer information to the hard drive during polling operations Norton Speed Disk and other disk defragmenting tools may have difficulty operating during...

Page 78: ...sses the Verify Disabling Reporting window Figure 37 Verify Disabling Reporting Option window This window informs about the consequences of disabling the reporting function After confirmation PrinterM...

Page 79: ...led Re enable the Reporting Option only if it was previously disabled The Reporting Option can be enabled at any time However please refer to Projecting Hard Disk Requirements on page ix of the Prefac...

Page 80: ...hourly then a standard report contains an entry for every hour within the report generation time parameters defined by the user provided the reporting data printer file has data stored for each hour I...

Page 81: ...To parameters are set selecting the Show Report button initiates the report generation process At the completion of the report generation process a Report window is displayed The report window title...

Page 82: ...se and spreadsheet packages When importing a PrinterMap report file to a third party package identify the report as having comma delimited fields NOTE Microsoft Excel may remove leading zeros from the...

Page 83: ...te displays the toner percentage remaining in each toner cartridge A printer may not provide enough information for PrinterMap to display a toner percentage Toner level values are then expressed as so...

Page 84: ...displays the printer s MAC address Model This attribute displays the model number of the printer and is only optional for group reports Vendor Name This attribute displays the name of the printer s m...

Page 85: ...rinterMap stores up to two years of reporting data in individual printer files in the Drive Install Directory Data Accinfo directory At the end of the second year PrinterMap removes all data from the...

Page 86: ...1st unless the Keep Showing This Warning box is unselected The Details button accesses a window providing details about the impending data deletion For this window current polling selections are used...

Page 87: ...PrinterMap User Guide 71...

Page 88: ...ditions that constitute a printer alarm how to view alarms for a particular printer or the alarm log and how to configure automatic responses to alarms Detecting printer status and corresponding alarm...

Page 89: ...l detected printer alarms to the alarm history log Refer to Alarms in Chapter 2 for more details Viewing Alarms Printer alarms detected by PrinterMap may be viewed in two different ways An individual...

Page 90: ...al Red Offline Critical Red Unknown Critical Red If PrinterMap is unable to determine the cause of an alarm condition Invalid Alarm Type is displayed NOTE A printer s status on the topology and relate...

Page 91: ...s is Drive Install Directory reports Print Prints contents of the alarm log The default printing orientation is Landscape All entries are printed Refresh Refreshes alarm log data displayed in the wind...

Page 92: ...y a time stamp Adding text is not required In this case only the date and time stamp is displayed under the Comment heading Selecting multiple alarm records and the Acknowledge button assigns a single...

Page 93: ...is chapter for basic troubleshooting suggestions when experiencing operational problems with PrinterMap This chapter explores troubleshooting techniques for the following areas Log Files and Debug Fun...

Page 94: ...eter Process Log Files Topology Main PrinterMap application pmap log topology log Discover Discover process pmap log discover log Status Status polling process pmap log status log Reporting Report pol...

Page 95: ...y the date time of occurrence and name of the generated process Maximum log file size can also be specified in the logfile parameter of the Drive Install Directory pmap ini file Default measured in ki...

Page 96: ...scover is re attempted the log file Drive Install Directory discover log contains more information If a particular printer is not discovered try the following 1 Verify that a response is received from...

Page 97: ...ately updates printer status if a change is recognized If the icon changes color check the Status panel of the Configuration window to ensure the poll rate is set to a frequency matching expectations...

Page 98: ...Unable to open file Drive Install Directory data accinfo nnnnnnnnnnn zzz where nnnnnnnnnnnn represents a physical address and zzz represents a 3 letter vendor code This occurs when starting the Printe...

Page 99: ...value Return code from failing function Description Function 1detected that function 2 did not successfully complete An error code integer value is returned System Action Function dependent User Acti...

Page 100: ...with return code value Variables function 1 Failing function value Return code from failing function Description Function 1 failed and an error code is returned System Action Function dependent User A...

Page 101: ...endent User Action Check to be sure the directory exists Check to see if the file exists if it is supposed to Check permissions on the file Text Unable to open group file filename Variables filename G...

Page 102: ...s the PrinterMap process detecting this condition is terminated User Action Check to be sure the Drive Install Directory mib ini file exists Check permissions on the file Text Unable to retrieve maxim...

Page 103: ...key key Variables section Section heading in pmap ini file section key Name for a value within the section Description PrinterMap is unable to find the key value in the specified section System Action...

Page 104: ...function Printer information files are currently locked Variables function Function trying to write to printer information file Description PrinterMap cannot write to a printer information file becaus...

Page 105: ...semaphore System Action Specified process terminates User Action Review the PrinterMap log for information related to the failure cause Text process already running second instance not started Variab...

Page 106: ...PrinterMap discover process successfully completed System Action None User Action None Text License key retrieval failed only Xerox printers are discovered Variables None Description Because the Disc...

Page 107: ...p_get_local_timeout default value is 400ms snmp_get_remote_timeout default value is 1000ms snmp_set_timeout default value is 20s User Action Verify the pmap ini file exists and that the entries mentio...

Page 108: ...ntinue System Action Discover process terminates User Action Verify the PrinterMap discover process is configured correctly and or the local machine is properly configured for the desired discover typ...

Page 109: ...ecified in the user s guide are adequate NOTE Routers may be configured to only maintain IP addresses in their ARP cache for a very short time This can adversely affect the PrinterMap discover process...

Page 110: ...ny errors System Action None User Action Verify the specified IP address range does have SNMP capable network printers which should have been discovered Use the ping command from a DOS prompt to verif...

Page 111: ...must be installed in order to perform IPX discover Variables None Description Discover process is unable to initialize the Novell NetWare API which is necessary to perform an IPX discover System Acti...

Page 112: ...preferred server name is configured on the PrinterMap discover configuration panel and that Novell s Client32 software is installed and operational Text Unable to terminate Netware API return code val...

Page 113: ...d an invalid IP address System Action Discover process terminates User Action Correct invalid IP address by replacing it with an IP address of the proper format For example 208 207 96 4 Text IP addres...

Page 114: ...ion None User Action Correct invalid IP address by replacing it with an IP address of the proper format as specified here For example 208 207 96 4 Text Unable to retrieve subnet mask for router ip_add...

Page 115: ...currently configured report polling interval This results in missing reporting data and incomplete PrinterMap reports System Action Next report poll starts when the current one is complete User Actio...

Page 116: ...og for accompanying error messages indicating the cause of error and takes corrective action Text PrinterMap Reporting service terminating due to user request Variables None Description The Reporting...

Page 117: ...em Action Attempt to install service is terminated User Action Review information in ErrorReason Verify that all PrinterMap programs are correctly installed Text process installed Variables process Na...

Page 118: ...in ErrorReason Additional technical assistance is required Text Stopping process Variables process Name of PrinterMap service process Description Attempting to stop the service process System Action...

Page 119: ...s is removed from the list of services controlled by the Service Control Manager System Action None User Action This normally occurs in context of disabling the Reporting Option Text DeleteService fai...

Page 120: ...l PrinterMap directories exist as installed Text Stopping creation of Reporting data files after limit of number files processed Attempting to process more than this limit Variables number is the numb...

Page 121: ...mber is the number of files created Description Enabling of the Reporting Option is requested and accomplished The number of created reporting data files is provided System Action None User Action Non...

Page 122: ...ata files after limit of number files processed Attempting to process more than this limit Variables number is the number of files expected to be processed Description The user requested that the Repo...

Page 123: ...on None User Action None PrinterMap Alarm Log Messages Text Old version of alarm log file found Proceeding to convert Variables None Description Alarm log file format not compatible with current Print...

Page 124: ...contents of the alarm log file User Action Rename the temporary newalarm log to alarm log Text Unable to remove the path file for re writing Variables path Path of alarm log file used by PrinterMap D...

Page 125: ...current PrinterMap version System Action PrinterMap attempts converting the file format User Action None PrinterMap Status Service Messages Text Status poll cycle takes longer than configured polling...

Page 126: ...Action Restart the Status service when it is desirable to begin monitoring printer status and data dynamically Text PrinterMap Status exiting poll_interval is set to None Variables None Description T...

Page 127: ...Reason System returned error message Description Attempt to install a service failed The reason for the failure is found in ErrorReason System Action Attempt to install service is terminated User Acti...

Page 128: ...topped Variables process Name of PrinterMap service process Description The service process is stopped System Action Continue with other processing in the context of the stop service request User Acti...

Page 129: ...or message Description Attempt to remove a service from the Service Control Manager failed The reason for the failure is found in ErrorReason System Action Attempt to remove service is terminated User...

Reviews: