distributed license management installation guide · fixed width bold user input in console...

72
Distributed License Management Installation Guide Release 4.5

Upload: others

Post on 16-Oct-2020

25 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License ManagementInstallation Guide

Release 4.5

Page 2: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Please direct questions about Distributed License Management or comments on this document to:

Technology Customer SupportCompuware Corporation

Customer Support Hotline1-800-538-7822

FrontLine Support Web Site:http://frontline.compuware.com

For telephone numbers in other geographies, see the list of worldwide offices at http://www.compuware.com.

Access is limited to authorized users. Use of this product is subject to the terms and conditions of the user’s License Agreementwith Compuware Corporation. Documentation may be reproduced by Licensee for internal use only. All copies are subject to theterms of this License Agreement. Licensee agrees to provide technical or procedural methods to prevent use of the Software andits documentation by anyone other than Licensee.

Copyright © 2010 Compuware Corporation. All rights reserved. Unpublished rights reserved under the Copyright Laws of theUnited States.

U.S. GOVERNMENT RIGHTS—Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forthin Compuware Corporation license agreement and as provided in DFARS 227.7202-1(a) and 227.7202-3(a) (1995), DFARS252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable.Compuware Corporation.

This product contains confidential information and trade secrets of Compuware Corporation. Use, disclosure, or reproduction isprohibited without the prior express written permission of Compuware Corporation. Access is limited to authorized users. Useof this product is subject to the terms and conditions of the user’s License Agreement with Compuware Corporation.

Compuware and FrontLine are trademarks or registered trademarks of Compuware Corporation.

Java is a trademark or registered trademark of Sun Microsystems.

Adobe® Reader® is a registered trademark of Adobe Systems Incorporated in the United States and/or other countries.

All other company and product names are trademarks or registered trademarks of their respective owners.

Doc: CWDLIX4EBuild: September 2, 2010, 14:27

Page 3: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Contents

5Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5Who Should Read This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8Customer Support Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11Chapter 1 ∙ Licensing Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11License Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12License Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13License Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13Node-Locked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13Concurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13Borrow-Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13User Manage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14Redundant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14First-Come, First-Served . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14License Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15Determine if You Need the Compuware License Service . . . . . . . . . . . . . . . . . . . . . .15License Server is Required (Concurrent) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16License Server is Not Required (Node-Locked) . . . . . . . . . . . . . . . . . . . . . . . . .17Redundant License Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17Request a License from Compuware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18Impact to System Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19License Installation Checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21Chapter 2 ∙ License Installation and Configuration for Windows . . . . . . . . . . . . . .21Installing the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22Configuring the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23Configuring the License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Installing on Windows Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3Distributed License Management Installation Guide

Page 4: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

25What To Do When a Server Fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25Installing to a Windows Virtual Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27Chapter 3 ∙ License Installation and Configuration for Windows CE . . . . . . . . . . .27Compuware LicenseSync - The Synchronization Tool . . . . . . . . . . . . . . . . . . . . . . . .27Access LicenseSync Through Microsoft ActiveSync . . . . . . . . . . . . . . . . . . . . . .28The CE Client Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Saving Device Information/Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Importing a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29Transferring License Keys to a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30Using Borrowed Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30Removing License Keys from a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33Chapter 4 ∙ License Installation and Configuration for UNIX . . . . . . . . . . . . . . . .33Installing the Compuware License Service for UNIX . . . . . . . . . . . . . . . . . . . . . . . . .34Configuring the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35Installation for UNIX Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38What To Do When a Server Fails on UNIX . . . . . . . . . . . . . . . . . . . . . . . .38UNIX Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39Comparing Compuware License Service Versions . . . . . . . . . . . . . . . . . . . . . . .

41Chapter 5 ∙ Environment Consistency for UNIX Platforms . . . . . . . . . . . . . . . . . .41DLM Data Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43Chapter 6 ∙ License Borrowing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45Chapter 7 ∙ DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45Supported Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46DLM Web Interface Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47Installing the DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47Creating User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49Defining the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50Configuring the DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51Starting the DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53Appendix A ∙ Host Name and Host ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53Determine Host Information of a Computer on Windows . . . . . . . . . . . . . . . . . . . . . .54Determine Host Information of a Computer on UNIX . . . . . . . . . . . . . . . . . . . . . . . . .

55Appendix B ∙ License Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59Appendix C ∙ Client-Server Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . .59Client Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59Client Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62Server Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Distributed License Management Installation Guide4

Contents

Page 5: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Introduction

The Distributed License Management Installation Guide provides information and proceduresto:

• Obtain a license.

• Install concurrent (multi-user) or node-locked (single-user) licenses.

• Configure the license environment.

• Troubleshoot license installation errors.

Who Should Read This GuideThis guide is intended for administrators who are installing Compuware products.You can find reference and usage information in the online help for the licensing components.For more information, see License Components [p. 11].It is assumed that you are familiar with basic Microsoft Windows and Web browser navigation.If this is not the case, familiarize yourself with the documentation for Microsoft Windows andyour Web browser before reading this guide.

ConventionsThe following font conventions are used throughout documentation:

IndicatesThis font

Terms, commands, and references to names of screen controls and userinterface elements.

Bold

Links to Internet resources and linked references to titles in Compuwaredocumentation.

Conventions [p. 5]

Cited contents of text files, examples of code, command line inputs or systemoutputs. Also file and path names.

Fixed width

User input in console commands.Fixed width bold

5Distributed License Management Installation Guide

Page 6: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

IndicatesThis font

Place holders for values of strings, for example as in the command:Fixed width italic

cd directory_name

Menu items.Menu → Item

TerminologyUnderstanding the following terms will facilitate the user’s understanding of this guide:

ClientThe licensing component of a program that has the capacity to authorize or deny aprogram’s startup. The authorization process is dependent on license sources.

Concurrent keySee counted key.

Counted keyAny served key that contains an attribute that specifies a physical limit on the number oflicensed clients authorized to run a licensed product concurrently. The limit is enforcedby a combination of the Compuware License Service and its clients.

Floating keySee counted key.

Host IDAny identifier that uniquely identifies a workstation.

KeySee license key.

LicenseSee license key.

License fileAn XML based file that contains a single license object.

License keyAn XML object, a sub-component of a license object, which contains application-clientspecific information and system specific information that defines the extent to which oneor more associated applications can run.

License objectA license object contains one or more license keys.

License serverA single networked node that hosts the Compuware License Service.

License serviceA service that runs as a background process on a licensed server. It provides a searchabledatabase of license keys to facilitate the process of networked licensing.

License sourceA license file or a reference to a licensed server.

Distributed License Management Installation Guide6

Introduction

Page 7: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

License tokenThe result of a successful license request. The license token is a copy of a valid key. Inthe case of counted keys, license tokens are like virtual toll tickets, returned to theCompuware License Service when the licensed product no longer needs it.

Licensed clientAny workstation authorized, through a license source, to run one or more Compuwareproducts.

Licensed productA purchased Compuware program, licensed by a license source.

NodeA single workstation. Networks consist of one or more nodes.

Node-lockedSee uncounted key.

Served keyAny licensed key that is loaded into the Compuware License Service database fornetworked licensing.

Uncounted keyAn uncounted key is any key associated with a product whereby usage of the product isnot dependent on a predetermined limit.

DocumentationDistributed License Management comes with both an installation guide and online help.The installation guide is in PDF format. It is available from the product installation disk and,after installation, from C:\Program Files\Common Files\Compuware.The online help covers how to use the following DLM licensing components:

• Distributed License Management application

• Distributed License Management Web Interface

There are several ways to access the online help from within a licensing component:

• From the Help menu, choose Index to browse for help for the licensing component beingused.

• Click [F1] to open the Help menu.

• Open C:\Program Files\Common Files\Compuware\DLMHelp.chm.

Getting HelpAt Compuware, we strive to make our products and documentation the best in the industry.Feedback from our customers helps us maintain our quality standards. If you need supportservices, please obtain the following information before contacting Compuware CustomerSupport:

7Distributed License Management Installation Guide

Introduction

Page 8: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

• The name and release number (version) of the Compuware product you are using, in additionto the name and release number of the Distributed License Management component. Obtainthis information by choosing Help → About. The name and release number are alsodisplayed on the covers of the product and DLM documentation.

• Installation information, including:

◦ Installed options

◦ Whether the product uses local or network databases

◦ Whether it is installed in the default directories

◦ Whether it is a stand-alone or network installation

◦ Whether it is a client or server installation

• Environment information, such as the operating system and release on which the productis installed, memory, hardware/network specifications, and the names and releases of otherapplications that were running.

• The location of the problem in the DLM or product software, and the actions taken beforethe problem occurred.

• The exact product error message, if any.

• The exact application, licensing, or operating system error messages, if any.

• Your Compuware client, office, or site number if available.

Customer Support Information

FrontLine Support Web Site

You can access online information for Compuware products via our FrontLine support site athttp://frontline.compuware.com. FrontLine provides access to critical information about yourCompuware products. You can review frequently asked questions, read or downloaddocumentation, access product fixes, or e-mail your questions or comments. The first time youaccess FrontLine, you are required to register and obtain a password. Registration is free.Compuware now offers User Communities, online forums to collaborate, network and exchangebest practices with other Compuware solution users worldwide. Go tohttp://groups.compuware.com/ to join.

Contacting Customer Support

Phone• USA and Canada: 1-800-538-7822 or 1-313-227-5444.

• All other countries: Contact your local Compuware office. Contact information isavailable at http://frontline.compuware.com.

WebYou can report issues via the Report and Track Calls tab on the FrontLine home page.

Distributed License Management Installation Guide8

Introduction

Page 9: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

NOTEPlease report all high-priority issues by phone.

MailCustomer SupportCompuware CorporationOne Campus MartiusDetroit, MI 48226-5099

Corporate Web Site

To access Compuware's site on the Web, go to http://www.compuware.com. The Compuwaresite provides a variety of product and support information.

9Distributed License Management Installation Guide

Introduction

Page 10: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License Management Installation Guide10

Introduction

Page 11: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 1

Licensing Overview

Compuware software products are protected from unauthorized usage via a standard licensingmechanism. The Distributed License Management components validate that an appropriatelicense is available and facilitate the license management and administration needs for yourCompuware products.The licenses are provided in files that can be installed on individual end-user desktops fortemporary or node-locked licenses, or can be installed on a central license server for centralizedadministration of licenses.When a central license server is used, individual end-user (client) machines or servers runningCompuware products must connect to a license service to obtain their license. To do this inWindows, use the Distributed License Management application on each target machine. OnUNIX, use the Distributed License Management - Command Line Version (DLMCV) to establishthe host name and port number of the server machine running the license server.Licensing your Compuware product depends on several factors:

• The type of license file you received from Compuware.

• The number of users specified in your license file.

• The use of Compuware License Service, or not.

License ComponentsNOTESome Compuware products do not support all of the product components.

Compuware licensing software consists of the following key components:

Distributed License Management (DLM) ApplicationA Windows-based administration tool that can display all Compuware product licenseinformation available on both the client and server environments. The DLM application

11Distributed License Management Installation Guide

Page 12: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

is also used for license configuration. On systems where the Compuware License Serviceis installed, the user-definable attributes of a license server can be changed.

Compuware License ServiceThe application cpwr.exe, invoked by the DLM application or executed from the commandline, that manages and services requests for the licenses of your Compuware products.The Compuware License Service can be installed on Windows and UNIX platforms. Inmany cases, it is recommended that you co-locate the Compuware License Service withthe server-based components of one of the Compuware products you are installing.

License fileA data file that contains information about the license you have obtained for one or moreof your Compuware products. To review the contents of your license file, open it withInternet Explorer.

DLM Web InterfaceA Web-based tool that allows an administrator to perform simple license serveradministration within a browser window.

License TypesSome Compuware products allow a time-limited trial license automatically without requiringinstallation of a license file. Other products require a license file even for a trial. If you startyour Compuware product without a license, it either informs you that the license is missing orindicates that an automatic time-limited trial has started. Each time you start a product on anautomatic time-limited trial, you may be asked if you want to install a permanent license or tocontinue the trial. Before the trial runs out, you should acquire a permanent license fromCompuware. For more information, see Request a License from Compuware [p. 17].Compuware offers several types of licenses. These licenses types are described below.

NOTESome products do not support all license types.

PermanentA permanent license has no ending date.

TemporaryA temporary license has a fixed expiration date. You must request this license fromCompuware’s sales team.

Rolling TrialA rolling trial license is automatically installed when you install some Compuwareproducts. When this is provided, it allows you to run the product for a specific time period(14–45 days from the day you install the product) and is locked to a specific system. Eachtime you start your Compuware product, a message appears informing you of the timeleft before the trial license expires. With a rolling trial license, you have the ability toreview the product before deciding to purchase it.

Distributed License Management Installation Guide12

Chapter 1 ∙ Licensing Overview

Page 13: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

License ModelsCompuware offers two license models: node-locked and concurrent.

Node-LockedA node-locked license is a license that is tied to a particular machine via a unique identifier(generally the NIC MAC Address, but optionally a hard disk signature). There are two types ofnode-locked licenses: trial (demo) and permanent.For node-locked licenses, the use of the Compuware License Service is not required, but it canbe used if you want a central place to store all of your licenses. A node-locked license is denotedby the absence of the <count> tag for the licensed feature. For more information, see LicenseServer is Not Required (Node-Locked) [p. 16].

ConcurrentA concurrent (counted) license is server-based and requires the use of the Compuware LicenseService. This license allows you to share the use of a product with more than one user. Thereare several types of concurrent license models: borrow-enabled, user manage, redundant, andfirst come, first served (FCFS).A concurrent license is denoted by the <count> tag for the licensed feature. It allows you to usea specific number of licenses without assigning them to a particular workstation. When allavailable licenses are checked out, no additional users can run the product until a license ischecked back in.User duplication allows the user to run an unlimited number of instances of an application aslong as it is the same user on the same machine. The net usage in this case is always one for theindividual user, regardless of the number of instances running.For more information, see License Server is Required (Concurrent) [p. 15].

Borrow-EnabledBorrow-enabled is a type of concurrent license model that allows a user to borrow a feature orproduct up to a specified amount of days. The user checks out a feature and indicates how longto borrow it without exceeding the 365-day limit.Each checkout is exclusive to each user, meaning multiple users could use the same machine,but have access only to the keys checked out by their user ID. Users can check in the key at anytime within the borrow time frame specified. If this is not done, once the time expires the useris no longer able to use that key and it goes back into the server for other users to borrow.A disadvantage to using this type of concurrent model is that if a machine with a borrowedlicense on it becomes disabled or lost, the borrowed license remains checked out until the timelimit has expired. A good rule of practice is to keep the checkout duration to a minimum.

User ManageUser manage is a type of concurrent license model that allows the license administrator tocontrol user access to specific options or features. Administrators can grant or deny access tospecified users or groups of users. The following is the code in the server configuration file:

13Distributed License Management Installation Guide

Chapter 1 ∙ Licensing Overview

Page 14: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

<user_management>

<application>

<user/>

<everyone/>

</application>

</user_management>

The system administrator using the configuration object user_management can manage onlylicenses that contain keys that have the Umanage parameter. For more information, see Umanage[p. 57]. User Manage-enabled keys authorize an administrator to control which users haveaccess to the key that has the keyword Umanage defined.Before setting up a <user_management> section, the administrator must get the <App> namefrom the key or keys that support User Management. This will require examination of the licensefile. For more information, see License Files [p. 55]. Using the App name as a parameter, theadministrator then defines which users have access to the application, identified by App. Forexample:<fileAid>

<everyone/>

< abcwec0/>

< abcddg0/>

</fileAid>

In the above example, the keyword everyone instructs the license service that all users areauthorized to access the key. When the everyone keyword is specified, individual users thatare added to the definition are perceived by the license service as excluded from the set of“everyone”. Hence, the above example would read "allow everyone to use the key fileAidexcept abcwec0 and abcddg0." The absence of the everyone keyword means that only identifiedusers are to be granted access to the license key. Users that are not listed will be denied access.A separate entry must exist for each key that supports the Umanage parameter. Users can bedefined by either their host ID or LAN ID (login ID).

RedundantA redundant server license is a type of concurrent license model that provides limited protectionagainst license server failure. It disperses the responsibility of managing the license files overa predetermined number of servers. For more information, see Redundant License Servers[p. 17].

First-Come, First-ServedFirst-come, first-served (FCFS) is a type of concurrent license model that limits the number ofphysical users to a defined set. A physical user is defined as a login ID and is allowed to runon one machine per network. The set of defined users is based on a registration process in whichthe Compuware License Service registers each licensed user up to N users, where N is basedon the license count. The Nth+one user that attempts to register is denied.

License EnvironmentIt is often the case that multiple license sources (or license servers) are defined in a user's licenseenvironment. When a request is made to check out a license for a Compuware product, alllicense sources in the license environment are scanned until a valid key is found.

Distributed License Management Installation Guide14

Chapter 1 ∙ Licensing Overview

Page 15: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Before you attempt to run a particular product, be sure that one of the license sources you havedefined contains information for the product you want to run. Also, if there are old or obsoletelicense sources in your environment setting, you should delete them to improve product responsetime. Only currently operating servers should be specified in the license environment setting.For information on configuring the license environment, see the appropriate topic:

• Windows — Configuring the License [p. 23]

• UNIX — Installation for UNIX Clients [p. 35]

Determine if You Need the Compuware License ServiceThe first step in the licensing process is to determine whether it is necessary to install and runthe Compuware License Service. The Compuware License Service is a long running processserving multiple client machines, so most often you install it on one central server machine foryour entire organization.The Compuware License Service can serve all Compuware product lines. You do not needmultiple license services unless you are running redundant servers. For more information, seeRedundant License Servers [p. 17].The DLM application, for Windows only, provides an interface to configure the CompuwareLicense Service. DLM determines the need for the Compuware License Service based on thelicense files provided to it. If a license file requires the Compuware License Service, DLM willautomatically install, start, and configure the Compuware License Service with the defaultsettings.On non-Windows platforms, the administrator must view the license to determine if theCompuware License Service is necessary. In general, the Compuware License Service shouldbe started for all counted licenses. Any license containing a <count> tag is a counted-concurrentlicense. On non-Windows platforms, the Compuware License Service can be administered usingthe Distributed License Management - Command Line Version (DLMCV).

License Server is Required (Concurrent)A license file containing the <count> tag is considered to be concurrent or floating, and requiresuse of the Compuware License Service. A concurrent license allows you to run a Compuwareproduct on more than one client so that multiple users can access the product. This means thatyou purchase a specific number of licenses without assigning these licenses to particular clientsor having to obtain their unique node identifiers.The Compuware License Service keeps track of licenses as they are checked out and checkedin by users. Licenses are checked out by users on a first-come, first-served basis when theyaccess the product. After all available licenses are issued, no additional users can run the productuntil another user exits and a license is checked in. Your license determines how many userscan access the product at one time.

15Distributed License Management Installation Guide

Chapter 1 ∙ Licensing Overview

Page 16: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Figure 1. Typical Configuration for a Concurrent License

The Compuware License Service must be running on a computer or server that is always availableto all clients needing access to the product.Installation and configuration procedures differ depending on the platform. For more information,see License Installation and Configuration for Windows [p. 21] and License Installation andConfiguration for UNIX [p. 33].

License Server is Not Required (Node-Locked)A node-locked license is tied to a particular machine via its NIC card address or disk ID.

Figure 2. Typical Configuration for a Trial or Node-Locked License

When you have a node-locked license, installation is very straight-forward using one of thefollowing options:

• You can install the license directly on the end-user desktop, in which case you do not needthe Compuware License Service.

• You can install the Compuware License Service on a remote node to consolidate yourlicenses in one location.

Distributed License Management Installation Guide16

Chapter 1 ∙ Licensing Overview

Page 17: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Redundant License ServersIf a large number of licenses are governed by a single license server, failure of the server becomesa major event. To prevent problems, you should set up redundant servers so that if one servergoes down, the Compuware License Service can still function.License server redundancy provides quality of state by eliminating a single point of failure.Under license server redundancy, multiple license servers are deployed to support a singlelicense. In the event of a partial failure (that is, the failure of a subset of the license servers),the subset of remaining servers is able to maintain a temporary state of license support for apredetermined amount of time while the initial state is restored. Refer to the online help formore information on redundant servers.

Request a License from CompuwareTo obtain a permanent license, you must provide Compuware with the host information of themachine on which the license will reside. You can either contact Worldwide License Managementat [email protected] or determine the host information using the DLM applicationand e-mail that information to Compuware.When you receive your license file, copy the file to a directory on the machine identified in thelicense file. For more information, see License Files [p. 55].

Supported PlatformsThe following table lists the platforms upon which DLM components can be installed, licensed,and run.

Table 1. Supported Platforms

VersionsOperating System

2000WindowsServer 2000Server 2003 Standard/Enterprise/Web Editions (32-bit/x64)Server 2003 R2 Standard/Enterprise/Web Editions (32-bit/x64)Server 2008 Standard/Enterprise/Web Editions (32-bit/x64)Server 2008 R2 Standard/Enterprise/Web Editions (32-bit/x64)XP, through SP3 (32-bit/x64)Vista, through SP1 (32-bit/x64)Windows CE 4.2 and 5.0

5L 5.2 and 5.3AIX (32-/64-bit)6L 6.1

V5R3AS/400V5R4IBMi V6R1

17Distributed License Management Installation Guide

Chapter 1 ∙ Licensing Overview

Page 18: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

VersionsOperating System

V7.2Open VMS AlphaV7.3V7.3-2V8.2V8.3

V8.2Open VMS ItaniumV8.3

11i 1.0 (32-/64-bit)HP-UX PA-RISC

11i 2.0 (32-/64-bit):HP-UX Itanium11i 3.0 (32-/64-bit):

V5.1bUNIX Tru64

8Solaris (32-/64-bit)910

2.1Red Hat Enterprise Linux ES (32-/64-bit)3.04.05.0

4.4Red Hat Enterprise Linux ES zSeries(31-/64-bit) 5.0

Redflag 4.1Asian UX 32-bit

8SuSE Linux ES (32-/64-bit)910

9SuSE Linux ES zSeries (31-/64-bit)10

Impact to System PerformanceThe License Server (cpwr.exe) requires the following system resources.

• Memory — 4.3 MB

• Disk space — 1 MB

Distributed License Management Installation Guide18

Chapter 1 ∙ Licensing Overview

Page 19: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

License Installation ChecklistsIf you are installing a Compuware product with an rolling trial capability, you do not need totake any further action until you obtain your permanent license. Your trial license allows youto use your product for a period of time from 14 to 45 days, depending on the product.The following checklists can assist you in the licensing process after your rolling trial hasexpired, or if you are installing your permanent license. Begin with the following:

Determine the type of license model you have (node-locked or concurrent), and whether itrequires the Compuware License Service. For more information, see License Models [p. 13]and Determine if You Need the Compuware License Service [p. 15].

If your license requires it, install the Compuware License Service. Refer to the checklistbelow.

If you have a node-locked license and do not require DLM, install the Compuware product.Refer to the product's installation guide.

Compuware License Service Installation Checklist

Select the platform (Windows or UNIX) on which the Compuware License Service mayrun.

• For Windows, see License Installation and Configuration for Windows [p. 21].

• For UNIX, see License Installation and Configuration for UNIX [p. 33].

Use the DLM application to perform one of the following:

• Configure the license.

• Assign the license file to the Compuware License Service.

Have end-users add the license service source to their license environment using either theDLM application (Windows only) or the Distributed License Management - Command LineVersion. For more information, see Installing on Windows Clients [p. 24] and Installationfor UNIX Clients [p. 35].

If license borrowing is enabled (for concurrent licenses only):

• For administrators, see the License Borrowing Checklist for Administrators [p. 19]checklist.

• For clients, see the DLM Web Interface Checklist [p. 20] checklist.

If you are using the DLM Web Interface, see the DLM Web Interface Checklist [p. 20]checklist.

If the tag <Umanage> is in your license files, see Umanage [p. 57].

License Borrowing Checklist for Administrators

Check that you have a concurrent license, which is required in order to use license borrowing.

19Distributed License Management Installation Guide

Chapter 1 ∙ Licensing Overview

Page 20: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Check whether your license file has the <borrow> tag. For more information, see LicenseBorrowing [p. 43].

DLM Web Interface Checklist

Install the DLM Web Interface. For more information, see DLM Web Interface InstallationOverview [p. 46].

Create user accounts for the Compuware License Service. For more information, see CreatingUser Accounts [p. 47].

Identify the Compuware License Service to the DLM Web Interface. For more information,see Defining the Compuware License Service [p. 49].

Link the DLM Web Interface to the Compuware License Service. For more information,see Configuring the DLM Web Interface [p. 50].

Distributed License Management Installation Guide20

Chapter 1 ∙ Licensing Overview

Page 21: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 2

License Installation and Configuration forWindows

The procedures in this chapter describe how to install the Distributed License Managementcomponents on a Windows server.

Installing the Compuware License ServiceTIPIf you are on a client that may be a server, see Installing on Windows Clients [p. 24] to installthe Compuware License Service and bypass the following steps.

Follow the instructions below to install the Compuware License Service. For best results, closeall programs before installing your Compuware product and the DLM components.

1. From installation media, select Install (Compuware) License Service.This starts the InstallShield wizard for the Compuware License Service. You need tonavigate through several screens to proceed through the InstallShield wizard. These screensrequire you to perform tasks such as:

• Read and accept the License Agreement.

• Provide customer information.

• Start copying files.

2. Click Next after completing each screen of the InstallShield wizard.3. After the files are copied, click Finish to complete the installation.

Reboot the machine, if specified.

4. Open the DLM interface.From the Windows Start menu, choose Programs → Compuware → Distributed LicenseManagement to implement your Compuware license.

21Distributed License Management Installation Guide

Page 22: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

5. Click Add to specify the location of the served license, then click OK.

DLM will verify that the license is valid and install and start the Compuware LicenseService.

Configuring the Compuware License ServiceTIPFor further instructions when installing to a Windows virtual environment, see Installing to aWindows Virtual Environment [p. 25]

Before you can start the Compuware License Service, you must supply Worldwide LicenseManagement with the host ID of the node on which you plan to run the Compuware LicenseService. In return, Compuware will send you a license file.Complete the following steps to request a license file, install the license, start the license server,and launch DLM:

1. From the Windows Start, select Programs → Compuware → Distributed LicenseManagement.

2. Click Show System Information. The System and Environment Information dialogbox appears.

Distributed License Management Installation Guide22

Chapter 2 ∙ License Installation and Configuration for Windows

Page 23: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

3. Click Save To File and save the text file.4. Email the text file to [email protected].

Compuware then sends back a license file.

5. Copy the license file to C:\Program Files\Common Files\Compuware\License.

6. Start the license server by double-clicking C:\Program Files\CommonFiles\Compuware\cpwr.exe.

IMPORTANTYou cannot run more than one Compuware License Service at a time. If one is running,shut it down before starting a new one.

7. To launch DLM, from the Start menu, select Programs → Compuware → DistributedLicense Management.

Configuring the LicenseAll client and server systems require that one or more valid license sources be added to theirlicense environments in order to use a licensed Compuware product. A license source can be alocal file or a server reference (for example, port@host). In either case, the license source mustauthorize the system and the Compuware products for which it is deployed.The DLM application simplifies this process by providing an identical method for configuringboth client and server systems. It facilitates licensing on client systems by placing the licensesource in a configuration file. The server system also has a configuration file containing itslicense sources.

23Distributed License Management Installation Guide

Chapter 2 ∙ License Installation and Configuration for Windows

Page 24: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Concurrent License

When using a concurrent license model, each client machine must be configured to referencethe licensed server. The licensed server is defined as any system that has been authorized by avalid license file to provide remote start-up authorization for Compuware applications. Beforea licensed server can authorize remote application start-up, it must be running the CompuwareLicense Service (cpwr.exe).The Compuware License Service is automatically registered and started on the licensed servermachine by DLM when a valid server license is presented to DLM.In addition to the registration, configuration, and activation of the Compuware License Service,DLM also creates the Borrow License Server tab for those server licenses that support licenseborrowing. On client systems that reference licensed servers that support license borrowing,the Borrow License Client tab is automatically created by DLM. For more information, seeLicense Borrowing [p. 43].

Node-locked License

In the case of a node-locked license model, only the system designated in the license file isauthorized to run the specified Compuware applications. DLM only accepts a node-lockedlicense on the system that it authorizes.

Installing on Windows ClientsPerform the steps below to define a local license environment by adding a license source.

NOTEIn DLM release 4.5, you now can add the license file directly to the License\ folder, then startup the license server to install a license.

• In Windows XP, the folder is Documents and Settings\AllUsers\.Compuware\license\.

• In Windows Vista, the folder is Users\Public\.Compuware\license\.

1. Click the Local Environment tab.2. Click Add to open the Add License dialog box.

Distributed License Management Installation Guide24

Chapter 2 ∙ License Installation and Configuration for Windows

Page 25: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

3. Type the fully qualified path to a license or click Browse to open the Open dialog box andfind the license file.Or, type the port@host definition if you are attempting to access a concurrent license. Theport number is typically 7188.

4. Click OK to add the license source to the environment.If this is a concurrent license, this starts and installs the Compuware License Service andadds the Server Environment tab to the DLM application. If this concurrent license isborrow-enabled, it will add the Borrow License Server tab to the DLM application aswell. When provided with a license source, DLM performs an analysis, determines whatis needed to implement it into the local environment, and checks for errors.

5. If using redundant servers, repeat step Step 3 [p. 25] and Step 4 [p. 25] on each client.6. To initialize the redundancy policy, launch the product that uses DLM from one client.

What To Do When a Server FailsIf redundant servers have been set up and a server(s) goes down, you can continue to operateCompuware products without interruption for the failsafe duration as long as you do not fallbelow the failsafe count. No action is necessary after bringing up the downed server(s).

Installing to a Windows Virtual EnvironmentIn order to obtain a license key to run in a virtual environment, a unique identifier must first begenerated using dlmInfo.exe.The dlmInfo.exe application generates a unique identifier using the Ethernet address and thenetwork name on which the virtual environment image resides.If the Compuware product is already installed, dlmInfo.exe is located in the Windows CommonFiles directory (the default location is C:\Program Files\CommonFiles\Compuware\dlmInfo.exe). Otherwise, dlmInfo.exe can be obtained by downloadingit from FrontLine at http://frontline.compuware.com.Once the results are obtained, they should be submitted to Compuware. For more information,see Configuring the Compuware License Service [p. 22].

25Distributed License Management Installation Guide

Chapter 2 ∙ License Installation and Configuration for Windows

Page 26: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Figure 3. Example dlmInfo.exe output

Supported Virtual Environments

• VMware

◦ Workstation

◦ ESX Server

◦ Lab Manager

• Microsoft

◦ Hyper-v

◦ Virtual Server

Distributed License Management Installation Guide26

Chapter 2 ∙ License Installation and Configuration for Windows

Page 27: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 3

License Installation and Configuration forWindows CE

Distributed License Management provides license support for Windows CE based mobileproducts. The mobile implementation supports both single-user and, to a limited extent,concurrent license models.

Compuware LicenseSync - The Synchronization ToolCompuware LicenseSync is a desktop synchronization tool that provides license support formobile devices by facilitating the transfer (i.e., synchronization) of license keys through adialog-based user interface. It supports the communication protocols currently supported byMicrosoft ActiveSync.LicenseSync enables end users to transfer both concurrent (borrow-enabled) transactions andsingle-user license keys between a desktop computer and an attached mobile device. Bothsingle-user license keys and borrow transactions are transferable (i.e., can be synchronized)between a mobile device and any desktop that supports the DLM runtime. For license borrowing,connectivity must exist between the license server and the hosting desktop.

Access LicenseSync Through Microsoft ActiveSyncCompuware LicenseSync is accessible in Microsoft ActiveSync through Tools → AdvancedTools → Compuware LicenseSync. The following graphic is from ActiveSync 3.8. The locationof this command varies in other versions of ActiveSync, but it is available.

27Distributed License Management Installation Guide

Page 28: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Figure 4. Compuware LicenseSync in Microsoft ActiveSync

The CE Client RuntimeDue to the nature of mobile devices (the uncertainty of persistent network connectivity),concurrent licensing is limited to explicit borrowing. This requires that all concurrent keysdesignated for mobile device access be borrow-enabled.

InstallationLicense installation occurs automatically during the product’s mobile installation.

Saving Device Information/StatusTo save the device information/status, click Save. LicenseSync writes the device informationto a file.

Figure 5. Device Information/Status in LicenseSync

Importing a License1. Click Import a License File to display the Open dialog box.

Distributed License Management Installation Guide28

Chapter 3 ∙ License Installation and Configuration for Windows CE

Page 29: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

2. Select the desired file and click Open.The license keys contained in the license file will be displayed.

Transferring License Keys to a Device1. Select the key(s) to be transferred.

29Distributed License Management Installation Guide

Chapter 3 ∙ License Installation and Configuration for Windows CE

Page 30: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

2. Click Add.The status of the transferred key(s) will change to On Device and the location/device willchange to the device name.

Using Borrowed KeysBefore borrowed keys can be transferred to a device they must first be borrowed using the DLMproperties dialog box. For more information, see License Borrowing [p. 43]. CompuwareLicenseSync checks periodically for borrowed keys and automatically imports them for transfer.Once imported, borrowed keys are selected for synchronization just as normally imported keysare.Borrowed keys that are transferred to a device cannot be returned to the hosting computer (i.e.the computer to which the mobile device is attached). Instead, borrowed transactions are returneddirectly to the server for which they were initially borrowed.

Removing License Keys from a Device1. Select the features to be removed from among the keys with a status of On Device.2. Click Remove.

Distributed License Management Installation Guide30

Chapter 3 ∙ License Installation and Configuration for Windows CE

Page 31: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

31Distributed License Management Installation Guide

Chapter 3 ∙ License Installation and Configuration for Windows CE

Page 32: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License Management Installation Guide32

Chapter 3 ∙ License Installation and Configuration for Windows CE

Page 33: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 4

License Installation and Configuration for UNIX

The licensing process varies based on the Compuware product being installed, your agreementwith Compuware, and the platform on which the Compuware License Service is installed.When the Compuware License Service is needed, setup involves the following steps:

1. Install the Compuware License Service and its components.Installation of the Compuware License Service is only required for concurrent license types(denoted by the <count> tag for the licensed feature). For more information, see Installingthe Compuware License Service for UNIX [p. 33].Installing the Compuware License Service is not required if you have a node-locked license.For more information, see Installation for UNIX Clients [p. 35].

2. Configure the Compuware License Service to start. For more information, see Configuringthe Compuware License Service [p. 34].

3. Configure each client to access the Compuware License Service. For more information,see Installation for UNIX Clients [p. 35].

Installing the Compuware License Service for UNIXFollow the steps below to install the Compuware License Service.

1. Load the installation media on your system (root access required).2. Change to the mount directory.

For example, if /cdrom is the mount directory, type the following:cd /cdrom

3. Navigate to the directory on the installation media that contains the Compuware LicenseService installation files.See the product documentation for the specific Compuware product for the location of thelicense installation component.

4. Execute the command to install the Compuware License Service on your system.

33Distributed License Management Installation Guide

Page 34: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Type:install.sh install_bundle target

If you do not specify a target, the installation will be placed in /opt/compuware/dlm Rootaccess may be required to create the directory. If you specify a directory, the CompuwareLicense Service files will be installed directly into the target directory.

5.

You are notified when the installation is completed.

NOTEIf the installation has a problem creating the directory, you are notified of the error and areforced to exit.

Figure 6. Install the Compuware License Service

Configuring the Compuware License ServiceBefore a client can access a served license, the corresponding server must have the CompuwareLicense Service installed and running. You can configure the Compuware License Service tostart automatically (each time the server boots) or to be started manually.

1. Identify the host ID.Before you can start the Compuware License Service, you must supply Compuware withthe host ID of the node on which you plan to run it. In return, Compuware will send you alicense file. To obtain the host ID, perform the following commands:cd /target

dlminfo.sh

The ID, which the licensing system uses for validation, is displayed:

Distributed License Management Installation Guide34

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 35: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

2. Send this ID information to [email protected] then sends back a license file.

3. Copy the license file to /target/license.

4. Do one of the following:

IMPORTANTYou cannot run more than one Compuware License Service at a time. If one is alreadyrunning, you must shut it down before starting a new one.

• To start the Compuware License Service manually (required each time the serverreboots), type cpwr.sh -start.

• To start the Compuware License Service automatically each time the server reboots,follow the suggested procedure below for the appropriate platform.

ActionPlatform

In etc/rc.local, type the following command on one line:AIX/target/cpwr.sh -start

In /sbin/rc3.d, create a file named s95cwlm.server and add the followingcommand to the file:

HP-UX

/target/cpwr.sh -start

In /etc/rc.d/rc2.d, create a file named s95cwlm.server and add thefollowing command to the file:

Linux

/target/cpwr.sh -start

In /etc/rc2.d, create a file named s95cwlm.server and add the followingcommand to the file:

Sun Solaris

/target/cpwr.sh -start

Installation for UNIX ClientsIf the Compuware License Service is required (concurrent license), each client must be configuredto access the license key database. If the Compuware License Service is not required (node-lockedlicense), a license file is required on each client machine.

35Distributed License Management Installation Guide

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 36: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

The Distributed License Management - Command Line Version (DLMCV) is the command-lineversion of the Windows GUI-based DLM application. While limited in functionality, the DLMCV mirrors most of the functionality provided by its GUI-based counterpart. The purpose ofDLMCV is to provide a simple text interface that is platform and display independent. It providesUNIX text-based support and support for script-based configurations.The DLMCV application is located in the license installation directory on the same directorylevel as the Compuware License Service.To launch the command-line version of the DLM application, type:dlmcv.sh

The DLMCV user interface uses a series of text-based menus, called command lists. Eachcommand list and its submenu is hierarchically organized by category and is based on thefunctionalities provided by each menu tree. Each menu label begins with one or more uppercaseletters. Entering either the label of a menu or its abbreviated character set (denoted by theuppercase characters) provides access to the menu item. Menu items are either references tosubmenus or commands. Clicking the Enter key from any submenu returns you to the nexthighest menu level.When the DLMCV is launched, the Main menu is displayed. It contains two submenus: Clientand License Service. The following figure shows the Main menu.

Figure 7. DLMCV Main Menu

To add a license to the client environment:

1. Access the Client menu by typing either c or client.The Client menu displays the following list of configuration and diagnostics commandsfor the administration of a license client.

Distributed License Management Installation Guide36

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 37: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

2. Select the license path by typing: l (one).

3. At the prompt, specify the port@host to your license server or the fully qualified path toa local license file, then press [Enter].

37Distributed License Management Installation Guide

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 38: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

NOTEFor more information on using the displayed commands, type ? from within any of thecommand menus and press [Enter]. You can also refer to the DLM application’s onlinehelp.

4. If you are using redundant servers, repeat the preceding step on each client.5. To initialize the redundancy policy, launch the product that uses DLM from one client.

What To Do When a Server Fails on UNIXIf redundant servers have been set up and a server(s) goes down, you can continue to operateCompuware products without interruption for the failsafe duration as long as you do not fallbelow the failsafe count. No action is necessary after bringing up the downed server(s).

UNIX ComponentsThe installation directory for the UNIX platform includes the following files:

ReadmeAdditional Compuware License Service information.

/binFor Compuware use only.

/configDirectory containing the server configuration file config.xml.

cpwr.shCompuware License Service.

dlminfo.shSystem information.

Distributed License Management Installation Guide38

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 39: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

install.logContains data from the installation process.

dlmcv.shDistributed License Management - Command Line Version.

libdlm32.soRuntime library used by clients.

libdlm64.soRuntime library used by clients.

/licenseDirectory containing license files.

osMulti-platform support.

vlog.shCompuware License Service log file.

Troubleshooting

Comparing Compuware License Service VersionsFollow the instructions below to compare the Compuware License Service version numberalready on the license server with the version number on the product installation media.

1. Determine the version number already on the license server:a) Navigate to the directory on the server where the Compuware License Service is

located.b) Type:

cat /target/dlm_version

Make note of the Compuware License Service version number located in the responsemessage.

2. Determine the version number on the product installation media:a) Insert the product installation media, open a command prompt, and navigate to the

directory of the installation media containing the install bundle.b) To display the version information, type:

cat dlm_version

3. If the installation media has a newer version, install the new Compuware License Service.For more information, see Installing the Compuware License Service for UNIX [p. 33].

39Distributed License Management Installation Guide

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 40: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License Management Installation Guide40

Chapter 4 ∙ License Installation and Configuration for UNIX

Page 41: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 5

Environment Consistency for UNIX Platforms

On UNIX platforms, DLM determines the location on a system by using relative paths basedon the executable being launched. This allows users to install DLM to any location.On AS/400 systems, however, the relative path concept is not available. In order to get aroundthis problem temporarily, DLM was installed to a fixed location. Starting with DLM 4.2, theAS/400 implementation is more consistent with the UNIX implementation.

DLM Data Configuration FilesAs with Windows and UNIX, administrators have the option to define globally the licensedclient environment for all end users on a system. In a global environment, all users share acentral .compuware folder in which the licensed client’s environment is stored.On UNIX, the global configuration folder is located in the root directory of the system; onWindows, it is located in the \Documents and Settings\All Users directory.The global configuration folder .compuware for the AS/400 is stored under the directory definedby the DLM_ROOT data area. In addition, as with other supported platforms, end users can havea local configuration, which overrides a global configuration.On UNIX and Windows, the presence of a .compuware folder in a user’s login directory identifiesa local configuration. On the AS/400, not every user has a login directory, since login directoriesare not required. To provide similar functionality, an administrator can define data areas withinDLM.LIB, naming them after user login names that contain the parent directory locations inwhich local configuration folders reside. During application startup, the DLM runtime willcheck for a local configuration by checking for the presence of a username-based data areawithin the DLM.LIB library object. If the data area exists, the client environment is loaded fromthe directory defined in the user’s data area. If a matching data area is not found, the DLMruntime loads the client environment from /.compuware/config.xml. DLM does not providea user interface to add user data areas, since the AS/400 already provides APIs and commandsto perform this task.The following diagrams illustrate the DLM.LIB library object and the DLM root folder in whichconfiguration information is stored.

41Distributed License Management Installation Guide

Page 42: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Figure 8. DLM.LIB Library Object on the QSYS.LIB File System.

Figure 9. DLM Data Files on the ROOT File System

AS/400 administrators can set up local client configurations by using the following series ofcommands:CRTDTAARA DTAARA(DLM/USERNAME) TYPE(*CHAR) LEN(256) VALUE('userdirectory')

CPY OBJ('/.compuware') TODIR('userdirectory') SUBTREE(*ALL)

NOTEThe DLM root directory is a directory on the root file system that contains DLM configurationfiles.The USERNAME refers to the login name of a user.The userdirectory refers to the parent directory where the .compuware folder resides.

Distributed License Management Installation Guide42

Chapter 5 ∙ Environment Consistency for UNIX Platforms

Page 43: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 6

License Borrowing

Configuration of the license borrowing components is handled automatically when a license isinstalled via the Distributed License Management application on Windows. For UNIX, use theDistributed License Management - Command Line (DLMCV) application.

Time Zone Effect on License Borrowing:

Borrowing across time zones can affect the actual amount of time your borrowed license isavailable for use. The start of the borrowing period is defined by the time zone of the licensedserver from which the license is borrowed.

Windows Only

On client systems that reference licensed servers that support license borrowing, the BorrowLicense Client tab is automatically configured and added to DLM. From this tab, you are ableto borrow and return available licenses. On server systems that add a license that supports licenseborrowing, the Borrow License Server tab is automatically configured and added to DLM.From this tab, the system administrator is able to manage the borrow features. The BorrowLicense Client tab and the Borrow License Server tab cannot coexist in DLM.

43Distributed License Management Installation Guide

Page 44: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License Management Installation Guide44

Chapter 6 ∙ License Borrowing

Page 45: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

C H A P T E R 7

DLM Web Interface

The DLM Web Interface provides a central point of license administration. It runs on an HTTPserver and is configured and administered by using the cpwrCGIAdmin.exe file.The DLM Web Interface allows the administrator to monitor and maintain the Compuwareclient/server licensing environment from a remote location via a Web browser.

Figure 10. The DLM Web Interface

The DLM Web Interface consists of three components:

• Java applet (dlm.jar)

• User configuration tool (cpwrCGIAdmin.exe)

• CGI (cpwrCgi.exe)

The CGI module and user configuration tool are non-Java applications. Each supported platformhas its own version of these components.

Supported EnvironmentsThe DLM Web Interface is supported in the following environments.

Web Servers

• IIS on Windows 2000 Server

45Distributed License Management Installation Guide

Page 46: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Browsers

• Internet Explorer 5.5, 6.0 and 7.0

• Netscape 6.2

NOTEJava Plug-in 1.3 and 1.4 for Netscape 6.2 are not supported in the AIX, HP, and RedHatenvironments.

IMPORTANTThe Java applet component requires that client systems that access the applet via a Web browserhave a minimum of Java 1.4.2 installed for Java support.

Platforms

The following table lists the platforms on which the DLM Web Interface can be installed. Thetable also lists the components provided on each platform for the DLM Web Interface.

NOTEAn administrator with root access to the machine should perform installation and configurationof these components.

Table 2. Supported Platforms

Component ListPlatforms

cpwrCGIAdmin.exeWindows NT 4.0cpwrCGI.exeWindows 2000

Windows XP

cpwrCGIAdmin.exe <platform>LinuxaesHP-UX 32- bit and 64-bit

OSF/DigitalAIX 32-bit and 64-bitSunOS/Solaris 32-bit and 64-bit

DLM Web Interface Installation OverviewThe following steps are necessary to install and operate the DLM Web Interface in yourenvironment:

1. Install the Compuware License Service, its components, and a concurrent license for theserver.

• Windows — For more information, see Installing the Compuware License Service[p. 21].

Distributed License Management Installation Guide46

Chapter 7 ∙ DLM Web Interface

Page 47: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

• UNIX — For more information, see Installing the Compuware License Service forUNIX [p. 33].

2. Install the DLM Web Interface and its components. For more information, see Installingthe DLM Web Interface [p. 47].

3. Create user accounts. For more information, see Creating User Accounts [p. 47].4. Define the Compuware License Service. For more information, see Defining the Compuware

License Service [p. 49].5. Configure the DLM Web Interface. For more information, see Configuring the DLM Web

Interface [p. 50].6. Start the DLM Web Interface. For more information, see Starting the DLM Web Interface

[p. 51].

Installing the DLM Web Interface

Prerequisites

You need root or administrative access to the HTTP server to run the InstallShield wizard.

This procedure applies to both Windows and UNIX platforms.

1. In your Compuware product installation media, double-click the Remote Licensing Toolto start the InstallShield wizard for the DLM Web Interface.If your installation media does not have this entry, contact Compuware Customer Supportto request the DLM Web Interface tool.

2. Navigate through the InstallShield wizard.The screens guide you through installation tasks:

a. Read and accept the License Agreement.

b. Provide customer information.

c. Choose your Destination Location. There is no default location. You must specify adestination before continuing. This location must be on your HTTP server and it shouldbe designated as the site location for the DLM Web Interface.

d. Start copying files.

Click Next after completing each screen.

3. Click Finish to complete the installation.

Creating User AccountsOnly users with accounts can access the Compuware License Service. User accounts are addedto the dlm_password file that is located in the /etc directory on UNIX platforms and theC:\Windows directory on Microsoft platforms.To create user accounts, run the cpwrCGIAdmin.exe executable file for the platform thatcorresponds to the system you have designated as your HTTP server. The cpwrCGIAdmin.exe

47Distributed License Management Installation Guide

Chapter 7 ∙ DLM Web Interface

Page 48: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

file has a text-based GUI, which means that it can be run in a text-based terminal window, suchas Telnet.

IMPORTANTYou must have root or administrative access to the HTTP server to run the component.

To run the cpwrCGIAdmin component:

1. At the command prompt, type cpwrCGIAdmin to display the cpwrCGIAdmin Main Menuscreen.

2. Type U and press [Enter] to access the User Database Menu.

3. Type N and press [Enter] to add a new user.4. Type a user name and press [Enter].5. Type a password for the newly created user and press [Enter].6. Re-type the password for confirmation and press [Enter].

Distributed License Management Installation Guide48

Chapter 7 ∙ DLM Web Interface

Page 49: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

A message appears on the screen to confirm that the user was added to the User Database.

7. To add another user, press [Enter], then repeat steps 3 through 6.8. When you have created all the new users you need, return to the Main Menu by pressing

[Enter] three times.

Defining the Compuware License ServiceBefore interaction between a client (applet) and the Compuware License Service can occur, youmust identify the Compuware License Service to the CGI.

1. At the Main Menu of cpwrCGIAdmin, type H and press [Enter] to access the Host DatabaseMenu screen.

2. Type A and press [Enter] to add a host name or TCP/IP address.3. Type the host name or TCP/IP address of the Compuware License Service to be added,

and press [Enter].The TCP/IP address can be either the hostname-alias or the actual IP address of a systemthat is running the Compuware License Service.

4. Type an alias name for the host and press [Enter].• If an alias is specified, the alias is displayed on the client instead of the TCP/IP identifier

of the Compuware License Service. References to the Compuware License Servicecan use either the alias or the host name.

• If an alias is not specified, only the host name or TCP/IP address, whichever is suppliedduring the creation of the host entry, can be used to identify the Compuware LicenseService.

5. Type the port number where the Compuware License Service is listening and press [Enter].The port number is specified within the server configuration file.A message appears on the screen to confirm that the alias and host was added to the HostDatabase.

49Distributed License Management Installation Guide

Chapter 7 ∙ DLM Web Interface

Page 50: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

6. To add another host, press [Enter], the repeat steps 3 through 5.7. When you have added all the hosts you need, press [Enter] three times to return to the

Main Menu.8. Type U and press [Enter] to access the User Database Menu.9. Type A and press [Enter] to add a host to a user's account.10. Type the name of the user from the list displayed and press [Enter].11. Type the host name, or TCP/IP address, or alias of the Compuware License Service where

the user needs access, and press [Enter].A message appears on the screen to confirm that the reference to the host name was addedfor the user.

12. To add another host reference to a user’s account, press [Enter], then repeat steps 10 and11.

13. When you have added all the required host references, press [Enter] three times to returnto the Main Menu.

14. Type E and press [Enter] to exit.

Configuring the DLM Web Interface

Prerequisites

After you have configured your user accounts and the individual license services, copy thecpwrcgi.exe file to the cgi-bin location on the Web server.The cpwrcgi.exe file is located in the exec folder, which was installed during the DLM WebInterface installation.

NOTEThe CGI only allows one client at a time to communicate with an individual Compuware LicenseService.

After the CGI has been configured, perform the steps below to set up the DLM Web Interface:

1. Go to the location of the DLM Web Interface.2. Create a link from your intranet site to the DLM Web Interface.

For example, http://sitename/dlmweb/dlm.html.

3. Open the dlm.html file.4. Modify the dlm.html source file in the following areas:

a) The <param name=cgidir> value must be changed to point to the location ofcpwrcgi.exe.

b) The <param name=timeout> value must specify how long you want to wait beforetimeout occurs for the user.

Distributed License Management Installation Guide50

Chapter 7 ∙ DLM Web Interface

Page 51: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Starting the DLM Web InterfaceAfter you configure the DLM Web Interface, users can access it in a browser window.

Prerequisites

To run the DLM Web Interface, you must have Java Runtime Environment (JRE) version1.4.2 or later. If you do not have this JRE, you are prompted to install the correct version of theJRE.

1. Open a browser window.For more information, see Supported Environments [p. 45].

2. Type the intranet site address in the Address field of the browser window and press [Enter].3. Log in.

For instructions on how to log in to the DLM Web Interface, access the online help byclicking Global Help on the Login screen of the DLM Web Interface.

51Distributed License Management Installation Guide

Chapter 7 ∙ DLM Web Interface

Page 52: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License Management Installation Guide52

Chapter 7 ∙ DLM Web Interface

Page 53: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

A P P E N D I X A

Host Name and Host ID

The host name is the unique name that identifies a computer on a network. A computer mayhave several of these (aliases). The host ID is the machine identification number of a Host. ForWindows PCs, this is the Ethernet Card ID.To obtain a license for your Compuware product, you must provide the host information of themachine on which the license will reside.If a Compuware License Service is required, this is the server machine. You need to supplyCompuware with the host name and host ID of the server on which the Compuware LicenseService will run, not the host IDs of all of your clients.If no Compuware License Service is required, the host is the same machine on which the productis installed.

Determine Host Information of a Computer on WindowsTo determine the host information needed in order to request a permanent license fromCompuware, follow the steps below.

1. Start the DLMapplication.2. Click the System Information link to view the host information.3. Save the host information.

a) Click Save As to open the Save As dialog box.b) In the Save in list, select a directory.c) Type the name of the text file (usually hostinfo.txt) in the File name field.d) Click Save.

4. Send the file via e-mail to Compuware Worldwide License Management [email protected].

53Distributed License Management Installation Guide

Page 54: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Determine Host Information of a Computer on UNIXTo determine the host information needed in order to request a permanent license fromCompuware, follow the steps below.

1. Navigate to the directory in which the Compuware License Service is located (for example,/opt/compuware/cpwr_4.0).

2. Type dlminfo.shA message like the following is displayed:Byte format : Little-endian

Current user: fhcwlm

Hostname : stizus

Ip Address : 172.16.18.66

Host id : 18f6ce29

3. Send the host name and host ID via e-mail to Compuware Worldwide License Managementat [email protected].

Distributed License Management Installation Guide54

Appendix A ∙ Host Name and Host ID

Page 55: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

A P P E N D I X B

License Files

All license files contain a single license object. Each license object contains one or moresub-objects called license keys. Each licensed product or product option has a correspondinglicense key.A license key identifies, through sub-object definitions, the usage extent of a purchased product.The usage extent defined by the license key is based on the purchase agreement .The modification of license keys within a licensed object by an end user invalidates the purchaseagreement, preventing the associated application or application option from functioning.The customer ID is a sub-object of the license object and is contained within the <customer_id>tag. End users are free to cut and paste license keys from one license object to another, providedthat the key shares the same customer ID as the target license object. License keys from differentcompanies cannot be interchanged or merged.A license key begins with the tag <key protected=’security key’ > and ends with the tag</key>. The sub-objects of a key are protected by the key tag <key protected=’securitykey’>. Each sub-object/parameter within the key defines a particular usage limitation or behaviorlimitation for the product authorized by the key. The following is an example of a license key.The tags are defined below.<license>

<key protected='security key'>

<Description>product description</Description>

<App>application name (or undefined)</App>

<Vers>application version/release (or undefined)</Vers>

<Start>start date (or undefined)</Start>

<End>end/expiration date (or undefined)</End>

<Count>maximum number of concurrent users,

or the keyword unlimited, undefined, or infinite</End>

<hostid>

<Eth>Ethernet address of the licensed system</Eth>

<Softkey_id>the Softkey ID of the licensed system</Softkey_id>

<Serial>the disk serial number from the licensed system</Serial>

<Ip>the IP address of the licensed system</Ip>

</hostid>

<Fcfs/>

<Borrowing/>

<Umanage/>

<Dup_usr/>

<Grace>the length of grace in hours</Grace>

<Usr_session_limit>the maximum number of concurrent sessions</Usr_session_limit>

55Distributed License Management Installation Guide

Page 56: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

<Parameters>application-specific parameters</Parameters>

</key>

</license>

AppThe App parameter can contain one of three possible value-types:

• The name/abbreviation of the application authorized by the key

• An alias-listAn alias-list is a list of application names defined under a single key. Each name inan alias-list is separated by a vertical bar ( | ).

• The keyword undefinedA key that has an <App> value of undefined authorizes the use of any Compuwareproduct. The <Vers> parameter of a key that has <App> set to undefined is ignored.An undefined key can be multi-user or single-user. The license administrator orend-user determines the usage of the key through its configuration into the licenseenvironment. A key contained within a license object, configured as a served license,is treated as a multi-user counted/concurrent key. A key that is not configured as aserved license is treated as a single-user uncounted license.

VersThe Vers parameter of a key contains the version of the application authorized by thekey. If the value of the version parameter is undefined, the key supports all versions ofthe product or product option identified by the key. In cases were the version numberapplies, the license key version must be greater than or equal to the version of the productlicensed by the key.

StartThe Start parameter contains the effective start date of the license agreement. The startdate is formatted DD.MMM.YY. A license key with a <Start> parameter value of undefineddoes not have an effective start date.

EndThe <End> parameter contains the expiration date of the key. The date is formattedDD.MMM.YY. A license key with an <End> parameter of undefined does not expire.

CountThe <Count> parameter defines the maximum number of concurrent instances of a product,end users using a product, or individuals that can use a product. A Compuware LicenseService is required to support keys that contain a <Count> parameter. Single-user licensesdo not contain a <Count> parameter.A license that has a <Count> value of unlimited, undefined, or infinite can be eitherconcurrent-counted or single-user uncounted. All three keywords have the same meaning:the license key has no limitations on the number of users that can access it. If theunlimited keyword is present and the key is served, count limits are not enforced;however, if a session limit is imposed (See <Usr_session_limit>), users are limited toa defined number of sessions.

Distributed License Management Installation Guide56

Appendix B ∙ License Files

Page 57: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Hostid and hostidThe <Hostid> and <hostid> parameters identify one or more systems that are authorizedto serve or use a license key. A license key will contain either <Hostid> or <hostid>,not both. Each is interpreted differently:

HostidIf the license key contains the parameter <Hostid>undefined</Hostid> , thelicensed application can run on any machine.

hostidIf the license key uses the parameter <hostid>, it contains references to one ormore of the following parameters to define the host ID.

• <Eth> — A system's MAC address

• <Softkey_id> — A system's softkey ID

• <Serial_no> — A system's disk serial number (Windows platforms only)

• <Ip> — The IP address of the system

FcfsThe <Fcfs/> (First Come First Serve) parameter is a flag that identifies a key thatauthorizes the first N unique users, where N is defined as <Count>. Once N users havebeen registered with the Compuware License Service, other users are denied. Userregistration is independent of sessions; users remain registered until they are physicallyremoved from the user-registration file. This file is located in the server’s configurationdirectory, named Usrs. The <Fcfs> parameter is only supported with concurrent-countedlicenses. Hence, it is an extension of the concurrent-counted license model.

BorrowingThe <Borrowing/> parameter is a flag that identifies a borrow-enabled key.Borrow-enabled keys must have <Count> defined within the key. Keys that contain the<Borrowing/> flag allow end-users to borrow licenses from the Compuware LicenseService for user-defined periods of time, where the smallest interval is one hour and themaximum interval is 365 days. The license administrator can place additional restrictionson the length of time a key-token can be borrowed (For more information, see ServerConfiguration File [p. 62].).

UmanageThe <Umanage/> parameter allows a license administrator to manage which end usershave access to a key. With User Management, the license administrator must set up a<user_management> object in the server’s configuration file, defining which end usershave access to the licensed application. Users that do not have access to the key will bedenied application startup for the application that corresponds to the key.

Dup_usrIf the <Dup_usr/> parameter is present, the same user can start multiple instances of anapplication with only the first instance consuming a license token.

57Distributed License Management Installation Guide

Appendix B ∙ License Files

Page 58: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

GraceThe value of the <Grace> parameter cannot be changed. The default value is 36 hours.

Usr_session_limitIf the <Usr_session_limit> parameter is present, each end user is limited to runningthe specified maximum number of session instances of a product at a time. The usersession limit is not the number of licenses consumed by a product, but the number oftimes a product session is established. Hence, a license key that authorizes user duplicationand user session limits only consumes one token per user, but limits the user to thespecified maximum session instances of the application.

ParametersThe <Parameters> tag contains additional parameters that are defined by the applicationthat sponsors the key.

Distributed License Management Installation Guide58

Appendix B ∙ License Files

Page 59: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

A P P E N D I X C

Client-Server Configuration Files

CPWR is the standard network based licensing solution used by all Compuware products. Theformat of data transmissions between CPWR clients and license managers is platform-independent,providing support for heterogeneous networks. This means that a Compuware License Servicerunning on one platform type can communicate with a client running on a different platformtype.Configuration files (files used to configure the license environment on either a client or server)are XML-based, which provides a similar heterogeneous methodology for componentconfiguration. The placement of these files on CPWR clients and servers is similar for all supportedplatforms. Hence, administering licensing on one platform is similar and requires the sameamount of effort as administering licensing on a different platform.It is not necessary to perform configuration tasks by hand since Distributed License Management(Windows only) and Distributed License Management - Command Line Version automate theseprocesses.

Client Configuration File

Client Configuration File

.compuware\ Directory

Each user must have a .compuware\ directory. The .compuware\ directory should be createdin each user's login directory. If a user's .compuware\ directory cannot be found, the CPWRclient will try to use the .compuware\ directory that resides in the system's root directory. ForWindows, it is the windows_root_drive:\documents and settings\All Users directoryand for UNIX it is the "/" directory. The location of the .compuware\ directory allows anadministrator to define a client system's configuration per user or globally for all users. The.compuware\ directory contains a configuration file config.xml, which identifies license sourcesthat are to be used by the licensed client during key resolution. It also contains other specific

59Distributed License Management Installation Guide

Page 60: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

client attributes that define the licensed client's environment. On a client system, a licensedsource can be a fully qualified path to a license file or a port@host definition of a server.

Configuration File Format

File Keys

A client configuration file consists of the following parameters

licenseThe license attribute is used to define license sources. A license source can be aport@host definition or a fully qualified path to a license file. Client configurations musthave at least one license entry.

connection_timeoutThe connection_timeout parameter identifies the maximum amount of time that a clientcan wait for a reply from an identified license server before giving up. If connectionsbetween a particular client and server result in frequent timeouts, the end-user shouldincrease this value.

nagle_algorithmThe nagle_algorithm switch instructs the license client to use the Nagle Algorithmwhen transmitting data via TCP/IP to DLM. By default, this action is disabled. Youshould contact Compuware support before enabling this behavior.

server_loadingGiven multiple license sources (i.e. port@hosts delimited by the tag license), the presenceof the server loading flag instructs the client to split bulk license requests, requests ofone or more license tokens, across multiple license sources.

proxy_serverThis attribute will define the port number on which the license proxy will be listening.

borrow_serverThe port at host defined here has features that are borrow-enabled.

Distributed License Management Installation Guide60

Appendix C ∙ Client-Server Configuration Files

Page 61: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

portWhen a CPWR licensed client connects with the Compuware License Service to make alicense request, it uses the port number of the Compuware License Service's sourcedefinition, port@host, to define the outgoing stream for data sent to the CompuwareLicense Service. The OS on the client chooses a return port to provide to the CompuwareLicense Service with its outgoing data stream. By default, clients of client serverapplications use the first available port. Because port number selection by the OS canseem somewhat random in nature, there can be complications for end-users that are tryingto configure openings in their firewall to support licensing. To simplify this process,CPWR clients allow end-users to specify a range of ports that can be used by the clientfor the Compuware License Service's outgoing data stream — the client's incoming datastream. This allows firewall administrators to limit the number of return port openingsin their firewall.The start member of the port attribute identifies the first port that is to be tried by theclient for the Compuware License Service's output stream. This port number can be thesame or different from the port number specified on the system where the CompuwareLicense Service resides; however, if the client and the Compuware License Service resideon the same system, the starting port number should be different.The range member of the port attribute specifies the range of ports that will be tried bythe client when it attempts to establish an output stream for the Compuware LicenseService. Hence, a client will try port numbers that range from start to start+range wherestart+range should be less than 65535. As with start, the range of port numbers attemptedby the client can not include the port number used by the Compuware License Servicein the case were the client resides on the same system as the Compuware License Service. If a range is not provided, the client will attempt to use the port number that is definedby the start parameter only. If the range is provided, it must be a value that is greaterthan or equal to zero.The linger member should only be used with the assistance of Compuware Engineersor TSRs. In most cases, this value should not be set. The linger member is an integervalue from -1 to N that controls the length of time that the operating system maintains aTIME_WAIT status on a previously closed socket. Sockets are used by the TCP/IP layeras streams of communications between CPWR clients and servers.

user_case, host_caseThis attribute instructions the client on how its information is to be broadcast to theCompuware License Service. If the value is UPPER, the client broadcasts user informationin upper case, regardless of the character case returned by the system. These attributesare useful when dealing with User Managed licenses.

poolThe pool field identifies the pool/family of users that a client belongs to. This shouldonly be used if virtual license pools have been created by the license administrator in theCompuware License Service's configuration file. For more information, see pools [p. 68].

61Distributed License Management Installation Guide

Appendix C ∙ Client-Server Configuration Files

Page 62: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Server Configuration FileLicense keys that contain the Count parameter can only be accessed through the CompuwareLicense Service. A served key that contains a Count parameter is defined as a concurrent-countedkey. As with license files, the Compuware License Service uses an XML-formatted file, theconfigurations file (config.xml), to identify user modifiable attributes. All object names, stringtags, are enclosed in “<” and are case-sensitive. They must be entered in exactly as shown. Theconfiguration file (config.xml) is located in the config directory of the Compuware LicenseService's installation directory. The server section of the configuration file contains parametersthat define: the server’s timeout, license files, and port number. Other parameters/objects withinthe server section are optional. A running Compuware License Service will automatically re-load the configuration file ifchanges are detected. Hence, the modification of the configuration file does not require theCompuware License Service to be restarted.

Distributed License Management Installation Guide62

Appendix C ∙ Client-Server Configuration Files

Page 63: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

The server section of the configuration file is a required section in the Compuware LicenseService’s configuration. In the server section, the following parameters are defined:

63Distributed License Management Installation Guide

Appendix C ∙ Client-Server Configuration Files

Page 64: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

NOTEAll parameters are not required in the configuration file.

Parameters

portThe port number identifies the port number that the Compuware License Service is touse; it is a numeric value, for example: 7166. Clients that request application startupfrom the server, must include the port number in their config definitions (i.e. port@host).

max_threadsOn Windows only, handler threads are spawned to handle each license request. Thenumber and frequency at which threads are launched to handle client requests is dependenton the Compuware License Service's work load. Under certain conditions, namely networksecurity, license administrators may choose to limit the number of threads that can belaunched by the Compuware License Service at any given time.

connection_timeoutThe connection_timeout parameter specifies to the Compuware License Service howlong it is to keep a non-responding connection open. The timeout value is defined inseconds. Changing the default, 10, to a lower value may cause connection problems forCPWR clients. Changing the default, 10, to a higher value may affect the overallperformance of the Compuware License Service. If this variable does not exist, 10 secondsis assumed. To determine the optimal performance for your particular configuration, you may need to play around with the value.

new_log_on_startIf this option is present, the server will create a new log file when it is started, destroyingthe previous log.

max_log_sizeThis parameter, if specified, places a limit on the size of the log file in bytes. If notprovided, the log file has no size limitation.

licenseThe license parameter identifies a single license source. A license source is the fullyqualified path to a single license file that contains on or more license keys. A configurationfile can contain a single license parameter or multiple license parameters. If no licenses are defined in the Compuware License Service’s configuration file, theCompuware License Service uses the license repository. Licenses loaded from therepository are loaded in a sequence based on the last access dates of the files. This formof license configuration is known as User Independent License Deployment, whereasUser Dependent License Deployment requires the user to identify the location of eachlicense source to the Compuware License Service via the configuration file. If changesare detected in the license files defined in the configuration file or the license repository,the Compuware License Service will automatically reload them prior to the next licenserequest. Changes can include the addition of new license files, the removal of existinglicense files, or the modification of existing license files. The license repository allows

Distributed License Management Installation Guide64

Appendix C ∙ Client-Server Configuration Files

Page 65: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

users to drag and drop new licenses into a single location for the Compuware LicenseService to pick up, simplifying the administration of new license files.

net_securityThe Compuware License Service’s memory usage is dependent on the number of validrequests that it receives from its clients. To prevent web attacks, that is, the transmissionof malicious data designed to overwhelm the Compuware License Service; three levelsof security are provided. The first two levels are enforced and maintained by default. The third security layer is controlled by the end-user. The tag net_security instructsthe Compuware License Service to prevent/ignore frequent unidentifiable transmissionsfrom previously identified sources. Hence, if a transmission source is identified in aconnection as having malicious intent, the Compuware License Service will close theconnection immediately with out committing additional resources to process the message. There are three possible configurations for the net_security option.

Configuration 1Under configuration one, the Compuware License Service keeps track of systemsthat have sent erroneous transmissions. By default, only three failed transmissionsare allowed per source before the Compuware License Service begins blocking onthe source; that is, preventing connections with the source. To enable this behavior,add the tag <net_security/> to the Compuware License Service’s configurationfile, config.xml.

Configuration 2If the number of denials before blocking is too large or too small, the end-user canspecify the number of denials before blocking using the same tag, net_security. <net_security>nn</net_security>

If the net_security tag is defined in this manner, nn identifies the number offailed transmissions that can occur from a previously identified system before it isblocked.In both Configurations 1 and 2, the Compuware License Service keeps track ofsystems that have sent erroneous transmissions in a file called elk_security.txt,located in the Compuware License Service's config directory.

Configuration 3In many cases, the identities of the client machines that will be communicatingwith the Compuware License Service are already known. Users can identify systemsto the Compuware License Service as 'friendly'. Other systems that are not identifiedas friendly will be blocked. As with Configuration 1, this configuration is activatedby the presence of the key entry <net_security/> in the service configurationfile. In addition, the end-user must create the file elk_security.txt in the config\directory of the Compuware License Service installation tree. Each record in thefile should contain one ip-address entry identifying the machine that is authorizedto talk with DLM. For example:

65Distributed License Management Installation Guide

Appendix C ∙ Client-Server Configuration Files

Page 66: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

The elk_security.txt fileDepending on the configuration chosen for security, the elk_security file willbe formatted as above, or each record will be formatted as follows:Ip-address fault_count

The first field of the record shown above is the IP address of the system thatdelivered the unidentifiable message and the second field is the number of timesthat faulty messages were sent from the identified source. This format only appliesto Configurations 1 and 2, where the Compuware License Service keeps track ofbad connections.Entries within the file can be added and removed using a text editor.Changes to the elk_security.txt file require a the Compuware License Servicerestart before the changes take effect.

mail_notificationThe mail_notification tag allows a systems administrator to instruct the license serviceto provide email notifications for license related issues. The email protocol used by thelicense service is Simple Mail Transfer Protocol abbreviated as SMTP.

smtpThe smtp tag defines a hostname or IP address of a system that handles SMTPrequests – the networked mail server.

IMPORTANTIf you are using a SMTP server as a relay to the main mail server the followingsteps will need to be performed on the relay server:

1. Right-click on Default Virtual SMTP server and select Properties

2. Click the Access Tab and select Relay

3. Under select which computer may relay through this virtual server changethe radio button fromonly the list below to all except the list below.

enabledThe enable tag toggles the emailing system off and on. The presence of the enabletag toggles emailing on, and the absence of the tag toggles emailing off.

onThe on keyword delimits the condition(s) for which the license service will sendemails.

deniedThe denied keyword instructs the license service to send email notifications forfailed license requests. There are two types of denial definitions supported.

• In the first, only the denied tag is specified. Under this definition, all requeststhat are denied by the Compuware License Service are emailed to the targetedrecipients.

Distributed License Management Installation Guide66

Appendix C ∙ Client-Server Configuration Files

Page 67: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

• In the second definition, the administrator can filter out denial messages basedon their content. The filter-tag can be used to keep or discard denial messagesbased on hostname, username, or feature name. Both the keep and discardtags accept wild cards. For example, <discard>*.compuware.com</discard>would eliminate any messages that contain a hostname, username, or featurethat contains the string “.compuware.com”.

frequencyThe frequency tag determines how often a message is to be sent within a 24-hourperiod. This is not a required tag.In addition to license-failure notification, notifications can be defined for: serverstart and stop (stop, start), security faults (security), and license key expiration(expire). The expire tag provides expiration notification for keys that will expirewithin the specified number of days. Expiration notifications are sent out every 24hours relative to when the Compuware License Service is started.

toThe to tag identifies the targeted recipient, that is, the individual that will receivethe email notifications. A mail_notification object can have one or more targetedrecipients defined.

subjectThe subject tag provides the subject matter of the email. If the subject tag is notprovided the Compuware License Service will choose a subject based on thetransmission type.

user_management

The systems administrator using the configuration parameter user_management canmanage only licenses that contain keys that have the Umanage option (See Umanage.). User Managed enabled keys authorize an administrator to control which users have accessto the key. A particular key being any key that has the keyword Umanage defined.Before setting up a user_management section, the administrator must get the App namefrom the key or keys that support User Management. Using the App name as a parameter,the administrator then defines which users have access to the application identified byApp. For example:

In the above example, the keyword everyone instructs the Compuware License Servicethat all users are authorized to access the key. When the everyone keyword is specified,individual users that are added to the definition are perceived by the Compuware License

67Distributed License Management Installation Guide

Appendix C ∙ Client-Server Configuration Files

Page 68: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Service as excluded from the set of “everyone”. Hence, the above example would read"allow everyone to use the key fileAid except pfhwec0 and pfhddg0." The absence ofthe everyone keyword means that only identified users are to be granted access to thelicense key. Users that are not listed will be denied access. A separate entry must existfor each key that supports the Umanage option. Users can be defined by either their hostid or LAN id (login id).

pools

A license pool is a pool of license tokens defined by a concurrent-counted license key. The number of license tokens available in a license pool is dependent on the number oftokens authorized by the corresponding key. For more information, see CompuwareLicense Files in the Distributed License Management Help. By default, a license poolexists for each concurrent-counted license key. The pools entry allows a licenseadministrator to manage the distribution of license tokens by using virtual pools that setlimits on token dispersal. Pools are not a feature of the license key; therefore, anyconcurrent-counted key can support pools. Once a pool is defined for a particularkey/application, all clients that use that key or application must be provided with a poolid. Clients that are not assigned pool ids are denied access to the key/application. Eachapplication pool identifier is assigned a count limit “max token count” by the licenseadministrator. The total of all imposed limits can exceed the Count limit set by the licensekey since denial will always occur when Count+1 tokens are in use. Multiple users canshare the same pool ID. Users that share defined pool ID's are collectively limited byboth the pool limit and the key-count.Example:

In the above example, there are three virtual pools defined for FileAID. Clients/usersthat have a pool id of UofD are limited to the usage of 100 copies of FileAID. Therefore,all users that identify themselves as belonging to UofD are restricted to 100 tokens as agroup.

Distributed License Management Installation Guide68

Appendix C ∙ Client-Server Configuration Files

Page 69: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

borrow/concurrent

borrowThe borrow keyword can be used to restrict the maximum number of license tokens andthe maximum number of days that a particular key/application can be borrowed. Sinceborrowing is an extension of concurrency, only current keys can be borrowed.

concurrentThe concurrent keyword allows an administrator to limit the use of concurrent licenses.

69Distributed License Management Installation Guide

Appendix C ∙ Client-Server Configuration Files

Page 70: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Distributed License Management Installation Guide70

Appendix C ∙ Client-Server Configuration Files

Page 71: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Index

AActiveSync 27

BBorrow License Client tab 43borrow-enabled 13

CCCompuware License Service

DLM Web Interface 49checklists 19Compuware License Service 11

comparing versionsUNIX 39

configuring in UNIX 34configuring in Windows 22installing

UNIX 33Windows 21

not required 16required 15uninstalling

Windows 21Compuware LicenseSync

installing 27concurrent 13, 15, 23configuring

DLM application 23DLM Web Interface 50

Customer Support 7contact information 8online support site 8

DDistributed License Management, See DLMDLM 11DLM application 11

DLM Web Interface 11, 45configuring 50creating user accounts 47defining the Compuware License Service 49install checklist 19installing 47starting 51supported environments 45

dynamic update of user file 14

EEthernet card ID 53

Ffirst-come, first served license 14floating license 13

Hhelp 7host ID 53host name 53

Iinstallation checklists 19installing

Compuware License ServiceUNIX 33Windows 21

Compuware LicenseSync 27DLM Web Interface 47license

UNIX 33, 41Windows CE 27

virtual environment 25

71Distributed License Management Installation Guide

Page 72: Distributed License Management Installation Guide · Fixed width bold User input in console commands. Distributed License Management Installation Guide 5. This font Indicates Fixed

Llicense

borrow-enabled 13borrowing 43certificate 11components 11concurrent 13, 23configuration

UNIX 35Windows 23

first-come, first-served 14floating 13installation

checklists 19UNIX 33, 41Windows CE 27

models 13node-locked 13, 23redundant 14requesting from Compuware 17types 12user manage 13

license environment 14UNIX 35

license files 55

Mmultiple license files 14

Nnode-locked 13, 23

Pplatforms supported 17

Rredundant server license 14redundant servers 17requesting a license 17

Ssupport 7supported platforms

DLM application 17system performance 18system requirements 18

TTechnical Support 7troubleshooting

UNIX 39

Uuninstalling

Compuware License ServiceWindows 21

UNIXcomponents 38license environment 35license installation 33, 41

user accounts 47user manage license 13

Vvirtual environment 25

WWindows CE 27

Distributed License Management Installation Guide72

Index