Distributed License Management User Guide

Distributed License Management User Guide
Release 4.5
Please direct questions about Distributed License Management or comments on this document to:
Compuware Customer Support
FrontLine Support Login Page:
http://go.compuware.com
Copyright © 2012 Compuware Corporation. All rights reserved. Unpublished rights reserved under the Copyright Laws of the
United States.
U.S. GOVERNMENT RIGHTS-Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in
Compuware Corporation license agreement and as provided in DFARS 227.7202-1(a) and 227.7202-3(a) (1995), DFARS
252.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. Disclosure is prohibited without
the prior express written permission of Compuware Corporation. Use of this product is subject to the terms and conditions of the
user's License Agreement with Compuware Corporation.
Documentation may only be reproduced by Licensee for internal use. The content of this document may not be altered, modified
or changed without the express written consent of Compuware Corporation. Compuware Corporation may change the content
specified herein at any time, with or without notice. All current Compuware Corporation product documentation can be found at
http://go.compuware.com.
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.
Build: September 27, 2012, 7:35
Contents
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Who Should Read This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customer Support Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
7
7
8
9
10
10
Chapter 1 ∙ Introduction to DLM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Welcome to DLM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Request a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Determine Host Information of a Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Determine Host Information for Windows systems . . . . . . . . . . . . . . . . . . . . . . . . .
Determine Host Information for UNIX systems . . . . . . . . . . . . . . . . . . . . . . . . . . .
Determine Host Information of a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compuware License Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
13
13
13
14
14
15
16
16
Chapter 2 ∙ Client-Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Client Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
21
23
Chapter 3 ∙ Distributed License Management Application . . . . . . . . . . . . . . . . . . .
Welcome to the DLM Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Explore the DLM Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Local Environment Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Environment Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Borrow License Server Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Borrow License Client Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add a License Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove a License Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
33
33
35
36
37
38
40
40
40
41
Distributed License Management User Guide
3
Contents
4
Reorder the License Sources List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License feature status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Local Environment Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add a License Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove a License Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Local Environment Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Start the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Stop the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove the Compuware License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Environment Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View a Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Filter Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flush a Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Move a Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
42
42
43
43
44
44
45
45
46
46
46
47
47
48
49
50
51
Chapter 4 ∙ License Usage Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Peak Usage Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Peak Usage Reporting for Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UMFilter.exe - (for UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
53
53
57
60
Chapter 5 ∙ Distributed License Management – command line version . . . . . . . . .
Welcome to the DLMCV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DLMCV_Client_Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Borrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Broadcast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Who . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DLMCV License Service Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DLMCV Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61
62
63
64
67
68
69
70
70
71
72
73
81
Chapter 6 ∙ Distributed License Management – mobile . . . . . . . . . . . . . . . . . . . . .
Introduction to DLM - Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compuware LicenseSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Saving Device Information/Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Removing License Keys from a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
83
83
83
85
86
87
Chapter 7 ∙ License Borrowing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Borrow License Client Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
89
89
Distributed License Management User Guide
Contents
Borrow License Server Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How Do I... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Borrow a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Return a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define Borrow Policy Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define Borrow Policy Settings for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create a Group File for Borrowing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Check Out a Group for Borrowing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
91
91
92
92
92
92
95
Chapter 8 ∙ Distributed License Management web interface . . . . . . . . . . . . . . . . .
Welcome to the DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Explore the DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Status Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Feature Details Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log File Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License File (View/Edit) Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License File (Import) Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Manage Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Messages in DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How Do I... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching the DLM Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reset DLM Web Interface Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Change Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Show Licenses that Expire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Show Licenses Checked Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License File (Import) Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Filter Log File Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flush the Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Change Number of Records Displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
97
97
97
98
99
100
100
101
102
102
102
102
103
104
104
105
105
106
107
107
108
Appendix A ∙ Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
111
Appendix B ∙ Licensing Support for Unsupported Platforms . . . . . . . . . . . . . . . . .
cpwrProxy32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
113
113
Appendix C ∙ Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Check Your Services List (XP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Check Your Services List (NT and 2000) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fully Qualified Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License Server Does Not Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customer Support Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
115
115
124
124
124
124
125
Appendix D ∙ GUI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adjust the Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Duration, in years, to store license usage data field . . . . . . . . . . . . . . . . . . . . . . . . . . .
Broadcast Attributes Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
127
127
127
127
Distributed License Management User Guide
5
Contents
6
Configuration environment field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection timeout in seconds for client field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection timeout in seconds for server field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create new log when server starts field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create usage report field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable Email Notification field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Expiration warning at startup field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
License Proxy field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum log size in bytes field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum threads field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modify location of server files field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network security field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pool ID field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pools field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Port number field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User manage field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
128
128
128
128
129
129
133
133
133
133
133
135
135
135
136
136
Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
139
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
143
Distributed License Management User Guide
INTRODUCTION
The Distributed License Management Installation Guide provides information and procedures
to:
•
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 Guide
This 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 in the Distributed License Management
Installation Guide.
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 and
your Web browser before reading this guide.
Documentation Conventions
The following font conventions are used throughout documentation:
This font
Indicates
Bold
Terms, commands, and references to names of screen controls and user
interface elements.
Citation
Emphasized text, inline citations, titles of external books or articles.
Documentation
Conventions [p. 7]
Links to Internet resources and linked references to titles in Compuware
documentation.
Distributed License Management User Guide
7
Introduction
This font
Indicates
Fixed width
Cited contents of text files, inline examples of code, command line inputs or
system outputs. Also file and path names.
Fixed width bold
User input in console commands.
Fixed width italic
Place holders for values of strings, for example as in the command:
cd directory_name
Menu ➤ Item
Menu items.
Text screen shots.
Screen
Code block
Blocks of code or fragments of text files.
Terminology
Understanding the following terms will facilitate the user’s understanding of this guide:
Client
The licensing component of a program that has the capacity to authorize or deny a
program’s startup. The authorization process is dependent on license sources.
Concurrent key
See counted key.
Counted key
Any served key that contains an attribute that specifies a physical limit on the number of
licensed clients authorized to run a licensed product concurrently. The limit is enforced
by a combination of the Compuware License Service and its clients.
Floating key
See counted key.
Host ID
Any identifier that uniquely identifies a workstation.
Key
See license key.
License
See license key.
License file
An XML based file that contains a single license object.
License key
An XML object, a sub-component of a license object, which contains application-client
specific information and system specific information that defines the extent to which one
or more associated applications can run.
License object
A license object contains one or more license keys.
8
Distributed License Management User Guide
Introduction
License server
A single networked node that hosts the Compuware License Service.
License service
A service that runs as a background process on a licensed server. It provides a searchable
database of license keys to facilitate the process of networked licensing.
License source
A license file or a reference to a licensed server.
License token
The result of a successful license request. The license token is a copy of a valid key. In
the case of counted keys, license tokens are like virtual toll tickets, returned to the
Compuware License Service when the licensed product no longer needs it.
Licensed client
Any workstation authorized, through a license source, to run one or more Compuware
products.
Licensed product
A purchased Compuware program, licensed by a license source.
Node
A single workstation. Networks consist of one or more nodes.
Node-locked
See uncounted key.
Served key
Any licensed key that is loaded into the Compuware License Service database for
networked licensing.
Uncounted key
An uncounted key is any key associated with a product whereby usage of the product is
not dependent on a predetermined limit.
Documentation
Distributed 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 being
used.
•
Click [F1] to open the Help menu.
•
Open C:\Program Files\Common Files\Compuware\DLMHelp.chm.
Distributed License Management User Guide
9
Introduction
Getting Help
At 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 support
services, please obtain the following information before contacting Compuware Customer
Support:
•
The name and release number (version) of the Compuware product you are using, in addition
to the name and release number of the Distributed License Management component. Obtain
this information by choosing Help ➤ About. The name and release number are also
displayed 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 product
is installed, memory, hardware/network specifications, and the names and releases of other
applications that were running.
•
The location of the problem in the DLM or product software, and the actions taken before
the 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 information for Compuware products via our FrontLine support site. You can
review frequently asked questions, read or download documentation, access product fixes, or
e-mail your questions or comments. The first time you access FrontLine, you are required to
register and obtain a password. Registration is free. To access FrontLine, log in to
http://go.compuware.com. Select your product from the Product Support dropdown list.
You can also access product User Communities from http://go.compuware.com. After you log
in, select Customer Support User Groups and select your product line.
Contacting Customer Support
Phone
•
10
USA and Canada: 1-800-538-7822 or 1-313-227-5444.
Distributed License Management User Guide
Introduction
•
All other countries: Contact your local Compuware office. Contact information is
available at http://go.compuware.com.
Web
You can report issues via the Report and Track Calls tab on the FrontLine home page.
NOTE
Please report all high-priority issues by phone.
Mail
Customer Support
Compuware Corporation
One Campus Martius
Detroit, MI 48226-5099
Corporate Web Site
To access Compuware's site on the Web, go to http://www.compuware.com. The Compuware
site provides a variety of product and support information.
Distributed License Management User Guide
11
Introduction
12
Distributed License Management User Guide
CHAPTER 1
Introduction to DLM
Welcome to DLM
Welcome to Distributed License Management (DLM).
Compuware’s DLM software facilitates the license management and administration needs for
your Compuware products. 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 the Compuware License Service, or not.
Request a License
To obtain a permanent license for your Compuware product, you must gather the host information
of the machine on which the license resides. After gathering the host information, send it via
e-mail to Compuware's Worldwide License Management (WLM) department at
license_mgt@compuware.com. A Compuware representative assists in the generation of a valid
license file.
TIP
If the Compuware License Service is required, it resides on a server machine. You need to
supply Compuware with the host ID of the server on which the Compuware License Service
runs, not the host IDs of the client machines.
After you receive a license file from Compuware, configure the license by providing DLM on
each machine with a license source. Refer to the Distributed License Management Licensing
Guide for installation and configuration procedures.
Determine Host Information of a Computer
The host Information listing displays all of the pertinent host information on the machine you
are using. You can also determine the host information by examining the license file. For more
Distributed License Management User Guide
13
Chapter 1 ∙ Introduction to DLM
information, see Determine Host Information of a License File [p. 15]. This information is
required by Compuware when you Request a License [p. 13]. The process for determining host
information depends on the platform. Please refer to the corresponding procedures:
Determine Host Information for Windows systems [p. 14]
Determine Host Information for UNIX systems [p. 14]
Determine Host Information for Windows systems
1.
2.
Start DLM.
Click the Show system information link at the bottom left of the screen.
3.
If desired, save the system information:
a. On the Show System Information dialog box, click Save to File ....
b. In the Save as drop down list, select a directory and type the name of the text file
(usually hostinfo.txt) in the File name field.
c. Click Save.
d. Send the file via e-mail to Compuware's Worldwide License Management department
at license_mgt@compuware.com.
Determine Host Information for UNIX systems
1.
2.
Navigate to the directory in which the Compuware License Service is located (for example,
/cpwr/license).
Type dlminfo and click <Enter>. The following will be displayed:
dlminfo - Copyright (C) 2006 Compuware Corporation
---------------------------------------------------------------
14
Distributed License Management User Guide
Chapter 1 ∙ Introduction to DLM
Platform
: Microsoft WindowsByte format : Little-endian
Current user: PFHJSE0
Hostname
: dtw44148d02Ip Address : 10.19.17.194
Host id
: 000f1fd6ebbbDisk Serial : 9875fa70
3.
Provide the host name and host ID information to Compuware's Worldwide License
Management department via e-mail at license_mgt@compuware.com.
Determine Host Information of a License File
In addition to determining the host information of a computer, you can also determine the host
information by looking in the license file (license.lic). The host Information displays all of
the pertinent host information on the machine you are using. This information is required by
Compuware when you request a license. For more information, see Request a License [p. 13].
Concurrent License
To determine the Host Name and Host ID for concurrent licenses, look in the first line of the
license file. See the example below:
Node-Locked License
HOST ID String
The HOSTID string is only found in node-locked licenses and defines the Host ID of the
client that can execute a given feature. The typical values for HOSTID are either a host ID
from a machine or the keyword ANY. If you see the keyword ANY in your license file,
the license can run a feature on any single client machine, based on the license terms and
conditions. See the example below:
SoftKey ID String
The SoftKey ID string identifies a machine as unique based on the machine's hardware,
hardware configuration, and time of activation. The typical values for SoftKey ID are
either an ID string from a machine or the keyword OTHER. See the example below:
Distributed License Management User Guide
15
Chapter 1 ∙ Introduction to DLM
License Files
Compuware License Files
All license files contain a single license object. Each license object contains one or more
sub-objects called license keys. Each licensed product and/or product option has a corresponding
license 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 contractual
agreement that was established, with Compuware, when the product was purchased. The
modification of license keys within a licensed object by an end-user invalidates the purchase
agreement preventing the associated application or application option from functioning.
End-users are free to cut and paste license keys from one license object to another provided that
the key shares the same customer id as the target license object. Hence, license keys from
different companies cannot be interchanged or merged. The customer id is a sub-object of the
license object and is contained within the customer_id tag.
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=’security
key’>. These sub-objects include App, Vers, Start, End, Count, hostid, Hostid, Fcfs, etc. Each
sub-object/parameter within the key defines a particular usage limitation or behavior limitation
for the product authorized by the key. A license key can consist of 13 or more possible
parameters/sub-objects. The parameters shown in the figure above are defined below.
Parameters
The following parameters can be used to define a license key:
App
The App parameter can contain one of three possible value-types:
16
Distributed License Management User Guide
Chapter 1 ∙ Introduction to DLM
•
The name/abbreviation of the application authorized by the key
•
An alias-list, which is a list of application names defined under a single key. Each
name in an alias-list is separated by a ‘|’.
•
The keyword undefined. A key that has the App parameter defined as undefined
authorizes the usage of any Compuware product. The Vers parameter of keys that
have the App field set to undefined are ignored. An undefined key can be multi-user
or single-user. The license administrator or end-user determines the usage of the key
through its configuration into the license environment. 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 a served license is treated as
a single-user uncounted license.
Vers
The Vers parameter of a key contains the version of the application authorized by the
key. If the version parameter is defined as undefined the key supports all versions of
the product or product option identified by the key. In cases were the version number
applies, the license key version must be greater than or equal to the version of the product
licensed by the key.
Start
The Start parameter contains the effective start date of the license agreement. Both the
Start and the End fields are formatted DD.MMM.YY. A Start parameter that contains
the value undefined does not have an effective start date.
End
The End member contains the effective ending date of the key – the key’s end-of-life date.
As with the Start parameter, the End parameter is formatted DD.MMM.YY. The End
parameter can also be set to undefined. License keys with the End parameter set to
undefined do not expire.
Count
The Count parameter defines the maximum number of concurrent instances of a product,
end-users using a product, or individuals that can use a product. The Compuware License
Service is required to support keys that contain a Count parameter. Uncounted single-user
licenses do not contain a Count parameter.
A license that has a count of unlimited, undefined, or infinite can be either
concurrent-counted or single-user uncounted. All three keywords have the same meaning;
either result in a license key that has no limitations on the number of users that can access
it. If the unlimited 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 to a
defined number of sessions.
Hostid and hostid
The Hostid and hostid parameters identify one or more systems which are authorized
to serve or use a license key. A license key will contain either Hostid or hostid, not
both. Each is interpreted differently. They differ by content and the character case of the
first letter “H.” License keys that have the parameter “<Hostid>undefined</Hostid> “,
can run on any machine. If the parameter hostid exists, it will contain references to one
or more of the following host id types:
Distributed License Management User Guide
17
Chapter 1 ∙ Introduction to DLM
Host ID type
Description
Eth
A system's MAC address
Softkey_id
A system's softkey id (softkey is defined in DLM 4.1)
Serial_no
A system's disk serial number (Windows platforms only)
Ip
The ip-address of the system
Fcfs
The Fcfs (First Come First Serve) parameter is a flag that identifies a key that authorizes
the first N unique users, where N is defined as Count. Once N-users have been registered
with the Compuware License Service, other users are denied. The registration process
of end-users is based on the First Come First Serve model. In other words, once
Count-users have been registered with the Compuware License Service, the Count+1th
user is denied. User registration is session independent; users remain registered until they
are physically removed from the user-registration file. This file is located in the server's
config directory named Usrs. Users will only be allowed to run on one machine per
network. Fcfs is only supported with concurrent-counted licenses. Hence, it is an
extension of the concurrent-counted license model.
Borrowing
The Borrowing parameter is a flag that identifies a borrow-enabled key. Borrow-enabled
keys must have a Count field defined within the key. Keys that contain the Borrowing
flag allow end-users to borrow licenses from the Compuware License Service for user
defined periods of time, where the smallest interval is one hour and the maximum interval
is 365 days. The license administrator can place additional restrictions on the length of
time a key-token can be borrowed. For more information, see Server Configuration File
[p. 23].
Umanage
The Umanage parameter allows a license administrator to manage which end-users have
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-users
have access to the licensed application. Users that do not have access to the key will be
denied application startup for the application that corresponds to the key.
Dup_usr
If this parameter is present, the same user can start multiple instances of an application
with only the first instance consuming a license-token.
Grace
The Grace parameter is currently not changeable. The default value is 36 hours.
Usr_session_limit
If this tag is present, each end-user is limited to running max session instances of a
product at a time. Max sessions do not refer to the number of licenses consumed by a
product, but the number of times a product session is established. Hence, a license key
that authorizes user duplication and user session limits only consumes one token per user
but limits the user to max session instances of the application.
18
Distributed License Management User Guide
Chapter 1 ∙ Introduction to DLM
Parameters
The Parameters member contains additional parameters that are defined by the application
that sponsors the key.
Distributed License Management User Guide
19
Chapter 1 ∙ Introduction to DLM
20
Distributed License Management User Guide
CHAPTER 2
Client-Server Configuration
DLM is the standard network-based licensing solution used by distributed Compuware products.
The format of data transmissions between CPWR clients and the Compuware License Service
is platform independent, providing support for heterogeneous networks.
This means that DLM running on one platform type, i.e. UNIX, Windows, can communicate
with a client running on a different platform type. Conversely, 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 component configuration. The placement of these
files on CPWR clients and servers is similar for all supported platforms. Hence, administering
licensing on one platform is similar and requires the same amount of effort as administering
licensing on a different platform. It is not necessary to perform these tasks by hand since the
DLM application (Windows only) and/or the Distributed License Management - Command
Line Version (DLMCV) automate these processes.
Client Configuration File
.compuware\ Directory
Each user must have a .compuware\ directory. The .compuware\ directory should be created
in each user's login directory. If a user's .compuware\ directory cannot be found, the CPWR
client will try to use the .compuware\ directory that resides in the system's root directory. For
Windows, it is the windows_root_drive:\documents and settings\All Users directory
and for UNIX it is the "/" directory. The location of the .compuware\ directory allows an
administrator 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
sources that are to be used by the licensed client during key resolution. It also contains other
specific client attributes that define the licensed client's environment. On a client system, a
licensed source can be a fully qualified path to a license file or a port@host definition of a
server.
Distributed License Management User Guide
21
Chapter 2 ∙ Client-Server Configuration
Configuration File Format
File Keys
A client configuration file consists of the following parameters
license
The license attribute is used to define license sources. A license source can be a
port@host definition or a fully qualified path to a license file. Client configurations must
have at least one license entry.
connection_timeout
The connection_timeout parameter identifies the maximum amount of time that a client
can wait for a reply from an identified license server before giving up. If connections
between a particular client and server result in frequent timeouts, the end-user should
increase this value.
nagle_algorithm
The nagle_algorithm switch instructs the license client to use the Nagle Algorithm
when transmitting data via TCP/IP to DLM. By default, this action is disabled. You
should contact Compuware support before enabling this behavior.
server_loading
Given multiple license sources (i.e. port@hosts delimited by the tag license), the presence
of the server loading flag instructs the client to split bulk license requests, requests of
one or more license tokens, across multiple license sources.
proxy_server
This attribute will define the port number on which the license proxy will be listening.
borrow_server
The port at host defined here has features that are borrow-enabled.
port
When a CPWR licensed client connects with the Compuware License Service to make a
license request, it uses the port number of the Compuware License Service's source
definition, port@host, to define the outgoing stream for data sent to the Compuware
License Service. The OS on the client chooses a return port to provide to the Compuware
License Service with its outgoing data stream. By default, clients of client server
22
Distributed License Management User Guide
Chapter 2 ∙ Client-Server Configuration
applications use the first available port. Because port number selection by the OS can
seem somewhat random in nature, there can be complications for end-users that are trying
to 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 client
for the Compuware License Service's outgoing data stream — the client's incoming data
stream. This allows firewall administrators to limit the number of return port openings
in their firewall.
The start member of the port attribute identifies the first port that is to be tried by the
client for the Compuware License Service's output stream. This port number can be the
same or different from the port number specified on the system where the Compuware
License Service resides; however, if the client and the Compuware License Service reside
on 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 by
the client when it attempts to establish an output stream for the Compuware License
Service. Hence, a client will try port numbers that range from start to start+range where
start+range should be less than 65535. As with start, the range of port numbers attempted
by the client can not include the port number used by the Compuware License Service in
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 defined
by the start parameter only. If the range is provided, it must be a value that is greater than
or equal to zero.
The linger member should only be used with the assistance of Compuware Engineers
or TSRs. In most cases, this value should not be set. The linger member is an integer
value from -1 to N that controls the length of time that the operating system maintains a
TIME_WAIT status on a previously closed socket. Sockets are used by the TCP/IP layer
as streams of communications between CPWR clients and servers.
user_case, host_case
This attribute instructions the client on how its information is to be broadcast to the
Compuware License Service. If the value is UPPER, the client broadcasts user information
in upper case, regardless of the character case returned by the system. These attributes
are useful when dealing with User Managed licenses.
pool
The pool field identifies the pool/family of users that a client belongs to. This should only
be used if virtual license pools have been created by the license administrator in the
Compuware License Service's configuration file. For more information, see pools [p. 29].
Server Configuration File
License keys that contain the Count parameter can only be accessed through the Compuware
License Service. A served key that contains a Count parameter is defined as a concurrent-counted
key. As with license files, the Compuware License Service uses an XML-formatted file, the
configurations file (config.xml), to identify user modifiable attributes. All object names,
string tags, are enclosed in “<” and are case-sensitive. They must be entered in exactly as shown.
The configuration file (config.xml) is located in the config directory of the Compuware License
Service's installation directory. The server section of the configuration file contains parameters
Distributed License Management User Guide
23
Chapter 2 ∙ Client-Server Configuration
that define: the server’s timeout, license files, and port number. Other parameters/objects within
the server section are optional.
A running Compuware License Service will automatically re-load the configuration file if
changes are detected. Hence, the modification of the configuration file does not require the
Compuware License Service to be restarted.
24
Distributed License Management User Guide
Chapter 2 ∙ Client-Server Configuration
The server section of the configuration file is a required section in the Compuware License
Service’s configuration. In the server section, the following parameters are defined:
NOTE
All parameters are not required in the configuration file.
Parameters
port
The port number identifies the port number that the Compuware License Service is to
use; it is a numeric value, for example: 7166. Clients that request application startup from
the server, must include the port number in their config definitions (i.e. port@host).
Distributed License Management User Guide
25
Chapter 2 ∙ Client-Server Configuration
max_threads
On Windows only, handler threads are spawned to handle each license request. The
number and frequency at which threads are launched to handle client requests is dependent
on the Compuware License Service's work load. Under certain conditions, namely network
security, license administrators may choose to limit the number of threads that can be
launched by the Compuware License Service at any given time.
connection_timeout
The connection_timeout parameter specifies to the Compuware License Service how
long it is to keep a non-responding connection open. The timeout value is defined in
seconds. Changing the default, 10, to a lower value may cause connection problems for
CPWR clients. Changing the default, 10, to a higher value may affect the overall
performance of the Compuware License Service. If this variable does not exist, 10 seconds
is assumed. To determine the optimal performance for your particular configuration, you
may need to play around with the value.
new_log_on_start
If this option is present, the server will create a new log file when it is started, destroying
the previous log.
max_log_size
This parameter, if specified, places a limit on the size of the log file in bytes. If not
provided, the log file has no size limitation.
license
The license parameter identifies a single license source. A license source is the fully
qualified path to a single license file that contains on or more license keys. A configuration
file can contain a single license parameter or multiple license parameters.
If no licenses are defined in the Compuware License Service’s configuration file, the
Compuware License Service uses the license repository. Licenses loaded from the
repository are loaded in a sequence based on the last access dates of the files. This form
of license configuration is known as User Independent License Deployment, whereas
User Dependent License Deployment requires the user to identify the location of
each license source to the Compuware License Service via the configuration file. If
changes are 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 license request. Changes can include the addition of new license files, the removal
of existing license files, or the modification of existing license files. The license repository
allows users to drag and drop new licenses into a single location for the Compuware
License Service to pick up, simplifying the administration of new license files.
net_security
The Compuware License Service’s memory usage is dependent on the number of valid
requests that it receives from its clients. To prevent web attacks, that is, the transmission
of malicious data designed to overwhelm the Compuware License Service; three levels
of 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 instructs the
Compuware License Service to prevent/ignore frequent unidentifiable transmissions from
previously identified sources. Hence, if a transmission source is identified in a connection
as having malicious intent, the Compuware License Service will close the connection
26
Distributed License Management User Guide
Chapter 2 ∙ Client-Server Configuration
immediately with out committing additional resources to process the message. There are
three possible configurations for the net_security option.
Configuration 1
Under configuration one, the Compuware License Service keeps track of systems
that have sent erroneous transmissions. By default, only three failed transmissions
are allowed per source before the Compuware License Service begins blocking on
the source; that is, preventing connections with the source. To enable this behavior,
add the tag <net_security/> to the Compuware License Service’s configuration
file, config.xml.
Configuration 2
If the number of denials before blocking is too large or too small, the end-user can
specify 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 of failed
transmissions that can occur from a previously identified system before it is blocked.
In both Configurations 1 and 2, the Compuware License Service keeps track of
systems that have sent erroneous transmissions in a file called elk_security.txt,
located in the Compuware License Service's config directory.
Configuration 3
In many cases, the identities of the client machines that will be communicating with
the Compuware License Service are already known. Users can identify systems to
the Compuware License Service as 'friendly'. Other systems that are not identified
as friendly will be blocked. As with Configuration 1, this configuration is activated
by the presence of the key entry <net_security/> in the service configuration file.
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 the
file should contain one ip-address entry identifying the machine that is authorized
to talk with DLM. For example:
The elk_security.txt file
Depending on the configuration chosen for security, the elk_security file will be
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 that delivered
the unidentifiable message and the second field is the number of times that faulty
messages were sent from the identified source. This format only applies to
Configurations 1 and 2, where the Compuware License Service keeps track of bad
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 Service
restart before the changes take effect.
Distributed License Management User Guide
27
Chapter 2 ∙ Client-Server Configuration
mail_notification
The mail_notification tag allows a systems administrator to instruct the license service
to provide email notifications for license related issues. The email protocol used by the
license service is Simple Mail Transfer Protocol abbreviated as SMTP.
smtp
The smtp tag defines a hostname or IP address of a system that handles SMTP
requests – the networked mail server.
IMPORTANT
If you are using a SMTP server as a relay to the main mail server the following steps
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 change
the radio button fromonly the list below to all except the list below.
enabled
The enable tag toggles the emailing system off and on. The presence of the enable
tag toggles emailing on, and the absence of the tag toggles emailing off.
on
The on keyword delimits the condition(s) for which the license service will send
emails.
denied
The denied keyword instructs the license service to send email notifications for
failed license requests. There are two types of denial definitions supported.
•
In the first, only the denied tag is specified. Under this definition, all requests
that are denied by the Compuware License Service are emailed to the targeted
recipients.
•
In the second definition, the administrator can filter out denial messages based
on their content. The filter-tag can be used to keep or discard denial messages
based on hostname, username, or feature name. Both the keep and discard
tags accept wild cards. For example, <discard>*.compuware.com</discard>
would eliminate any messages that contain a hostname, username, or feature
that contains the string “.compuware.com”.
frequency
The frequency tag determines how often a message is to be sent within a 24-hour
period. This is not a required tag.
In addition to license-failure notification, notifications can be defined for: server
start and stop (stop, start), security faults (security), and license key expiration
(expire). The expire tag provides expiration notification for keys that will expire
within the specified number of days. Expiration notifications are sent out every 24
hours relative to when the Compuware License Service is started.
28
Distributed License Management User Guide
Chapter 2 ∙ Client-Server Configuration
to
The to tag identifies the targeted recipient, that is, the individual that will receive
the email notifications. A mail_notification object can have one or more targeted
recipients defined.
subject
The subject tag provides the subject matter of the email. If the subject tag is not
provided the Compuware License Service will choose a subject based on the
transmission type.
user_management
The systems administrator using the configuration parameter user_management can
manage only licenses that contain keys that have the Umanage option (See Umanage.).
User Managed enabled keys authorize an administrator to control which users have access
to 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 name
from 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 by
App. For example:
In the above example, the keyword everyone instructs the Compuware License Service
that 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
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 of the
everyone keyword means that only identified users 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 option. Users can be defined by either their host id or
LAN id (login id).
pools
Distributed License Management User Guide
29
Chapter 2 ∙ Client-Server Configuration
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 of
tokens authorized by the corresponding key. For more information, see Count [p. 17]. By
default, a license pool exists for each concurrent-counted license key. The pools entry
allows a license administrator to manage the distribution of license tokens by using virtual
pools that set limits on token dispersal. Pools are not a feature of the license key; therefore,
any concurrent-counted key can support pools. Once a pool is defined for a particular
key/application, all clients that use that key or application must be provided with a pool
id. Clients that are not assigned pool ids are denied access to the key/application. Each
application pool identifier is assigned a count limit “max token count” by the license
administrator. The total of all imposed limits can exceed the Count limit set by the license
key since denial will always occur when Count+1 tokens are in use. Multiple users can
share the same pool ID. Users that share defined pool ID's are collectively limited by
both the pool limit and the key-count.
Example:
In the above example, there are three virtual pools defined for FileAID. Clients/users that
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 a group.
borrow/concurrent
30
Distributed License Management User Guide
Chapter 2 ∙ Client-Server Configuration
borrow
The borrow keyword can be used to restrict the maximum number of license tokens and
the maximum number of days that a particular key/application can be borrowed. Since
borrowing is an extension of concurrency, only current keys can be borrowed.
concurrent
The concurrent keyword allows an administrator to limit the use of concurrent licenses.
Distributed License Management User Guide
31
Chapter 2 ∙ Client-Server Configuration
32
Distributed License Management User Guide
CHAPTER 3
Distributed License Management Application
Welcome to the DLM Application
Welcome to the Distributed License Management (DLM) application.
The Distributed License Management application is a Windows-based GUI designed to help
you set up and manage your license files. DLM is resizable only if the tabs are not completely
viewable from within the dialog. For example, if running on a non-English machine, it is
possible that the data within the tabs will be truncated. When DLM is started on a configured
system, it immediately analyzes the license path and checks license sources for expired features.
DLM displays all Compuware product license information available on both the client and
server environments. It is used for license configuration and it provides current information
about the system and local environment.
On systems where the Compuware License Service is installed, the user-definable attributes of
the Compuware License Service can be changed using the DLM application's User Management
options. When a central license server containing the Compuware License Service is used,
individual end-user (client) machines or servers running Compuware products must connect to
the Compuware License Service to obtain their license. To do this, use the DLM application on
each client machine or use a UNIX environment variable to establish the host name and port of
the machine running the Compuware License Service.
You can also use the DLMCV to perform license administration tasks. For more information,
see Welcome to the DLMCV [p. 61]. Since the DLM application is Windows-based, those on
the UNIX platform must use the DLMCV instead of DLM.
Explore the DLM Application
After you log in to the DLM application, the Local Environment screen appears. You can also
access the Advanced Configuration tab, which enables your local license environment. On
systems where the Compuware License Service is installed, the Server Environment tab will
be accessible. While in the DLM application, click a tab name to open the window for that tab.
Distributed License Management User Guide
33
Chapter 3 ∙ Distributed License Management Application
34
•
Help link: This link will display the online help of the tab which is currently selected.
Also, [Pf1] will bring up the online help.
•
Show system information: This link will display the below screen showing the system
information of the machine.
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
•
About License Management: This link will display the below screen showing information
about Compuware’s Distributed License Management.
Local Environment Tab
In the Distributed License Management application, the Local Environment tab displays
information about the currently configured path. The License source/path section of the Local
Environment tab is used to review and manipulate the license environment. The Licensed
features section of the Local Environment tab is used to check for feature usage and general
license errors. Also, this section allows ascending and descending sorting on all of the displayed
columns.
Before you can use the DLM application, you must first add a license source. When a license
source is displayed in the License sources/path field, only buttons relevant to that selected
source are enabled. Lastly, if you right-click on the source and it is a port@host definition, then
you will have the ability to view the log, clear the log, view the audit file and clear the audit
file.
Lastly, in previous versions of DLM, there was the ability to create an audit file based on whether
or not the license server administrator turned on this functionality. The audit file kept a
comma-delimited file of checkouts and check-ins for each user. Since DLM provides the
infrastructure for an improved usage tracking system, there is no longer a need for the auditing
capability. Therefore, when the License Service is re-started for the first time, it will check to
see if auditing has been turned on. If it has, it will inform the administrator that auditing is no
Distributed License Management User Guide
35
Chapter 3 ∙ Distributed License Management Application
longer available, but that the new usage tracking system is. The administrator will need to go
into either the DLM Windows application or the DLM command-line tool and set it up.
Server Environment Tab
The Server Environment tab displays information about the local Compuware License Service.
It provides the ability to administer the Compuware License Service. This tab is only visible
on systems with the Compuware License Service installed.
36
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
Borrow License Server Tab
The Borrow License Server tab displays the currently borrowed features for the server and
provides the system administrator with the ability to place borrow restrictions on certain features.
Distributed License Management User Guide
37
Chapter 3 ∙ Distributed License Management Application
Advanced Configuration Tab
The Advanced Configuration tab provides the ability to configure the license environment for
both the client and server. If the machine has Distributed License Management running, then
the Server Configuration options are present. Once you select an option, a selection is required,
a button becomes activated, or text can be entered into the field.
38
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
Click the links below for more information about the fields on the Advanced Configuration
tab:
•
Create usage report field [p. 129]
•
Expiration warning at startup field [p. 133]
•
Broadcast Attributes Field [p. 127]
•
Configuration environment field [p. 128]
•
Connection timeout in seconds for client field [p. 128]
•
Pool ID field [p. 135]
•
License Proxy field [p. 133]
•
Connection timeout in seconds for server field [p. 128]
•
Create new log when server starts field [p. 128]
•
Duration, in years, to store license usage data field [p. 127]
•
Enable Email Notification field [p. 129]
•
Maximum log size in bytes field [p. 133]
Distributed License Management User Guide
39
Chapter 3 ∙ Distributed License Management Application
•
Maximum threads field [p. 133]
•
Modify location of server files field [p. 133]
•
Port number field [p. 136]
•
Network security field [p. 135]
•
Pools field [p. 135]
•
User manage field [p. 136]
Borrow License Client Tab
The Borrow License Client tab displays the features that are borrow-enabled for all the servers
specified in your Local Environment. This tab allows you to borrow licenses for user-determined
amounts of time.
License Environment
Add a License Source
Use the Local Environment tab to add a license file and define multiple licensing environments
(paths) for a machine.
1.
40
Start the DLM application.
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
2.
3.
4.
5.
6.
7.
Click the Local Environment tab.
On the Local Environment tab, click Add. The Add License Source dialog box appears.
Type the name of the file or the port@host server definition of the Compuware License
Service in the provided field. Or select a previously added name from the drop-down box.
Go to step 7.
If you do not know the license file name, click the Browse for a license file on disk link
to browse for the file you want to add.
Select the license file and click Open.
Click OK to add the license to the License source/path field.
TIP
Before you attempt to run a particular product, be sure that one of the paths you defined contains
the license file for the product you want to run. If there are multiple old or obsolete paths listed
in the License source/path field, you should delete them to improve product response time.
Only currently operating servers should be specified in the local environment setting.
IMPORTANT
Adding a concurrent license from a shared location is not supported and will cause problems
for the Compuware License Service. However, you may add a single-seat or node-locked license
from a shared location.
Remove a License Source
When needed, you can remove a license source from the license environment.
1.
2.
3.
4.
Start the DLM application.
Click the Local Environment tab.
In the License source/path field, select a license source.
Click Remove. The Remove dialog box appears.
5.
Click Yes to confirm that you want to remove the source. If not, click No to cancel.
Reorder the License Sources List
This function allows you to move an item in the License Source/path field up one position in
the list.
Distributed License Management User Guide
41
Chapter 3 ∙ Distributed License Management Application
When a Compuware product attempts to check out a license, it searches all of the paths in the
listing until it finds a valid feature line. Therefore, if many paths are specified, it is best to move
a license that is used more often to the top of the list, which results in faster license check outs.
1.
2.
3.
4.
Start the DLM application.
Click the Local Environment tab.
In the License source/path field, select a license source to move up one position in the
list.
Click Move Up to move the item up one level in the list.
License feature status
Checking the status of a license feature allows you to identify the users currently using this
feature, as well as checking your license environment for errors. The dialog box will display
the number of users and whether the feature is working properly.
1.
2.
3.
4.
Open the DLM application.
Click the Local Environment tab.
Select a feature in the License features field.
Click Status. The Status dialog box appears, identifying the users currently using the
feature as well as if the feature is working properly.
5.
Click Close to close the dialog.
Local Environment Tab
In the Distributed License Management application, the Local Environment tab displays
information about the currently configured path. The License source/path section of the Local
Environment tab is used to review and manipulate the license environment. The Licensed
features section of the Local Environment tab is used to check for feature usage and general
license errors. Also, this section allows ascending and descending sorting on all of the displayed
columns.
42
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
Before you can use the DLM application, you must first add a license source. When a license
source is displayed in the License sources/path field, only buttons relevant to that selected
source are enabled. Lastly, if you right-click on the source and it is a port@host definition, then
you will have the ability to view the log, clear the log, view the audit file and clear the audit
file.
Lastly, in previous versions of DLM, there was the ability to create an audit file based on whether
or not the license server administrator turned on this functionality. The audit file kept a
comma-delimited file of checkouts and check-ins for each user. Since DLM provides the
infrastructure for an improved usage tracking system, there is no longer a need for the auditing
capability. Therefore, when the License Service is re-started for the first time, it will check to
see if auditing has been turned on. If it has, it will inform the administrator that auditing is no
longer available, but that the new usage tracking system is. The administrator will need to go
into either the DLM Windows application or the DLM command-line tool and set it up.
License File
Add a License Source
Use the Local Environment tab to add a license file and define multiple licensing environments
(paths) for a machine.
1.
2.
Start the DLM application.
Click the Local Environment tab.
Distributed License Management User Guide
43
Chapter 3 ∙ Distributed License Management Application
3.
4.
5.
6.
7.
On the Local Environment tab, click Add. The Add License Source dialog box appears.
Type the name of the file or the port@host server definition of the Compuware License
Service in the provided field. Or select a previously added name from the drop-down box.
Go to step 7.
If you do not know the license file name, click the Browse for a license file on disk link
to browse for the file you want to add.
Select the license file and click Open.
Click OK to add the license to the License source/path field.
TIP
Before you attempt to run a particular product, be sure that one of the paths you defined contains
the license file for the product you want to run. If there are multiple old or obsolete paths listed
in the License source/path field, you should delete them to improve product response time.
Only currently operating servers should be specified in the local environment setting.
IMPORTANT
Adding a concurrent license from a shared location is not supported and will cause problems
for the Compuware License Service. However, you may add a single-seat or node-locked license
from a shared location.
Remove a License Source
When needed, you can remove a license source from the license environment.
1.
2.
3.
4.
Start the DLM application.
Click the Local Environment tab.
In the License source/path field, select a license source.
Click Remove. The Remove dialog box appears.
5.
Click Yes to confirm that you want to remove the source. If not, click No to cancel.
Local Environment Tab
In the Distributed License Management application, the Local Environment tab displays
information about the currently configured path. The License source/path section of the Local
Environment tab is used to review and manipulate the license environment. The Licensed
features section of the Local Environment tab is used to check for feature usage and general
44
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
license errors. Also, this section allows ascending and descending sorting on all of the displayed
columns.
Before you can use the DLM application, you must first add a license source. When a license
source is displayed in the License sources/path field, only buttons relevant to that selected
source are enabled. Lastly, if you right-click on the source and it is a port@host definition, then
you will have the ability to view the log, clear the log, view the audit file and clear the audit
file.
Lastly, in previous versions of DLM, there was the ability to create an audit file based on whether
or not the license server administrator turned on this functionality. The audit file kept a
comma-delimited file of checkouts and check-ins for each user. Since DLM provides the
infrastructure for an improved usage tracking system, there is no longer a need for the auditing
capability. Therefore, when the License Service is re-started for the first time, it will check to
see if auditing has been turned on. If it has, it will inform the administrator that auditing is no
longer available, but that the new usage tracking system is. The administrator will need to go
into either the DLM Windows application or the DLM command-line tool and set it up.
Compuware License Service
Start the Compuware License Service
If the Compuware License Service is not running, you have to start it in order to enable the use
of your server license.
Distributed License Management User Guide
45
Chapter 3 ∙ Distributed License Management Application
1.
2.
3.
Start the DLM application.
Click the Server Environment tab.
Click Start.
Stop the Compuware License Service
You can stop the Compuware License Service in order to switch to a different license or perform
service in your license environment.
1.
2.
3.
Start the DLM application.
Click the Server Environment tab.
Click Stop.
Remove the Compuware License Service
When needed, you can remove the Compuware License Service from your license environment.
1.
2.
3.
Start the DLM application.
Click the Server Environment tab.
Click Remove.
This also removes the Server Environment tab from DLM.
Server Environment Tab
The Server Environment tab displays information about the local Compuware License Service.
It provides the ability to administer the Compuware License Service. This tab is only visible
on systems with the Compuware License Service installed.
46
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
Log File
Log File
Compuware License Service servers maintain a log file of user activities. Logged information
is stored in the logging folder in the file log.txt. Compuware License Service log files contain
two types of entries: IN and OUT. An IN entry logs an increment in the number of available
license tokens. An OUT entry logs a decrement in the number of available license tokens.
Log File Format
Log entry records are based on the following format:
[MM/DD/YY-HH:MM:SS] —ACTION—METHOD tok(token information) cv(version information)
usr(user information)
app(application, version) cnt(n)
or
[MM/DD/YY-HH:MM:SS] —ACTION-ERR usr(user information) app(application, version) cnt(n)
******error reason
Parameters
[MM/DD/YY-HH:MM:SS]
The time stamp field identifies the time that the transaction occurred. The MM field
contains the month, the DD field contains the day, the YY field contains the year, the HH
Distributed License Management User Guide
47
Chapter 3 ∙ Distributed License Management Application
field contains the hour, the MM field contains the minutes, and the SS field contains the
seconds.
ACTION
The ACTION field is either IN, OUT or HRTB. The action IN denotes an increment in
the number of available license tokens while OUT and HRTB denote a decrement in the
number of available license tokens.
METHOD
The METHOD field identifies the method used by the end-user to perform the action.
This information is provided for Compuware Support.
tok
The tok field identifies information about the license token this action is attached to.
cv
The cv field identifies which version of the Compuware License Service the client is
running.
usr
The usr field identifies information about the user that requested a license token. Fields
within the usr field are delimited by the ‘@’ symbol. In most cases, an end user will be
identified as follows: user_name@host_name@session_identifier.
app
The app field contains the application name and the requested application version.
cnt
The cnt (count) field contains the number of tokens that were requested in the transaction.
In the case of an IN action, it is the number of tokens returned.
Error Log Entries
Errors occur when transactions bump up against the limits of an enforced license agreement.
OUT actions that fail produce log messages that have additional information. Failed OUT
messages contain two lines of data: the first line containing information about the request, and
the second line containing the error condition. In cases where pool-id based errors occur, the
user's pool identifier is also listed in the log message, delimited by the keyword pool.
View a Log File
The log file is where the Compuware License Service writes its diagnostics.
1.
2.
3.
48
Start the DLM application.
Click the Local Environment or Server Environment tab.
If you are on
a. the Local Environment tab, select a license source in the License sources/path field.
Right-click on License source in the License sources/path field. This is the only way
to view the log from the Local Environment tab.
b. the Server Environment tab, click View Log or View Log File to open the View Log
dialog box.
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
On the View Log dialog box, you can review the log file and filter information logged
by a license server from a remote or local location. The View Log dialog box can
display up to 1,000 lines. If the log file is larger than 1,000 lines, only the last 1,000
lines are loaded into its buffer and displayed.
4.
If desired, enable log filtering.
Log filtering enables you to search on keywords or phrases in the log file. The Filter
Content box of the View Log box enables you to filter out unwanted content. Filtering
works on the entire log file, not just what is displayed in the dialog box. Type the text you
want to include in the filter. However, if there is text you want to exclude, type it in and
select the Exclude check box. If capitalization is not important, select the Ignore Case
check box. Once you have specified your parameters, click the Filter Content button. To
save the results of the filter, click the Save As Button. If needed, click the Clear Filter
button to return to the original log file content.
Filter Content
dialog box enables you to filter out unwanted content. Filterin Filtering enables you to perform
a search on keywords or phrases in the log file. The Filter Content box of the View Logg
works on the entire log file, not just what is displayed in the dialog box.
1.
2.
3.
Start the DLM application.
Click the Local Environment or Server Environment tab.
If you are on
a. the Local Environment tab, you must first select a license source in the License
sources/path field. Right-click on License source in the License sources/path field.
This is the only way to view the log from the Local Environment tab.
Distributed License Management User Guide
49
Chapter 3 ∙ Distributed License Management Application
b. the Server Environment tab, click View Log to open the View Log dialog box.
4.
5.
6.
7.
8.
9.
In the Filter Content field, type the text you want to include in the filter.
If, on the other hand, there is text you want to exclude from the filter, type that text in the
Filter Content field and select the Exclude check box.
If capitalization of text is not important in the filter criteria, select the Ignore Case check
box.
Click Filter Content to perform the filter.
To save the results of the filter, click Save As.
If needed, click Clear Filter to remove the filter and return to the original list of log file
contents.
Flush a Log File
A good troubleshooting technique is to flush the log file when repeated errors occur. This way,
the only items written into the log file are the diagnostics pertaining to the error condition.
1.
2.
3.
50
Start the DLM application.
Click the Server Environment tab.
Click Clear Log. The Empty Log File dialog box appears.
Distributed License Management User Guide
Chapter 3 ∙ Distributed License Management Application
4.
Click Yes to continue and flush the log file, or click No to cancel.
Move a Log File
The Distributed License Management license service enables an end-user to specify an alternate
location for the server files that need write permissions, and to move the server files to that
alternate location. The license service has log files, configuration files, cache files and temporary
files that need to be written to while the service is running. When the end-user activates this
functionality, these files will be redirected to a specified location. During this activation, it will
be imperative that DLM copy any existing files from the current location to the new location,
in order to retain all records of checked out licenses.
Both the DLM application and the DLM command-line tool provide a user interface for setting
up this functionality. When the user activates this functionality through one of the two user
interfaces, DLM will write a file to the current directory registering the new location of the
server files. Then, if the license service finds this file, it will read the location and write any
data there; otherwise, it will write the data to the default location.
When the user goes to the Advanced Configuration tab for the first time, the default location
of the server files will be filled in (as shown above). If the user wants to change the location,
they will select Modify location of server files and click the ellipsis button to the right. This
will bring up a dialog box allowing them to navigate to the directory of choice. This dialog box
enables the user to select folders only, not individual files. Once the location is selected, click
OK and this will be the new location of the server files. The user must re-start the license
service before the changes take effect.
The command-line utility (dlmcv.exe) will also enable the Unix end-user to modify the location
of the server files. In the License Service Command List, there is an option called Server
Distributed License Management User Guide
51
Chapter 3 ∙ Distributed License Management Application
file location. When selected, this will display the current location of the server files and
enable the user to set this to an alternate location. Once the user has set this to a different
location, the license service must be re-started.
During the activation and de-activation of this functionality, it is necessary to copy any existing
files to the new location so DLM can continue to monitor license usage consistently.
52
Distributed License Management User Guide
CHAPTER 4
License Usage Monitoring
DLM allows users to track license usage in two ways:
•
Peak usage reporting, which allows users to create reports about DLM peak license usage
based on user-provided parameters. For more information, see Peak Usage Reporting
[p. 53].
•
Usage monitoring.
While peak usage reporting is available upon request, usage monitoring is always on. Data is
captured in a compact binary format and all numerical fields within the database are in big-endian
byte ordering to provide cross-platform compatibility.
Peak Usage Reporting
DLM allows users to create reports about DLM peak license usage. Users can enter the following
data as filter criteria:
•
Application name
•
User name
•
Host/machine name
•
Error type
•
Pool ID
•
Date and time range
Usage reports can be created via two methods:
•
Using the DLM application (for Windows)
•
Using UMFilter.exe (for UNIX)
Regardless of method used to create the report, the report data is output to one or more
comma-delimited text files, one file for each of the following:
•
Usage data
•
Unique users (optional)
Distributed License Management User Guide
53
Chapter 4 ∙ License Usage Monitoring
•
Unique hosts (optional)
On Windows machines with Excel 2007 or above, these reports open in Excel and include an
additional report — a usage chart — that displays the usage data in a visual representation. One
limitation of Excel is that it cannot handle a file larger than 65,536 lines. If the report is larger,
the user will receive a message to refine their search to be more exclusive.
UNIX users can display the text files in a graphing tool of their choice.
Usage Data
54
Distributed License Management User Guide
Chapter 4 ∙ License Usage Monitoring
Usage Chart
When using the Threshold License Model, available under certain circumstances as directed by
Compuware, the usage graph shows usage compared to the number of licensed users and the
established threshold, as shown below.
Distributed License Management User Guide
55
Chapter 4 ∙ License Usage Monitoring
Unique User List
56
Distributed License Management User Guide
Chapter 4 ∙ License Usage Monitoring
Unique Host List
Peak Usage Reporting for Windows
Follow the steps below to create a usage report.
1.
Click the Advanced Configuration tab.
2.
Click
at the right end of the Create usage report row. The Connect to a Compuware
License Server dialog box appears.
Distributed License Management User Guide
57
Chapter 4 ∙ License Usage Monitoring
3.
4.
Enter or select from the drop-down list the port@host definition of the license server from
which to retrieve the data, then click OK. The Create Usage Report dialog box appears.
Complete the dialog box according to the field descriptions below.
The fields on the Create Usage Report are as follows:
58
Distributed License Management User Guide
Chapter 4 ∙ License Usage Monitoring
Report file name
This field displays a default report name and location where your application data
folder resides. To browse to a different location, click
and navigate to a different
folder. The default name is report.txt and increments by one beginning at
report0001.txt.
Create a unique list of users which have used the application during the specified time
period
(optional) Select this check box if you want the usage report to include a list of the
users who have used the application during the specified time period. The default
name is user_list.txt and increments by one beginning at user_list0001.txt.
Create a unique list of host machines which have accessed the application during the
specified time period
(optional) Select this check box if you want the usage report to include a list of the
host machines who have used the application during the specified time period. The
default name is host_list.txt and increments by one beginning at host_list0001.txt.
Application name from license file
Specify the Compuware product name for which you want to create a usage report.
The drop-down list is prepopulated with the names of all Compuware products
available from the specified license server.
Host/Machine name
(optional) Specify the certain host/machine name for which you want to create a usage
report.
User name
(optional) Specify a certain user for which you want to create a usage report.
Pool ID
(optional) Specify a pool identifier for which you want to create a usage report.
Error type
(optional) Specify an error code for which you want to create a usage report.
Starting date
Specify the date on which you want the usage report to start.
Ending date
Specify the date on which you want the usage report to end.
Specify a starting and ending time
(optional) Select this check box if you want to specify a specific time of the day from
which to report. The Starting time and Ending time fields will become enabled.
Starting time
Specify the time you want the report to start.
Ending time
Specify the time you want the report to start.
5.
Click OK to create the reports. The reports open in Excel, if a supported version exists on
the machine, or in a text file. The graphics below show samples of the reports.
Distributed License Management User Guide
59
Chapter 4 ∙ License Usage Monitoring
NOTE
If the port@host specified does not have a usage database to report against, a message is
displayed informing the user that the report cannot be created. To quit without creating the
report, click Cancel.
UMFilter.exe - (for UNIX)
UMFilter provides cross platform and script support for data filtering. UMFilter is a command
line utility that facilitates both database filtering and the conversion of filtered data to
comma-delimited files. UMFilter.exe can be found in the installation directory where DLM
was installed. The syntax of UMFilter is below:
Syntax
UMFilter [[[-f filename ] | [-s port@host] ] [-sd MMDDYYYY]
[-ed MMDDYYYY] [-u username] [-a feature] [-h hostname]
[-st HH:MM[AM|PM]] [-et HH:MM[AM|PM]]]
Parameters
-f
Used to specify a local database file.
-s
Used to specify a remote service that has capture enabled.
-sd
Specifies the starting date within the database where filtering is to begin.
-ed
Specifies the ending date, that is, the date of the last record were filtering is to end.
-st
Start time window.
-et
Ending time window.
-u
Filter all records that contain the provided username.
-a
Filter all records containing the provided feature name.
-h
Filter all records that contain the provided hostname.
60
Distributed License Management User Guide
CHAPTER 5
Distributed License Management – command line
version
Welcome to the DLMCV
Welcome to the Distributed License Management - Command Line Version (DLMCV), the
command line version of the Windows GUI-based Distributed License Management. While
limited in functionality, the DLMCV mirrors most of the functionality provided by its GUI-based
counterpart, the DLM. The purpose of the DLMCV is to provide a simple text interface that is
platform and display independent. It provides UNIX text-based support and support for
script-based configurations.
The DLMCV application is located in the license installation directory on the same directory
level as the Compuware License Service server.
To launch the command line version of DLM from Windows run dlmcv.exe, and from UNIX
run dlmcv.sh.
The DLMCV user interface uses a series of text-based menus, called command lists. Each
command list and its submenu is hierarchically organized by category and is based on the
functionalities provided by each menu tree. Each menu label begins with one or more uppercase
letters. Entering either the label of a menu or its abbreviated character set (denoted by the
uppercase characters) provides access to the menu item. Menu items are either references to
submenus or commands. Hitting the enter key from any sub-menu returns you to the next
highest menu level.
DLMCV Main (Root) Menu
When the DLMCV is launched, the first menu displayed is the DLMCV Main menu. It contains
two submenus:
DLMCV_Client_Menu [p. 62]
DLMCV License Service Menu [p. 73]
dlmcv - Copyright (C) 2006, Compuware Corporation.
All rights reserved
Distributed License Management User Guide
61
Chapter 5 ∙ Distributed License Management – command line version
---DLMCV Main--Client
License Service
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
DLMCV_Client_Menu
The DLMCV's Client Menu provides the following list of configuration and diagnostics
commands for the administration of a license client:
•
Applications [p. 63]
•
Borrow [p. 64]
•
Broadcast [p. 67]
•
License path [p. 68]
•
Pools [p. 69]
•
Server Loading [p. 70]
•
Timeout [p. 70]
•
Who [p. 71]
•
Verify [p. 72]
To access the Client menu from the DLMCV Main Menu, enter either
'client' <enter>.
---Client command list--Applications
Borrow
BRoadcast
License path
Pools
Server loading
Timeout
Who
Verify
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv>?
62
Distributed License Management User Guide
'c' <enter> or
Chapter 5 ∙ Distributed License Management – command line version
To display additional information about each command, enter ‘?’ followed by <enter>, which
toggles the Help on and off.
---Client command list--Applications
Borrow
BRoadcast
License path
Pools
Server loading
Timeout
Who
Verify
:::::::::-
list applications supported by local client
borrow and/or return a license
set/view client broadcast attribute
configure and/or display the license path
view and/or modify the pool id of the current user
enable or disable server loading
configure and/or display the timeout interval
show feature usage
verify that a feature is working properly
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv>
Applications
The Applications command displays a list of features/applications supported by the current
license environment. To execute the Applications command, enter 'a' [<Enter>] or
'applications' [<Enter>].
Source: 7188@sfa141282k
Feature
-----------------------------941
Java Developer
Java Doc
DevPartnerSecurityChecker
DEVPARTNER_FAULT_SIMULATOR
application_expert
application_vantage
OptimalView
AV_expert_analysis
AV_unattended_capture_mgr
AV_Extended_Merge
AV_WDE
542
552
BoundsChecker
QARun_Developer
QARun_Rented_Runtime
Version
---------06.01
1.0
1.0
01.00
01.00
09.00
09.50
03.03
09.50
09.50
09.50
09.50
06.60
07.00
07.02
04.90
04.90
Days Left
Association
------------- --------------0
False
0
False
0
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
307
False
----- Hit the enter key to continue -----
The list of applications/features may comprise multiple pages, clicking [<Enter>] will take
you through each page, in turn.
Distributed License Management User Guide
63
Chapter 5 ∙ Distributed License Management – command line version
Borrow
The Borrow menu provides a set of functionality that allows a licensed client to manage borrowed
transactions. The ability to borrow is dependent on the keys provided in the license file. Only
borrow-enabled features* can be borrowed. To enter the Borrow menu, enter 'b' [<Enter>]
or 'borrow' [<Enter>].
Current setting(s):
Current borrow usage:
no features currently borrowed
---[Borrow
Command list---
]
Group
In
Out
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
NOTE
A borrow-enabled feature is any application, defined by a licensed key, that contains the tag
<Borrowed>.
The Borrow menu, as with many third-level menus, is separated into two sections: a Command
List and a Current Settings section. The Current Settings section displays the current
configuration of the client for that particular set of related options. In the case of borrowing, it
displays any previously borrowed features.
Group command
The Groupcommand allows a user to specify a group file. For more information, see Create
a Group File for Borrowing [p. 92].
Out command
The Out command facilitates application borrowing. Upon entering the Out command,
a list of borrow-enabled features is displayed.
Feature
----------------------------Uniface Products
Vantage Products
grp1
grp2
Java Developer
Java Doc
64
Distributed License Management User Guide
Version
Expiration
---------- -----------group
group
group
group
group
group
group
group
1.0
17-dec-2004
1.0
17-dec-2004
Chapter 5 ∙ Distributed License Management – command line version
DevPartnerSecurityChecker
DEVPARTNER_FAULT_SIMULATOR
application_expert
application_vantage
AV_expert_analysis
OptimalAdvisor
USRVUSP
UTL
UMSS
USOL
USRV3GL
USRVCORBA
USRVMSS
USRVSOL
01.00
01.00
09.00
09.50
09.50
01.00
08.04
08.04
08.04
08.04
08.04
08.04
08.04
08.04
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
Enter feature name or ['n' to continue] :
If more than one feature/application is borrow-enabled and the feature list does not fit on
one page, navigation can be performed using n for next and p for previous. Once the
desired feature is visible, enter the feature name followed by the [<Enter>] key.
Feature
-----------------------------Uniface Products
Vantage Products
grp1
grp2
Java Developer
Java Doc
DevPartnerSecurityChecker
DEVPARTNER_FAULT_SIMULATOR
application_expert
application_vantage
AV_expert_analysis
OptimalAdvisor
USRVUSP
UTL
UMSS
USOL
USRV3GL
USRVCORBA
USRVMSS
USRVSOL
Version
---------group
group
group
group
1.0
1.0
01.00
01.00
09.00
09.50
09.50
01.00
08.04
08.04
08.04
08.04
08.04
08.04
08.04
08.04
Expiration
-----------group
group
group
group
17-dec-2004
17-dec-2004
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
27-jan-2006
Enter feature name or ['n' to continue] : USOL
USOL 08.04 selected.
Is this the feature and version that you are
attempting to borrow: (Y/N)?
When prompted to accept the selection, enter Y for yes. If the feature name exists more
than once in the list of borrow-enabled features, entering N eliminates each subsequent
match from the list of selectable features on the current page.
(1) hours
(2) days
--------------------------------Enter borrow unit type (1->2):
Distributed License Management User Guide
65
Chapter 5 ∙ Distributed License Management – command line version
Following the selection of the borrow-enabled feature, the DLMCV prompts for the
duration of the borrow transaction; that is, how long the license token is to be kept
out/borrowed. Borrow transactions can last from one hour to 365 days. Before the duration
of a borrow transaction can be specified, the time unit must be defined.
(1) hours
(2) days
--------------------------------Enter borrow unit type (1->2): 1
Enter the length in hours to borrow: 8
Once a feature has been borrowed successfully, information about the borrow transaction
is displayed in the Current Settings section of the Borrow menu.
Current setting(s):
Current borrow usage:
Format: Feature, Host, DD:HH:MM:SS
------------------------------------------------------USOL, 7188@sfa141282k, 00:07:59:59
---[Borrow
Command list---
]
Group
In
Out
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
In command
The In command terminates a borrow transaction.
Current setting(s):
Current borrow usage:
Format: Feature, Host, DD:HH:MM:SS
-------------------------------------------------------
66
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
USOL, 7188@sfa141282k, 00:07:59:59
---[Borrow
Command list---
]
Group
In
Out
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv> in
Enter feature name to return-unborrow: USOL
Broadcast
The Broadcast menu provides functionality to alter the broadcast behaviors of a client system
(See Client Broadcast Attributes.).
Current setting(s):
Broadcast: upper case
---[Broadcast Command list--Set
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Set Command
The Set command sets the broadcast attribute for a licensed client (See Client Broadcast
Attributes.).
Options
[1] Upper case
[2] Lower case
[3] Matched case
-----------------------------------Enter case sensitivity option: [1-3]
Distributed License Management User Guide
67
Chapter 5 ∙ Distributed License Management – command line version
License path
The License Path menu is used to view, add, and remove items in the license path.
Current setting(s):
not set
---[License path
Command list---
]
Add
Remove
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Add command
The Add command adds license sources to the license path.
Current setting(s):
not set
---[License path
Command list---
]
Add
Remove
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Remove command
The Remove command removes license sources from the license path.
Current setting(s):
7188@sfa141282k
68
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
---[License path
Command list---
]
Add
Remove
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv> r
Enter a license source to delete: sfa141282k
Pools
The Pools menu allows a client to be assigned a pool id – see pools.
Current setting(s):
Pool id: nill
---[Pools
Command list---
]
Set
Clear
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Set command
Set the pool ID for the client system.
Current setting(s):
Pool id: nill
---[Pools
Command list---
]
Set
Clear
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
Distributed License Management User Guide
69
Chapter 5 ∙ Distributed License Management – command line version
by the leading uppercase characters.
dlmcv> s
Enter pool id: Wayne State University
Clear command
Clears the client system’s pool ID – see pool ID's. By default pool ID's are not assigned
to clients.
Server Loading
The Server Loading menu allows server loading to be toggled off and on – see server loading.
Current setting(s):
Loading: disabled
---[Server loading ] Command list--Enable
Disable
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Enable Command
The Enable command authorizes the client to break up bulk-license over multiple license
sources.
Disable Command
The Disable command disables the break up of bulk-license requests. This is the default
behavior.
Timeout
The Timeout menu allows the client’s current timeout setting to be viewed and/or changed.
Current setting(s):
Timeout : 10
---[Timeout
Command list---
]
Set
70
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Set Command
The Set command changes the current timeout value. Timeout values are integer and in
seconds.
Current setting(s):
Timeout : 10
---[Timeout
Command list---
]
Set
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv> s
Enter new timeout interval: 20
Who
The Who command displays the usage of an entered feature/application.
---Client command list--Applications
Borrow
BRoadcast
License path
Pools
Server loading
Timeout
Who
Verify
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv> Who
Distributed License Management User Guide
71
Chapter 5 ∙ Distributed License Management – command line version
trying 7188@dtw108051d01; please wait,....
Enter feature name: QADirector32
The following text appears.
Usage for feature QADirector32
Host: 7188@sfa141282k
User
Version
--------------------------------------QACPUSER@C3YUD4AYWYSLDRVHHF...
05.01
QACPUSER@VAGQ0W553AYYYB255O...
05.01
QACPUSER@PHUB1VBM1GRABKENAF...
05.01
QACPUSER@IQH3GZUSTGPG0TMXFL...
05.01
QACPUSER@G0FOSJJOZYZTJ455TJ...
05.01
QACPUSER@IGZMFF55OKPMMNZULE...
05.01
QACPUSER@EDUHJLAOIMO2O4Y5TG...
05.01
QACPUSER@D0XHB455SRPQYQ45XE...
05.01
QACPUSER@4LAHN32XJ5M35K45NI...
05.01
QACPUSER@TMOUQZQRAIYTMG4511...
05.01
QACPUSER@2TVE4C45RLBO3QMJQB...
05.01
QACPUSER@GOJ41M45PE0E5P45YE...
05.01
QACPUSER@DHHLCJABPI5Y2VVWNM...
005.001
QACPUSER@SDTJT255I20WZ255JB...
005.001
QACPUSER@XG5RLQAXPMKNDNFYHN...
005.001
----- Hit the enter key to continue -----
Count
-------3
7
12
1
1
1
1
2
1
2
1
1
1
3
1
Verify
The Verify command is used to diagnostically check an individual feature.
---Client command list--Applications
Borrow
BRoadcast
License path
Pools
Server loading
Timeout
Who
Verify
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Enter '?' for help.
Enter feature name: QADirector32
Enter version: 5.01
72
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
On success, information about the license key is displayed.
This feature is working properly
source
: 7188@sfa141282k
feature/app
: QADirector32
requested version : 5.01
actual version
: 05.01
expires
: 307 days
type
: concurrent
----- Hit the enter key to continue -----
On failure, an error is printed for each failed source.
Enter version: 3.1
Feature: windows 3.1 could not be verified.
The most likely error:
error: The application that was requested is not licensed
code: -1
All errors:
source: Borrowed
error: The application that was requested is not licensed
code : -1
source: 7188@sfa141282k
error: The application that was requested is not licensed
code : -1
source: Grace
error: The application that was requested is not licensed
code : -1
source: compulock
error: The application that was requested is not licensed
code : -1
DLMCV License Service Menu
The DLMCV's License Service menu provides the following commands which provide
functionality to configure a local Compuware License Service:
•
Applications [p. 74]
•
Borrow [p. 75]
•
Email Notification [p. 76]
•
Host id [p. 77]
•
License Path [p. 77]
•
Network Security [p. 78]
Distributed License Management User Guide
73
Chapter 5 ∙ Distributed License Management – command line version
•
New Log [p. 79]
•
Port Number [p. 79]
•
Timeout [p. 79]
•
Who [p. 80]
To access the License Service menu from the DLMCV Main Menu, enter either “ 'l'
[<Enter>] or 'license' [<Enter>].
A local Compuware License Service is defined as a licensed application/service that administers
concurrent license tokens to licensed clients. The administration of a Compuware License
Service requires a concurrent license that is locked to the machine from which the License
Service administers licenses. Changes to the Compuware License Service’s configuration from
within this menu do not require the restart of the Compuware License Service. However, some
changes will not take effect until you exit the DLMCV.
These commands should only be used on a
licensed server.
---License service command list--Applications
Borrow
Host id
License path
Network security
New log
Port number
Timeout
Usage monitoring
Who
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv>
Applications
The Applications command lists all features/applications that are administered by the
Compuware License Service.
Feature
---------------------------------------101
102
DevPartnerSecurityChecker
application_expert
application_vantage
OptimalView
AV_expert_analysis
AV_unattended_capture_mgr
AV_Extended_Merge
AV_WDE
74
Distributed License Management User Guide
Version
--------1.0
1.0
01.00
09.00
09.50
03.03
09.50
09.50
09.50
09.50
Days Left
--------39
39
296
296
296
296
296
296
296
296
Count
-------2
2
100
100
100
100
100
100
100
100
Chapter 5 ∙ Distributed License Management – command line version
542
552
BoundsChecker
QARun_Developer
QARun_Rented_Runtime
ClientVantage
OptimalAdvisor
06.60
07.00
07.02
04.90
04.90
09.70
01.00
296
296
296
296
296
296
296
100
100
100
100
100
100
100
Borrow
The Borrow menu provides functions to regulate the duration and amount of borrow transactions
that are created through license borrowing. All borrow enabled feature are listed when you
enter the Borrow menu. Information about each borrow enabled feature is displayed in a table.
The table consists of the following elements:
Feature
Identifies the names/abbreviations of all features that are borrow-enabled.
Max Days
Identifies the maximum number of days that a feature can be borrowed.
Max Count
Identifies the maximum number of tokens that can be borrowed.
Total Available
Identifies the tokens that are reserved that cannot be borrowed.
Current setting(s):
Feature
Max Days
----------------------------- --------DevPartnerSecurityChecker
365
application_expert
365
application_vantage
365
AV_expert_analysis
365
OptimalAdvisor
365
USRVUSP
365
UTL
365
UMSS
365
USOL
365
USRV3GL
365
---[Borrow
] Command list---
Max Count
---------100
100
100
100
100
100
100
100
100
100
Total Available
---------------0
0
0
0
0
0
0
0
0
0
Configure
Who
From within the Configure command you can change the values for all three borrow-feature
settings.
Current setting(s):
Feature
----------------------------DevPartnerSecurityChecker
application_expert
application_vantage
AV_expert_analysis
OptimalAdvisor
USRVUSP
UTL
UMSS
Max Days
--------365
365
365
365
365
365
365
365
Distributed License Management User Guide
Max Count
---------100
100
100
100
100
50
100
100
Total Available
---------------0
0
0
0
0
50
0
0
75
Chapter 5 ∙ Distributed License Management – command line version
USOL
USRV3GL
---[Borrow
]
365
365
Command list---
100
100
0
0
Configure
Who
In the above example, USRVUSP has 50 license tokens that can be borrowed and 50 license
tokens that cannot be borrowed.
Email Notification
The Email notification command provides the ability to send license issue related email
notifications to one or more user-defined administrators. License issue related notifications
supported include license request denials, security warnings, license service terminations, license
server restarts, abnormal license service terminations and expiration notifications.
These commands should only be used on a licensed server.
---Email Notification Command List--Enable/disable
Notification types
Smtp mail server
SUbject
To
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv>
There are 5 different commands from within the Email notification command that are
available to you.
Enable/disable
Enables or disables the email notification functionality.
Notification types
Provides the ability to determine which notifications will be activated, thereby sending
an email when they occur. The following command list will appear allowing you to select
which notifications to receive:
76
•
Expiration
•
Restart
•
Stop
•
Usage errors
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
•
Warn
Smtp mail server
Provides the ability to set the smtp mail server name.
Subject
Provides the ability to set the subject line of the email to represent a user-defined subject.
If one isn’t used, then a default subject line will be used.
To
This allows you to set email addresses that will receive the email notifications.
Host id
The Host id command displays host id information about the Compuware License Service.
These commands should only be used on a
licensed server.
---License service command list--Applications
AUditing
Borrow
Host id
License path
New log
Port number
Timeout
Who
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv> ho
trying 7188@dtw108051d01; please wait,....
Identifier
-------------Eth
Ip
Serial
Value
------------------------------000f1feb6cf6
10.19.18.5
8c8b144b
----- Hit the enter key to continue -----
License Path
The License Path menu, as with the License Path menu in the Client menu, provides functionality
to Add and Remove license files from the Compuware License Service's search path. Valid
license sources in the Compuware License Service's search path must be fully qualified paths
Distributed License Management User Guide
77
Chapter 5 ∙ Distributed License Management – command line version
to existing license files. License files can be added to the Compuware License Service’s search
path by copying them into the license\ folder, which is located in the installation directory
of the Compuware License Service, or by adding them using the License Path command from
within the Compuware License Service menu.
Current setting(s):
c:\qaload1.xml, referenced by (configuration)
C:\Documents and Settings\PFHWEC0\dlm4.0\elk\license\101-102.xml, referenced
by (repository)
C:\Documents and Settings\PFHWEC0\dlm4.0\elk\license\global.xml, referenced
by (repository)
---[License path ] Command list--Add
Remove
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
"Repository" files are licenses located in the license folder of the Compuware License Service’s
installation directory. "Configuration" files are files that exist outside of the license repository.
When adding a license file to the environment, be sure to use the fully qualified path.
Network Security
The Network security menu allows you to set additional security settings for the Compuware
License Service.
Current setting(s):
Security: disabled
---[Network security
Command List---
]
Set
Clear
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
78
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
New Log
The New Log menu allows new log creation to be toggled off and on. When enabled, the
Compuware License Service creates a new log whenever it is restarted.
Current setting(s):
New log file on License Service start: disabled
---[New log
]
Command list--Enable
Disable
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Port Number
The Port Number menu provides a means to view and change the port number the Compuware
License Service listens on.
Current setting(s):
Port Number: 7188
---[Port number ]
Command list--Set
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Timeout
The Timeout menu provides a means to view and change the Compuware License Service’s
timeout interval. The timeout interval identifies the maximum amount of time that the
Distributed License Management User Guide
79
Chapter 5 ∙ Distributed License Management – command line version
Compuware License Service will spend attempting to communicate with a disconnected or
malfunctioning client.
Current setting(s):
Timeout: 20
---[Timeout
]
Command list--Set
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
dlmcv>
Who
The Who command lists users of all currently licensed features.
These commands should only be used on a
licensed server.
---License service command list--Applications
Borrow
Host id
License path
Network security
New log
Port number
Timeout
Usage monitoring
Who
Hit enter to return to the previous menu or key
in a command. Commands can be abbreviated using
the first N unique characters which are denoted
by the leading uppercase characters.
Enter '?' for help.
dlmcv> who
Enter feature name: QADirector32
There are no users currently using this feature.
----- Hit the enter key to continue -----
80
Distributed License Management User Guide
Chapter 5 ∙ Distributed License Management – command line version
DLMCV Command Line Options
The Distributed License Management - Command Line Version (DLMCV) runs in two states:
text-based menu and command line. Following are the Command Line Options.
Using DLMCV with Command Line Options
With its command line options the DLMCV functionality can be invoked from a script or directly
with command line switches. Some functions can only be accessed via the command line and
others can only be accessed from the menu mode. The command line functions include:
Borrow a license
dlmcv –brw –feat feature_name –vers feature_version [[-days]|[-hrs]
period ]
Return a borrowed license
dlmcv –rbrw –feat feature_name
Show borrow usage
dlmcv –brw –usage [-host hostname_of_server ]
Show feature usage
dlmcv –usage –feat feature_name [-host hostname ]
Show server port number
dlmcv –pget
Set server port number
dlmcv –pset port_number
List server license files
dlmcv –srv –plist
List client license sources
dlmcv –cl –plist
Remove server license source
dlmcv –srv –del license_source
Remove client license source
dlmcv –cl –del license_source
Add server license source
dlmcv –srv –add license_source
Add client license source
dlmcv –cl –add license_source
Server status
dlmcv –stat [-host hostname ]
Set server timeout
dlmcv –tmset timeout –srv
Set client timeout
dlmcv –tmset timeout –cl
Get server timeout
dlmcv –tmget –srv
Distributed License Management User Guide
81
Chapter 5 ∙ Distributed License Management – command line version
Get client timeout
dlmcv –tmget –cl
Get hostid information
dlmcv –id [-host hostname ]
Get log file
dlmcv –log [-host hostname ]
Import a license file onto a remote server
dlmcv –import license_file –host hostname
List server supported features
dlmcv –srv –flist [-host hostname ]
List features supported for local client
dlmcv –cl –flist
Verify a feature
dlmcv –verify –feat feature_name –vers feature_version
Probe a system for a Compuware License Server
dlmcv –probe –host hostname [-prange start:end ]
82
Distributed License Management User Guide
CHAPTER 6
Distributed License Management – mobile
Introduction to DLM - Mobile
DLM supports Windows CE mobile devices. It provides the same core functionality as its
desktop counterpart, allowing products to re-use their existing licensing source on mobile
devices. In addition, this mobile implementation supports both single-user and, to a limited
extent, concurrent license models.
The CE client runtime
Due to the nature of mobile devices (the uncertainty of persistent network connectivity),
concurrent licensing is limited to explicit borrowing. This requires that all concurrent keys
designated for mobile device access be borrow-enabled.
Installation
This installation is installed automatically during the product’s mobile installation.
Compuware LicenseSync
Compuware LicenseSync is a desktop synchronization tool that provides license support for
mobile devices by facilitating the transfer (i.e., synchronization) of license keys through a
dialog-based user interface. It supports the communication protocols currently supported by
Microsoft ActiveSync.
Compuware LicenseSync enables end users to transfer both concurrent (borrow-enabled)
transactions and single-user license keys between a desktop computer and an attached mobile
device. Both single-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.
Microsoft ActiveSync
Access Compuware LicenseSync through Microsoft’s ActiveSync utility via Tools ➤ Advanced
Tools ➤ Compuware LicenseSync…. It interfaces with Microsoft ActiveSync through
Distributed License Management User Guide
83
Chapter 6 ∙ Distributed License Management – mobile
Microsoft’s RAPI interface. The following screenshot represents ActiveSync 3.8. In other
ActiveSync versions, the shortcut location varies, but it is available.
Compuware LicenseSync - User Interface
The Compuware LicenseSync user interface contains two sections. The upper most section
provides connectivity status and hardware information about the attached device. The lower
section provides information on active licenses and licenses pending synchronization.
The table below describes elements of the Compuware LicenseSync UI displayed above.
84
Distributed License Management User Guide
Chapter 6 ∙ Distributed License Management – mobile
Component /
Button / Link
Description
Device
When connected to a mobile device, the Device Information/Status field contains information
Information/Status necessary for licensing the mobile device. The list box displays the hostname of the desktop
computer and the string “Not connected” when a mobile device is not present.
License Keys
The License Keys field contains a list of license transactions that reside on the attached mobile
device or are pending synchronization with the mobile device. Pending transactions, identified
by the string “pending synchronization,” are transactions borrowed (using DLM.EXE) or
imported single-user license keys. Rows that do not contain fields with the string “pending
synchronization” identify synchronized license keys, keys active on the attached mobile device.
In the absence of a mobile device, only borrow transactions pending synchronization are
displayed.
Help hyperlink
This link will display the online help for the Compuware LicenseSync application.
Save button
This button will save the mobile device system information to a file.
Connect button
This button will connect to a mobile device, which has been placed on a cradle.
Add button
This button will add the selected license to the mobile device. This will be activated once a
License Key has been selected.
Remove button
This button will remove the selected license from the mobile device.
Import button
This button will import a license file from the host machine to the mobile environment. Once
a license file has been imported, the user will need to select that license file and click the Add
button to transmit it to the mobile device.
Close button
This button will close the application.
Saving Device Information/Status
Click the Save button. LicenseSync will write the device information to a file.
Distributed License Management User Guide
85
Chapter 6 ∙ Distributed License Management – mobile
Importing a License
1.
86
Click the Import a License File button.
Distributed License Management User Guide
Chapter 6 ∙ Distributed License Management – mobile
2.
Select the desired file in the Open dialog box and click Open. The license keys contained
in the license file will be displayed.
Removing License Keys from a Device
1.
2.
Select (highlight) the features to be removed from among the keys with a status of On
Device.
Click the Remove button.
Distributed License Management User Guide
87
Chapter 6 ∙ Distributed License Management – mobile
88
Distributed License Management User Guide
CHAPTER 7
License Borrowing
License borrowing enables you to check out concurrent licenses from the Compuware License
Service and then use a Compuware product disconnected from the network. When you reconnect
to the network, the license can be checked back in, making it available for all users.
License borrowing is facilitated through the use of two features of the Distributed License
Management (DLM) application:
•
Borrow License Client Tab [p. 40] — displays the features that are borrow-enabled for all
the servers specified in your Local Environment which have borrow-enabled features. This
tab allows you to borrow licenses for user-determined periods of time.
•
Borrow License Server Tab [p. 37] — displays the currently borrowed features for the
server and provides the system administrator with the ability to place borrow restrictions
on certain features
Borrow License Client Tab
The Borrow License Client tab displays the features that are borrow-enabled for all the servers
specified in your Local Environment. This tab allows you to borrow licenses for user-determined
amounts of time.
Distributed License Management User Guide
89
Chapter 7 ∙ License Borrowing
Borrow License Server Tab
The Borrow License Server tab displays the currently borrowed features for the server and
provides the system administrator with the ability to place borrow restrictions on certain features.
90
Distributed License Management User Guide
Chapter 7 ∙ License Borrowing
How Do I...
Borrow a License
TIP
Do not adjust the date and time on a client machine with a borrowed license. For more
information, see Adjust the Date and Time [p. 127].
1.
2.
3.
4.
5.
6.
7.
Start the DLM application.
Select the Borrow License Client tab.
Select a feature (license) by clicking a feature in the Available features section. This will
activate the Borrow button (unless the feature is expired).
Click Borrow and the Borrow dialog box will appear.
Select either Days or Hours as the interval for this borrow transaction.
Type the desired time in the text box. The time requested cannot exceed 365 days or the
equivalent number of hours (Or, your administrator may have placed a more stringent
maximum that you must adhere to.).
Click Apply and the borrowed transaction will be executed. If there is an error, the error
dialog box will appear and the transaction will be canceled.
Distributed License Management User Guide
91
Chapter 7 ∙ License Borrowing
NOTE
Borrowing across time zones can affect the actual amount of time your borrowed license is
available for use. The start of the borrowing period is defined by the time zone of the licensed
server from which the license is borrowed.
Return a License
After you borrow a license, you must return the license when you are finished using it on the
client machine. If you do not return the license before the license expires, two things happen:
•
On the client machine, the product that is checked out under the expired license does not
run.
•
On the server, the Compuware License Service makes this license available to all users on
the network.
1.
2.
3.
Start the DLM application.
Select the Borrow License Client tab.
Select a feature (license) by clicking a feature in the Borrowed features section. This will
activate the Return button.
Click Return and the license will be returned to the server.
4.
Define Borrow Policy Settings
For more information, see Borrow License Server Tab [p. 37].
Define Borrow Policy Settings for UNIX
For more information, see Welcome to the DLMCV [p. 61].
Create a Group File for Borrowing
A group is one or more common product features grouped under a single common name. These
groups are defined in group files and a single group file can contain multiple groups. The file
names will have a .grp extension. Group files must be created via the DLM application.
1.
2.
92
Start the DLM application.
Select the Borrow License Client Tab.
Distributed License Management User Guide
Chapter 7 ∙ License Borrowing
3.
Click the Groups button and the Groups dialog box will appear.
4.
Check the Use borrow group file checkbox and click the Browse for a group file on disk
link. Browse for a file, select an existing entry in the drop-down box or browse to the
location of where you want to create a group file and click the Create button.
5.
Enter the name of the file to be created in the File name box and click Open. The Groups
dialog box is displayed again. You will see that the Edit button has been activated.
Distributed License Management User Guide
93
Chapter 7 ∙ License Borrowing
6.
Click the Edit button to open and edit the group file to your specifications. You will find
the following information within the group file regarding how to set up the group files:
---------# This file was created to define borrow groups.
# Please read the following comments on how to manage
# a borrow group file.
# All lines beginning with a '#' symbol are comment lines.
# A Borrow group is a group of borrow enabled features
# grouped under a single name/handle. Borrow
groups are
# useful in borrowing and returning sets of features/applications.
# Borrow groups are identified by their group handle name.
# All Borrow groups begin with the keyword "fgroup"
followed by
# a "[", a group name, and an ending "]".
# Features/applications or members of a group are defined using
# the "feat" keyword. As
with group name definitions each feature/application
# member must be entered on a separate line. A
feature definition
# begins with the keyword "feat" followed by a "[",
a feature/application
# name, and an ending "]". Feature/applications
that are defined in a
# group are not case sensitive; however, each member value should exist
# in the license.
# Here is an example of a group called "alpha" that references
the applications
# a, b, c, and d.
# fgroup[alpha]
#
feat[a]
#
feat[b]
#
feat[c]
#
feat[d]
fgroup[Uniface]
feat[appA]
feat[appB]
----------
7.
8.
94
Follow the instructions within the group file to create each group. Save the group file and
exit Notepad and you will be returned to the Groups dialog box.
Click the OK button to exit the Groups dialog box. The group file has been created and
activated, so proceed to the Borrow License Client tab to perform your borrowing tasks.
Distributed License Management User Guide
Chapter 7 ∙ License Borrowing
Check Out a Group for Borrowing
TIP
Before you can check out a group for borrowing, you must first create a group file for borrowing
using the DLM application. For more information, see Create a Group File for Borrowing
[p. 92].
1.
2.
Start the DLM application.
Select the Borrow License Client tab. Any available groups to be borrowed will appear
first in theAvailable Features section of this tab.
3.
Select (highlight) the group you want to borrow and click the Borrow button.
Distributed License Management User Guide
95
Chapter 7 ∙ License Borrowing
96
Distributed License Management User Guide
CHAPTER 8
Distributed License Management web interface
Welcome to the DLM Web Interface
The DLM Web Interface provides a central point of remote license administration. It allows an
administrator to view the current status of authorized license managers through a user-friendly
Web interface without being present at the server. In addition, an administrator can remotely
manage license files and perform basic diagnostics on the licensing environment.
The DLM Web Interface consists of several components. These components include a Java
applet, a user configuration tool, and a CGI (Common Gateway Interface). Unlike the applet
portion of the DLM Web Interface, the CGI module and user configuration tool are non-Java
applications, which means that unique binaries exist for each supported platform.
Explore the DLM Web Interface
The Distributed License Management Web Interface provides a central point of remote license
administration. It allows an administrator to view the current status of authorized license servers
through a user-friendly Web interface without being present at the server. In addition, an
administrator can remotely manage license files and perform basic diagnostics on the licensing
environment.
When you log in to the DLM Web Interface, the Server Status Tab [p. 98] appears as the default
home screen.
Distributed License Management User Guide
97
Chapter 8 ∙ Distributed License Management web interface
Common Elements
Although individual DLM Web Interface screens display information specific to one aspect of
licensing, all DLM Web Interface screens share the following common features.
•
Global Help and Logoff buttons.
•
Tabs to other DLM Web Interface screens.
•
Current Server drop-down list.
•
Refresh Tab and Refresh All buttons.
Server Status Tab
The Server Status tab displays information about all servers that are authorized to the logged-in
user, as well as file information regarding the current server. This tab is read-only; you cannot
modify any of the fields or table entries.
98
Distributed License Management User Guide
Chapter 8 ∙ Distributed License Management web interface
Feature Details Tab
The DLM Web Interface's Feature Details tab displays information about the features licensed
on the current server and details regarding feature usage. You cannot use any of the fields or
table entries on this window to update the License Server.
Upon initial entry into this tab, the tree structure displayed is collapsed and neither of the search
results tables are displayed. To expand the tree structure, click the radio button next to the folder
in the list.
Distributed License Management User Guide
99
Chapter 8 ∙ Distributed License Management web interface
Log File Tab
The Log File tab displays the log file (portions of it), allows filtering capabilities to help locate
specific details or errors in the licensing environment, and allows you to flush the log file while
in update mode.
License File (View/Edit) Tab
The License File (View/Edit) window displays the contents of the license file. The contents
displayed are not feature-related and can be edited by an authorized user. If you have read-only
access, all fields are uneditable and the tab appears as License File (View). If the license is a
redundant server license, none of the fields are editable, whether in update or read mode.
100
Distributed License Management User Guide
Chapter 8 ∙ Distributed License Management web interface
1.
You can modify any of the following fields:
•
Host ID (must be a string with valid characters)
•
Server Port # (must be numeric)
TIP
To cancel any change, click Reset. However, once you apply your changes to the license
server, you cannot reset them to the previous setting.
2.
Click Apply.
When you edit the Host ID or Server Port #, the server is restarted and all tabs in the DLM Web
Interface are reloaded. In addition, the User Configuration Tool is updated with the new
information. All user accounts with access to a specific Host ID are updated to reflect the new
Host ID.
License File (Import) Tab
The License File (Import) tab is enabled only for users with update access (see figure 6). This
tab allows you to send a new license file to the Compuware License Service.
If the license file is acceptable, it is applied to the Compuware License Service. If errors are
found, those errors appear in a dialog box.
1.
2.
3.
4.
5.
6.
Open the DLM Web Interface.
Click the License File (Import) tab.
Open your license file in a text editor, for example Notepad.
Select and copy your license file (using [Ctrl+C]).
Paste the copied text (using [Ctrl+V]) into the text area field of the window.
Click Import License. The license file is sent to the CGI module and scanned for errors.
Distributed License Management User Guide
101
Chapter 8 ∙ Distributed License Management web interface
If the license is acceptable, it is applied to the Compuware License Service. If errors are found,
those errors appear in a dialog box.
User Manage Tab
If any of the features on the License Server have the Umanage option, then the DLM Web
Interface's User Manage tab allows you to edit those options here.
Upon initial entry into this tab, the tree structure displayed is collapsed. To expand the tree
structure, click the radio button next to the appropriate folder in the list.
Error Messages in DLM Web Interface
If you encounter problems with the DLM Web Interface, please consult any of the related error
messages below for specific error resolution procedures or contact Customer Support for
immediate assistance. For more information, see Customer Support Information [p. 10].
NOTE
To view general error messages for DLM, see Error Messages [p. 115].
How Do I...
Logging In
There are two modes available to you when accessing the DLM Web Interface. You can log
into the DLM Web Interface in either Read Access or Update Access mode. Update
capabilities are restricted to one user per server at any given time. For example, if User1
successfully logs in to the server with update access and User2 tries to log in to the same server
102
Distributed License Management User Guide
Chapter 8 ∙ Distributed License Management web interface
with update access while User1 is logged in, then User2 is denied update access. However,
User2 can log in to that server using read access.
1.
Start the DLM Web Interface in a browser window using the site address provided by your
system administrator. The Login window appears.
2.
In the User ID field, type your User ID and in the Password field, type your password.
You are restricted to three failed password attempts before your password is revoked.
Your user ID and password are case-sensitive and must match exactly how they have been
configured in the User Configuration Tool. Refer to the Distributed License Management
Licensing Guide.
3.
Click Login. The button is disabled until you type a password in the password field and
becomes disabled again after your click it.
4.
Select a Compuware License Service server from the drop-down list that displays servers
you are authorized to access.
Select either Read Access (selected by default) or Update Access (if available to your User
ID).
Click Connect.
5.
6.
Launching the DLM Web Interface
After you click Connect to log in and it is loading in your browser window, it appears that the
application is not launching because the screen looks inactive. However, the way to determine
whether the DLM Web Interface is running is to look in the bottom left corner of your browser
window. If you see the following messages, then the application is loading.
Applet started.
Busy contacting server. Please
wait...
Distributed License Management User Guide
103
Chapter 8 ∙ Distributed License Management web interface
If the application takes an unusually long time to load after you log in and select a server, and
your license and log files contain numerous features and users, you can perform either of the
following steps.
1.
2.
Flush the log file. This should be done periodically to increase streaming. For more
information, see Flush a Log File [p. 50].
Disable the remote review of the log file or license file. Refer to the chapter on the DLM
Web Interface in the Distributed License Management Licensing Guide for information on
configuring the DLM Web Interface in Windows.
If you do not get a connection to the DLM Web Interface and it does not load, open your Java
Console to determine the error and contact Compuware Customer Support. For more information,
see Customer Support Information [p. 10].
Reset DLM Web Interface Login
The Reset button is enabled after you click Login to log in. For more information, see Logging
In [p. 102].
Click Reset to restart the login process and clear the User ID and Password fields.
Change Password
You can change your password to access the DLM Web Interface.
2.
Start the DLM Web Interface in a browser window using the site address provided by your
system administrator. The Login window appears.
In the User ID field, type your user ID and in the Password field, type your password.
3.
Click Change. The Change Password dialog box appears.
1.
104
Distributed License Management User Guide
Chapter 8 ∙ Distributed License Management web interface
4.
5.
6.
7.
In the Old Password field, type your current password.
In the New Password field, type your new password.
In the Confirm New field, type your new password again.
Click Enter.
The old password is compared to your user ID. If the password change is successful, your user
ID is carried back to the Login panel, where you must log in with your new password. For more
information, see Logging In [p. 102].
Show Licenses that Expire
You can search for license features that expire on or before a certain date.
1.
2.
3.
4.
Start the DLM Web Interface.
Click the Feature Details tab.
In the Show me licenses that expire on or before field, click the arrow in the drop-down
box and either
•
select mm/dd/yyyy and type a date in that format (for example 02/20/2004) or
•
select today.
Click Enter to display the results.
If no results are found, an empty table appears.
Show Licenses Checked Out
You can search for license features that are checked out by a specific user or host.
1.
2.
Start the DLM Web Interface.
Click the Feature Details tab.
Distributed License Management User Guide
105
Chapter 8 ∙ Distributed License Management web interface
3.
4.
In the Show me licenses that are checked out by field, type a user or host name. You
must specify the entire user or host name; wild cards are not allowed. An exact match is
required, without regard to capitalization.
Click Enter to display the results.
If no results are found, an empty table appears.
License File (Import) Tab
The License File (Import) tab is enabled only for users with update access (see figure 6). This
tab allows you to send a new license file to the Compuware License Service.
If the license file is acceptable, it is applied to the Compuware License Service. If errors are
found, those errors appear in a dialog box.
1.
2.
3.
4.
5.
6.
Open the DLM Web Interface.
Click the License File (Import) tab.
Open your license file in a text editor, for example Notepad.
Select and copy your license file (using [Ctrl+C]).
Paste the copied text (using [Ctrl+V]) into the text area field of the window.
Click Import License. The license file is sent to the CGI module and scanned for errors.
If the license is acceptable, it is applied to the Compuware License Service. If errors are found,
those errors appear in a dialog box.
106
Distributed License Management User Guide
Chapter 8 ∙ Distributed License Management web interface
Filter Log File Contents
Filtering allows you to perform a search on a word in the log file. You can view certain log file
records by narrowing the displayed records in the Log File field to those containing (or not
containing) certain text you specify. You can filter on an individual text string, not a phrase as
an entire text field in one string. Filtering works on the entire log file, not just what is displayed
in the Log File field.
1.
2.
Start the DLM Web Interface.
Click the Log File tab.
3.
4.
In the Filter Log By field, type the text you want to include in the filter.
If, on the other hand, there is text you want to exclude from the filter, type that text in the
Filter Log By field and select the Exclude check box.
If capitalization of text is NOT important in the filter criteria, select the Ignore Case check
box.
Click Apply Filter to perform the filter.
5.
6.
TIP
Filters can be performed multiple times in sequence to narrow down your searches.
Previously filtered text and settings are retained until you click Remove Filter.
7.
If needed, click Remove Filter to remove the filter and return to the original list of log file
contents. You can also clear the filter if you change the number of records displayed while
text is filtered.
Flush the Log File
Flushing the log file is a good troubleshooting technique if repeated errors occur. This way, the
only items written into the log file are the trapped diagnostics.
1.
2.
Start the DLM Web Interface.
Click the Log File tab.
Distributed License Management User Guide
107
Chapter 8 ∙ Distributed License Management web interface
3.
Click Flush Log to clear the contents of the log file specified in the Log File field. If the
user has read-only access, this button is disabled.
The log file on the server is flushed and the Log File field (displaying the log file) changes to
reflect the nearly-empty log file. One record is listed indicating that the log file was cleared.
Change Number of Records Displayed
In Update mode, you have the option to change the number of records displayed in the Log
File field. By default, you can either view the first 1000 or last 1000 records by choosing the
appropriate radio button.
NOTE
Changing the number of records displayed clears any current Filter Log File Contents [p. 107].
108
1.
2.
Start the DLM Web Interface.
Click the Log File tab.
3.
Click Change. The # Records Displayed dialog box appears.
Distributed License Management User Guide
Chapter 8 ∙ Distributed License Management web interface
4.
5.
In the field provided, type the number of records you want displayed in the Log File field
(range 1-100).
Click OK.
The text for the View first 1000 records and View last 1000 records radio buttons changes to
reflect the number of records you have chosen to be displayed. Also, the Log File field adjusts
to only display the specified number of records.
Distributed License Management User Guide
109
Chapter 8 ∙ Distributed License Management web interface
110
Distributed License Management User Guide
APPENDIX A
Redundancy
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 single
license. In the event of a partial failure, that is, the failure of one or more license servers, the
subset of remaining servers are able to maintain a temporary state of license support until the
initial state is restored.
Most redundant license systems rely on communications between license servers to maintain a
consistent count of usage. The Compuware License Service relies on its clients to maintain
license count consistency across redundant license servers.
How a redundant license is defined
A license that supports redundancy contains a redundant-object, identified by the keyword
"redundant", and one or more license-key objects that reference the redundant-object. Redundant
objects begin with <redundant protected=’security key’> and end with </redundant>.
License keys that reference redundant objects contain the field <redundant>. Only keys
containing the keyword “redundant” have redundancy.
As with license key definitions, a security key to prevent content modification protects redundant
objects. Not all keys in a license file that contain a redundant object are necessarily redundant.
Hence, a single Compuware License Service can support both redundant and simple concurrent
at the same time. Simple concurrent is defined as any non-redundant concurrent license key.
This is contrary to other licensing solutions, which can only support redundant or simple
concurrent at any given time. A license file can contain multiple redundant objects. Only those
servers, identified by ID, in a particular redundant object provide support for the redundant
policy for that key. A license key is considered redundant if it contains the keyword 'redundant'.
<license>
<redundant protected=’security key’ ><Policy_id>
a unique identifier</Policy_id >
</Failsafe_count>the minimum number of contacts necessary to
authorize a successful license checkout</Failsafe_count>
</Initial_state>the total number of redundant systems</Initial_state>
</Failsafe_duration>the maximum number of days a partial state can occur
</Failsafe_duration ></redundant>
<key
protected=’security key’ >
<Description>product
description</Description>
Distributed License Management User Guide
111
Appendix A ∙ Redundancy
<App>application
name or undefined</App>
<Vers>application
version or undefined</Vers>
<Start>start
date or undefined</Start>
<End>
end date or undefined </End>
<Count>the
number of concurrent users or the keyword unlimited, undefined, or
infinite</Count>
<hostid>
<Eth>Ethernet
address of licensed system</Eth>
<Softkey_id>the
softkey id of the licensed system</Softkey_id>
<Serial>the
disk serial number of the licensed system</Serial>
<Ip>the
ip address of the licensed system</Ip>
</hostid>
<Hostid>undefined</Hostid>
<Fcfs/>
<Redundant>
policy id
</Redundant
>
<Borrowing/>
<Umanage/>
<Dup_usr/>
<Grace>the
length of grace in hours</Grace>
<Usr_session_limit>max
sessions </Usr_session_limit>
Or
<Max_usr_sessions>max
sessions </Max_usr_sessions >
<Parameters>application
specific parameters</Parameters>
</key>
</license>
Components of a redundant object
Redundant objects contain four key fields:
Policy_id
Ties the redundant definition to its corresponding license keys.
Failsafe_count
Identifies the minimum number of servers that can be running to support a corresponding
redundant key.
Initial_state
Contains the total number of servers that provide redundancy support for corresponding
redundant keys.
Failsafe_duration
Identifies the maximum number of days that a failsafe state can exist before the initial
state must be restored.
112
Distributed License Management User Guide
APPENDIX B
Licensing Support for Unsupported Platforms
cpwrProxy32
cpwrProxy32 is a proxy service that provides licensing support for unsupported platforms - that
is, platforms that support Compuware products that have not yet been supported by the
Compuware License Service. The cpwrProxy32 acts as a client for Compuware's licensing. It
is used only in cases where it is required by a licensed product. Applications that use
cpwrProxy32 are required to use concurrent licensing.
The cpwrProxy was developed to provide support for unsupported platforms, that is, platforms
that supported Compuware products that have not yet been supported by Compuware's licensing
system. The cpwrProxy application acts as a TCP/IP relay between an unsupported
platform-based client and a license server running on a supported platform. Both the cpwrProxy
and the license server, cpwr, must be run on a supported platform. The cpwrProxy application
is a self-installing service that acts as a relay between a licensed client application (on an
unsupported platform) and the license server.
If cpwrProxy32 is run on a system that currently supports a license server, the port number
chosen for cpwrProxy32 must be different from the port number used by the license server.
Syntax
cpwrProxy32
[[-port port][-install[-start]|-remove]|[-stop]]
| [-port?] | [-h] | [-status]
-install
install as a service
-port
specify a port number to listen on
-start
start in the foreground or as a service
-remove
remove the service
-stop
stop the service if it has been installed
Distributed License Management User Guide
113
Appendix B ∙ Licensing Support for Unsupported Platforms
-port?
get current port number
-help
help
-status
status
-about
about
114
Distributed License Management User Guide
APPENDIX C
Troubleshooting
Error Messages
Code
-1
Symptom
The application that was
requested is not licensed.
Cause
Resolution
This error indicates that the
license file does not contain
a license for the product /
component / feature you
are attempting to use.
If you have licensed this
feature, verify that the
license has been received
and set up.
Verify that the hostid
identified by the license
key matches the hostid of
the machine. The hostid is
located under the
<Hostid> or <hostid> tag
of the license key.
Contact Compuware to
purchase a license allowing
you to use this feature.
-2
-3
A low memory condition
exists and some requested
resources could not be
allocated.
The requested application
version is newer than the
version currently
authorized.
Distributed License Management User Guide
Check resources and verify.
If needed, free some space
and try again.
If resources check out fine,
record steps to reproduce
and contact Compuware
support.
Your license does not
support the version of the
application you are
attempting to run.
Make sure that the
application version
identified in the license key
is greater than or equal to
the version of the product
you are attempting to run.
115
Appendix C ∙ Troubleshooting
Code
Symptom
Cause
Resolution
If the problem persists,
please contact Compuware
support.
-4
An unknown internal error
occurred.
Record steps to recreate
this issue and contact
Compuware support for
assistance.
-5
The license period for the
requested application has
expired.
Contact Compuware to
obtain a new license.
-6
The System ID that was
The application is being
authorized for the requested run on a machine that has
application does not match. not been authorized.
Verify that the machine on
which the application is
running is the correct
machine (i.e., the hostid
matches the hostid
identified under the key in
the license file).
If it is, then contact
Compuware to obtain a
new license with the correct
System ID.
-7
The provided license file
does not exist.
Check to see if the file has
been renamed. If so, open
the DLM application and
delete the old license file
name and add the new
license file name.
If a concurrent license,
contact your network
administrator for
assistance.
-8
116
This client has not been
configured for licensing.
Distributed License Management User Guide
The client configuration
file has not been created.
Run the DLM application.
This will create the client
configuration file. From
within DLM's Local
Environment tab, select
the Add button and
perform one of the
following:
•
browse to the location
of a valid license file.
•
enter the port@host
definition of a running
Appendix C ∙ Troubleshooting
Code
Symptom
Cause
Resolution
Compuware License
Service
•
enter the fully
qualified path to a
valid license file.
If the problem persists,
record steps to reproduce
and contact Compuware
support.
-9
The licensed number of
concurrent users has been
reached; try again later.
The number of users using
the application exceeds the
number of users licensed to
use the application.
Have one or more users log
out of the application.
If this occurs frequently,
contact your sales
representative and purchase
a larger capacity license
key.
If the number of counted
users does not match the
number of actual users
contact Compuware
support.
-10
A connection could not be
established between this
client and the Distributed
License Management.
This error is usually caused Ensure that the Compuware
by one of the following
License Service is running.
reasons:
Shutdown and restart
•
Compuware License Compuware License
Service has not been Service.
started yet
Verify that you are using
the correct License
•
the wrong server
definition, port@host, Environment value.
is being used
•
-11
The version of the license
client does not match the
version of the Compuware
License Service.
the port or hostname
has been specified
incorrectly
If the problem persists,
contact Compuware
support.
Ensure that the client is at
the same version level as
the Compuware License
Service version.
Contact Compuware
support.
Distributed License Management User Guide
117
Appendix C ∙ Troubleshooting
Code
Symptom
-12
The connection between
the client and Compuware
License Service has timed
out.
-13
The connection between
the client and Compuware
License Service was
prematurely closed.
Cause
Resolution
This error occurs when the Ensure that Distributed
timeout period allotted for License Management is
a connection has expired. still running.
This results from one of
these conditions:
•
Compuware License
Service is down
•
the hostname of
Compuware License
Service has been
changed and is not
reflected by the
port@host definition
in the license path
•
the LAN or WAN is
not fast enough
This error could occur due
to Compuware License
Service being brought
down between a
client/server connection or
the connection between
Compuware License
Service and the client was
broken.
Increase the client timeout
value from within the DLM
application; see DLM
documentation.
Coordinate the timeout
value of the client with the
timeout value on the
Compuware License
Service; see documentation
or contact your systems
administrator.
Verify that connectivity
still exists between
Compuware License
Service and the client.
Verify that Compuware
License Service is running
on the license server.
Verify that hostname or IP
address identified in the
license path on the client
matches the one on the
server.
If you are referencing the
hostname in the license
path try using the IP
address.
If this continues to occur
frequently or sporadically,
contact Compuware
support.
118
-14
The digital signature for the Internal systems error.
data sent or the data
received was invalid and/or
garbled.
Record steps to reproduce
the error and contact
Compuware support.
-15
Could not read socket
stream.
Record steps to reproduce
the error and contact
Compuware support.
Distributed License Management User Guide
Internal systems error.
Appendix C ∙ Troubleshooting
Code
-16
Symptom
Cause
Resolution
The application that you
The application that you
Wait until the transaction
have requested has already have requested has already expires to request another
been borrowed.
been borrowed.
license or return the license
before trying to borrow it
again.
If you do not have a license
borrowed, contact
Compuware support.
-17
The administrator has
excluded this system,
restricting it from using the
requested application.
The license administrator
will need to remove your
system ID or LAN ID from
the user_management
exclude parameter in the
server configuration file.
Check documentation on
user management.
-18
The administrator has
excluded this user account,
restricting it from using the
requested application.
The license administrator
will need to remove your
user account from the
user_management
parameter in the server
configuration file, if the
<everyone> tag has been
set.
The license administrator
will need to add your user
account to the
user_management
parameter in the server
configuration file.
Important Note:
The license administrator
MUST set up the
user_management
information if a license has
the <Umanage> tag.
-19
Under the current set of
Grace is not available for
conditions, in the active
the product that you are
license environment, grace attempting to use.
is not authorized.
Verify that the feature you
are attempting to use is not
licensed for a single user.
Verify that connectivity
exists between the license
server and the client.
Reconnect to the LAN or
WAN that the Compuware
Distributed License Management User Guide
119
Appendix C ∙ Troubleshooting
Code
Symptom
Cause
Resolution
License Service is on and
try launching the product
again.
-20
An uncounted license can
not be used concurrently.
A license was added to the Remove the uncounted
license server that is not a license from the
concurrent license.
Compuware License
Service environment.
Install the license on the
machine that has a
matching hostid.
-21
-22
The grace period has
expired or was never
activated for this system.
The maximum number of
registered users has been
reached; no more users
may be registered at this
time.
A connection could not be
established with the
Compuware License
Service, and the grace
period (3 days from the last
product usage ) has
expired.
Re-establish connectivity
with Compuware License
Service.
The number of registered
users in the Compuware
Options File has exceeded
the number of allowed
users.
Remove one or more users
from the registration file on
the Compuware License
Service (
If Compuware License
Service can not be
recovered, contact
Compuware support for a
new license file.
drive:\program
files\common
files\Compuware\config\Usrs
).
Restart the Compuware
License Service.
If this is a frequent
problem, you may want to
purchase a license key with
a higher user capacity,
contact Compuware
support.
120
-23
The start date of the
requested application
precludes the authorized
start date identified in the
corresponding key.
This is a pre-license
agreement error.
-24
The authorized session
limit for this user and the
requested application has
been reached.
The user has exceeded the If you frequently exceed
session limit specified in
the limit you may want to
the license file. Some
purchase a license key with
a higher capacity of
Distributed License Management User Guide
Wait until the start date has
been reached or contact
Compuware support.
Appendix C ∙ Troubleshooting
Code
Symptom
Cause
license keys limit the
number of instances of a
product that can be run
under one user account.
-25
The use of a concurrent
A Compuware License
user key as a node-locked, Service is required to
single-user, key is not
support this license.
allowed.
Resolution
sessions, contact
Compuware support.
Verify that the license is for
the current machine.
If the license is for the
current system remove it
from the license
environment and add it
again.
If the license is not for the
current system, install the
license on the system
identified by the hostids in
the license file.
If the license was generated
in error contact
Compuware support.
-26
The number of licenses
allotted to your assigned
pool has been exceeded,
contact your system's
administrator.
-27
The application that you are A pool id has not been
attempting to checkout
assigned to the end-user
requires a pool identifier, when one is required.
one has not been provided.
Contact your license
administrator to set up this
pool id.
-28
The number of licenses
All of the licenses allocated
allotted by your
for borrowing are used.
administrator for borrowing
has been reached.
Contact your license
administrator to request
more licenses for
borrowing.
-29
Invalid key signature,
contact Compuware
support.
Internal system error.
Contact Compuware
support.
-30
You have requested more
days than has been
authorized by your
administrator.
The amount of days
Contact your license
available to borrow a
administrator. This is
license has been exceeded. controlled within the
server's configuration file
via the DLM application.
Distributed License Management User Guide
The pool maximum set up Contact your license
in the server's configuration administrator.
file has been reached.
121
Appendix C ∙ Troubleshooting
Code
Symptom
Cause
Resolution
-31
You have requested more
than 365 days, which is the
maximum borrow limit.
-32
Borrow transaction error,
contact Compuware
support.
Internal system error.
Contact Compuware
support.
-33
A valid redundant feature
does not have a valid
redundant policy.
Internal system error.
Contact Compuware
support.
-34
One or more redundant
servers are not running;
you are below the failsafe
threshold.
-35
Redundant policy has not
yet been initialized.
Specify a length less than
365.
Start all of the redundant
servers.
This results from one of
these conditions:
•
•
Make sure that all of the
systems identified in the
All of the Compuware redundant key (see
documentation) have been
License Services on
the systems identified started.
by the redundant key Contact Compuware
have not been started. support.
A status was
performed on one of
the redundant license
servers. This is
expected and there is
no resolution.
-36
The redundancy failsafe
period has expired.
Contact your license
administrator.
-37
One or more features
This error indicates that a
within the association could feature was not available
not be checked out.
for check out due to none
available.
Use the Usage button from
within the DLM
application to see who is
using the application or its
subcomponents. Have one
or more users log off the
application or its
subcomponents.
If all of the features are not
available, or you frequently
have problems accessing
the products identified by
the association, you may
want to consider
122
Distributed License Management User Guide
Appendix C ∙ Troubleshooting
Code
Symptom
Cause
Resolution
purchasing a larger
capacity license key,
contact Compuware
support.
-38
You can not run this
application from within a
remote shell.
-39
License borrowing requires An attempt was made to
Start all redundant license
all redundant servers to be borrow a license without all servers.
running.
of the redundant servers
running. This is not
authorized.
-40
Redundancy is not
supported for this license
model.
-41
An unknown internal error
has occurred.
-42
The specified license
An attempt was made to
Contact Compuware
method is not supported on use an unsupported license support.
this platform.
method on this platform.
-43
An attempt was made to
use an un-licensed
concurrent key as a served
node-locked key.
-44
A previously translated 3.x A translated 3.x license has Contact Compuware
key has expired.
expired.
support.
-45
The date on the client is not The client machine's date
consistent with the date on is not consistent with the
the Compuware License
server.
Service; the key has
expired on the client.
-288888
Terminal Services is not
supported for this license
model or product.
Distributed License Management User Guide
An attempt was made to
run a node-locked license
from a remote session. This
is not authorized.
An attempt was made to
perform redundancy on a
license model that is not
supported.
Do not run
single-user/node-locked
licensed applications from
within a remote session.
If redundancy is needed,
please contact a
Compuware salesperson to
discuss.
Contact Compuware
support.
Contact Compuware
support.
Correct the client or server
date.
A user cannot terminal
Contact Compuware
service into a machine and product support.
use this product with the
current license model.
123
Appendix C ∙ Troubleshooting
Check Your Services List (XP)
The following only applies to Windows XP.
1.
2.
Choose Start ➤ Settings ➤ Control Panel.
If Windows XP is:
a. in Category View, click the Performance and Maintenance category, then click
Administrative Tools.
b. in Classic View, click Administrative Tools.
3.
Double click the Services icon to display the Services dialog box.
If you did not install a permanent license when the Compuware License Service was installed,
then the Compuware License Service was not installed.
Check Your Services List (NT and 2000)
The following only applies to Windows NT and 2000.
1.
2.
Choose Start ➤ Settings ➤ Control Panel.
Double-click the Services icon to display the Services dialog box.
If you did not install a permanent license when the Compuware License Service was installed,
then the Compuware License Service was not installed.
Fully Qualified Domain
If the client and the Compuware License Service are not on the same subdomain of the network,
you must use a Fully Qualified Domain (FQD) to identify the license source at
port@host.subdomain.domain.
Example
7166@sfa7119x.prodti.compuware.com
License Server Does Not Start
If the Compuware License Service does not start, perform any or all of the items below to resolve
the issue.
124
•
If the machine was not rebooted after installation, try rebooting.
•
The machine ID does not match the machine identification in the license file. If this is the
case, contact Compuware Worldwide License Management.
•
To start Compuware License Service, choose Start ➤ Programs ➤ Compuware ➤
Distributed License Management. If the Compuware License Service does not start, it
produces an exception error to assist in troubleshooting.
•
The license file(s) has been moved or is not located in the specified directory. You cannot
see a file if your folder settings are preventing you from doing so.
Distributed License Management User Guide
Appendix C ∙ Troubleshooting
To verify that your file settings allow you to view all files:
1.
Open Windows Explorer.
2.
3.
Choose View ➤ Options.The Options dialog box appears.
On the View tab, verify that the Show all files option is selected.
Customer Support Information
FrontLine Support Web Site
You can access information for Compuware products via our FrontLine support site. You can
review frequently asked questions, read or download documentation, access product fixes, or
e-mail your questions or comments. The first time you access FrontLine, you are required to
register and obtain a password. Registration is free. To access FrontLine, log in to
http://go.compuware.com. Select your product from the Product Support dropdown list.
You can also access product User Communities from http://go.compuware.com. After you log
in, select Customer Support User Groups and select your product line.
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 is
available at http://go.compuware.com.
Web
You can report issues via the Report and Track Calls tab on the FrontLine home page.
NOTE
Please report all high-priority issues by phone.
Mail
Customer Support
Compuware Corporation
One Campus Martius
Detroit, MI 48226-5099
Corporate Web Site
To access Compuware's site on the Web, go to http://www.compuware.com. The Compuware
site provides a variety of product and support information.
Distributed License Management User Guide
125
Appendix C ∙ Troubleshooting
126
Distributed License Management User Guide
APPENDIX D
GUI Reference
Adjust the Date and Time
Do not adjust the date and time on a client machine with a borrowed license. This renders the
license inoperable and you are not able to use the license until after the number of days you
established for the borrowing period has expired. If you need to adjust the date and time, first
return the license to the Borrow Proxy Server, change the date and time, and then re-borrow
the license.
TIP
Each time you start the Compuware product with a borrowed license, a message appears
displaying the number of days remaining on the borrowed license. You can also click Time
Remaining on the Borrow License Client to view the time remaining on the borrowed license.
Duration, in years, to store license usage data field
This field allows the license server administrator to specify how long to store the usage data
the license server collects (which is then used to create usage reports). The default, and minimum
value, is one year.
Broadcast Attributes Field
Allows you to change how your system information is broadcast to Distributed License
Management (i.e., uppercase or lowercase). Possible values are:
Upper Case
Causes the client system to broadcast its host and user name in uppercase letters when
requesting a license from DLM.
Lower Case
Causes the client system to broadcast its host and user name in lowercase letters when
requesting a license from DLM.
Distributed License Management User Guide
127
Appendix D ∙ GUI Reference
Mixed Case
Causes no changes to be made to the client’s host and user name during a license request
to DLM.
Configuration environment field
The user can use this dialog to enable and change the configuration environment.
This will allow you the ability to create two client configuration environments:
System
This is the default. This can be used by all users and processes on the machine.
User
This is specific for the specified user.
When both the System and User configuration environments are on the machine, the user’s
environment is used exclusively. So, this activation must be handled with care. The
Configuration environment field is only needed if the System Administrator or a Compuware
representative has informed you to revise its settings.
Once the changes have been made, click the OK button to enable your modifications.
Connection timeout in seconds for client field
Allows you to specify an amount of time, in seconds, after which the connection will time out
if not responded to by Distributed License Management.
Connection timeout in seconds for server field
Allows you to specify an amount of time, in seconds, after which Distributed License
Management will time out.
Create new log when server starts field
Allows the license administrator the ability to create a new log on each start up. If a new log
is required, select Yes from the combo box. This will erase the existing log and create a new
log on the next start up.
128
Distributed License Management User Guide
Appendix D ∙ GUI Reference
Create usage report field
The Create usage report field on the Advanced Configuration tab launches the Create Usage
Report dialog box, which is used to create a usage report. For more information, see Peak Usage
Reporting [p. 53].
Enable Email Notification field
DLM now provides a user interface to manage the configuration of the email notification feature.
Using the DLM Application's Advanced Configuration tab, the user can send license related
email messages to one or more user-defined administrators. The notifications supported include
product directed notifications, license request denials, security warnings, license service
Distributed License Management User Guide
129
Appendix D ∙ GUI Reference
terminations, license service re-starts, abnormal license service terminations and expiration
notifications.
Enabling email notification
From the DLM Application's Advanced Configuration tab, the user can select (highlight)
Enable email notification, and a small button containing an ellipsis will appear in the right-hand
corner of the row. Click the ellipsis button and the dialog box below is displayed.
If email notification is currently not activated, then the page will be deactivated except for the
Enable email notification checkbox. Once the user checks this box, then the rest of the page
is activated, enabling the user to define how the email notification will function. Below is a
screen shot showing everything activated and enabled.
130
Distributed License Management User Guide
Appendix D ∙ GUI Reference
The Email Notification dialog box has check boxes for the various types of message alerts that
can be sent. When the Notify administrator(s) when application will expire … alert is
selected, this will enable the edit box so the user can specify the number of days from which to
be notified.
When the Notify administrator(s) when application will expire … check box is selected, an
email is sent to all email addresses listed in the Recipient(s) box whenever the number of users
is above the normal license count.
For the Notify administrator(s) of failed license requests option, there are two sub-options
available. Only one of these can be selected at a time and the appropriate list will be displayed.
If the user wants to change the list to the other option, when the change occurs, the user will
be asked to verify that they want the previous entries deleted.
Keep:
This specifies the individual, host or application for which the user wants to be notified
when a failed license request is encountered.
Discard:
This specifies the individual, host or application for which the user will not be sent an
email when a failed license request is encountered.
Distributed License Management User Guide
131
Appendix D ∙ GUI Reference
Finally, when the Limit the number of times to send the same failed email notification is
selected, the edit box is enabled, allowing the user to specify a number. If no frequency is
specified, the email recipient will receive all failed license request messages.
The SMTP Server provides the user the ability to specify which SMTP server to use for routing
their email notifications.
The Recipient section provides the user the ability to add and remove email addresses which
will receive the email notifications.
The Subject section provides the user the ability to have a general email message for all email
notifications. If nothing is specified, then the license service will use pre-determined messages
based on the subject matter.
The Keep, Discard, SMTP Server and Recipient sections will each have a Most Recently
Used (MRU) list, so the user specifying the information can be allowed to select previously
written data.
Below are the three Add dialog boxes for the Keep, Discard and Recipient sections:
Once changes have been made, click OK to enable your modifications.
132
Distributed License Management User Guide
Appendix D ∙ GUI Reference
Expiration warning at startup field
If this option requires changing, click the ellipsis button to the right to display the below dialog.
Once the changes have been made, click the OK button to enable your modifications.
License Proxy field
Provides the ability to administer the Compuware License Proxy on a client machine. The
Compuware product you purchased will inform you if you need to start this Proxy. If this is
needed, click the ellipsis button and the below dialog box will appear.
Maximum log size in bytes field
Provides the license administrator the ability to place a size limitation on the log file. If nothing
is specified or the value is 0, then there is no limitation on the size.
Maximum threads field
On Windows only, handler threads are spawned to handle each license request. The number
and frequency at which threads are launched to handle client requests is dependent on the
Compuware License Service's work load. Under certain conditions, namely network security,
license administrators may choose to limit the number of threads that can be launched by the
Compuware License Service at any given time.
Modify location of server files field
The Distributed License Management license service enables an end-user to specify an alternate
location for the server files that need write permissions, and to move the server files to that
alternate location. The license service has log files, configuration files, cache files and temporary
files that need to be written to while the service is running. When the end-user activates this
Distributed License Management User Guide
133
Appendix D ∙ GUI Reference
functionality, these files will be redirected to a specified location. During this activation, it will
be imperative that DLM copy any existing files from the current location to the new location,
in order to retain all records of checked out licenses.
Both the DLM application and the DLM command-line tool provide a user interface for setting
up this functionality. When the user activates this functionality through one of the two user
interfaces, DLM will write a file to the current directory registering the new location of the
server files. Then, if the license service finds this file, it will read the location and write any
data there; otherwise, it will write the data to the default location.
When the user goes to the Advanced Configuration tab for the first time, the default location
of the server files will be filled in (as shown above). If the user wants to change the location,
they will select Modify location of server files and click the ellipsis button to the right. This
will bring up a dialog box allowing them to navigate to the directory of choice. This dialog box
enables the user to select folders only, not individual files. Once the location is selected, click
OK and this will be the new location of the server files. The user must re-start the license
service before the changes take effect.
The command-line utility (dlmcv.exe) will also enable the Unix end-user to modify the location
of the server files. In the License Service Command List, there is an option called Server
file location. When selected, this will display the current location of the server files and
enable the user to set this to an alternate location. Once the user has set this to a different
location, the license service must be re-started.
During the activation and de-activation of this functionality, it is necessary to copy any existing
files to the new location so DLM can continue to monitor license usage consistently.
134
Distributed License Management User Guide
Appendix D ∙ GUI Reference
Network security field
Allows the license administrator the ability to place additional security on Distributed License
Management. If this functionality is desired, click the ellipsis button to the right and the window
below will be displayed.
Below describes the three possibilities within this window:
Prevent communications
This will prevent communications from a client/source after a specified amount of failed
transmissions. The default value is 3.
Provide authorization to communicate to server
If you know which systems will be communicating to Distributed License Management,
you can select this option and identify those IP address in a text file. Click the Identify...
button to add the IP addresses.
No additional network security
This is the default value.
Pool ID field
Provides the ability to identify the pool with which the client belongs. This should only be used
if virtual pool identifications have been created by the license administrator.
Pools field
Provides the license administrator the ability to separate features into virtual pools. Once a pool
has been defined, all clients referencing that license server must have a pool ID.
1.
Click the ellipsis button to the right and the dialog box below will display.
Distributed License Management User Guide
135
Appendix D ∙ GUI Reference
2.
Add or edit a pool identifier.
•
To add a pool identifier to a particular feature, select the feature and click the Add
button.
This will provide you the ability to add a Pool ID as well as the number of licenses
associated with this identifier.
•
To modify the number of licenses associated with an existing pool identifier, click the
Edit button and you will be able to change the count
Port number field
This provides the ability to modify the port number of Distributed License Management. You
will need to stop DLM before changing the port number, which can be done from the dialog
box after clicking the ellipsis button.
User manage field
This functionality will only be available for license features which have the <Umanage> tag in
its license file. Click the ellipsis button to display the User Manage dialog box.
136
Distributed License Management User Guide
Appendix D ∙ GUI Reference
1.
Add or remove a user definition.
•
To add a user definition, select the feature to which you want to add a user and click
the Add button.
If the keyword “everyone” is added, this provides access to everyone. However, if
“everyone” is present, the users specified in the list will not have access.
•
2.
To remove a user from the list, select the user and click the Remove button.
Once the changes have been made, click the OK button to implement them.
Distributed License Management User Guide
137
Appendix D ∙ GUI Reference
138
Distributed License Management User Guide
Glossary
Glossary
alias
See Host Name.
borrow-enabled
Borrow-enabled is a type of concurrent license model that allows a user to borrow a feature or
product up to a specified amount of days.
Compulock
See Trial License.
concurrent license
This type of license model allows the product to run on more than one workstation so that
multiple users can access the product. When all available license are checked out, no additional
users can run the product until a license is checked back in. Permanent and temporary licenses
are types of concurrent licenses. Concurrent license is also known as a floating or network
license.
demo license
See Trial License.
DNS
Domain Name System. A database system that translates an IP address into a domain name.
dynamic update of the user file
The dynamic update of the user file is a type of concurrent license model that restricts the number
of users that can use a licensed feature to a pre-defined number.
floating license
See Concurrent License.
Distributed License Management User Guide
139
Glossary
Host ID
The machine identification number of a host. For Windows PCs, this would be the Ethernet
address of the network interface card or MAC address.
Host Name
A unique name that identifies a computer on a network. A single computer can have several
host names, also called aliases.
license server
The dedicated machine where the Compuware License Service is installed.
network license
See Concurrent License.
NIS
Network Information Service. A client-server protocol for keeping track of user and host names
on a network.
node-locked license
This type of license model allows the product to run on a single, specified workstation (node).
The product cannot be used on any other workstation. Permanent, temporary, and trial licenses
are types of node-locked licenses.
permanent license
This type of license gives you access to the product under the terms of your contract with
Compuware. Compuware offers two types of permanent licenses: node-locked and concurrent.
redundant license server
A redundant server license is a type of concurrent license model that provides limited protection
against license server failure by dispersing the responsibility of managing client licenses over
three independent servers.
server
On a local area network (LAN), a computer running administrative software that controls access
to the network and its resources. In this case, the product licenses and provides resources to
computers functioning as workstations (client machines) on the network.
single-user license
See Node-locked License.
temporary license
A temporary license has a fixed expiration date from the time it is installed on your system.
You must request this license from Compuware's Technical Support.
Terminal Services
Terminal Services provide functionality similar to a terminal-based, centralized host, or
mainframe environment in which multiple terminals connect to a host computer. Each terminal
provides a conduit for input and output between a user and the host computer.
140
Distributed License Management User Guide
Glossary
trial license
This type of licensing is installed when you install your Compuware product and it allows you
to run the product for a specific time period (typically 14-45 days from the day you install the
product).
Distributed License Management User Guide
141
Glossary
142
Distributed License Management User Guide
Index
Index
A
ActiveSync 83
adding licenses/paths 40, 43
B
Borrow License Client Tab 40, 89
Borrow License Server Tab 37, 90
borrow policy settings 92
borrowing
89, 91–92
adjusting date and time 91
borrow a license 91
return a license 92
broadcast attributes 127
C
clear the Log 50
Command Line Options 81
Compuware's Worldwide License Management 13
cpwrProxy32 113
Customer Support
10, 125
contact information 10, 125
online support site 10, 125
DLM (continued)
Welcome to the DLM Application 33
DLM Web Interface
97–104, 106–108
Feature Details Tab 99
launching 103
License File (Import) Tab 101, 106
License File (View/Edit) Tab 100
Log File Tab 100
logging in 102
number of records displayed, change 108
password, change 104
reset login 104
Server Status Tab 98
user interface 97
Welcome to the DLM Web Interface 97
DLMCV
61, 81
DLMCV Command Line Options 81
E
environment 35–36, 42, 44, 46
error 115
error messages
102
DLM Web Interface 102
D
F
Distributed License Management
13, 45–46
start 45
stop 46
DLM
13, 33, 35, 37, 40, 42, 44, 89–90
Borrow License Client Tab 40, 89
Borrow License Server Tab 37, 90
Local Environment Tab 35, 42, 44
user interface 33
Welcome to DLM 13
Feature Details Tab 99
filtering
49, 100
DLM application 49
DLM Web Interface 100
flushing the log file
50, 107
DLM application 50
DLM Web Interface 107
Fully Qualified Domain FQD) 40, 43, 124
Distributed License Management User Guide
143
Index
G
getting started 13
Group file 92
H
help
10, 115
error messages 115
Host information
13–14
UNIX 14
windows 14
log file (continued)
filtering (continued)
DLM Web Interface 107
flushing
50, 107
DLM 50
DLM Web Interface 107
View Log 49
viewing 48
Log File Tab 100, 107
M
mobile 83
L
R
license
records, change number displayed 108
Redundancy 111
Reorder 41
return a license 92
13–14, 35, 40–46, 89, 92, 100–101, 106
adding 40, 43
borrowing 89, 92
editing
100
DLM Web Interface 100
environment 35, 42, 44
host information
13–14
UNIX 14
windows 14
import 101, 106
removing 41, 44
reordering the list 41
requesting 13
returning 92
server
45–46
starting 45
stopping 46
License Borrowing 89, 92
License File Tabs
100–101, 106
Import 101, 106
View/Edit 100
License Service 40, 43
License Source/path
40–41, 43–44
source/path 40, 43
License sources/path 35, 42, 44
LicenseSync 83
licensing support 113
Local Environment Tab 35, 40–44
log file
48–50, 107–108
filtering
49, 107
DLM 49
144
Distributed License Management User Guide
S
server
45, 124
starting 45, 124
Server Does Not Start 124
Server Status Tab 98
services list
124
Windows 2000 124
Windows NT 124
Windows XP 124
show licenses
105
checked out 105
that expire 105
support 10
T
Technical Support 10
troubleshooting 102, 124
U
Umanage 102
UNIX 61
User Manage Tab 102
W
Web 97
Windows CE 83