SafeCom Save-O-Meter Administrator s Manual

Size: px

Start display at page:

Download "SafeCom Save-O-Meter Administrator s Manual"

Marylou Maxwell
5 years ago
Views:

1 SafeCom Save-O-Meter Administrator s Manual D November 2012

2 Trademarks: Nuance, the Nuance logo, SafeCom, SafeCom Go, SafeCom P:Go, SafeCom epay and the SafeCom logo are trademarks of Nuance Communications, Inc. or its affiliates in the United States and/or other countries. All other trademarks referred to herein are the property of their respective owners. Nuance Communications, Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to products and documentation without prior notification. Third Party Software: This software may contain third party software which requires notices and/or additional terms and conditions. Such required third party software notices and/or additional terms and conditions are located in the SafeCom Third Party Notice document. Patent: Nuance Communications, Inc. has received the following British patent GB B, US patent US 6,952,780 B2 and Europe EUR EP Copyright Nuance Communications, Inc. All rights reserved Nuance Communications, Inc. Lautrupvang 12 DK-2750 Ballerup Denmark Phone: Web: safecom.eu D

3 Table of contents 1 Introduction Requirements Available documentation About this manual Document history Install SafeCom Save-O-Meter Overview Windows Firewall - Ports that must be opened Install Internet Information Service (IIS) Windows 2008 server IIS Install SafeCom Save-O-Meter Configure SafeCom Save-O-Meter Enable savings on SafeCom Server Set up tracking in SafeCom Administrator Save-O-Meter Widget Test the Save-O-Meter Widget Savings XML format for data Save-O-Meter calculations Regulatory information Index D

4 1 Introduction 1 Introduction The purpose of SafeCom Save-O-Meter is to visualize the result of managing print behavior. The SafeCom Save-O-Meter gives an instant overview of print volumes and environmental savings. Display the SafeCom Save-O-Meter widget live on your intranet to show employees how much they help save every day. 1.1 Requirements SafeCom G3 Server version S *05 or higher SafeCom Tracking In order for SafeCom Save-O-Meter to be shown on a company's CMS, the following requirements must be met: Access to IIS on the CMS as well rights to change and/or upload the web.config file are necessary. Make sure that the necessary in- and outbound ports are opened on the SafeCom Server and the Web server ( ). The IP address to the CMS must be known. Note: Some CMS' have trouble interpreting the Save-O-Meter code correctly. An extra script can be created, making sure that the CMS can read the code correctly. 1.2 Available documentation SafeCom Smart Printing SafeCom Smart Printing Administrator s Quick Guide D10600 How to install a SafeCom Smart Printing solution. SafeCom G4 SafeCom G4 Administrator s Manual D60650 A comprehensive Manual that the administrator should consult to make a successful SafeCom solution. Includes information about SafeCom Tracking, SafeCom Rule Based Printing, SafeCom Client Billing, and SafeCom Pay. SafeCom Save-O-Meter Administrators Manual D60640 (this manual) This manual describes how to install and configure the Save-O-Meter and Save-O-Meter widget. Furthermore it goes into detail with the savings calculations behind the SafeCom Save-O-Meter. D

5 1 Introduction 1.3 About this manual This manual applies to SafeCom G4 Server version S *01. This manual is organized as follows: Chapter 1 Introduction lists the requirements, the supplied SafeCom documentation, and describes how this manual is organized. Chapter 2 Install SafeCom Save-O-Meter describes how to install and set up SafeCom Save-O-Meter. Chapter 3 Save-O-Meter Widget describes how to set up and configure the Save-O-Meter Widget. Chapter 4 Save-O-Meter calculations contains a detailed description of the savings calculations behind the Save-O-Meter. 1.4 Document history Revision D SafeCom G4 Server version S *01. Cosmetic changes. Revision D Updated section 2.4 with information about security settings on Windows 2008 R2 server and IIS 7.5 Revision D SafeCom G3 Server version S *03. Updated screenshots to reflect name changes to SaveOMeterProxy. Edited section Enable savings on SafeCom Server Revision D SafeCom G3 Server version S *05. New section on how to enable the Savings key on the SafeCom Server (2.4.2). Revision D SafeCom G3 Server version S *05. Initial version. D

6 2 Install SafeCom Save-O-Meter 2 Install SafeCom Save-O-Meter 2.1 Overview To install the SafeCom Save-O-Meter you have to perform the following on the web server: Windows Firewall - Ports that must be opened (2.2) Install Internet Information Service (IIS) (2.3) Install SafeCom Save-O-Meter (2.4) D

7 2 Install SafeCom Save-O-Meter 2.2 Windows Firewall - Ports that must be opened Below is an overview of the inbound and outbound ports that must be opened on the SafeCom server and web server. Server SafeCom master server with local database TCP UDP In Out In Out External SQL server SafeCom master server with external SQL server Web server With offline tracking outbound port 7900 if used to collect tracking data from the slaves. With online tracking inbound port 7900 on the master must be open. 2 SQL server may use another TCP port than SQL server may use another TCP port than With offline tracking outbound port 7900 if used to collect tracking data from the slaves. With online tracking inbound port 7900 on the master must be open. D

8 2 Install SafeCom Save-O-Meter 2.3 Install Internet Information Service (IIS) Windows 2008 server IIS On the web server, click Start, point to Programs, Administrative Tools, right-click Server Manager and click Run as administrator. 2. In the Server Manager right-click Roles and click Add Roles. 3. In the Add Roles Wizard opens. Click Next. 4. In the list of Roles check Web Server (IIS). You may be prompted to also add Windows Process Activation Service. Click Add Required Features to add this. Click Next. 5. The Introduction to Web Server dialog appears. Click Next. 6. In Role services check the following: Under Application Development check ISAPI Extensions. Under Security check Basic Authentication. Under Security check Windows Authentication. 7. Under Management Tools make sure that the following two checkboxes are selected: IIS Management Console. IIS Management Service (and click Add Required Features to add this). 8. Under Application Development and make sure that the following five checkboxes are selected: ASP.NET..NET Extensibility (and click Add Required Features to add this). ASP. ISAPI Extensions. ISAPI Filters. 9. Click Next and then Install. 10. When the installation has succeeded click Close. 2.4 Install SafeCom Save-O-Meter 1. Download the file save-o-meter_widget_1_0.zip from the link supplied to you or from SafeCom Insite. 2. Copy the following files and folders to the IIS root directory C:/inetpub/wwwroot/ on the web server. bin css gfx js index.html SaveOMeterProxy.ashx D

Open the folder js and right-click the file saveometer.js and choose Edit. 4. Change the IP-address to the web server at the top of the file, save the file and exit.

9 2 Install SafeCom Save-O-Meter On Windows 2008 R2 server and/or IIS 7.5 unblock security options for the SaveOMeterProxy.ashx file and the web.config file in the wwwroot folder and all files in the bin, css, and js folders: Right-click the file and select Properties. In the General tab s Security section click Unblock. 3. Open the folder js and right-click the file saveometer.js and choose Edit. 4. Change the IP-address to the web server at the top of the file, save the file and exit. If the system returns an Access denied upon saving and exiting, try copying the file to the desktop, edit the copied version and then replace the original file in the SaveOMeter folder with the edited, copied version. D

2 Install SafeCom Save-O-Meter 2.4.1 Configure SafeCom Save-O-Meter Two application settings must be added in the Internet Information Services (IIS) Manager.

10 2 Install SafeCom Save-O-Meter Configure SafeCom Save-O-Meter Two application settings must be added in the Internet Information Services (IIS) Manager. One that specifies how often the savings must be cached and another that specifies the SafeCom Server from which you would like to retrieve the savings information. 1. Open the Internet Information Services (IIS) Manager from Administrative tools. 2. Browse to Default Web Site in the left pane. 3. In the ASP.NET pane double-click Application Settings. 4. Click the Add button in the right pane to add the following two application settings: a) The first application setting specifies how often the savings data are cached: Name: SaveOMeterCacheMinutes Value: 30 b) The second application setting specifies the SafeCom server from which you want to retrieve the savings data: Name: SaveOMeterRemoteUrl Value: where the IP address must be changed to the IP address of your SafeCom Server. Caution! In a multi-server installation, the IP address, specified in the Value field, must be the IP address of the Master server. D

$config has been created in C:\inetpub\wwwroot, with the right settings as specified in the application settings. Note: The <appsettings> can also be inserted directly in the web.$

11 2 Install SafeCom Save-O-Meter 5. Close the Internet Information Services (IIS) Manager and verify that the file web.config has been created in C:\inetpub\wwwroot, with the right settings as specified in the application settings. Note: The <appsettings> can also be inserted directly in the web.config file if the web.config file already exists in the C:inetpub\ folder. Also if you need to change the application settings, this can be done directly by editing in the web.config file Enable savings on SafeCom Server In order for the scjobserver to be able to provide the savings information, the Savings key on the SafeCom server must be enabled. 1. Open the Registry Editor. 2. Browse to HKEY_LOCAL_MACHINE and then SOFTWARE. 3. If SafeCom runs 32-bit on Windows 64-bit, expand the Wow6432 node, then SafeCom, and SafeComG3. If SafeCom runs 64-bit on Windows 64-bit, expand SafeCom and SafeComG3. On Windows 32-bit, expand SafeCom and SafeComG4. 4. Click Savings and modify the value names according to the following: Right-click Enabled in the pane to the right, select Modify set Value data to '1' and click OK. Right-click Interval in the pane to the right, select Modify then in the Value data field specify in seconds the interval in which the Save-O-Meter widget is provided with new savings numbers. Click OK. Right-click Port in the pane to the right, select Modify then in the Value data field type in the TCP port that the server is listening on (usually 7707). Click OK and exit the registry editor. D

12 2 Install SafeCom Save-O-Meter Set up tracking in SafeCom Administrator In order for SafeCom to be able to supply the necessary information to SafeCom Save-O-Meter, tracking of deleted print jobs must be set up in SafeCom Administrator. 1. Open and login to SafeCom Administrator. 2. Right-click a server and select Server properties. 3. On the Tracking tab, select the Track deleted print jobs check box. 4. Click Apply and OK. Caution! In a multi-server installation this must be set up on all master and slave servers. D

3 Save-O-Meter Widget 3 Save-O-Meter Widget The Save-O-Meter widget is Flash-based and intended to be embedded on an HTML web page on the organization s intranet in order to show the savings

13 3 Save-O-Meter Widget 3 Save-O-Meter Widget The Save-O-Meter widget is Flash-based and intended to be embedded on an HTML web page on the organization s intranet in order to show the savings resulting from the use of SafeCom Smart Printing. Note: For the SafeCom Save-O-Meter Widget to work make sure that TCP port 7707 is open on the SafeCom server. Every time the Widget makes a TCP connection to the SafeCom application on the specified port the savings data is forwarded to the Widget in XML format (3.3). 3.1 Test the Save-O-Meter Widget Open a browser and enter the IP address of the SafeCom server for which you would like to see the Save-O-Meter. The Save-O-Meter Widget opens and the savings data for the specific SafeCom server shows as specified in section Savings Savings are aggregated for these periods: Total Yearly Monthly Weekly The Total is never reset, whereas the others are reset according to their period. Savings are calculated in number of black and white pages saved (due to user deletion, autodeletion, or duplex) and color pages saved (due to user deletion, auto-deletion, duplex, or b/w print), as well as in trees, CO2, and H2O. Refer to chapter 4 for additional information concerning the calculations used in the Save-O-Meter. D

14 3 Save-O-Meter Widget 3.3 XML format for data The Save-O-Meter statistics data from the SafeCom Server is available in the following XML format. <saveometer> <lastupdate> :00:00</lastUpdate> <statistics> <week> <percent>14</percent> <sheets>170</sheets> <bw>170</bw> <color>170</color> <trees>4</trees> <CO2>2.5</CO2> <water>4.23</water> </week> <month> <percent>14</percent> <sheets>170</sheets> <bw>170</bw> <color>170</color> <trees>4</trees> <CO2>2.5</CO2> <water>4.23</water> </month> <year> <percent>14</percent> <sheets>170</sheets> <bw>170</bw> <color>170</color> <trees>4</trees> <CO2>2.5</CO2> <water>4.23</water> </year> <total> <percent>14</percent> <sheets>170</sheets> <bw>170</bw> <color>170</color> <trees>4</trees> <CO2>2.5</CO2> <water>4.23</water> </total> </statistics> </saveometer> D

15 4 Save-O-Meter calculations 4 Save-O-Meter calculations The tracking server updates savings statistics upon each tracking event which is triggered when: A job is deleted or modified due to Rule Based Printing, such as forced duplex and forced mono. A user actively deletes a job at the device. The system deletes a job as the time-out expires. A print job is decomposed into three printing resources Paper sheets (RS), Monochrome toner ink (RM), and Color toner ink set (RC) that it consumes (or saves) as it is printed, deleted, or modified by RBP. Paper sheets (RS) Unit is mm 2, square millimeters. For each paper sheet identified by the driver and/or the parser as having size w*h is printed, the area a=w*h of that sheet is added to RS. Sizes are derived from [1]. For example if three A4 sheet are used, then the RS used for this job is 3 * 210 * 297. All of the jobs below uses the same amount of paper resource and thus evaluates the same RS: o o o 4 duplex pages on 2 A3 sheets 2 simplex pages on 2 A3 sheets 8 duplex pages on 4 A4 sheets Monochrome toner ink (RM) Unit is also mm 2. For each impression on a page of a paper size X, the RM resource used is defined to be the area of X in unit mm 2. For example, if a job consists of 2 monochromes A3 impressions (regardless of how many sheets of paper it prints on), then the job s usage of resource RM is 2 * 297 * 420. This variable RM is a function of color and impressions only, as its value is indifferent to how much of the paper is actually covered by black ink. 5 impressions of a black dot on A3 paper is defined to use the same amount of RM resources as 10 impressions of 100% black on A4 paper. Color toner ink set (RC) Apart from the fact that this resource is triggered for color impressions only, its mechanism is identical to that of the RM resource. This is a distinct resource having a distinct market value. D

16 4 Save-O-Meter calculations The SafeCom system can reduce the consumption of resources RS, RM and RC by the following saving events: E1: A job is forced to use toner save due to RBP rules (saves RM, RC). If applied, then RM, RC is multiplied by 0.75 as derived from [2]. E2: A job is forced to use duplex due to RBP rules (saves RS) E3: A job is forced to print in monochrome due to RBP rules (saves RC) E4: A job is deleted due to RBP rules (saves RS,RM,RC) E5: A job is deleted due to users intervention at the printer (saves RS,RM,RC) E6: A job is deleted due to system time out expire after a warning was sent to the user that didn t collect the job at the printer (saves RS,RM,RC) Upon a tracking event, the following information: SAV(j) = [ Out(j), Off(j), Sys(j), User(j), RBP(j) ] is calculated from job j Out(j): The amount of RS, RM and RC actually consumed at the printer. Sys(j): The amount of RS, RM and RC that was saved due to event E6. User(j) : The amount of RS, RM and RC that was saved due to event E5. RBP(j): The amount of RS, RM and RC that was saved due to events E1,, E4. Off(j): The amount of RS, RM and RC that would have been consumed had none of the saving events E1,, E6 taken place. This calculation is done by reversing the transformations E1,, E6 applied to the print job. Upon each tracking event, the tracking server then aggregates SAV(j) in the statistics for all jobs J* printing under 7 time periods: SavTotal(J*): Total to date. Never resets. SavYear(J): Yearly SavHYear(J): Half-yearly SavQu(J): Quarterly SavMo(J): Monthly SavWeek(J): Weekly SavDay(J): Daily D

4 Save-O-Meter calculations The information shown in SafeCom Administrator s Save-O-Meter is derived from the current SavTotal(J*) retrieved from the Tracking server at the time of displaying.

The paper area for these resources are first normalized to A4, A3, default or some other paper sizes that might be filled out in the charging scheme.

17 4 Save-O-Meter calculations The information shown in SafeCom Administrator s Save-O-Meter is derived from the current SavTotal(J*) retrieved from the Tracking server at the time of displaying. The resources RS, RM and RC are converted into Credits by applying the default primary charging scheme to SavTotal(J*). The paper area for these resources are first normalized to A4, A3, default or some other paper sizes that might be filled out in the charging scheme. SafeCom Administrator then converts (only) resource RS (paper sheets, area) into grams of paper (5 grams for an A4 ~ grams/m 2 ) and from this into environmental resources: Water By [5], recycling 1 short ton (0,91 t) of paper saves 26 m 3 of water. Trees By [5], recycling 1 short ton (0,91 t) of paper saves 17 mature trees. CO 2 By now defunct [3], Production of 1 ton of copy paper produces 5,690 lb. of greenhouse gases. Some information now available at [4]. References [1] [2] LaserJet.pdf 77% = "Toner life extended by 30%": 1 / % = "Reduction in cost": 0.55 / Mean 75%, or factor [3] [4] [5] D

18 5 Regulatory information 5 Regulatory information WARNING NOTE: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. Consult the dealer or an experienced radio/tv technician for help. CAUTION: Changes or modifications not expressly approved by SafeCom a/s could void the user s authority to operate this equipment according to part 15 of the FCC rules. This equipment generates, uses, and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual, may cause interference to radio communications. It has been tested and found to comply with the limits for a Class A computing device pursuant to Subpart B of Part 15 of FCC Rules, which are designed to provide reasonable protection against such interference when operated in a commercial environment. Operation of this equipment in a residential area is likely to cause interference in which case the user will be required to take whatever measures may be required to correct the interference at the user's own expense. CE conformance: This product has been developed and produced in accordance with the EMC directive and the Low Voltage directive and therefore carries the CE mark. EMC directive: This product observes the rules and regulations of the EMC directive. If so required, a declaration of conformity in local language stipulating the applied rules and regulations can be obtained. D

19 6 Index 6 Index Document history, 5 Internet Information Service, 6, 8 Manuals, 4 Patent, 2 Regulatory information, 18 SafeCom Administrator, 12 SafeCom Save-O-Meter, 6 Save-O-Meter Calculations, 15 Widget, 13 System requirements, 4 Third Party Software, 2 Trademarks, 2 Windows Firewall, 6, 7 D

Nuance SafeCom Go Ricoh User s Guide

Nuance SafeCom Go Ricoh User s Guide D20703-09 November 2012 Trademarks: Nuance, the Nuance logo, SafeCom, SafeCom Go, SafeCom P:Go, SafeCom epay and the SafeCom logo are trademarks of Nuance Communications,