Monitor Print Popup for Mac. Product Manual.

Transcription

1 Monitor Print Popup for Mac Product Manual

2 Monitor Print Popup for Mac Product Manual Copyright 2013 Monitor Business Machines Ltd The software contains proprietary information of Monitor Business Machines Ltd. It is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Monitor Business Machines Ltd. All rights reserved. No part of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Monitor Business Machines Ltd. 31a Normanby Road, Mt Eden, Auckland 1024, NEW ZEALAND Published: 13/12/2013 The Monitor Logo and Supervisor are registered trademarks of Monitor Business Machines Ltd. Any other products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks.

3 Contents Overview 1 Introduction to Monitor Print Popup... 1 System Requirements Server Configuration Enable the Mac Popup Interface... 2 Install the Microsoft LPD... Service 2 Firew all... 4 Installation... 5 Configure the Popup Profile... 5 General tab... 6 Account Validation tab... 7 Configure PrintPopupPreferences.plist... 8 Installing Monitor Popup... 9 Upgrading Monitor Popup Administrator Guide Configuring Monitor Popup Monitor Popup Configuration... Interface 11 PrintPopupPreferences.plist Troubleshooting Monitor Popup Errors Logging User Guide 14 Scripting 15 Launch Monitor Print Popup Exit Monitor Print Popup Get the Current Account/Ticket Number Set the Current Account/Ticket Number Delete All Print Jobs Contents i

4

5 Overview The Monitor Print Popup for Mac Product Manual is a comprehensive guide to installing and configuring the the Monitor Popup application. The following topics are covered in this manual: Introduction to Monitor Print Popup o System requirements o Server configuration o Installing the Monitor Popup Administrator Guide o Configuring the Monitor Popup o Troubleshooting User Guide Scripting Please read this manual before installing the Monitor Popup application. Introduction to Monitor Print Popup The Monitor Print Popup application is installed on a Mac workstation to manage printing via the Monitor Print system. The Monitor Popup application tracks any jobs printed at the workstation, and can then identify the user by their logged in username, or prompt them to enter their credentials for authentication. The user can then see their balance and the cost of their print job and may choose to print or cancel the job. The Monitor Popup also supports unauthenticated printing, which allows a user (typically a guest) to submit a print job to a queue without having first authenticated. The user can then obtain a guest ticket or create their Supervisor Net account and authenticate when they release the print job. The Monitor Popup has simple AppleScript ability, that allows you to integrate it with other Monitor and third-party applications. See the Scripting page for more information. Overview 1

6 System Requirements Supervisor Net Server: o Supervisor Net version or later Mac Client: o Mac OS X version 10.4 or later Server Configuration Enable the Mac Popup Interface The port on which the Monitor Popup will communicate with the Monitor Print system must be enabled on the Supervisor Net server. To do this, open the Print Manager Configuration UI by navigating to Start >> All Programs >> Monitor Business Machines >> Supervisor Net >> Configure Print Manager. Ensure that Mac Popup is set to enabled. The default port is 8083 and should be left at this value unless there is a very good reason to change it. When prompted, restart the Print Manager service to apply any changes. Install the Microsoft LPD Service Mac workstations print to the Monitor Print server using LPR/LPD, which must be installed on the print server(s) where the Monitor Queue Manager is installed. This mechanism is used to ensure that the jobs are delivered to the print queue with the owner's name, workstation IP address and document name intact. Microsoft Windows servers do not usually have this feature installed and running by default. 2

7 To enable this feature on Windows 2008R2 (for other operating systems, please refer to the appropriate Microsoft technical documentation): 1. Open the Server Manager, highlight the Roles section on the left and then click the Add Roles button. 2. Select the Print and Document Services role and click Next. 3

8 3. Click Next at the information screen that follows, and then enable the LPD Service. 4. Click Next and then Install. 5. When the installation is complete, open the Services control panel and ensure that the LPD Service has been installed and is in a Started state. Firewall By default, the Monitor Print Popup communicates with the Supervisor Net server on the following ports: o The interface (SOAP) server port configured in the Supervisor Net Settings in Supervisor Net Administrator o The Mac Popup port configured in the Print Manager Configuration These ports are configurable, however assuming the above default ports are used, the Supervisor Net server firewall must be opened for TCP connections on these two ports. 4

9 Installation The Monitor Popup application is distributed as a disk image (.dmg) file. Running the disk image file will mount "Monitor Print Popup" as a device containing two files: Monitor Popup 7.x.x.x - The Monitor Popup installation file and the version that will be installed PrintPopupPreferences.plist - The Monitor Popup configuration file The Monitor Popup must be configured to receive its setup from the Supervisor Net server via a popup profile. If the necessary configuration is performed before the installation of the popup application, the popup will be ready for use immediately and no further configuration is required on each Mac workstation. The recommended method for installing the Monitor Popup is as follows: 1. Configure the popup profile 2. Configure the PrintPopupPreferences.plist file 3. Install the Monitor Popup application Configure the Popup Profile When the Monitor Popup is installed and configured to connect to the Supervisor Net server, it will receive its configuration via a popup profile. If the popup profile is configured before the Monitor Popup is installed then the application will be ready for use immediately. Popup profiles can also be edited after the installation of the Monitor Popup, however the application must be restarted on each Mac workstation to receive the new configuration. Popup profiles can be created and edited on the Supervisor Net server in the Popup Profiles tab of Monitor Print Administrator. By default the Monitor Popup uses the 'default' popup profile, however a new profile can be created and used instead. Multiple profiles can be used around a site if a different configuration will be used in different locations or by different user groups. The Monitor Print Popup Profiles are used to configure the Monitor Popup for both Windows and Mac. To display only the configuration options applicable to the Monitor Popup for Mac, check 'Show Options Available for Mac Popup' at the bottom of the Monitor Print Administrator window. The popup profile configuration options are explained below. 5

10 General tab Get Jobs By When a print job is submitted, the Monitor Print system must find the workstation from where the job was submitted and trigger the Monitor Popup. The Monitor Print system can locate the workstation and match the print job using the IP address of the workstation (Machine ID), or the name of the logged in user (User Name). The reason for choosing one option over the other depends on how users will log into a workstation that is running the popup application. Please view the table below for an explanation of the two options. Option Explanation Machine ID The Monitor Popup will use the IP address of the workstation where the print job originated to display the popup. This option should be used in a public environment where users are logged into multiple workstation using the same credentials. If this option was set to User Name, every user would receive a popup each time someone prints a job User Name The Monitor Popup will use the name of the logged in user to display the popup. This option should be used when users log in with unique network credentials and may move between workstations. The popup will follow them as they move around Ignore Domain If ticked the popup can operate in a multi-domain environment. If not ticked the Queue Manager must be on the same domain as the user submitting the job otherwise the user will not get a popup Show Popup as Each Job Arrives This will force the popup window to appear each time a print job is submitted. This should be disabled if users will submit many jobs to the queue before authenticating to release them, otherwise they will be prompted to authenticate as each job is submitted. Banner Image The image that is displayed on the Monitor Popup UI. The default is the Monitor logo (circled below) however a custom image may be used instead. 6

11 Display Job Confirmation For These Price Codes Set by price code to display a confirmation window before the job is submitted to the queue. If enabled the confirmation window will appear after the user has authenticated, displaying their balance and the cost of the job, allowing them to proceed or cancel the job. Account Validation tab Look Up Account This option determines which field in the Supervisor Net Primary database the popup will authenticate the user against. By Explanation 7

12 Primary Number The popup will authenticate the user against the Primary Number field of Supervisor Net Primary ID The popup will authenticate the user against the Primary ID field of Supervisor Net User Entered ID The popup will not attempt to authenticate the user, but will instead prompt the user to enter an ID for the print job. The user will enter this ID at a release station to locate their print job(s) and then authenticate to release them Mask Input Any data entered when authenticating a user account will be masked. Validate Account This option determines how the popup will obtain the user information to authenticate based on the "Look Up Account" option configured above. Use Explanation User Entry The user will be prompted to manually enter their credentials Login Name The popup will submit the user's logged in name for authentication against the field configured in Look Up Account Monitor Login Only applicable if the user has already logged into the workstation through the Monitor Reservation system. The popup will take the user's credentials that were entered to log into the workstation and submit them for authentication to release their print job Persist User Entered Data If the popup is configured to prompt the user for their credentials for authentication, this option can be used to allow the user-entered data to persist for a period of time, or until the user logs out or chooses to be 'forgotten'. When this is enabled the user's information will be retained so they do not need to authenticate each time they submit a print job. The options are: o For 'x' minutes - the user's information will be retained for the specified amount of time o Until User Cancels - the user's information will be retained until they log out or choose to be forgotten by 'right-clicking' on the Monitor Popup icon and selecting "Forget Current User" Configure PrintPopupPreferences.plist When the Monitor Popup is installed, the installer will deploy the PrintPopupPreferences.plist file that is contained in the same folder as the installation package. If the site requires two different configurations to be deployed, simply copy the installation package and PrintPopupPreferences to a different folder and make the necessary configuration changes before installing the popup application. If there is no PrintPopupPreferences file in the folder containing the installation package, the popup will be installed with the default configuration and must be configured on each workstation after the installation. The configuration items found in the PrintPopupPreferences.plist file are explained below. 8

13 Enable Request Logging Enable debug logging for diagnosis, this should not be enabled during normal operation. Popup Profile The popup profile that will be used to configure the Monitor Popup. Popup profiles can be created and edited in the Popup Profiles tab of Monitor Print Administrator on the Supervisor Net server. Port - Popup The Mac Popup port that was configured in the Enable the Mac Popup Interface section of this manual. The default value is Port - SOAP The Interface Server (SOAP) port that is configured in the Server tab of Supervisor Net Settings in Supervisor Net Administrator. The default value is Validation Prompt The Monitor Popup will automatically prompt the user depending on which credentials they must enter at the popup, therefore this item does not need to be configured and can be left blank. However if the default prompt is not suitable, a prompt can be configured here and this message will be displayed when the user authenticates at the popup. Server Address The Supervisor Net server address. Installing Monitor Popup To install the Monitor Popup, run the Monitor Print Popup package and follow the on screen instructions. The installer will deploy the PrintPopupPreferences.plist file that is contained in the same folder as the installation package. Running the installation package requires Administrative privileges. Once the Monitor Popup has been installed, the application will automatically run when any user logs into the Mac workstation. 9

14 Upgrading Monitor Popup To upgrade the Monitor Popup, run the Monitor Print Popup package and follow the on screen instructions. The installer will not overwrite any existing PrintPopupPreferences configuration, even if there is a PrintPopupPreferences.plist file in the same folder as the installation package. 10

15 Administrator Guide Configuring Monitor Popup If the PrintPopupPreferences.plist file was configured before the Monitor Popup application was installed, there is no further configuration required. Once the Monitor Popup application has been installed, it can be configured through the System Preferences menu or by editing the PrintPopupPreferences.plist file that was deployed during the installation. Monitor Popup Configuration Interface To configure the Monitor Popup application through its configuration interface, open the System Preferences menu on the Mac workstation and select Monitor Print Popup from the "Other" category: To edit the configuration, click the lock and enter the Administrator password: The configuration options are explained below: Server Address Administrator Guide 11

16 The Supervisor Net server address. SOAP Server Port The Interface Server (SOAP) port that is configured in the Server tab of Supervisor Net Settings in Supervisor Net Administrator. The default value is Mac Popup Port The Mac Popup port that was configured in the Enable the Mac Popup Interface section of this manual. The default value is Popup profile The popup profile that will be used to configure the Monitor Popup. Popup profiles can be created and edited in the Popup Profiles tab of Monitor Print Administrator on the Supervisor Net server. Once the Supervisor Net server and ports have been configured, the available Popup profiles will be displayed in the drop-down list. Validation prompt The Monitor Popup will automatically prompt the user depending on which credentials they must enter at the popup, therefore this item does not need to be configured and can be left blank. However if the default prompt is not suitable, a prompt can be configured here and this message will be displayed when the user authenticates at the popup. Enable verbose request logging Enable debug logging for diagnosis, this should not be enabled during normal operation. PrintPopupPreferences.plist The PrintPopupPrefences.plist configuration file is installed to the \Library\Application Support\Monitor folder. Any configuration changes made through the Monitor Popup configuration interface in the System Preferences menu are saved to this file. The Monitor Popup can also be configured by editing this file, please read the Configure PrintPopupPreferences.plist section for more information. Troubleshooting Monitor Popup Errors When the Monitor Popup first launches, it will show in the dock with the loading icon: If there are any configuration or user authentication errors, they will also be displayed on the Monitor Popup icon: 12 Administrator Guide

17 Each Monitor Popup error is explained below: Offline The Monitor Popup can't connect to the Supervisor Net server, or the Supervisor Net server or port configuration is incorrect. Profile The Popup profile is invalid. Reg Err There is no Supervisor Popup (PPU) license available. No User The popup authenticates the user by their logged in name but the user does not exist in Supervisor Net. Locked The popup authenticates the user by their logged in name but the user's account is locked. Expired The popup authenticates the user by their logged in name but the user's account is expired. Logging The Monitor Print Popup writes to a log file located in the /Library/Logs/Monitor folder. A log is created for each user that logs into the Mac with the popup running. If the logged in user is "Guest" then the log file will be named "PrintPopup-guest.log". For diagnostic purposes, debug logging can be enabled through the Monitor Popup configuration, however this should not be enabled during normal operation. Administrator Guide 13

18 User Guide Once the Monitor Popup has been installed, the Monitor Popup application will automatically run when any user logs into the Mac workstation. The Monitor Popup icon will show in the dock and can be used to open the Monitor Popup window where the user may view any print jobs waiting for release, and print or delete them. The number of print jobs the user has waiting for release will be displayed on the Monitor Popup icon: To open the Monitor Popup window, click on the icon in the dock: o To print one or multiple jobs, ensure the print jobs are checked (ticked) and click Print Check ed. o To delete one or multiple jobs, ensure the print jobs are selected (highlighted) and click Delete. o To view the job information for a print job, select (highlight) the print job and click Job Info. The user's name and balance will be displayed if they are authenticated by their logged in name, or if the user is prompted to authenticate and the Persist User Entered Data option is enabled in the Popup Profile (see the Configure the Popup Profile section for more information). Forget current user If the Popup Profile is configured to persist user data, the user will have the option to be 'forgotten' so when a job is printed the popup will prompt the next user to authenticate again. To forget the currently authenticated user, right-click on the Monitor Popup icon in the dock and select Forget current user. 14 User Guide

19 Scripting Monitor Print Popup has simple AppleScript support that allows you to integrate it with other Monitor and third party products. AppleScript is a standard part of OS X, and allows querying and control of applications. For more information about AppleScript, visit the Apple web site, or search for AppleScript information online Using AppleScript with Monitor Print Popup you can: Launch Monitor Print Popup. Exit Monitor Print Popup. Get the Account/Ticket number of the current user. Set the Account/Ticker number. Delete all print jobs for the current user. The sections below describe how to achieve each of these actions. Launch Monitor Print Popup If an AppleScript sends any command to Monitor Print Popup, and the application is not yet running, AppleScript will launch the application. The following example script will launch Monitor Print Popup (if required) and bring it to the front of all other windows. tell application "Monitor Popup" activate end tell Exit Monitor Print Popup The standard AppleScript quit command is used to exit the application. Monitor Print Popup will normally prompt to confirm the exit, but using "quit saving no" will suppress this prompt. tell application "Monitor Popup" quit saving no end tell Get the Current Account/Ticket Number The property usernumber returns the number of the current Account/Ticket being used by Monitor Print Popup. If the account is not valid, the number returned will be an empty string. The following code sets the AppleScript variable "num" to the current account number. tell application "Monitor Popup" set num to usernumber end tell Scripting 15

20 Set the Current Account/Ticket Number The property usernumber can be used to set the current Account/Ticket being used by Monitor Print Popup. tell application "Monitor Popup" set usernumber to " " end tell Delete All Print Jobs The delete AppleScript command will delete all the print jobs queued for the workstation on which Monitor Print Popup is running. tell application "Monitor Popup" delete end tell 16 Scripting

21 Monitor Business Machines Ltd 31a Normanby Road, Mt Eden, Auckland 1024, New Zealand. Phone: Web: