Dell OpenManage Printer Essentials User’s Guide Regulatory model: BEL01 Regulatory type: BEL01001
NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION ind icates potential damage to hardware or loss of data if instructions are not followed. WARNING: A warning ind icates a potential for property damage, personal injury, or death. 2016 Dell Technologies. All rights reserved.
Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . 9 Key features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 OMPE architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Product support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 License management . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Activating license online . . . . . . . .
Printer group selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Changing the column position. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Filtering a list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Filtering a list column . . . . . . . . . . . . . . . . . . . . . . . . .
Printer operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Blocking a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Unblocking a blocked printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Deleting a printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Exporting printer data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing a map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Deleting a map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 8 Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Updating firmware from Dell Cloud Connect . . . .53 Updating firmware manually . . . . . . . . . . . . . . . . . . . 54 9 Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Adding a policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11 Templates . . . . . . . . . . . . . . . . . . . . . . . . 65 Updating a template. . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Using custom templates . . . . . . . . . . . . . . . . . . . . . . . 66 Deleting a template . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Activating a template . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Deactivating a template . . . . . . . . . . . . . . . . . . . . . . . 67 12 Schedules . . . . . . . . . . . . . . . . . . . . . . . .
Ordering consumables . . . . . . . . . . . . . . . . . . . . . . . . 78 Configuring an alert . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 15 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 80 SMTP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Changing proxy settings . . . . . . . . . . . . . . . . . . . . . . . 80 Configuring ADS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Customizing preferences . . . . . . . . . . . . . . . . . . . . .
18 Database Cleanup . . . . . . . . . . . . . . . . . 89 Cleaning the database once . . . . . . . . . . . . . . . . . . . . 89 Scheduling monthly database cleanup . . . . . . . . . . 90 Deleting a database cleanup schedule . . . . . . . . . . 90 19 Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Exporting logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 20 Troubleshooting . . . . . . . . . . . . . . . . . . 92 21 Frequently Asked Questions. . . . . . . .
Appendix A: Trouble Ticketing system configuration for alerts in OMPE . . . . . . . . 100 Appendix B: Template Components . . 101 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 Introduction Dell OpenManage™ Printer Essentials (OMPE) is a state-of-the-art printer management software, with light-weight architecture. Its easy-to-use modern web interface provides all the features essential for effective printer management in a corporate network. With OMPE, administrators can easily manage and monitor both Dell and nonDell printers. OMPE provides complete status information of the printer fleet with a friendly and organized user interface.
Updating printer firmware - Printer firmware for all printers in the fleet can be updated at the same time. Scheduling - Printer management tasks can be executed without user intervention using the schedule feature. Sending alert emails - OMPE can be configured to notify administrators about printer centric events by sending alert emails. Setting policies - The configuration settings for all printers of a particular model can be simultaneously monitored or configured by enforcing policies.
IPv4 LAN Network Workstation Printers Personal Computer Tablet Rich browser UI SNMP / EWS OMPE Server ADS Server SMTP Dell Cloud Connect Server Product support For more information, check the Dell support website at http://www.dell.com/support. Online help OMPE online Help provides detailed information about using the software for managing your printer fleet. To display the online help window, click in Title bar menu and click Online Help.
License management After the initial installation of the software, you can use a 30 day trial of the full featured version of OMPE. To use a fully licensed version, a permanent license for OMPE can be easily obtained by providing the customer information to Dell. On license requisition, you will receive an activation key to activate the OMPE license. OMPE license activation is done in the Get License widget. To open the Get License widget: From the Login window, click Click to Activate License.
6. Click ACTIVATE. NOTE: Please ensure that your system’s SMTP settings are correctly setup for Dell to receive the activation request. For more information, see SMTP configuration.
2 Getting Started OMPE is installed using the OMPE installer package available in the Dell website. The installer package is equipped with all the prerequisites including templates for supported printer models. The installer package can also upgrade from OMPMv2. The OMPE installer package installs Java as a prerequisite prior to installation. OMPE uses port 80 or 8080 for web interface. Installing OMPE 1. From support.dell.com, navigate to Printers OpenManage Printer Essentials.
12. If you setup ADS, you can use windows credentials to log in to OMPE using Single Sign-On. To configure Single Sign-On, see Setting up Single Sign-On. 13. Select HTTP Port as 80 or 8080. 14. To create a desktop shortcut, select Create Desktop Shortcut. 15. Click Next. 16. By default, a user with administrator privileges is configured with user name admin. Enter a valid password in the Password field. 17. Reenter the password in the Confirm Password field. 18. Click Next. 19.
20. To update all discovered printers from OMPMv2 to OMPE, select Yes. Else select No. 21. Click Next. 22. To review or change any installation settings, click Back. 23. Click Install. The Setup Status window displays the status of OMPE installation in a progress bar. NOTE: The normal installation time is approximately five minutes. 24. On successful installation, InstallShield displays a message indicating installation is complete.
25. To launch OMPE immediately, select the check box. 26. Click Finish. Setting up ADS You can use Active Directory Service (ADS) to authenticate and authorize users to log in to the OMPE server using their system credentials. 1. In the ADS configuration window, select Use Active Directory LDAP Authentication. NOTE: Active Directory Service uses Lightweight Directory Access Protocol (LDAP) for authentication. 2.
On successful configuration of ADS, the installer continues with configuring Single Sign-On. Setting up Single Sign-On Using the Single Sign-On feature, an Active Directory user can log in to OMPE using the windows credentials. NOTE: Single Sign-On can be set up only at the installation stage. 1. During installation, complete Active Directory Service (ADS) Configuration and click Next. NOTE: Active Directory Service (ADS) must be configured before proceeding with Single Sign-On configuration. 2.
2. Enter a valid username and password. 3. For OMPE to remember your username and password, select Remember me. 4. If you want to log in using Single Sign-On, select Use Windows login credentials. NOTE: If you have not configured Single Sign-On during installation, this check box will not be visible. NOTE: This feature is supported on IE, Chrome, Mozilla Firefox and Edge web browsers. The check box to use Windows login credentials will not be visible in other web browsers. 5.
8. Click Log In. NOTE: If an activation key is entered, the warning message is not displayed during subsequent login. NOTE: The host name-IP address mapping entry must be added to the hosts file on Windows machine. Uninstalling OMPE You can uninstall OMPE from the Start menu or using Add/Remove Programs in the Control Panel. To uninstall from the Start menu: Click Start All Programs Dell Printers OMPE Uninstall While uninstalling, OMPE prompts for database retention.
The OMPE user interface consists of the following basic elements: 1 4 3 2 5 6 1 2 3 Title bar Navigation pane Workspace window 4 5 6 Title bar menu Quick-launch toolbar Action menu Title bar The title bar displays the OMPE title which consists of a menu with the following drop-down menu buttons: • - Displays the Notification widget that notifies status of important events and operations. For more information, see Notification widget.
Navigation pane All printer management operations supported by OMPE are organized in separate windows. A window is the main work area of OMPE where you can view and manage printers. To access various windows in OMPE, use the menu commands in the Navigation pane on the left side of the OMPE screen. The following table lists the various windows accessible from the Navigation pane and its functions: Menu command Description Home > Dashboard Provides an overview of printers in a dashboard.
Menu command Description Supplies Orders for consumables. Settings > * Preferences Configure the dashboard and printer list views and enable or disable printer data upload to Dell Print Metering. SMTP Configure SMTP settings. Proxy Configure the proxy settings for OMPE. Users Enables user account management. Cleanup Remove unwanted data history from the database. Backup Generate database backup.
Keyword search box - To search for a keyword in a list, enter the keyword in the search box provided on top of the list. Widget - Separate dialog boxes with editable fields to perform printer specific operations. Customizing Lists OMPE displays printer details in a list form for clarity and easy management. You can customize lists displayed in OMPE with simple list operations like search, sort, pagination and filtering.
Printer group selection To display the list of printers from a printer group, select the printer group from the group selection box on the top right corner of the list. Changing the column position To change the position of columns in a list, drag the column header to the required position. Sorting It is possible to sort a list based on the order of items in a single column.
Filtering a l ist column By filtering a column, the list displays only the rows with selected values in a column. 1. Click on the drop down arrow next to the column header. 2. Select Filter. 3. Select the condition for the filter in Show items with value that drop-down box. 4. Enter or select the filter value. 5. Click Filter.
3 Discovery Before Dell OpenManage Printer Essentials (OMPE) can manage network printers, it needs to discover the printers on the network. OMPE detects and identifies all printers connected to a network based on their IP address. After discovery, the printers are automatically placed in predefined groups and displayed in the printer status list. The details of all discovered printers are stored in OMPE database.
Discovery mode Description Subnet mask mode Discovers all printers across a subnet. For example, when IP address is 192.168.0.1 and subnet mask is 255.255.255.0, OMPE searches for printers in IP address ranging from 192.168.0.1 to 192.168.0.255. CSV import mode Discovers printers with IP addresses imported from a comma separated value file. It is the fastest way to discover multiple printers with a known IP address distributed across multiple subnets.
2. In the navigation pane, click Home Discovery. NOTE: If the estimated time taken for discovery exceeds 30 minutes, then a warning message is displayed indicating a potential delay and prompting the user to continue. The Discovery widget is displayed on the right side of the dashboard.
Authentication Algorithm - Select the required authentication protocol: (MD5) or Secure Hash Algorithm (SHA). Privacy Password - Enter a valid password used by the privacy protocol for message encryption and decryption. Confirm Password - Reenter the privacy password for confirmation. Privacy Algorithm - Select the required privacy protocol: Data Encryption Standard (DES) or Advanced Encryption Standard (AES). NOTE: Password should have a minimum of 8 characters and not exceed 255 characters.
8. For Subnet Mask mode, in the Discovery Mode Input(s) field, enter the IP address and Subnet Mask. 9. For CSV Import mode, in Discovery Mode Input(s), click Upload and select the .csv file to import. NOTE: You can create a CSV file for a set of printers by specifying the list of IP addresses in a comma separated list in ANSI text format and save it as.txt file. NOTE: A CSV file with the list of IP addresses cannot have any wildcard characters. 10.
Editing discovery profile You can modify the discovery settings of a saved discovery profile using this option. 1. In the Discovery widget, click Edit Discovery tab. 2. From the Select Discovery drop-down list, select the name of discovery profile to be changed. 3. Edit the profile settings as required. 4. Click Update. Deleting a d iscovery profile 1. In the Discovery widget, click Edit Discovery Profile tab. 2. From the Select Profile drop-down list, select the discovery profile to be deleted. 3.
4 Dashboard The Dashboard provides an overview of the printer parameters by displaying real time statistics of the printer fleet with the help of graphical charts. The Dashboard also provides information on the status of all ongoing and completed operations in the Notification widget on the right side of the dashboard. To view the dashboard: 1. Launch the Dell OpenManageTM Printer Essentials. 2. In the navigation pane, click Home Dashboard.
You can customize the dashboard to: • Change the position of the charts using drag-and-drop operation. • Select a chart to be hidden or displayed. • Select refresh interval for a chart. To customize the dashboard view, click Customizing dashboard view. .
In a column chart, to view the list of printers belonging to a column, click on the column. A pop-up displays a complete list of printers belonging to the column in the chart. The number of printers in the list is displayed above the chart name as shown below. NOTE: You can search for a printer within the list using the search bar in the pop-up. Changing dashboard chart settings You can change the chart settings using the action menu inside the dashboard chart. 1. From the chart action menu, click . 2.
Notification widget OMPE consists of several operations that are either system generated or initiated by the user. The Notification widget displays the status summary and progress of all OMPE operations. The status of the following OMPE operations are displayed as separate progress bars: • Discovery • Health Poll • EWS Poll • Status Poll (SNMP) • Internet Connection For an ongoing operation, the progress bar displays the estimated time required to complete the operation.
5 Printer List The Printer list view displays printer details in a list format with various parameters listed in separate columns. You can easily analyze and monitor printer details using list features like sorting, searching or filtering. Basic operations such as firmware upgrade, deleting a printer, copying printer configuration, printer blocking and exporting data are also available in the list view. To view the printer status list: 1. Launch the Dell OpenManageTM Printer Essentials. 2.
Status bar The status bar indicates the total number of printers in the network and the percentage of printers in each of the following states: • OK - Displayed in green indicates that the printers are in good health and in normal condition. • Warning - Displayed in orange indicates that at least one consumable is below the threshold or the printer operation panel displays a warning.
To modify parameters for a printer, in the printer details widget edit the fields required and click Apply. If the printer is assigned to a location in a map, to locate the printer on a map click Locate On Map. NOTE: Fields that cannot be modified in the printer details widget are in grey. Printer operations The printer list view also provides links to common printer operations that are discussed below.
A dialog box is displayed. 3. Click OK to confirm. NOTE: Blocked printers will be moved to All Blocked Printers group. For more information, see Groups. Unblocking a blocked printer OMPE will resume to retrieve status parameters from a blocked printer when you unblock the printer. 1. From the group selection box in the Printer list view, select All Blocked Printers group. 2. From the printer status list, select the printer(s). 3. From the action menu, click UNBLOCK. A dialog box is displayed. 4.
Updating firmware You can update firmware of one or more printers to its latest version from the Dell Cloud Connect server repository. NOTE: Firmware upgrade is performed only for Dell printers with available templates. 1. From the printer status list in the Printer list view, select the printer(s). NOTE: To select printers from a group, from the group selection box select the printer group. 2. From the action menu, click FIRMWARE UPGRADE. The Firmware Upgrade widget is displayed.
Copying configuration OMPE enables you to copy the configuration of a printer to one or more printers of the same printer model. CAUTION: Previous configuration of the printer will be lost on copying a new configuration. 1. From the printer status list in the Printer list view, select the printer(s). NOTE: To select printer(s) from a group, from the group selection box, select the printer group. 2. From the action menu, click COPY CONFIG. The Copy Configuration widget is displayed. 3.
5. Select the required schedule options for the selected frequency. • For Daily schedule, select the time from the Time drop-down list. • For Weekly schedule, select the day and time from the Day and Time drop-down lists. • For Monthly schedule, select the date and time from the Date and Time drop-down lists. 6. To add any notes, enter the notes in the Schedule Notes field. 7. From the Select Users list, select registered users who will receive the report through email. NOTE: This field is mandatory. 8.
6 Groups The Groups feature enables logical grouping of printers based on the printer characteristics. This helps administrators to perform several operations on multiple printers in a group at once. OMPE supports three types of printer groups: • System - Default groups pre-defined by OMPE. You cannot create, modify or delete system groups. • Manual Selection - Groups with no rules defined. You can add individual printers from the network to manual selection groups.
The Groups window displays a list of all available printer groups and its details. To view the list of printers present in a group, in the Name column click on the group name. Adding a group You can create both manual selection and rule based printer groups using this option. Add ing a manual selection group 1. From the action menu, click CREATE. The Create Group widget is displayed. 2. Select Manual Selection. 3. Click Next. 4. Enter a name for the group in the Enter the group name field. 5. Click Next.
An additional rule selection row is displayed. 11. Select the additional rule by repeating steps 7 to 10. NOTE: You can click to remove a rule. 12. Click Save. Printers satisfying the specified rules are displayed in the Groups > Create Group > Rule Based Selection window. 13. From the action menu, click SAVE. NOTE: To change the rule for a group, click Update Rule from the action menu. Editing a group You can modify printers in both manual selection and rule based groups by editing it.
All printers satisfying the defined rule are displayed in the Groups > Edit Group > Rule Based Selection window. NOTE: To change the rule, from the action menu click UPDATE RULE. 7. From the action menu, click SAVE. Deleting a group You can delete manual selection or rule based groups from the Groups window or Edit Group window. NOTE: When you delete a group, printers in the group are not deleted from the database. 1. From the group list in the Groups window, select the group. 2.
7 Maps Using the Map feature, location of network printers can be graphically represented on a map of the enterprise network. Maps reduce the time taken for troubleshooting because they help administrators to quickly identify the location of faulty printers. Using OMPE the user can upload a map and add printers to it. Printers are displayed as pins ( ) on a map. The pins ( ) indicate the printer’s location, updated health status and configuration. To open the Map window: 1.
Adding a map You can upload a map in JPEG, PNG or BMP formats to OMPE using this option. NOTE: If there are no maps uploaded to OMPE, only the add map button ( ) is enabled in the Map window. 1. In the navigation pane, click Maps. The Map window is displayed. 2. On the quick-access toolbar, click . The Add Map widget is displayed. 3. Enter a name for the map in the Name field. 4. To choose the map file that you want to upload, click Browse. 5. Click Save.
Add ing printers on the map Printers can be added to the map from the Select Printers list. 1. Drag the printer pins ( on the map. ) from the Select Printers list to relevant locations 2. From the action menu, click SAVE. NOTE: The Select Printers list displays only printer pins ( been added to the map. ) that have not Viewing printer details The Map window displays the map and the Select Printers list. To view the details of a printer on the map, place the mouse pointer on a printer pin ( ).
Clearing a map All printers marked on a map can be removed by clearing the map. 1. From the map selection drop-down list, enter or select the map name. 2. On the quick- access toolbar, click . NOTE: All printers are deleted from the map and the Select Printers list. Editing a map You can change the image file of an existing map using the Edit Map feature. 1. On the quick-access toolbar, click . The Edit Map widget is displayed. 2. Enter the map name in the Name field. 3.
8 Firmware The Firmware feature enables you to upgrade firmware for printers manufactured by Dell. OMPE enables firmware upgrade for printers from its repository. OMPE uses curl or lpr (Line Printer Remote) tool to upgrade printer firmware. You can also upgrade the firmware for a printer manually by uploading the firmware file. The firmware upgrade feature is also available from the printer list view in the Home window. Firmware upgrade can be performed immediately or scheduled for a later time.
NOTE: You can select firmware details of a printer group or search for printers using the group selection box and search bar on top of the list respectively. Updating firmware from Dell Cloud Connect server To update firmware for a printer you can choose from multiple firmware versions available in the Dell Cloud Connect server. NOTE: To update firmware, you need an internet connection to get connected to the Dell Cloud Connect server. 1.
11. Click OK. NOTE: The status of firmware download from Dell Cloud Connect server is displayed in a pop-up when you click in the quick-access toolbar. NOTE: Please check your proxy server settings if necessary to receive the list of firmware versions from the Dell Cloud Connect server. For more information, see Changing proxy settings. NOTE: If you select multiple printers for firmware upgrade, the firmware of each printer is upgraded to its latest version.
9 Policy Administrators can define and audit policies for printers in the network using the Policy feature. This helps administrators to identify and correct any deviation in the configuration of the printer fleet. The Policy feature enables administrators to define, check for conformance and enforce policies for printers in the network. You can define the following type of policies in OMPE: • Print - To configure printing settings such as orientation, color mode and so on.
Adding a policy You can create a new policy for a printer model using this option. 1. From the action menu, click CREATE. The Policy > Create Policy window is displayed. 2. Enter a name for the policy in the Policy Name field. 3. From the Model list, select the printer model. 4. To copy the current attributes of a printer as the policy settings, from the Printer list select. 5. From the Type list, select the type of policy. 6. Select the required settings for the policy type in the Settings field. 7.
Viewing pol icy widget To view policy details in a separate widget, click on the policy name in the policy list in Policy window. The Policy widget is displayed with the following tabs: • Details - displays the detailed policy settings. • Violation - displays a policy violation list with a list of printers that have violated the policy. Place the mouse pointer over violated by the printer.
Checking for conformance When a policy is defined, you can confirm if the policy is applied on the printers by checking for conformance immediately or on a scheduled time. 1. From the policy list in the Policy window, select the policy. 2. From the action menu, click CHECK CONFORMANCE. The Policy > Check Conformance window for the policy and printer model is displayed. NOTE: Policy conformance check can also be initiated by clicking Check from the policy list for the policy. 3.
The Policy > Edit Printer window is displayed with the policy name and printer model. 3. From the printer list, select the printers for which the policy has to be applied. 4. Click Update. Enforcing a policy When a policy is violated, you can impose the policy on a printer by enforcing it. You can enforce a policy immediately or schedule for a later time and date. 1. From the policy list in Policy window, select the policy. 2. From the action menu, click ENFORCE.
Editing a policy You can modify an existing policy using this option. 1. From the policy list in the Policy window, select the policy. 2. From the action menu, click EDIT. The Policy > Edit Policy window is displayed. 3. Reconfigure the policy. 4. Click Save. NOTE: To save and enforce the policy immediately, click Save & Enforce. The Policy > Enforce Conformance window is displayed. For more information on enforcing a policy, see Enforcing a policy.
10 Alerts The Alerts feature enables administrators to configure and manage email alerts based on printer parameter values. This helps you to be informed about key printer centric events without connecting to OMPE. Alerts are configured for a printer group. OMPE can send email alerts to both registered and unregistered users.
Field Description Email address Email address to which the alert is sent. Unregistered users can be added to receive alerts using this field. Email alerts are sent by OMPE using Simple Mail Transfer Protocol (SMTP). For more information on SMTP configuration, see SMTP configuration. Configuring email alerts 1. From the action menu in the Alerts window, click CREATE. The Alert widget is displayed. 2. From the Alert Type list, select the type of printer event for which the alert is to be generated. 3.
Using trouble ticket option To send trouble ticket alerts, you can choose from the available templates or create your own custom trouble ticket templates. 1. From the action menu in the Alerts window, click CREATE. The Alert widget is displayed. 2. From the Alert Type list, select the type of printer event to generate a trouble ticket. 3. Enter the threshold value in the % Remaining field. 4. From the Group Name list, select the printer group for which the trouble ticket is configured. 5.
Deleting an alert You can stop sending alerts or trouble tickets for a printer event by deleting the alert. 1. From the alerts list in Alerts window, select the alert. 2. From the action menu, click DELETE. A dialog box is displayed. 3. Click Delete to confirm.
11 Templates Templates are Extensible Markup Language (XML) files having a preset format and define all printer parameters managed by OMPE. Every printer model supported by OMPE is associated with a template. A template file defines how a parameter supported by OMPE is retrieved or set on the associated printer. Templates also store information about printer discovery, and firmware upgrade. Templates used by OMPE are open and non-proprietary.
Field Description Update Indicates if a template update is available Action Activate - Activates the template Deactivate - Deactivates the template Updating a template When an updated template version is available in the Dell Cloud Connect server repository, you can update it to any template version from the available list. NOTE: To update a template, you need an internet connection to get connected to the Dell Cloud Connect server. 1.
3. To choose the template file you want to upload, click Browse. 4. To activate the template, select Activate. 5. Click Register. Deleting a template You can delete a custom template using this option. NOTE: A base template and an active template cannot be deleted. NOTE: When a printer has a single template associated with it, you cannot delete the template. 1. From the template list in Templates window, select the template. 2. From the action menu, click DELETE. A dialog box is displayed. 3.
3. Click OK. NOTE: When you deactivate a custom template, the base template is automatically activated.
12 Schedules The Schedules feature in OMPE enables you to add, edit or delete schedules for various printer management operations.
Field Description Notes Notes entered by the user while adding a schedule Status Current status of scheduled task such as Running, Completed ( ), Recurring ( ), or Next Schedule Indicates the time and date of the next schedule* * For a completed schedule, indicates the time and date of completion. Adding a schedule You can add a new scheduled task from the Schedules window or from the task configuration page. 1. From the action menu, click CREATE. The Add Schedule widget is displayed. 2.
The schedule options are displayed. 2. From the Schedule Task list, select the required schedule frequency as Once, Daily, Weekly or Monthly. 3. From the Schedule to run on and Time drop-down lists, select the schedule date and time. NOTE: The task is repeated based on the selected frequency at the schedule time and date. Editing a schedule To reschedule a task, you can edit an existing schedule from the Schedules window. NOTE: Editing a schedule will not modify the task configuration settings. 1.
13 Connections OMPE communicates with printers using Simple Network Management Protocol (SNMP) and printer Embedded Web Server (EWS). OMPE uses SNMP for printer discovery and EWS for retrieving printer status parameters. During installation, OMPE is configured with default connection settings which can be changed by the administrator to suit the network environment.The Connections feature enables you to modify the SNMP and EWS connection settings for one or more printers in the network.
6. Enter the following details: Field Description Authentication and Privacy Options Select the corresponding check boxes to enable Authentication and Privacy profiles. Authentication Password Enter a valid password used by the authentication protocol for message authentication. Confirm Password Reenter the authentication password for confirmation. Authentication Algorithm Select the required authentication protocol: Message Digest Algorithm (MD5) or Secure Hash Algorithm (SHA).
2. From the action menu, click TEST CONNECTION. NOTE: If the SNMP v3 settings are empty, the TEST CONNECTION button is disabled. The status of the connection test is displayed in the progress bar. 3. If the test is successful, OMPE displays a message box prompting you to save the CSV report. If the test fails, an error message is displayed. On completion of testing, OMPE stores a consolidated report of success and failures for each IP address in a CSV file.
14 Reports Reports enables the administrators to get quick access to real time printer management information regularly. The Reports feature enables consolidation of data from one or more printers for generation of the following report types: • Device usage - It is a report on the number of pages printed within a snap shot period. • Printer asset/ Inventory - It is a report on the status of the printers.
3. To filter the report for a printer group, from the group selection menu select the printer group. 4. To filter the report with a specific keyword, enter the keyword in the search box. 5. Click Preview to view the report. NOTE: You can customize the previewed report to display selected columns, change the position of columns, and sort or filter rows using list operations. For more information, see Customizing Lists.
A dialog box is displayed as shown below. 12. Click Yes to save the report and view the file immediately.
15 Supplies The Supplies feature helps you to monitor consumables required and order replenishments for printers in the network. Using this feature you can: • View the consumables required. • Generate report of consumables to be ordered - for a single printer or printer group. • Order for consumables via Dell website. • Generate an alert when a consumable reaches the threshold value. You can view consumable information of printers based on the percentage of consumables remaining.
4. Click Order Consumable. The Dell website is open for making the purchase. Configuring an alert When a consumable is low, you can send an email alert to registered or unregistered users. 1. From the group selection box in the Supplies window, select the printer group. 2. From the quick-access toolbar click . The Alert widget is displayed. 3. Select the criteria for printer consumable information in the Percentage remaining less than (%) field. 4. Configure the alert.
16 Settings This feature enables you to configure the SMTP connection, change proxy settings, configure ADS and customize preferences for OMPE. SMTP configuration Dell OpenManage Printer Essentials (OMPE) uses Simple Mail Transfer Protocol (SMTP) to send email alerts. The SMTP window enables you to configure the SMTP settings in OMPE. 1. In the navigation pane, click Settings SMTP. 2. Enter the SMTP server address for outgoing emails in the SMTP Server field. 3.
Configuring ADS If Active Directory Service (ADS) is not setup during installation, you can configure it using this option. 1. In the navigation pane, click Settings ADS. 2. To use Active Directory LDAP Authentication, select Active Directory LDAP Authentication. 3. Enter the domain name in the ADS Domain Name field. 4. Enter the domain controller in the ADS Domain Controller field. 5. Enter the port number in the ADS Port Number field. 6. To use SSL connection, select Use SSL Connection. 7.
Customizing poll ing cycles OMPE monitors printers using polling mechanism. Polling in OMPE involves three cycles: Health, Status SNMP, and Status HTTP. • Health poll - Printer parameters such as printer status, page count and supply level are retrieved during Health poll. These parameters change frequently and are important to determine printer readiness. • Status poll - Parameters such as tray status, network configuration and printer settings are checked during status poll.
17 User Management The Users feature enables administrators to create users, define their roles and manage their privileges in OMPE. OMPE also supports Active Directory (AD) based authentication for its users. OMPE maintains two user roles: • Administrator - Can perform all the OMPE tasks. • User - Can perform only permitted tasks.
Feature Administrator Role User Role Policy management Add, Check for conformance, Enforce and delete policies No access Supplies management Order for consumables Order for consumables Software update Configure software updates No access User management View, Add, Modify, and Delete users No access Logs View No access Maps Add, Edit and Delete maps View only To open the Users window: 1. Launch the Dell OpenManageTM Printer Essentials. 2. In the navigation pane, click Settings Users.
Add ing an AD user account Before adding an AD user account, AD authentication must be successfully configured. For more information, see Configuring ADS. 1. From the action menu in the Users window, click CREATE. The New User widget is displayed. 2. From the User Type list, select ADS. NOTE: If ADS is not configured, this option is not enabled. 3. Enter the following AD user credentials for authentication: ADS Username and ADS Password. 4.
3. Click Delete to confirm. NOTE: You can delete other administrators account but not your own account.
18 Database Backup The Database Backup feature enables you to backup database immediately, or schedule database backup on a daily, weekly or monthly basis. To open the DB Backup Schedule window: 1. Launch the Dell OpenManageTM Printer Essentials. 2. In the navigation pane, click Settings Backup. Creating a database backup You can start a new database backup schedule using this option. 1. From the action menu in the DB Backup Schedule window, click NEW. The DB Backup widget is displayed. 2.
Restoring database 1. Close OMPE. 2. Place the OMPE backup folder on the local machine. NOTE: By default OMPE places the back up files in \Dell Printers\OMPE\backup\folder. 3. Open a command prompt and change the directory to \DellPrinters\OMPE\scripts. 4. Run the batch with the syntax: Restore.bat . Example: Restore.bat "C:\ProgramFiles\DellPrinters\OMPE\backup\mybackup_261120161255.
19 Database Cleanup The Database Cleanup feature facilitates removal of unused data history from the OMPE database for improved performance. OMPE maintains minute wise and hourly data in its database which is summarized on a daily basis. This process of summarizing detailed data for storage is called Roll-Up operation. Database roll-up reduces the number of records in the database, hence, increasing OMPE system response. By default, OMPE performs roll-up on a daily and monthly basis.
Scheduling monthly database cleanup 1. From the action menu in the DB Cleanup Schedule window, click NEW. The Cleanup widget is displayed. 2. Enter a name for the task in the Name field. 3. From the Schedule Task list, select Monthly. 4. From the Schedule report monthly on day list, select the day of the month the cleanup has to be performed. 5. From the Time drop-down list, select the schedule time. NOTE: The monthly schedule will be performed every month on the selected time and date. 6.
20 Logs OMPE logs all activities initiated by the user or the system. These activity logs can be viewed, archived and exported for troubleshooting. To open the Logs window: 1. In the title menu bar, click . 2. Click Logs. The Logs window display details of all OMPE activities such as the type of event, user/system that triggered the event, timestamp and the action performed. Exporting logs Logs are exported in Excel format. 1. From the action menu in the Logs window, click EXPORT.
21 Troubleshooting OMPE provides logs to indicate problematic events in the system. Each log displays an error code that provides information about an error that has occurred in the application. OMPE logs are available in the \ Dell Printers\OMPE\client\logs folder. This section lists the error codes generated in OMPE with its solutions. Error code Error message Troubleshooting steps 09980001 Configuration file missing or corrupted. 1. Check if the OMPE.
Error code Error message Troubleshooting steps 10380003 Policy already exists for this printer . Check and remove the policy of the same type before adding a new policy for the same printer. 10480001 Add printer to map failed. 1. Check if the printer is available and managed by OMPE. 2. If the printer is deleted inadvertently from OMPE, discover the printer again. 10580002 Could not set the values for printer . 1.
22 Frequently Asked Questions This chapter provides context wise solution for issues and concerns that users may encounter while using OMPE. For example, to view FAQs for Alerts, scroll down to the Alerts section in this chapter. Installation Q. "I am running OMPMv2 version on my server and would like to transition to OMPE" To upgrade, you can run the OMPE installer on the same machine where OMPMv2 is running.
a. If you are on a large enterprise network, to speed up the discovery it is suggested to run multiple discoveries with smaller target ranges. b. If the problem still persists, restart OMPE service by running RestartOMPEService.bat from the Install folder and then reinitiate the discovery. Printer Status Q. "My OMPE reports printer as offline even when the printer is up and connected to the network” a. Ensure the printer is accessible from OMPE server. Use the ping command line tool to confirm this. b.
d. Click Test Connection and ensure the test is successful. e. Open the printer details widget from the list view and click Refresh. f. Wait for a few minutes to see the updated printer status. g. Now retry your Set operation. Q. "Consumable Tab on Printer Details shows Collecting Data" OMPE uses current usage data to calculate the percentage toner remaining and pages remaining. It is likely that OMPE has not gathered enough usage data to calculate the forecast.
b. Check if firmware download is enabled on the printer. c. From the navigation pane, click Device Management Connections. d. Ensure EWS user name and password is correctly set for the printer. e. Click on Test buttons on Connection settings and ensure the test is successful. Policy Q. "Policy enforcement does not work in my OMPE" a. Check if EWS user name and password is correctly set on the printer. b. Open Connection Settings from the navigation panel of OMPE. c.
a. Enable SNMP Traps on the printer. b. Register OMPE server IP address or host name as SNMP trap receiver on the printer. c. Create an alert by selecting Alert Type as “SNMP Traps”. Q. "I am getting too many alerts from OMPE" OMPE has inbuilt alert suppression mechanism to ensure that repeat alerts are not sent to users. For all unresolved errors it sends repeat alert every 6 hours and this interval is configured in the OMPE configuration database.
the user when an update or a new template is available. Customers can install the update by clicking on 'Available' link and following the instructions in the next dialog. Similarly, when there are templates available for newer models, OMPE will show "New" against the models for which new templates are available. You can install the templates by clicking on "New" link and following the instructions in the next dialog. License Q. "My 30 day trial period has expired and OMPE is not allowing me to login.
Appendix A: Trouble Ticketing system configuration for alerts in OMPE OMPE supports trouble ticket template creation for alerts. Trouble tickets can be created in OMPE for the following ticketing systems: • KACE • BMC REMEDY • SERVICE NOW A trouble ticket is created by sending email to the ticketing system configured in OMPE. The ticketing system is configured by updating the ticket template available at the following path in the install directory: \OMPE\server\webapps\ROOT\conf\alert_template
Appendix B: Template Components OMPE uses SysObjectID SNMP value from RFC1213 to associate a template to a printer. OMPE compares the SysObjectID of the printer to the SysObjectID of the template and associates the printer to the template. The components of a template are: Template Component Description Properties Defines all template specific properties. Inheritance Defines mapping of properties between templates. Model info Defines properties related to the printer model.
Properties It defines all the properties specific to a particular template. The properties element consists of the template ID and the template name. Example: DELL2335DN DELL2335DN Inheritance It provides the parent templates from which the template inherits some properties.
Template variables Describes the properties that has to be set or retrieved from the printer model. The elements of property overrides are static-reads, web-reads, snmp-reads, web-writes, and snmp-writes.
• Constants define model-related properties that are static. The Constants content element of the reads defines the static property. It also contains the type and value text elements that define storage type and value for a particular property. Example: String *** • Web-reads define the properties that can be retrieved through the web.
• Snmp-reads define the properties that can be retrieved through SNMP. It communicates with the printer using object ID (OID) of a particular property for retrieving the information. The SNMPRead content element of the snmp-reads defines the SNMP reading property. The SNMPRead contains format element. Example: PAGE 108 String
Example 2: String
Example: • Translation - Translates value which is of type Biderctional.
Example: curl.exe ]> - Group information It describes one or more variable content with Write elements that define the Properties that can be set through SNMP Write and Web Write. Parameters which have similar URL are grouped to perform SET operations.
Tray information It describes the manufacturer specific tray computations which includes computation for Permissible Trays, Manual Trays, Overview, and Printer Details.
Glossary ADS Active Directory Service AES Advanced Encryption Standard CSV Comma Separated Values DES Data Encryption Standard EWS Embedded Web Server HTTP Hypertext Transfer Protocol JPEG Joint Photographic Experts Group LAN Local Area Network MD5 Message Digest Algorithm MIB Management Information Base PDF Portable Document Format PNG Portable Network Graphics SHA Secure Hash Algorithm SMTP Simple Mail Transfer Protocol SNMP Simple Network Management Protocol XML Extensible
Index A Alerts Configuring email alerts 64 Deleting an alert 64 Editing an alert 63 B Base template 65 Blocking a Printer 39 C Connection settings 72 Connection testing 73 Configuring ADS 84 Consumable information criteria 78 Copy configuration 42 Consumable usage 75 D Dashboard Dashboard chart settings 35 Dashboard charts 34 E EWS 72 Exporting printer data 40 Exporting system logs 91 F Firmware Current printer firmware 75 Firmware tool 53 Firmware Tool Parameter 53 Updating firmware 41 G Groups Adding a g
Select printers list 49 Scheduling a task 70 Predefined schedules 69 N Navigation pane 22 Notification widget 36 O OMPE Architecture 10 Installing OMPE 14 Starting OMPE 18 P Policy Adding a policy 56 Checking for conformance 58 Deleting a policy 60 Editing a policy 60 Enforcing a Policy 61 Policy Compliance 75 Policy types 55 Policy widget 56 Re-check 56 Re-Enforce 56 Printer list Printer list view 37 Printer operations 39 Deleting a printer 40 Printer status list report 42 Printer group selection 25 R Re
Administrator account 83 Deleting an user account 85 Editing an user account 83 User privileges 83 W Widget 24 Widget Refresh Interval 82 114|
