SAMreport-Lite P p USER'S GUIDE TM February 2005 COPYRIGHT Copyright © 2005 Macrovision Corporation. All Rights Reserved. The information contained herein contains confidential information and proprietary trade secrets and is the property of Macrovision Corporation. Any use, copy, publication, distribution, display, modification, or transmission of the information in whole or in part in any form or by any means without the prior express written permission of Macrovision Corporation is strictly prohibited. Except when expressly provided by Macrovision Corporation in writing, possession of this information shall not be construed to confer any license or rights under any of Macrovision Corporation's intellectual property rights, whether by estoppel, implication, or otherwise. ALL COPIES OF THE INFORMATION, IF ALLOWED BY MACROVISION CORPORATION, MUST DISPLAY THIS NOTICE OF COPYRIGHT AND OWNERSHIP IN FULL. TRADEMARKS Globetrotter, Macrovision, FLEXlm, FLEXbill, Flexible License Manager, and GTlicensing are registered trademarks or trademarks of Macrovision Corporation. All other brand and product names mentioned herein are the trademarks and registered trademarks of their respective owners. AUTODESK TRADEMARKS Autodesk, and AutoCAD are registered trademarks of Autodesk, Inc., in the U.S.A. and/or other countries. RESTRICTED RIGHTS LEGEND Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights of Technical Data and Computer Software clause of DFARS 252.227-0713 and FAR52.227-19 and/or applicable Federal Acquisition Regulation protecting the commercial ownership rights of independently developed commercial software. Contents Chapter 1 Quick Start to SAMreport-Lite........................................1 How to Obtain a License File...................................................................2 How to Install Java Runtime Environment.............................................2 How to Install SAMreport-Lite.................................................................3 How to Create and Set Up an Options File..............................................3 How to Use SAMreport-Lite.....................................................................4 How to Upgrade to SAMreport................................................................5 Chapter 2 Introduction....................................................................7 Intended Audience...................................................................................8 About This Manual..................................................................................8 What is License Management?................................................................8 What is SAMreport-Lite ?.........................................................................9 Chapter 3 Chapter 4 Chapter 5 Basics of Generating a Report.......................................11 Generate a Usage Summary Report........................................................12 Usage Summary Report.................................................15 Output Arrangement and Detail............................................................16 Report Input and Output..............................................17 Specifying Input Report Logs.................................................................18 Displaying Output to the Viewer Window............................................18 Navigating the SAMreport-Lite Viewer Window...................................18 Selecting Output Type and Output File Names.....................................19 Output Formats......................................................................................20 Format Specification:......................................................................20 Data Filters.............................................................................................21 Reports and Time Zones.........................................................................21 Setting Start and End Dates for a Report...............................................22 Chapter 6 Enabling and Managing Report Logs...........................23 How to Turn on a Report Log ...............................................................24 Size of the Report Log ...........................................................................25 Flushing Data to a Report Log...............................................................25 Managing Report Logs ..........................................................................25 i Finding the Version of the Vendor Daemon and lmswitchr.....................................................................................26 Rotating a Report Log with lmswitchr...........................................27 Avoiding Corruption in Report Logs.....................................................27 Chapter 7 SAMreport-Lite Error Messages.....................................29 ii | Contents Quick Start to SAMreport-Lite 1 In this chapter How to Obtain a License File How to Install Java Runtime This section gives you step-by-step instructions for installing TM SAMreport-Lite on your system. If you have any questions that are not addressed in this Quick Start section, consult the appropriate sections in this User's Guide. Environment How to Install SAMreport-Lite How to Create and Set Up an Options File How to Use SAMreport-Lite How to Upgrade to SAMreport How to Obtain a License File Before you install SAMreport-Lite, you must obtain a license file. SAMreport-Lite runs on any computer, but it can read only the report logs from the license server(s) where you obtain a license file. You will be asked for the location of this file during installation. To obtain a license file 1 On the server where you plan to manage licenses and report on them, on the Start menu, click All Programs (or Programs) Autodesk Network License Manager LMTOOLS. 2 In LMTOOLS, click the System Settings tab. 3 Record the host ID, which is located in the Ethernet Address field. NOTE If your server has more than one Ethernet adapter, select one that corresponds to a physical network adapter. 4 Exit lmtools. exe. 5 Next, you need to request a license file from Macrovision Corporation. On the Internet, go to the following website: http://autodesk.globes.com 6 Follow the online instructions for requesting a license file. 7 After completing the online request for the license file, you will receive an email that contains the license information. Copy and paste the license information from the email into a text editor. Save the file with an extension of .lic or .dat. Make sure you note where you saved the file and what you named it. You will be prompted for the location of the license file during the SAMreport-Lite installation. How to Install Java Runtime Environment SAMreport-Lite requires Java Runtime Environment 1.4.2_04. To install Java Runtime Environment 1 Insert the Autodesk product CD into your CD-ROM drive. 2 On the Media Browser, click the Install tab. 3 Click Network Deployment. 2 | Chapter 1 Quick Start to SAMreport-Lite 4 On the Network Deployment tab, under Install Supplemental Tools, click SAMreport-Lite 3.4. 5 Click Install JRE 1.4.2, and follow the on-screen instructions. How to Install SAMreport-Lite To install SAMreport-Lite 1 Insert the Autodesk product CD into your CD-ROM drive. 2 On the Media Browser, click the Install tab. 3 Click Network Deployment. 4 On the Network Deployment tab, under Install Supplemental Tools, click SAMreport-Lite 3.4. 5 Click Install, and follow the on-screen instructions. NOTE During installation of SAMreport-Lite, you will be asked for the location of your license file. If you do not have a license file, follow the procedures in How to Obtain a License File to obtain one. How to Create and Set Up an Options File To use SAMreport-Lite, you must configure your license server(s) to generate report logs. In the Network License Manager, you set up an Options file to enable SAMreport-Lite to create report logs. NOTE Complete instructions for setting up an Options file are located in the Autodesk Network Licensing Guide. You can access the guide from your product's Media Browser or in the Help system. To create and set up an Options file 1 In a text editor, create a file called adskflex.opt. 2 In the adskflex.opt file, enter the following syntax on a single line: REPORTLOG [+]report_log_path REPORTLOG must be uppercase, as shown. In the REPORTLOG syntax, "[+]" means that entries to the log file you create are appended rather than replaced each time the Network License How to Install SAMreport-Lite | 3 Manager is restarted. (It is recommended that you use this option so that you retain a history of log entries.) Path names that contain spaces must be enclosed in quotation marks. For example, the syntax REPORTLOG +"c:\My Documents\report.rl" means that a report log named report.rl is located in the folder c:\My Documents. 3 Save the adskflex.opt file to the same location where your license file exists. 4 Stop and then restart the Network License Manager. How to Use SAMreport-Lite To use SAMreport-Lite to generate a report 1 On the Start menu (Windows), click Start All Programs (or Programs) SAMreport SAMreport. 2 In the SAMreport-Lite window, click the Browse button. 3 In the Report Log dialog box, locate and specify your report log file. By default, the Report Log dialog box lists only files named with a .rl file name extension. If your report log file has a different extension, such as .log, open the Files of Type list and select All Files to list all the files. 4 In the SAMreport-Lite window, in the Output File box, specify the folder location and file name for your report output files. You do not need to specify the file name extension; the extension is automatically added to the name you supply based on the output formats you select. For example, if you select HTML and Text output formats and specify c:\my documents\report in Output File, the following report files are generated: c:\my documents\report.html c:\my documents\report.txt NOTE Be sure to specify the full path name for your output files. If you don't, output files are written to the current working directory, which may be the Windows desktop. Specifying a full path name ensures that your report files are saved in the folder you choose. 5 On the Report menu, click Generate. 6 The report you specified is generated. 4 | Chapter 1 Quick Start to SAMreport-Lite For more information about generating reports, see "Basics of Generating a Report" "Usage Summary Report". How to Upgrade to SAMreport The full-featured SAMreport product provides additional types of reports and options, and includes additional features such as command line batch processing. Upgrading to the full version of SAMreport does not require a new installation, just a new license file. To learn about the full-featured version of SAMreport, go to the Macrovision Corporation website at: www.macrovision.com How to Upgrade to SAMreport | 5 6 Introduction 2 In this chapter Intended Audience About This Manual What is License Management? What is SAMreport-Lite ? This chapter contains introductory information about license management, a description of SAMreport-Lite and explanatory information about this guide. Intended Audience SAMreport-LiteTM and this manual are intended for use by system administrators, system analysts, and managers who use FLEXlm® license management to produce usage reports for your software. About This Manual This manual is divided into five chapters and two appendixes: "Quick Start to SAMreport-Lite" on page 1 provides quick instructions for installing and using SAMreport-Lite. This chapter defines license management and introduces SAMreport-Lite. "Basics of Generating a Report" on page 11 contains instructions for generating a Usage Summary report from the SAMreport-Lite interface. "Usage Summary Report" on page 15 describes the Usage Summary report, and describes how to arrange report output. "Report Input and Output" on page 17 shows how to specify input files and describes output formats. "Enabling and Managing Report Logs" on page 23 provides guidelines for enabling and managing report logs. "SAMreport-Lite Error Messages" on page 29 lists some errors that you might get while running SAMreport-Lite. What is License Management? License management is a set of technologies that monitors the use of software. In some cases, it may also limit use of a product or record usage of a product. Most software companies have legal agreements that detail the obligations of the manufacturer and user to each other. These agreements are often referred to as "licenses." Some companies also include license management technology to simplify the legal use of their products. Throughout this documentation, the term "license" refers to a "token" obt ...