Sentinel EMS v7.1

User's Guide

ii

Sentinel EMS User's Guide

Document Revision History Part Number 007-011113-001, Revision F. Software versions 7.1 and later.

Revision

Action/Change

Date

A

Initial release - 2.1.

December 2011

B

Updated for release 2.2.

May 2012

C

Updated for release 6.3.

September 2012

D

Updated for release 6.4.

March 2013

E

Updated for release 7.0.

August 2013

F

Updated for release 7.1.

March 2014.

Disclaimer and Copyrights Copyright © 2014, SafeNet, Inc. All rights reserved. http://www.safenet-inc.com/ We have attempted to make this document complete, accurate, and useful, but we cannot guarantee it to be perfect. When we discover errors or omissions, or they are brought to our attention, we endeavor to correct them in succeeding releases of the product. SafeNet, Inc., is not responsible for any direct or indirect damages or loss of business resulting from inaccuracies or omissions contained herein. The specifications contained in this document are subject to change without notice. SafeNet®, Sentinel®, and EMS™ are registered and/or unregistered trademarks of SafeNet, Inc., in the United States and other countries. All other trademarks referenced herein are registered and/or unregistered trademarks of their respective owners.

Contents Preface Chapter 1: Introduction 1.1. Getting Started 1.1.1. Prerequisites for the Sentinel LDK Administrator 1.2. Logging on to the Sentinel EMS Portal 1.2.1. Forgot Password? 1.2.2. Changing Password 1.3. Navigating the Portal 1.3.1. The Home Page

Chapter 2: Administration Tasks 2.1. Managing Users 2.1.1. Filtering and Searching the Users List 2.1.2. Viewing the Details of a User 2.1.3. Tasks for Managing Users 2.1.4. Creating a User 2.1.5. Modifying User Details 2.1.6. Deleting a User 2.1.7. User Roles and Authorized Functions 2.2. Maintaining Master Keys 2.2.1. Tasks for Sentinel Master Keys 2.2.2. Editing Mail Notification 2.2.3. Renewing Your Sentinel LDK License 2.3. Configuring Sentinel EMS Properties Using Administration Console 2.4. Managing Custom Reports 2.4.1. Creating/Updating a Custom Report 2.4.2. Enabling/Disabling a Custom Report 2.4.3. Deleting a Custom Report 2.4.4. Running a Custom Report

Chapter 3: Product Management 3.1. Definitions of Features, Products, and License Models 3.1.1. Features 3.1.2. Products 3.1.3. License Models 3.2. Managing Features

vii 1 2 2 3 3 3 3 5

7 7 7 8 8 8 9 10 10 11 13 14 14 15 15 15 16 16 17

19 19 19 19 20 21

iv

Sentinel EMS User's Guide

3.2.1. Filtering and Searching the Features List 3.2.2. Viewing the Details of a Feature 3.2.3. Tasks for Managing Features 3.2.4. Creating a Feature 3.2.5. Updating Feature Details 3.2.6. Deleting a Feature 3.2.7. Obsolete/Restore a Feature 3.3. Managing Products 3.3.1. Filtering and Searching the Products List 3.3.2. Viewing the Details of a Product 3.3.3. Tasks for Managing Products 3.3.4. Creating a Product 3.3.5. Updating Product Details 3.3.6. Deleting a Product 3.3.7. Associating Features with a Product 3.3.8. Duplicating a Product 3.3.9. Defining a Modification Product 3.3.10. Defining a Provisional Product 3.3.11. Defining Product Cancellation 3.3.12. Changing Product Status 3.3.13. Protection Against Cloning 3.4. Defining License Terms 3.4.1. Working with Detachable Licenses 3.5. Defining Memory Data

Chapter 4: Managing Entitlements 4.1. Filtering and Searching the Entitlements List 4.2. Viewing the Details of an Entitlement 4.3. Tasks for Managing Entitlements 4.4. Creating an Entitlement 4.4.1. Adding Products to an Entitlement 4.4.2. Define Entitlement Type and Other Details 4.4.3. Editing Memory Data during Entitlement Generation 4.4.4. Save as Draft, Queue, or Produce an Entitlement 4.5. Updating Entitlement Details 4.6. Producing Entitlements 4.6.1. Producing Product Keys for the Entitlement 4.6.2. Producing Sentinel HL Keys for the Entitlement 4.6.3. Producing Protection Key Update File for an Entitlement 4.7. Deleting an Entitlement 4.8. Changing the Entitlement Status 4.8.1. Modifying Draft Entitlements 4.8.2. Modifying Queued Entitlements (Reopening)

21 21 21 22 23 23 23 24 24 24 24 25 29 29 29 30 30 34 37 38 39 39 42 45

49 49 50 50 51 53 53 57 58 59 60 60 61 61 63 63 63 64

v

4.9. Checking in C2V File 4.9.1. To Check in C2V Data 4.9.2. Removing/Applying Pending Updates 4.9.3. Formatting a Sentinel Protection Key 4.9.4. Enabling Licenses that have been Disabled due to Clone Detection 4.10. Checking in Key Data 4.10.1. Removing/Applying Pending Updates 4.11. Recycling Keys

Chapter 5: Managing Product Keys 5.1. Filtering and Searching the Product Keys List 5.2. Viewing the Details of a Product Key 5.3. Tasks for Managing Product Keys 5.4. Modifying Product Key Details 5.4.1. Enabling or Disabling a Product Key 5.4.2. Increasing/Decreasing the Number of Activations for a Product Key 5.5. Generating a V2C File to Manually Activate a Product 5.6. Viewing Previous Activations for a Product Key 5.7. Activation by End User

Chapter 6: Development 6.1. Generating a Bundle of Provisional Products 6.2. Exporting a List of Definitions 6.3. Branding the Remote Update System 6.4. Generating the RTE Installer 6.4.1. Signing the RTE Installer

Chapter 7: Managing Customers and Channel Partners 7.1. Managing Customers 7.1.1. Filtering and Searching the Customers List 7.1.2. Viewing the Details of a Customer 7.1.3. Tasks for Managing Customers 7.1.4. Tasks for Managing Contacts (for Company-type Customers) 7.1.5. Creating a Customer 7.1.6. Updating Details of a Customer 7.1.7. Deleting a Customer 7.1.8. Enabling/Disabling a Customer 7.1.9. Creating/Updating a Contact for a Company-type Customer 7.2. Managing Channel Partners 7.2.1. Filtering and Searching the Channel Partners List 7.2.2. Viewing the Details of a Channel Partner

64 65 65 66 67 68 69 69

71 71 71 71 72 72 72 72 74 75

77 77 78 79 80 81

83 83 84 84 84 84 85 86 86 86 87 87 88 88

vi

Sentinel EMS User's Guide

7.2.3. Tasks for Managing Channel Partners 7.2.4. Tasks for Managing Contacts (for Company-type Channel Partners) 7.2.5. Creating a Channel Partner 7.2.6. Updating the Details of a Channel Partner 7.2.7. Deleting a Channel Partner 7.2.8. Enabling/Disabling a Channel Partner 7.2.9. Creating/Updating a Contact for a Company-type Channel Partner

Chapter 8: Working with Reports 8.1. Available Reports 8.2. Generating a Report 8.3. Managing Scheduled Reports 8.3.1. Tasks for Managing Scheduled Reports 8.3.2. Scheduling a Report 8.3.3. Defining Recipients for a Scheduled Report

Glossary Index

88 88 89 90 90 90 90

93 93 94 95 95 95 97

99 109

Preface Who Should Read This Document? This guide is meant for administrators and general users in your organization who are responsible for performing various Entitlement (or license) management and distribution tasks.

Conventions Used in This Document Convention

Description

Bold lettering

Denotes keystrokes, menu items, window names, and fields.

Consolas

Denotes syntax, prompts, and code examples.

Italic lettering

Denotes file names and directory names. Else, used for emphasis.

Documentation Resources Document

What's in it?

User's Guide (this document)

Provides details about the functionalities available in Sentinel EMS and demonstrates the steps to perform various tasks using the graphical interface.

Configuration Guide Provides information about customizing the Sentinel EMS server. Web Services Guide Details the web service resources available to facilitate integration of EMS data and transactions with external IT systems like CRM and ERP. Acknowledgments

Contains acknowledgments for the third-party software used.

Support Contacts You can contact us using any of the following options: n

n

n

Business Contacts - To find the nearest office or distributor, use the following URL: http://www.safenet-inc.com/contact-us/ Technical Support - To obtain assistance in using SafeNet products, feel free to contact our Technical Support team: o

Phone: 800-545-6608 (US toll free), +1-410-931-7520 (International)

o

E-mail: [email protected]

o

URL: http://sentinelcustomer.safenet-inc.com/sentinelsupport/

Downloads - You may want to explore updated installers and other components here: www.sentinelcustomer.safenet-inc.com/sentineldownloads/

viii

Sentinel EMS User's Guide

Documentation Feedback To help us improve future versions of the documentation, we want to know about any corrections, clarifications, or further information you would find useful. When you contact us, please include the following information: n

The title, part number (if applicable), and version of the document you are referring to

n

The version of the product you are using

n

Your name, company name, job title, phone number, and e-mail ID

Send us e-mail at: [email protected]

1 Chapter 1: Introduction Welcome to Sentinel® EMS™. Sentinel EMS is a powerful role-based application designed to manage the business activities required to implement and maintain Sentinel LDK in your organization. Sentinel EMS streamlines the major work flows in the licensing life cycle of a protected software application, from the moment it is developed, through its packaging, marketing, selling, and order taking, to its distribution and upgrading. Sentinel LDK separates the software protection process (implemented with Sentinel Licensing API or Sentinel LDK Envelope) from the licensing and production processes (implemented with Sentinel EMS), enabling you to modify your company’s licensing strategy as necessary when circumstances change, and to implement these changes quickly and efficiently. The primary component of Sentinel EMS is the EMS Web Server. Users in your organization can access the application from client machines in the network using a web browser. Sentinel EMS handles three major work flows: license planning, entitlement generation and production, and software activation. It also provides a centralized license management interface for your customers. n

n

n

License planning: Business decision-makers, such as Product or marketing managers in an organization, can define Products, business rules, license terms, and protection levels. The output of the license planning process is a repository of licensed products that are stored in the EMS database—ready for customer orders. Production: Staff in your organization’s orders department receive and fulfill orders from customers. Software activation and online updates: These are performed by means of EMS when the software is at the end user’s site.

Before you start to use Sentinel EMS in your organization, you may want to prepare a detailed licensing plan for use with Sentinel LDK. This plan could include the licensing requirements for all the protected software applications to be sold by your company and distributed for trial use. While it is recommended that you have some level of licensing plan for all your applications prior to implementing Sentinel EMS, it is not a prerequisite. You can make licensing decisions as you work with Sentinel EMS. You can also vary your licensing plan at any time. Preparing your licensing plan can include:

2

Chapter 1: Introduction

n

Defining your software licensing strategy

n

Analyzing your software products

n

Identifying the functional components of these products

n

Defining product models and licensing models

n

Specifying licensing and protection options

For detailed information on preparing a licensing plan for use with EMS, and on Sentinel LDK concepts, refer to the Licensing section of the Sentinel LDK Software Protection and Licensing Guide.

1.1. Getting Started Before you start to use Sentinel EMS, ensure that: n

n

You have a URL to access Sentinel EMS at your site. You have received a Sentinel LDK user name and password from your Sentinel LDK system administrator.

After you have logged in to Sentinel EMS, you can change the Sentinel LDK password that you received to a password of your own choice. For additional information on changing your password, see "Changing Password" on page 3. Sentinel LDK passwords are case-sensitive, so ensure that you use upper-case and lowercase letters correctly when you type your password.

1.1.1. Prerequisites for the Sentinel LDK Administrator If you are performing administration functions for Sentinel LDK in your organization, it is essential that you check the following requirements before you (or other users) start to use Sentinel EMS: 1. A valid connection to the Sentinel EMS Server must exist. For additional information on installing the Sentinel EMS Server, see the Sentinel LDK Installation Guide. 2. You must have a Sentinel Master key that contains your license for Sentinel LDK and your company’s specific Vendor Code. If not previously introduced, the Sentinel Master key is introduced during the Sentinel EMS Server installation process. 3. The Sentinel Master key must remain connected to the Sentinel EMS Server machine in order to enable you to perform Sentinel EMS functions. If the Sentinel EMS Server is installed on more than one server machine, each server must have a separate Sentinel Master key locally connected. If you are evaluating Sentinel EMS, you can use the DEMOMA Batch Code provided, which does not require a Sentinel Master key. 4. You must define user names, passwords, roles, and batch access for each Sentinel EMS user, and also for yourself. For additional information, see "Managing Users" on page 7.

1.2. Logging on to the Sentinel EMS Portal

3

A default user name is provided with Sentinel LDK to enable you to log on to Sentinel EMS as the Sentinel LDK Administrator. The default user name is admin.

1.2. Logging on to the Sentinel EMS Portal To log on to the Sentinel EMS portal, you need a Sentinel LDK user name and password provided by your Sentinel LDK administrator. To log on: 1. Use the URL http://:/ems in a web browser to access the Login page, where denotes domain name (or IP address or network address) and denotes the port number of the Sentinel EMS server . 2. Enter your User ID and Password and click Login. It is recommended that you change your password after you log on for the first time.

1.2.1. Forgot Password? 1. In the login page, click Forgot Password. 2. In the screen that appears, enter your E-mail and click Recover Password. Your password will be e-mailed to you.

1.2.2. Changing Password You can change the password that you use to log on to Sentinel EMS. If you are authorized to perform Administration functions, you can change the password for other users. For more information, see "Modifying User Details" on page 9. To change your own password: 1. Log on to the Sentinel EMS portal with your user ID and current password. 2. Point the mouse to the down arrow icon at the top-right corner of the page and click Change Password. The Change Password pop-up appears. 3. Type your current password and new password. Passwords are case sensitive and must have at least six characters. 4. Click Save.

1.3. Navigating the Portal The Sentinel EMS top-level screens typically include the following:

4

Chapter 1: Introduction

Main Menu and Sub Menus When you click any item on the main menu, the corresponding items are displayed on the submenu. The functions that each user sees on the main menu vary based on the roles that are assigned to the user. The following table lists the functionalities available in each item in the main menu.

Menu Item Entitlements

Customers Reports Catalog

Available Functionalities n

"The Home Page" on page 5

n

"Chapter 4: Managing Entitlements" on page 49

n

"Chapter 5: Managing Product Keys" on page 71

n

"Checking in C2V File" on page 64

n

"Checking in Key Data" on page 68

n

"Recycling Keys" on page 69

n

"Managing Customers" on page 83

n

"Managing Channel Partners" on page 87

n

"Chapter 8: Working with Reports" on page 93

n

"Managing Scheduled Reports" on page 95

n

"Managing Products" on page 24

1.3. Navigating the Portal

Menu Item

5

Available Functionalities

Administration

Developer

n

"Managing Features" on page 21

n

"Managing Users" on page 7

n

"Maintaining Master Keys" on page 11

n

"Managing Custom Reports" on page 15

n

"Branding the Remote Update System" on page 79

n

"Generating the RTE Installer" on page 80

n

"Generating a Bundle of Provisional Products" on page 77

n

"Exporting a List of Definitions" on page 78

Main Pane This pane displays a list of available items, to view and select.

Details Pane Select an item in the main pane to view its details in the details pane.

Search Option Using this option you can filter the items that are listed in the main pane.

Page Navigation Bar The page counter indicates the currently displayed page, and the total number of pages in the entire list. You can navigate to the first page ( ), previous page ( ), next page ( ), and last page ( ) using the arrows.

Edit (

) and Action Buttons (

)

Using these buttons you can perform various actions like create, update, delete. The actions available in the action button vary based on the roles that are assigned to the user.

Using Help Detailed instructions for using each function and task in Sentinel EMS are provided in the Sentinel EMS Help documentation. To access help on any page, click the Help link at the top right of the screen. Many individual screens also contain a help button for information about the contents of the screen.

1.3.1. The Home Page The home page provides dashboard-like view of the important Entitlement-related items. This page is available to users with following roles:

6

Chapter 1: Introduction

n

Super User

n

Batch Code Admin

n

Report Generation

The following information is presented in the home page. The data presented to the user is accumulated based on the Batch Codes for which the user is authorized. Entitlements Summary graph

Graphically presents the Entitlements generated by all users in the recent past. Click the Monthly, Weekly, or Daily tabs to view the respective graph. The Entitlements created in a month/week/day represent the corresponding node on the graph. Put the cursor over any node to view the number of Entitlements in that month/week/day. The Show All link takes you to the Customer Entitlement Report. Activations Summary graph

Graphically presents the total Activations in the recent past. Click the Monthly, Weekly, or Daily tabs to view the respective graph. The Activations done in a month/week/day represent the corresponding node on the graph. Put the cursor over any node to view the number of Activations in that month/week/day. The Show All link displays the Customer Activation Report. Top 5 Customers chart

Presents a bar chart for five Customers with the highest number of Entitlements during the last year, month, or week. Click the Last Year, Last Month, or Last Week tab to view the respective chart. All the Customers are represented with different colors and the corresponding number of Entitlements are listed in the lower part of the pane. License Expiring in Next 30 Days table

Presents a list of activations for which the licenses will expire in the next 30 days. The table shows only 5 entries that have the nearest dates. Click a header (for example, Customer, EID, ...) to sort the table by that column. The Show All link generates a report showing all the licenses expiring in the next 30 days. High Selling Products table

The table presents a list of Products for which the highest number of Entitlements are generated. Only the top 5 are listed in the table. Click a header (for example, Customer, EID, ...) to sort the table by that column. The Show All link generates a report showing the most popular products ordered.

2 Chapter 2: Administration Tasks This chapter is intended for users with administrator role. After installing Sentinel EMS, you first need to log on to the portal using the default user ID (admin). Thereafter, you can create more users and configure access rights for them. While creating a user, you need to specify a unique identifier, User ID, for him and provide a password. The user can change the password later. You can manage access rights by Roles. You need to associate Roles with users so that they can log on to the Sentinel EMS portal. The following topics are addressed in this chapter: n

"Managing Users" on page 7

n

"Maintaining Master Keys" on page 11

n

"Configuring Sentinel EMS Properties Using Administration Console" on page 15

n

"Managing Custom Reports" on page 15

2.1. Managing Users To reach the Users page, on the main menu click Administration. The left pane displays a list of all Users and provides the following information about each User: Status

Status of the user as follows: Enabled—The user can log on to Sentinel EMS. Disabled—The user is blocked from logging on to Sentinel EMS.

User ID

The unique name assigned to a user for logging on to the Sentinel EMS portal.

E-mail

E-mail of the User.

Ref ID 1

Information that identifies the user in a different system, for example, a user ID in your company's ERP system.

Expires On

The date after which the user ID expires.

2.1.1. Filtering and Searching the Users List

8

Chapter 2: Administration Tasks 1. Select an option from the search drop-down list from User ID, Roles, Ref ID 1, Ref ID 2, Batch Codes. 2. Enter the complete or partial search string in the field that follows. 3. Click

. The list shows the relevant search results.

2.1.2. Viewing the Details of a User To view the details of a User, select a User from the left pane. The user details, associated Roles, and associated Batch Codes are displayed in the right pane.

2.1.3. Tasks for Managing Users New User (Edit)

Define a new User and assign roles. See "Creating a User" on page 8. View and edit the properties of the selected User. See "Modifying User Details" on page 9

(Action) > Delete Delete the selected User.

2.1.4. Creating a User The Create User screen enables you to define the properties of a new user. This page is available only for users who are authorized to perform Administration functions.

To define the properties of a user: 1. On the main menu, click Administration. The Users page appears. 2. Click New User. The Create User pop-up appears. 3. Specify a name for the user in the User ID field. This name will be used to log on to Sentinel EMS—it must be unique in the system. 4. In the E-mail field, enter an e-mail address for the user.

2.1. Managing Users

9

5. Enter the user's password in the Password field and re-enter it in the Confirm Password field. Users can change their own passwords later. You can also perform this task to change the passwords on behalf of users. 6. Select the appropriate radio button for Login Allowed. If you select No, the User will not be able to log on to the Sentinel EMS portal. 7. In the Expires On field, enter a date from which the User login will be disabled. Select Never to extend the date infinitely. 8. In the Locale drop-down list, select a default display language for the User. 9. Enter Ref ID 1 and Ref ID 2 if required. You can enter information that identifies the user in a different system, for example, a user ID in your company's ERP system. 10. In the Associated Roles pane, select the Roles you want to assign to the User. The User must be assigned at least one role. 11. In the Associated Batch Codes pane, select the Batch Codes on which you to want give permission to the User. A User must have permission on at least one Batch Code. 12. Click Save.

2.1.5. Modifying User Details The Edit User pop-up enables you to modify the properties of an existing user. This page is available only for users who are authorized to perform Administration functions. In this page you can modify data in all fields except User ID.

1. Select a User from the left pane. 2. Click

(Edit). The Edit User pop-up appears. You can modify the following in this screen: n

Change password for the User. To change the password, a. Click Change Password. b. Enter a new password for the user in the Password field and re-enter it in the Confirm Password field. The password will be changed after you click Save.

10

Chapter 2: Administration Tasks

n

E-mail—Change the e-mail for the user

n

Login Allowed—Allow/deny login for the user

n

Expires On—Edit the login expiry date

n

Locale—Update the default display language for the User

n

n

n

Ref ID 1 and Ref ID 2—Edit the reference IDs for the user. You can enter information that identifies the user in a different system, for example, a user ID in your company's ERP system. Modify Roles assigned to the user. At least one Role must be selected. Modify Batch Codes associated to the user. At least one Batch Code must be selected.

3. Click Save.

2.1.6. Deleting a User 1. Select a User from the left pane. 2. Click

(Action) > Delete.

3. In the pop-up that appears, click Yes.

2.1.7. User Roles and Authorized Functions The role assigned to each user determines the functions that the user is authorized to perform in Sentinel EMS. When a user logs on, Sentinel EMS displays only the relevant function groups available to the user, according to the user's assigned roles:

User Role

Description and Authorized Functions

Product Manager

The person, usually a product manager, who determines the product components to be protected (called Features in Sentinel EMS), how these components are used to define Products, and the license structure for the Products n Managing Features

Report Generation

n

Managing Products

n

Generating Reports

n

Managing Scheduled Reports

Entitlement Manager The person responsible for defining and managing Entitlements n Managing Customers (does not include Managing Activations) n

Managing Entitlements

Production

The person responsible for producing Entitlements n Producing Entitlements

Customer Services

The person responsible for performing manual Product activations n Managing Customers

2.2. Maintaining Master Keys

User Role

Description and Authorized Functions n

Development

Super User

Batch Code Admin

11

Managing Activation

The person, usually a software engineer, who protects the software using Sentinel LDK Envelope or the Sentinel Licensing API, and performs other development-related tasks, such as generating the Sentinel LDK Run-time Installer n Performing Development Tasks n

Operating Sentinel LDK ToolBox

n

Operating Sentinel LDK Envelope

Can perform all the tasks available in Sentinel LDK across Batch Codes. However, the primary responsibilities may include the following: n Managing Sentinel LDK users n

Maintaining Master Keys

n

Generating Reports

n

Managing Scheduled Reports

n

Managing Custom Reports

Can perform all the tasks available in Sentinel LDK in the Batch Codes assigned to him. However, the primary responsibilities may include the following: n Managing Sentinel LDK users n

Maintaining Master Keys

n

Generating Reports

n

Managing Scheduled Reports

n

Managing Custom Reports

2.2. Maintaining Master Keys Your Sentinel Master key contains the Sentinel LDK license that enables you to create licenses and lock them to the Sentinel protection keys that you send to your end users, to write specific data to the memory of a Sentinel protection key, and to update licenses already deployed in the field. The Master Keys function enables you to view the license status of each of your Sentinel Master keys in the selected batch. In addition, it enables you to introduce Master keys, renew your Sentinel licenses on the Master key, edit the properties of selected Batch Codes, and specify parameters for sending automatic e-mail reminders regarding Sentinel LDK license renewals. To reach the Master page, on the main menu click Administration > Master.

12

Chapter 2: Administration Tasks

The Master page displays a list of all Sentinel Master keys that are currently accessible on the network for the selected Batch Code. The following information is provided for each Master key. For details refer to Understanding the Sentinel LDK Master Key Licenses in the Sentinel LDK Software Protection and Licensing Guide. Key ID

The unique identity assigned to the Sentinel Master key.

Production Date when the Sentinel Master key was produced by SafeNet. Date Activation Module

Displays whether your Activation Module license is unlimited or issued for a limited time period. This depends on your purchase plan or subscription plan for Sentinel LDK. For more information, consult with your SafeNet sales representative. An Activation Module license is required to enable the software activation functionality of Sentinel LDK. You do not require an Activation Module license if you do not intend to create activation files for Sentinel SL keys or Product key based activations for Sentinel HL keys.

Standalone Displays the number of Standalone Licenses available. Licenses Each time a Product Key for your software is submitted by an end user, their Provisional license for your software is converted to a locked, machine-specific license, and one Standalone License is consumed. To use this functionality, you may need to purchase a pool of Standalone Licenses. (This depends on the nature of your purchase plan or subscription plan for Sentinel LDK.) Network Seats

Displays the number of Network Seats available. Each time a customer activates your software, the number of concurrent instances that you included in the Product is deducted from the network seats on your Master key. Network seats are required to enable users to run your software concurrently in a network environment. When you create an Entitlement for your customer: For each Feature in the Product, you specify whether concurrency is enabled for that Feature, and the number of instances (network seats) that are supported. To enable concurrency for Features, you may need to purchase network seats for

2.2. Maintaining Master Keys

13

your Master key (if required by your purchase plan or subscription plan). Cost of Unlimited Seats

If you specify the concurrency value for a license as “unlimited,” Sentinel LDK deducts from your seat pool the number of seats specified in the Unlimited Concurrency license type (also referred to as Cost of Unlimited Seats) on your Sentinel Master key. This is typically 100 seats.

Reporting Module License

Displays the number of days for which this module is available. The Reporting facility includes both predefined reports and the Custom Reports. Use of predefined reports does not require a specific license. However, use of the Custom Reports facility requires the Reporting Module license. This license is typically issued for a specific amount of time. The ability to define, generate and view custom reports is included in the Sentinel License Development Kit – Demo and Starter. Vendors who are experimenting with Sentinel LDK can learn first-hand about the Custom Reports facility.

Trialware Module

Displays the number of days for which this module is available. This module enables you to create and distribute Provisional Products (trialware). You must purchase the Trialware Module license separately from SafeNet in order to create Provisional Products.

Unlocked License Module

Displays whether this module is available. To generate Unlocked licenses, you must purchase the Unlocked License Module for the Master key. A protected application with an Unlocked license can be installed and operated on any computer and it has no time restriction.

See "Renewing Your Sentinel LDK License" on page 14 for detailed instructions on how to renew your Sentinel LDK license.

2.2.1. Tasks for Sentinel Master Keys Before performing any of the following tasks, you need to specify the Batch Code for the Master Key that you want to view and/or manage. In the Master page, select the required Batch Code from the Batch Code drop-down list. The available Master Keys for the Batch Code are displayed. You can perform the following tasks in the Master page: Collect Information Generate a Customer-to-Vendor (C2V) file to request updated data (such as a license renewal) for your Sentinel Master key. Update Master

Apply the Vendor-to-Customer (V2C) file to update the license for your Sentinel Master key.

E-mail Notification Set the parameters for sending automatic e-mail reminders to renew the Sentinel LDK license prior to its expiration. See "Editing Mail Notification" on page 14. Refresh

Refreshes the list of Sentinel Master keys.

14

Chapter 2: Administration Tasks

2.2.2. Editing Mail Notification Sentinel EMS can be configured to send automatic e-mail reminders to renew your Sentinel LDK license prior to its expiration. You can specify the e-mail recipients to whom you want the reminder to be sent. Each e-mail recipient can be specified as: n

A Sentinel LDK user for whom a valid e-mail address has already been defined.

n

Any valid e-mail address.

To specify recipients for e-mail notifications: 1. On the main menu, click Administration > Master. 2. Select the Batch Code in which you want to specify e-mail notification properties. 3. Click Actions > E-mail Notification. The E-mail Notification Properties for [Batch Code] popup appears. 4. To add a Sentinel LDK user as a recipient: a. Click Add User. b. Select one or more users to receive notifications. (Only users for whom an e-mail address was defined are listed.) c. Click Submit. Each selected user is added to the list in the E-mail Notification Properties pop-up. 5. To add the e-mail address for any other recipient: a. Click Add E-mail. The Add Recipient pop-up appears. b. Enter a recipient name and e-mail address. c. Click Submit. The recipient is added to the list in the E-mail Notification Properties pop-up. Repeat these steps for each recipient that you want to add to the list. 6. To remove any recipient from the list, click the row to select the recipient and then click Actions > Remove. 7. Select the executions threshold below which you want to be notified that the license is soon to expire. 8. Select the number of days threshold below which you want to be notified that any timelimited component of the license is soon to expire. 9. Click Save. The specified data is saved.

2.2.3. Renewing Your Sentinel LDK License Your Sentinel LDK license can be renewed at any time as follows:

2.3. Configuring Sentinel EMS Properties Using Administration Console

15

1. Click Collect Information to generate a Customer-to-Vendor (C2V) file that contains your current license data. 2. Send the C2V file to your SafeNet representative by e-mail, together with the order for the license renewal. 3. A Vendor-to-Customer (V2C) file to update your license will be returned. 4. Click Update Master. 5. Browse to select the V2C file. 6. Click Open to install your license renewal. If you are a Sentinel LDK Managed Services customer, submit your license renewal order directly to your Managed Services representative.

2.3. Configuring Sentinel EMS Properties Using Administration Console The Sentinel EMS Administration Console is a graphical, web-based tool that you can use to configure and manage various properties of the Sentinel EMS Server. The Administration account (used to access the Sentinel EMS Administration Console) is different from the Sentinel EMS admin account, even though both accounts have the same user name. When you change the password for one of these accounts, the password for the other account is not affected. Refer to the Sentinel EMS Configuration Guide for the parameters that can be configured in Sentinel EMS.

2.4. Managing Custom Reports This section is meant for administrators with 'Super User' or 'Batch Code Admin' role. Sentinel EMS provides a set of standard reports. However, if these reports do not have exactly what your users want you can define custom reports according to your requirement. To create custom reports, you need to be aware of the data model of Sentinel EMS. The detailed database schema is available in the Sentinel EMS Configuration Guide.

2.4.1. Creating/Updating a Custom Report 1. On the main menu, click Administration > Custom Reports. The Custom Reports page appears. 2. Click New Report. The Create Custom Report pop-up appears. Or, to update a custom report, select it and click is displayed.

(Edit). The Edit Custom Report pop-up

16

Chapter 2: Administration Tasks

3. In the Name field, provide a name for the report (maximum length 50 characters). 4. To enable the report, select the Enabled check box. You can leave it unchecked to create the report in disabled state. You can enable/disable the report later. 5. Specify the output format for the report in the Report Format drop-down list: n

n

CSV—Select this if you want to get the output in CSV format. Jasper—Select this if you want the output in CSV/PDF/HTML/RTF format. For this, you need to create the Jasper report template beforehand.

6. In the Query field, write a SQL query. Following is an example of a simple query: select * from T_ENT_Activation 7. For Jasper report, upload the Jasper template in the Report Template field. While creating a 'jrxml' file, replace the text [language="groovy"] with [language="java"] as Sentinel EMS does not support Groovy. 8. Click Validate to validate the SQL query. 9. Click Save. You can create scheduled reports for custom reports.

2.4.2. Enabling/Disabling a Custom Report If a custom report is disabled it won't appear in the reports list. You need to enable it to make it available to the users. 1. Select a custom report. 2. Click

(Action) > Enable (or

(Action) > Disable) to enable (or disable) the report.

2.4.3. Deleting a Custom Report A custom report cannot be deleted if a scheduled report exists for it.

2.4. Managing Custom Reports

17

1. Select a custom report from the left pane. 2. Click Actions > Delete. 3. In the pop-up that appears, click Yes.

2.4.4. Running a Custom Report Running a custom report is no different from running a pre-defined report. 1. On the main menu, click Reports. The Reports page appears. 2. At the bottom of the left pane, all available custom reports are displayed under the Custom Reports tab. 3. Select a report. 4. Select the output type from the Output Format drop-down list. 5. Click Generate Report.

3 Chapter 3: Product Management This chapter is intended for product managers. A product manager determines the Product components to be protected (called Features in Sentinel EMS), how these components are used to define Products, and the license structure for the Products. n

"Definitions of Features, Products, and License Models" on page 19

n

"Managing Features" on page 21

n

"Managing Products" on page 24

n

"Defining License Terms" on page 39

n

"Defining Memory Data" on page 45

3.1. Definitions of Features, Products, and License Models This section describes Features, Products, and License Models.

3.1.1. Features Each functional component in your software application can be independently controlled by a license. In Sentinel EMS, a component is referred to as a Feature. A Feature may be an entire application, a module, or a specific functionality such as Print, Save, or Draw. After one or more Features have been defined, they can be added to a Product that you can sell as one of your software items.

3.1.2. Products A collection of one or more licensed Features that can be sold as an item is referred to as a Product. Products can differ from each other, both in the Features that they contain, and also in the license terms specified for each Feature. You can control the specific Products you define, the Features they include, and the license terms assigned to each Feature in each Product. Typically, this function is performed by the product manager, and implemented by the software engineer. The implementation scenario can be one of the following:

20

Chapter 3: Product Management

n

n

You create a common product with all the related Features bundled. The order taker can switch on/off products while producing the order. The Features in the product can be controlled without changing its code by different license models. You can define a number of products with combination of different Features by understanding the market requirements and keep them ready for order.

3.1.3. License Models An important step in the development of a licensing strategy is the preparation of a licensing plan. Business decision makers in an organization, such as product or marketing managers, define protection and business rules, and specify the license models required to meet the company’s software distribution needs. A license model is the logic behind a business transaction relating to licensing. For example, a rental license model enables you to charge for the use of software for a specific period of time. License models constitute various parameters (attributes) that define how a Product can be used by the end user. You can configure usage terms to meet your company’s individual requirements. Sentinel EMS enables you to choose from a variety of built-in license models. n

Perpetual—The license can be used an unlimited number of times for an unlimited period of time.

n

Expiration Date—Specifies the date on which the license expires.

n

Execution Count—Specifies the maximum number of times that the Feature can be used.

n

n

Time Period—Specifies the number of days until the license expires, from the date of first use. Provisional—Specifies that the license can be used as a trial license. This license model is available only for Provisional Products.

These license models comprise license attributes, which belong to the following categories: n

Concurrency

n

License Terms

n

Accessibility

3.2. Managing Features

21

3.2. Managing Features To reach the Features page, on the main menu click Catalog > Features. The left pane displays a list of all Features and provides the following information about each Feature: Feature

The name of the Feature.

Feature ID A unique integer value that identifies the Feature. Ref ID 1

Information that identifies the Feature in a different system, for example, a Feature code in your company's ERP system.

Status

Indicates whether the Feature is included in any Product. Deployed (already included in some Product) Not Deployed (not included in any Product) The Feature has been marked obsolete. It can no more be included in a Product. However, it may remain part of pre-existing Products.

3.2.1. Filtering and Searching the Features List 1. In the Batch Code drop-down list select the Batch Code in which you want to search the Feature. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 2. Select an option from the search drop-down list from Feature Name, Ref ID 1, Ref ID 2. 3. Provide the complete or partial search string in the field that follows. 4. Click

. The list shows the relevant search results.

3.2.2. Viewing the Details of a Feature To view the details of a Feature, select a Feature from the left pane. The details are displayed in the right pane.

3.2.3. Tasks for Managing Features Before performing any of the following tasks, you need to specify the Batch Code for the Features that you want to view and/or manage. In the Features page, select the required Batch Code from the Batch Code drop-down list. The Features for the selected Batch Code are displayed. New Feature (Edit)

(Action) > Obsolete/Restore

Define a new Feature and its properties. See "Creating a Feature" on page 22 for details. View the properties of the selected Feature, and if the Feature is not currently included in a Product, to edit these properties. See "Updating Feature Details" on page 23 for details. Obsolete/restore a Feature. Obsolete Features are not available to be included in Products.

22

Chapter 3: Product Management

(Action) > Delete

Delete the selected Feature. This task is listed only if the Feature is not currently included in a Product (not deployed).

3.2.4. Creating a Feature The Create Feature pop-up enables you to define a new Feature and add it to the selected batch. By default, Sentinel EMS assigns a unique Feature ID to each new Feature. However, you can assign your own numeric identifier to the Feature, for example, to maintain consistency with existing Feature data. The same Feature ID may be used in more than one batch, but must be unique within each batch.

1. On the main menu, click Catalog > Features. The Features page appears. 2. In the Batch Code drop-down list select the Batch Code in which you want to create the Feature. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Click New Feature. The Create Feature pop-up appears. 4. In the Feature Name field, enter a name for the new Feature (maximum length 50 characters). The name must be unique in the selected batch. The naming convention is case-insensitive. For example, the Feature names Print, PRINT and print are considered identical. 5. Sentinel EMS generates a unique Feature ID for each new Feature in the Feature ID field. You can assign your own numeric identifier to the Feature, for example, to maintain consistency with existing Feature data. The Feature ID that you specify must be unique in the selected batch. You can check the availability of the Feature ID using the Available? button. 6. Enter Ref ID 1 and Ref ID 2 if required. You can enter information that identifies the Feature in a different system, for example, a Feature code in your company's ERP system. 7. In the Description field, you can enter text to provide additional information about the Feature. The description is optional (maximum length 1024 characters). 8. Click Save.

3.2. Managing Features

23

3.2.5. Updating Feature Details The Edit Feature pop-up enables you to update the details of a Feature. n

n

If a Feature has not been included in any Product—you can edit the Feature and modify all of its attributes, including the Feature Name and Feature ID. If the Feature has been included in one or more Products—the Feature ID can no longer be modified. However, you can edit the Feature Name, Ref IDs, and Description.

To edit a Feature: 1. Select a Feature from the left pane. 2. Click

(Edit). The Edit Feature pop-up appears.

3. Edit the fields as required. 4. Click Save.

3.2.6. Deleting a Feature If a Feature has not been included in any Product, you can delete it. A Feature cannot be deleted once it has been deployed in at least one Product. To delete a Feature: 1. Select a Feature from the left pane. 2. Click

(Action) > Delete.

3. In the pop-up that appears, click Yes.

3.2.7. Obsolete/Restore a Feature If you mark a Feature as obsolete, it will no longer be available for Products. To make the Feature available for Products again, you can restore it. You can obsolete Features that are already deployed. To Obsolete/Restore a Feature: 1. Select a Feature from the left pane. 2. Click

(Action) > Obsolete/Restore.

24

Chapter 3: Product Management

3.3. Managing Products To reach the Products page, on the main menu click Catalog. The left pane displays a list of all Products and provides the following information about each Product: Product Type The following Product types are available: Indicates that the Product is a Base Product. Indicates that the Product is a Modification Product. Indicates that the Product has been defined as Provisional. Indicates that this is a Cancellation Product, which can be used to cancel another Product. Product

Name of the Product.

Product ID

A unique integer value that identifies the Product.

Ref ID 1

Information that identifies the Product in a different system, for example, a Product code in your company's ERP system.

Status

Indicates the current status of the Product: Orange icon indicates that the Product is in Draft state. Green icon indicates that the Product is in Complete state. Indicates that the Product has reached End of Life state.

3.3.1. Filtering and Searching the Products List 1. In the Batch Code drop-down list select the Batch Code in which you want to search the Product. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. If the Batch Code is Cloud-enabled, the Products list contain both Cloud and LDK Products. Else, it displays only the LDK Products. 2. Select an option from the search drop-down list from Product Name, Ref ID 1, Ref ID 2. 3. Provide the complete or partial search string in the field that follows. 4. Click

. The list shows the relevant search results.

3.3.2. Viewing the Details of a Product To view the details of a Product, select a Product from the left pane. The details are displayed in the right pane.

3.3.3. Tasks for Managing Products Before performing any of the following tasks, you need to specify the Batch Code for the Products that you want to view and/or manage.

3.3. Managing Products

25

In the Products page, select the required Batch Code from the Batch Code drop-down list. The Products for the selected Batch Code are displayed. New Product

Define a new Product. n For a Product, you can specify its Features and their licensing details, and define the layout and contents of memory data. See " Creating a Product " on page 25 for details.

> Provisional

Define a new Provisional Product, which is built on a Base Product. A Provisional Product can be distributed as trialware or for use during a grace period. See "Defining a Provisional Product" on page 34 for details.

(Action) > Copy

Define a new Product using the properties of an existing Product. See "Duplicating a Product" on page 30 for details.

(Action)

(Action) > Modification

Define a new Modification Product that is a modified version of a Base Product or another Modification Product. Modification Products cannot be defined from a Provisional Product. See "Defining a Modification Product" on page 30 for details.

Define a new Cancellation Product from a Base Product or Modification Product, to cancel the selected Product. > Cancellation See "Defining Product Cancellation" on page 37 for details. (Action)

(Edit)

View the properties of a selected Product, and change them if the Product is not currently included in an Entitlement. See "Updating Product Details" on page 29 for details.

(Action) Mark the selected Product as End of Life (EOL). An EOL Product can no longer be > End of Life included in an Entitlement. This task is listed only if the status of the Product is Complete. (Action) > Complete

This task is listed if the Product has the status Draft or End of Life. Changes the status of the Product to Complete, so that it can be included in Entitlements.

(Action) > Delete

Delete the selected Product. This task is listed only if the Product and any derived Products are not currently included in an Entitlement (the status of the Product is Draft).

3.3.4. Creating a Product  The Create New Product page enables you to define a new Product. When you define a Product, you can specify the following: n

The Features the Product contains

n

Their individual license terms

n

The content and layout of the memory data stored in Sentinel protection keys

To create a Product:

26

Chapter 3: Product Management 1. On the main menu, click Catalog. The Products page appears. 2. In the Batch Code drop-down list select the Batch Code in which you want to create the Base Product. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Click New Product. The Create New Product page appears. 4. In the Protection Type drop-down list select LDK License. 5. In the Name field, enter a name for the product (maximum length 50 characters). The name must be unique in the selected batch. The naming convention is caseinsensitive, for example, the Trial, TRIAL, and trial are considered identical. 6. Sentinel EMS provides a unique sequential Product ID for each new Product in the Product ID field. You can also assign your own numeric identifier to the Product, for example, to maintain consistency with existing Product data. The Product ID that you specify must be unique in the selected batch. The Product ID should be between 1 and 65471. Both LDK and Cloud Products share this range. It is recommended that you use separate ranges of Product IDs for LDK and Cloud Products. This will help to prevent conflicts in cases of data migration or automatic Product creation through the check-in of C2V files. 7. (Optional) To add a description to the Product, click the Add Description link. The Description field appears. In this field, you can enter text to provide additional information about the Product (maximum length 510 characters). 8. In the Locking Type drop-down list, select the protection level for the Product: n

n

n

n

HL—The Product can be supplied with Sentinel HL keys only. SL User mode—The Product can be supplied with stand-alone Sentinel SL keys only. SL Admin mode—The Product can be supplied with network Sentinel SL keys only. HL or SL Admin mode—The Product can be supplied with either Sentinel HL keys or Sentinel SL keys (network).

3.3. Managing Products

n

27

HL or SL (Admin mode or User mode)—The Product can be supplied with either Sentinel HL keys or Sentinel SL keys (network or stand-alone). If you prefer not to specify the protection level in advance, you can assign this locking type to a Product. With this locking type, the decision on which type of Sentinel protection key is to be shipped with the Product is made when each Entitlement is processed.

W ARN I N G : A P r oduc t that has be e n de fine d w ith the Se ntine l HL or SL loc king type is alw ays supplie d w ith the Se ntine l SL ke y-le ve l of pr ote c tion, e ve n w he n it is shippe d w ith Se ntine l HL ke ys.

9. (Optional) To specify that the system should protect against machine cloning, enabling Products with licenses that are locked to Sentinel SL keys to be duplicated, ensure that the Clone Protection check box is selected. See Protection Against Cloning for more information about clone protection. This option is available only for Products that are locked to Sentinel SL keys. Only Products that contain Features will be clone-protected. This option appears only if the Display Clone Protection Control property is selected in the Admin Console. 10. (Optional) If you select HL, HL or SL Admin mode, or HL or SL (Admin mode or User mode), Upgrade to driverless check box appears. See Upgrading Sentinel HL keys to Driverless Configuration for details. 11. (Optional) The Rehost drop-down list appears if Sentinel SL locking type is selected. Select a value from the following: n

Enable—Enable rehosting for the Product.

n

Disable—Disable rehosting for the Product.

n

Leave as it is—Retain the value of rehost as is in the Protection key.

n

Specify at entitlement time—Enable rehosting to be specified at Entitlement generation.

12. Enter Ref ID 1 and Ref ID 2 if required (maximum 250 characters). You can enter information that identifies the Product in a different system, for example, a Product code in your company's ERP system. 13. You can specify Features in the Product at this stage or you can choose to do so later. To specify Features in the Product: a. Click Add Features. The Add Features to Product pop-up appears. b. Select the Features to add. Click Add Features to Product. The associated Features are displayed in the main screen.

28

Chapter 3: Product Management c. To remove a Feature from the Product, click × in the corresponding row. To remove multiple Features, select the Features and click Delete.

14. In the Excludable? column specify a value from the following. If you want to specify the same option for all Features, click All (to specify Can be excluded for all Features) or None (to specify Always include for all Features). n

n

Select Can be excluded if you want to enable the order taker to exclude the Feature while generating Entitlements. Select Always include if you want that the Feature should never be excluded.

15. To specify the license terms for an individual Feature, click the Configure link corresponding to the Feature. For multiple Features that require the same licensing details, you can specify the licensing terms at one time. Select check boxes for multiple Features, and click the Configure button at the top right corner of the pane. For detailed information on specifying license terms, see "Defining License Terms" on page 39. 16. To define memory areas and write data for secure storage, select the Memory tab. See Defining Memory Data for detailed instructions. 17. When you have finished defining the Product details, click: n

Save as Draft—to save the Product as Draft.

n

Save as Complete—to save the Product as Complete.

The new Product is displayed in the Products page. Upgrading Sentinel HL Keys to Driverless Configuration

Sentinel HL (Driverless configuration) keys are a type of Sentinel HL keys that do not require the Run-time Environment in order to protect an application on a Windows machine. These keys provide several advantages over Sentinel HL keys: n

(On a Windows machine) Employ HID drivers instead of HASP key drivers. (HID drivers are an integral part of the Windows operating system.) In many cases, it is possible to use these keys without installing any additional support software.

n

Support a higher number of Features.

n

Provide larger on-key memory space.

While creating a Product if you select the Upgrade to driverless check box for Sentinel HL (HASP configuration) keys then these keys can be upgraded in the field to Sentinel HL (Driverless configuration) keys. The HASP HL keys and Sentinel HL keys that are already in Driverless mode will remain unchanged.

W ARN I N G Th is p r o c e ss is ir r e v e r sib le an d u p gr ad e d ke y s m ay b e in ac c e ssib le b y pr ote c te d applic ations using A P I libr ar ie s olde r than Se ntine l L DK 6 .3 .

3.3. Managing Products

29

U pgr ade d Se ntine l HL N e t (Dr ive r le ss Configur ation) ke ys w ill r e quir e Se ntine l L DK 7 .0 or late r .

3.3.5. Updating Product Details The Edit Product page enables you to edit the details of a Product. The fields that you can edit depends upon whether the Product is deployed or not. If the Product is: n

n

Not deployed o

Draft—You can edit all fields including the associated Features.

o

Committed—You can edit all fields except the Product ID.

Deployed (included in an Entitlement)—You can edit the Name, Description, and Ref IDs.

To edit a Product: 1. On the main menu, click Catalog. The Products page appears. 2. In the Batch Code drop-down list select the Batch Code. The Products available in the Batch Code are displayed. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Select the Product to modify. 4. Click

(Edit). The Edit Product pop-up appears.

5. Edit the fields as required. 6. Click Save.

3.3.6. Deleting a Product You can delete a Product (Base Product, Modification Product, or Product Cancellation) only if it is in Draft state. However, deleting a Base Product removes all its variant Products. To delete a Product: 1. Select a Product from the left pane. 2. Click

(Action) > Delete.

3. In the pop-up that appears, click Yes.

3.3.7. Associating Features with a Product  You can associate Features with a Product that is not deployed. To associate Features: 1. Click Products. 2. Select the Product from the list.

30

Chapter 3: Product Management 3. Click

(Edit). The Edit Products page appears.

4. To associate Features with the Product: a. Click Add Features. The Add Features to Product pop-up appears. b. Select the Features to add. Click Add Features to Product. The associated Features are displayed in the main screen. c. To remove a Feature from the Product, click × in the corresponding row. To remove multiple Features, select the Features and click Delete. 5. From the Excludable check box, n

n

select Can be excluded if you want to enable the order taker to exclude the Feature while generating Entitlements. select Always include if you want that the Feature should never be excluded.

6. Click Save.

3.3.8. Duplicating a Product The Copy Product page enables you to define a new Product based on the properties of an existing Product. The Product properties, the Features, their license terms, and the content and layout of the memory data defined for the original Product, are available for you to retain or change as required. However, you cannot change the Protection Type. To copy a Product: 1. In the Products page select the Base Product or Modification Product from which you want to create a duplicate Product. 2. Click

(Action) > Copy. The Copy Product page appears.

3. The Copy Product screen is similar to the Creating a Product screen. The fields contain data from the source Product. 4. You must change the Name. 5. If you need to change the locking type, you must first remove all the Features from the Product Features list. Then, in the Locking Type drop-down list, select the protection level for the Product. 6. When you have finished defining the Product details, click: n

Save as Draft—to save the Product as Draft.

n

Save as Complete—to save the Product as Complete.

The new Product is displayed in the Products page.

3.3.9. Defining a Modification Product A Modification Product is a modified version of either a Base Product or another Modification Product. A Modification Product can contain changes such as:

3.3. Managing Products

n

A software upgrade

n

Varied license terms

n

Added Features

n

Removed Features

n

Changes to memory data

When you define a Modification Product, you can add/remove Features and change the license terms for each Feature in the selected Product. By default, data stored in memory segments of the original Product remain in the Modification Product. You can overwrite original data. You can edit the properties of a Modification Product if it has not yet been included in an Entitlement.

To define a Modification Product: 1. On the main menu, click Catalog. The Products page appears. 2. In the Batch Code drop-down list select the Batch Code in which you want to create the Modification Product.

31

32

Chapter 3: Product Management If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Select the Base Product or Modification Product for which you want to build the Modification Product and click Product page appears.

(Action) > Modification. The Create Modification

4. Enter a name in the Name field (maximum length 50 characters). The name must be unique in the selected batch. 5. (Optional) To add a description to the Product, click the Add Description link. The Description field appears. In this field, you can enter text to provide additional information about the Product (maximum length 510 characters). 6. If you need to change the locking type, you must first remove all the Features from the Product Features list. Then, in the Locking Type drop-down list, select the protection level for the Product: n

n

n

n

n

HL—The Product can be supplied with Sentinel HL keys only. SL User mode—The Product can be supplied with stand-alone Sentinel SL keys only. SL Admin mode—The Product can be supplied with network Sentinel SL keys only. HL or SL Admin mode—The Product can be supplied with either Sentinel HL keys or Sentinel SL keys (network). HL or SL (Admin mode or User mode)—The Product can be supplied with either Sentinel HL keys or Sentinel SL keys (network or stand-alone). If you prefer not to specify the protection level in advance, you can assign this locking type to a Product. With this locking type, the decision on which type of Sentinel protection key is to be shipped with the Product is made when each Entitlement is processed.

W ARN I N G : A P r oduc t that has be e n de fine d w ith the Se ntine l HL or SL loc king type is alw ays supplie d w ith the Se ntine l SL ke y-le ve l of pr ote c tion, e ve n w he n it is shippe d w ith Se ntine l HL ke ys.

7. Enter Ref ID 1 and Ref ID 2 if required. You can enter information that identifies the Modification Product in a different system, for example, a Product code in your company's ERP system. 8. Ensure that the Product Features tab is selected. The Features from the Base Product are displayed in this pane. You can add additional Features to the Modification Product or remove existing Features from the Modification Product as follows:

3.3. Managing Products

33

a. Click Add Features. The Add Features to Product pop-up appears. b. Select the Features to add. Click Add Features to Product. The associated Features are displayed in the main screen. c. To remove a Feature from the Product, click × in the corresponding row. To remove multiple Features, select the Features and click Delete. 9. From the Excludable check box, n

n

select Can be excluded if you want to enable the order taker to exclude the Feature while generating Entitlements. select Always include if you want that the Feature should never be excluded.

10. To specify the license terms for an individual Feature, click the Modify / Overwrite / Cancel / Leave link corresponding to the Feature. For multiple Features that require the same licensing details, you can specify the licensing terms at one time. Select check boxes for multiple Features, and click the click the Modify / Overwrite / Cancel / Leave buttons at the top right corner of the pane. For details about what these buttons do, see the following: n

Modify—To change the license terms for existing Features. In the pop-up that appears modify the license terms as needed. For example, you can increase/decrease execution counts and concurrent instances. This option is not available for newly added Features. If for an existing Feature the license type is Specify at entitlement time, then use Overwrite instead of Modify to change the license terms.

n

Overwrite—To define fresh license terms for existing or new Features. In the popup that appears define the license terms.

34

Chapter 3: Product Management

n

n

Cancel—To remove these from the Product. Leave—If you have modified, overwritten, or canceled a Feature, click Leave to return to its original configuration.

See "Defining License Terms" on page 39 for detailed instructions. 11. Select the Memory tab to define memory areas and write data for secure storage. (See defining new memory segment for details). 12. When you have finished defining the Product details, click: n

n

Save as Draft—To save the Modification Product as Draft so that you can update its details later. Save as Complete—This finalizes the Modification Product.

The new Modification Product is displayed in the Products page just below the Base Product.

3.3.10. Defining a Provisional Product A Provisional Product is built on a Base Product. In a Provisional Product you can define: n

A license duration of between 1 and 90 days

n

Features

n

Memory data

When you define a Provisional Product, the Features from the Base Product are automatically incorporated in the Provisional Product. You can modify the license duration for each Feature. You can also add or remove Features. In addition, you can define memory segments and their data (see "Defining Memory Data" on page 45 for details).

3.3. Managing Products

35

To define a Provisional Product: 1. On the main menu, click Catalog. The Products page appears. 2. In the Batch Code drop-down list select the Batch Code in which you want to create the Provisional Product. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Select the Base Product from which you want to build the Provisional Product and click (Action) > Provisional. The Create Provisional Product pop-up appears. 4. In the Name field type a name for the Provisional Product (maximum length 50 characters). The name must be unique in the selected Base Product. 5. (Optional) To add a description to the Product, click the Add Description link. The Description field appears. In this field, you can enter text to provide additional information about the Product (maximum length 510 characters). 6. If you need to change the locking type, you must first remove all the Features from the Product Feature(s) list. Then, in the Locking Type drop-down list, select the protection level for the Product: n

n

HL—The Product can be supplied with Sentinel HL keys only. SL User mode—The Product can be supplied with stand-alone Sentinel SL keys only.

36

Chapter 3: Product Management

n

n

n

SL Admin mode—The Product can be supplied with network Sentinel SL keys only. HL or SL Admin mode—The Product can be supplied with either Sentinel HL keys or Sentinel SL keys (network). HL or SL (Admin mode or User mode)—The Product can be supplied with either Sentinel HL keys or Sentinel SL keys (network or stand-alone). If you prefer not to specify the protection level in advance, you can assign this locking type to a Product. With this locking type, the decision on which type of Sentinel protection key is to be shipped with the Product is made when each Entitlement is processed.

W ARN I N G : A P r oduc t that has be e n de fine d w ith the Se ntine l HL or SL loc king type is alw ays supplie d w ith the Se ntine l SL ke y-le ve l of pr ote c tion, e ve n w he n it is shippe d w ith Se ntine l HL ke ys.

7. Enter Ref ID 1 and Ref ID 2 if required (maximum 250 characters). You can enter information that identifies the Product in a different system, for example, a Product code in your company's ERP system. 8. Add or remove Features as required: a. Click Add Features. The Add Features to Product pop-up appears. b. Select the Features to add. Click Add Features to Product. The associated Features are displayed in the main screen. c. To remove a Feature from the Product, click × in the corresponding row. To remove multiple Features, select the Features and click Delete. 9. To specify the license terms for an individual Feature, click the Configure link corresponding to the Feature. For multiple Features that require the same licensing details, you can specify the licensing terms at one time. Select check boxes for multiple Features, and click the Configure button at the top right corner of the pane. In the Configure License Terms pop-up that appears, you can define the following terms for Provisional Products: n

n

n

License type from: o

Provisional (Time Period)

o

Provisional (Perpetual)

Number of days (from 1 to 90) until the license expires [only for Provisional (Time Period) based]. Accessibility: o

To enable remote desktop access to the license, select the Remote Desktop check box.

3.3. Managing Products o

37

If the Feature for which license terms are being defined is in a Product that can only be locked to a Sentinel SL key, and you want to enable the Feature to be active on a virtual machine, select the Virtual Machine (SL) check box.

10. When you have finished defining the Product details, click: n

n

Save as Draft—To save the Provisional Product as Draft so that you can update its details later. Save as Complete—The new Provisional Product becomes ready to be incorporated in a bundle of Provisional Products. For more information, see "Generating a Bundle of Provisional Products" on page 77.

3.3.11. Defining Product Cancellation A Cancellation Product cancels the license terms of another Product. For example, a Cancellation Product can be used: n

n

To revoke a deployed license To cancel the license for a Product that has been returned before its license terms have expired

When you define a Cancellation Product, you can cancel the license terms for each Feature in the selected Product. Changes made to the memory data overwrites the original data. If a Cancellation Product has not yet been included in an Entitlement, you can edit its properties.

38

Chapter 3: Product Management

To define a Cancellation Product: 1. On the main menu, click Catalog. The Products page appears. 2. In the Batch Code drop-down list select the Batch Code in which you want to create the Cancellation Product. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Select the Product for which you want to create the Cancellation Product and click (Action) > Cancellation. The Create Cancellation Product page appears. 4. Type a name for the Cancellation Product in the Name field (maximum length 50 characters). The name must be unique in the selected batch. 5. Enter Ref ID 1 and Ref ID 2 if required (maximum 250 characters). You can enter information that identifies the Product in a different system, for example, a Product code in your company's ERP system. 6. (Optional) To add a description to the Product, click the Add Description link. The Description field appears. In this field, you can enter text to provide additional information about the Product (maximum length 510 characters). 7. To specify the license terms for individual Features, click the Modify / Cancel link corresponding to the Feature. For multiple Features that require the same licensing details, you can specify the licensing terms at one time. Select check boxes for multiple Features, and click the click the Modify / Cancel buttons at the top right corner of the pane. For details about what these buttons do, see the following: n

Modify—To specify the license terms for individual Features.

n

Cancel—To cancel license terms for a Feature.

8. When you have finished defining the Cancellation Product details, click: n

n

Save as Draft—To save the Cancellation Product as Draft so that you can update its details later. Save as Complete—This finalizes the Cancellation Product.

The new Cancellation Product is displayed in the Products page.

3.3.12. Changing Product Status Marking a Product as Complete

This task is listed for Products with status Draft or End of Life. This changes the status of the Product to Complete so that it can be included in Entitlements. To mark a Draft (or End of Life) Product as Complete:

3.4. Defining License Terms

39

1. Select the Product from the left pane. 2. Click

(Action) > Complete.

Marking a Product as End of Life (EOL)

This task is listed only if the status of the Product is Complete. An EOL Product can no longer be included in an Entitlement. To mark a Complete Product as EOL: 1. Select the Product from the left pane. 2. Click

(Action) > End of Life.

3.3.13. Protection Against Cloning Machine cloning involves copying the entire image of one machine (including your software and its legitimate license) to one or more other machines. With Sentinel LDK, you have the ability to detect probable machine cloning and to disable software that is locked to Sentinel SL keys until you are satisfied that the user has a legitimate license for your software. Sentinel LDK can detect probable cloning regardless of whether the machine cloned is a physical computer or a virtual machine. (For more information on clone detection, see the Sentinel LDK Software Protection and Licensing Guide.) You specify that you want clone protection to be applied to a Product at the time that you are creating or updating a Product. When the Sentinel LDK Run-time detects cloning, it disables the licenses for which clone protection was specified. The end user is unable to log on to the software for which cloned licenses have been detected. The end user must contact your vendor representative and submit a C2V file from the machine on which the cloned license was detected, along with their Product Key, in order to have the cloned key updated and the Product activated.

3.4. Defining License Terms In Sentinel EMS, you can specify the licensing details for each Feature in the Product that you are defining. You can also select two or more Features that require the same licensing details and specify the licensing terms only once. Licensing terms for a Feature can be defined when the Product is being created, or during Entitlement generation if this option has been enabled. n

Licensing Terms You can select one of the following license types: o

Execution Count: Specifies the maximum number of times the Feature can be used.

o

Expiration Date: Specifies the date on which the license for the Feature will expire.

40

Chapter 3: Product Management o

Perpetual: Indicates that the license can be used an unlimited number of times and for an unlimited period of time.

o

Time period: Specifies the number of days until the license expires, from the date of first use.

When you select the license type, you can also specify the values for the license terms. These license values will apply to all orders for this Product. For maximum flexibility, you can choose to leave the values to be specified at the time when each individual order is processed. Alternatively, you can select Specify at Entitlement time from the license type drop-down list, to enable the type of license to be specified at Entitlement generation. n

Concurrency If the Product is intended to be used on a network, you can specify the number of concurrent instances allowed for the Feature, and select how concurrent instances are counted.

n

Accessibility Depending on the locking type selected when you created the Product, and whether the Product is intended for use on a network, you may choose to make the license detachable. For more information on detachable licenses, see "Working with Detachable Licenses" on page 42.

n

Valid Sentinel HL Keys As you specify the various parameters that make up the license terms, the Valid Sentinel HL Keys pane at the bottom of the pop-up changes dynamically to indicate which type of Sentinel HL keys are compatible with the current license terms. The Valid Sentinel HK Keys pane appears only when Locking type is HL, HL or SL admin, or HL or SL admin or SL user.

To define the license terms for a Feature:

3.4. Defining License Terms

41

1. In the License Type drop-down list, select the license type for the Feature. 2. Enter the value for the license type in the subsequent field(s). This value will be applied to all orders for this Product. n

n

n

n

Execution Count: Specify the number of times the Feature may be used. For a Modification Product, you can increase or decrease the number of times specified in the original license. Expiration Date: Click the field to open a calendar and select the date on which the license will expire (or enter the date using the default date format on your computer). For a Modification Product, you can increase or decrease the number of days to change the date specified in the original license. Perpetual: No values are required for this license type. Time period: Specify the number of days until the license expires. The number of days is counted from the date on which the licensed Feature is first used.

3. To enable the value to be specified when each individual order is processed, select the Specify at Entitlement time option instead of defining the value. If the Product is not intended to be used on a network, proceed to step 8. Default value for Specify at Entitlement time option can be specified when this option is selected. 4. If the Product is intended to be used on a network, select the Concurrency check box. a. Specify the value for number of concurrent instances: n

n

To allow unlimited concurrence, keep the No Limit check box selected. To specify the number of concurrent instances allowed in the license, clear the No Limit check box and enter a value in the Concurrent Instances field.

42

Chapter 3: Product Management For a Modification Product, you can increase or decrease the number of instances specified in the original license. n

To enable the number of instances to be specified for each individual order, select Specify at Entitlement time.

b. Select what is to be counted as a concurrent instance, for the purposes of the license: n

Login: Each login request is counted as an instance.

n

Process: Each login request for a single process is counted as an instance.

n

Station: Each login request for a single machine is counted as an instance.

c. Ensure that the Network check box is selected. 5. If the Feature is to be detachable, ensure that the Network check box is selected, then select the Allow Detaching check box (only relevant for Products locked to Sentinel SL keys). 6. To enable remote desktop access to the license, select the Remote Desktop check box. If you allow remote desktop access, you are enabling end users to access the protected application from multiple remote desktops simultaneously. Depending on the nature of your application, you may have no objection to this. However, if you want to allow remote desktop access AND limit the number of concurrent processes, you must select the Concurrency check box and specify the number of concurrent processes allowed. 7. If the Feature for which license terms are being defined is in a Product that can only be locked to a Sentinel SL key, and you want to enable the Feature to be active on a virtual machine, select the Virtual Machine (SL) check box (this is selected by default). Selecting this check box enables a end user to deploy a single license on multiple machines. 8. Click OK to update the license terms for the Feature and return to the Edit Product pop-up.

3.4.1. Working with Detachable Licenses A detachable license is an SL license for a Product that can temporarily be removed from a pool of network seats and attached to a remote recipient machine. For example, the license for a Product may be detached from the network and attached to a laptop to enable a user to use the protected application while working offline. When a license is detached from the network, the license includes all Features in the Product that have been designated as detachable, and all protection key memory for the Product. Each instance of a detachable license relates to a specific recipient machine. A detachable license expires after a specified time, after which the license is automatically returned to the pool of network seats. You have the option of canceling the detachable license on the recipient machine and returning the license to the pool of network seats before the license expires.

3.4. Defining License Terms

43

Note the following: You cannot apply detachable licenses to Provisional Products.

n

Only Perpetual or Expiration Date license types are supported for detachable license.

n

Execution Count or Time Period license types cannot be used for detachable license.

n

This section describes: n

Defining a Product with a detachable license

n

Additional considerations when defining detachable licenses

n

Preparing a recipient machine for running a detached license

n

Detaching a license from the network

n

Attaching a license to a recipient machine

n

Canceling a detachable license from the recipient machine

Defining a Product with one or more Detachable Licenses

Products with detachable licenses are defined in the Create Products page, in the same way as other Products are defined. However, certain attributes are required at both Product and Feature level to enable detachable licenses. The locking type for the Product must be specified as either 'SL-AdminMode', 'HL or SLAdminMode', or 'HL or SL-AdminMode or UserMode'. To define a Product with a Detachable License: 1. In the Products page, click New Product. The Create Product pop-up appears. (The steps specific to defining detachable licenses are provided here. Refer to the Create Products page for detailed steps.) 2. From the Protection Type drop-down list, select LDK License. 3. In the Name field, enter a name for the product (maximum length 50 characters). The name must be unique in the selected batch. 4. In the Locking Type drop-down list, select one from the following options: n

SL-AdminMode

n

HL or SL-AdminMode

n

HL or SL-AdminMode or UserMode

5. To specify Features in the Product,

44

Chapter 3: Product Management a. Click Add Features. The Add Features to Product pop-up appears. b. Select the Features to add. Click Add Features to Product. The associated Features are displayed in the main screen. c. To remove a Feature from the Product, click × in the corresponding row. To remove multiple Features, select the Features and click Delete. You can add Features that will have detachable licenses and Features that will not have detachable licenses to a Product. 6. In the Product Features pane, select the Features for which you want to enable a detachable license, then click Configure. The Configure License Terms pop-up appears. 7. In the License Type drop-down list, select either Perpetual or Expiration Date. 8. Select the Concurrency check box, then specify your concurrency preferences. 9. Ensure that the Allow Detaching check box is selected.

10. In the Accessibility area, ensure that the Network check box is selected. 11. Click Save. The Configure License Terms pop-up closes and the Create Product page is displayed. 12. Click Save as Draft to save the Product as Draft. Click Save as Complete to mark the Product as Complete. Additional Information about Detachable Licenses

If you create an Entitlement in which you have several Modification Products that have been created from a single Base Product and one Modification Product has a Feature that is detachable and another Modification Product has the same Feature ID but it is not detachable, the Feature values for the last added Product will be applied. Only the Features for which the detachable options have been enabled will be included in a Product that is detached from the network. Preparing a Recipient Machine to Run an Application using a Detached License

In Entitlement for a recipient machine to run an application using a detached license, the Sentinel LDK Run-time Environment and vendor libraries must be installed. This is accomplished by creating a Run-time Environment Installer that automatically installs these components. To prepare a recipient machine for a Detached License: 1. On the main menu, click Developer > RTE Installer. The RTE Installer page appears. 2. Clear the Include V2C for Bundle of Provisional Products check box. 3. Click Generate. 4. Save the generated installer file. 5. Use the generated file to install Sentinel LDK Run-time Environment on the recipient machine.

3.5. Defining Memory Data

45

Detaching a License from the Network

You use Sentinel LDK ToolBox, the Sentinel Licensing API, or Sentinel Admin Control Center to detach licenses from the network. The process is described in the help documentation for each of these applications. Attaching a License to a Recipient Machine

A detached license is attached to a recipient machine by running the file that is created when a license is detached from the network. For more information, see the help documentation in Sentinel LDK ToolBox, the Sentinel Licensing API, or Sentinel Admin Control Center. Canceling a Detachable License from the Recipient Machine

Typically, a detachable license returns to the pool of network seats automatically when the license expires. You have the option of canceling a detachable license that has been attached to a recipient machine before the license expires and returning the license to the pool of network seats. This action must be performed from the recipient machine. For more information, see the help documentation in Sentinel LDK ToolBox, the Sentinel Licensing API, or Sentinel Admin Control Center.

3.5. Defining Memory Data The Define Memory Data tab of the Product Properties pop-up enables you to define the layout and contents of the memory data associated with the Product. This data is written to the Sentinel protection keys when an order for the Product is produced, or when the Product is activated using a Sentinel protection key. You can define segments in memory according to your requirements, and you can select different colors for the segments to make it easy to identify them. After you have defined a memory segment, you can enter data into the segment. You can redefine the data and segment layout as required. Alternatively, you can select the Specify at Entitlement time check box for one or more segments to enable staff to enter Customer-specific data when an order is being processed.

46

Chapter 3: Product Management

To define a new segment and data in memory: 1. Select the Memory tab in the Create Product pop-up.

2. Select the required memory type for the new segment from the Memory Type drop-down list: n

n

Read/Write Memory: Data that can be updated at run-time. For example, value variables for counters, information retrieved during interaction with the end user, and so on. Read-Only Memory: Data to be read at run-time. For example, the Product version number, text to be used in a "Welcome" message, fixed threshold values for counters, and so on.

3. If you prefer to use hexadecimal definitions instead of decimal definitions to define offset locations and addresses in memory, select the Hex addresses check box. 4. To define a new area in memory, click New. The New Memory Segment pop-up appears.

3.5. Defining Memory Data

47

5. Type a Name (maximum 50 characters) and Description (maximum 250 characters) for the new memory segment. These fields are optional. 6. Enter the Offset and Length of the new segment. You can select a Color from the palettes that will help you identify the segment. Length can have value 1–4032 for read/write memory and 1–2048 for read-only memory. 7. If you require the memory data for the New Memory Segment to be entered during Entitlement generation, select the Specify at Entitlement time check box. When defining memory data for a Provisional Product, you cannot specify that the data will be entered during Entitlement generation. 8. Click Save. The newly defined area is displayed in the lower section of the Memory tab. The segment addresses are displayed on the left.

To edit segments and data in memory: n

n

n

n

To edit the offset, size, or color of a memory segment, select the segment and click Edit. Make the required changes in the Edit Memory Segment pop-up and click Save to update the changes. To delete a memory segment, select the segment and click Delete. The segment is deleted. To save a memory segment as a XML file, select the segment and click Save. The File Download dialog box appears. Save the file to a directory in your system (default file name is memory.xml). To load a memory segment from a file, click Load. The Load Memory File pop-up appears. Click Browse to navigate to the directory containing the saved memory segments, select the required memory segment, and click Load. The selected memory segment is loaded. During Product definition, a loaded memory segment overwrites any pre-existing memory in that segment.

n

To unload a previously loaded memory segment from a file, select the segment and click the Undo. The memory unloads the last-loaded segment.

48

Chapter 3: Product Management

n

To display the memory map click Map.

When you have finished defining the memory segments and data, you can click the Select Feature tab to continue defining the properties for the Product. If you have finished defining the Product properties, click Save in the Product Properties pop-up. The new or updated Product is displayed in the Products page.

4 Chapter 4: Managing Entitlements This chapter is meant for order generation and production staff with 'Entitlement Manager' or 'Production' roles. After Features and Products have been defined in Sentinel EMS by the product manager, the order generation staff can generate Entitlements for the Products. Entitlement generation means producing orders for the Products already defined. Entitlements provide your customers the right to use your Products within the mutually agreed terms. Each Entitlement is identified by a unique Entitlement ID (EID). The Products associated are identified by unique Product Keys. The Entitlement also bears information on the number of copies of the product that the customer can use and the duration of use. To reach the Entitlements page, on the main menu click Entitlements. The left pane displays a list of all Entitlements and provides the following information about each Entitlement: Type

Indicates the Entitlement type: Order for Product Keys Order for Sentinel HL Keys

Order for Protection Key Update Created On The date and time the Entitlement was created. Customer

Name of the Customer who placed the order.

Status

The current status of the Entitlement.

4.1. Filtering and Searching the Entitlements List 1. In the Batch Code drop-down list select the Batch Code in which you want to search the Entitlement. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 2. Select an option from the search drop-down list from EID, Channel Partner, Customer Name, E-mail, Status, Ref ID 1, and Ref ID 2. 3. Provide the complete or partial search string in the field that follows. 4. Click

. The list shows the relevant search results.

50

Chapter 4: Managing Entitlements

4.2. Viewing the Details of an Entitlement To view the details of an Entitlement, select an Entitlement from the left pane. The details are displayed in the right pane.

4.3. Tasks for Managing Entitlements Before performing any of the following tasks, you need to specify the Batch Code for the Entitlements that you want to view and/or manage. In the Entitlements page, select the required Batch Code from the Batch Code drop-down list. The Entitlements for the selected Batch Code are displayed. New Entitlement

(Edit)

Create a new Entitlement for a Customer. You can create either a new LDK Entitlement or a Cloud Entitlement by selecting the appropriate option from the Protection Type drop-down list. See "Creating an Entitlement" on page 51 for details. View or (where applicable) modify the details of the selected Entitlement.

(Action) > Delete

Delete the selected Entitlement if it is in Draft state.

(Action) > Queue

Add the Entitlement to the production queue. This, changes the status of the selected Entitlement to Queued.

(Action) > Disable

Disable the Entitlement—the Entitlement can no more be produced.

(Action) > Enable

Re-enable the selected Entitlement.

(Action) > Reopen

Changes the status of the selected Entitlement to Draft (allowing the Entitlement to be modified). Reopen can be used for Entitlements with the following status: n Queued (the Entitlement is ready for production). n

Product Keys generated. Reopening this Entitlement cancels the generated Product keys.

(Action) > Produce

Produce the Entitlement. See "Producing Entitlements" on page 60 for details.

(Action) > Activate

Activate the Product Keys in an Entitlement for the end user. See "Generating a V2C File to Manually Activate a Product" on page 72 for details.

(Action) > Previous Activations

View activations that are already performed for a Product key. This task appears for Product keys for which at least one activation has been performed. See "Viewing Previous Activations for a Product Key" on page 74 for details.

4.4. Creating an Entitlement

51

4.4. Creating an Entitlement The Create New Entitlement page enables you to define a new Entitlement. When you create an Entitlement, you can: n

Specify the Products for which you want to create the Entitlement.

n

Edit the license terms for individual Features.

n

Edit the content and layout of the memory data stored inSentinel protection keys.

To create an Entitlement: 1. On the main menu, click Entitlements. The Entitlements page appears. 2. In the Batch Code drop-down list select the Batch Code in which you want to create the Entitlement. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Click New Entitlement. The Create New Entitlement page appears. 4. From the Protection Type drop-down list, select LDK License. 5. (Optional) In the Customer field, specify a Customer for which you are creating the Entitlement. Enter the first few characters of the Customer name. A list of matching names is populated. Select a name from the list or click ADD NEW to create a new Customer. To perform an advanced search, click . 6. If the Customer has multiple contact e-mail IDs, you can choose one from the E-mail field. If the Customer doesn't have any e-mail ID, you can proceed by leaving this field blank. 7. (Optional) To specify a Channel Partner, click the Add Channel Partner link. The Channel Partner field appears. Type the first few characters of the Channel Partner name. A list of matching names is populated. Select a name from the list. To perform an advanced search, click . If the Channel Partner has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list. 8. (Optional) To add reference IDs, click the Add Ref ID link. The Ref ID 1 and Ref ID 2 fields appear. In these fields you can enter information that identifies the Entitlement in another system. For example, the order code in your company's ERP system.

52

Chapter 4: Managing Entitlements 9. (Optional) To add a description to the Product, click the Add Entitlement Notes link. The Comments field appears. In this field, you can enter text to provide additional information about the Product (maximum length 500 characters).

10. Enter Start Date and End Date for the Entitlement. To extend the end date indefinitely, select Never Expires. 11. In the Entitlement Type field, specify one of the following: n

Product Key—Associates the Entitlement items to one or more Product Keys.

n

Hardware Key—Writes the Entitlement items to one or more Sentinel HL keys.

n

Protection Key Update—Enables changes to be made to the license data stored in deployed keys.

12. To select the Products to be included in the Entitlement, on the Product Details pane click Add Product. The Product Selection pop-up appears. 13. Select one or more Products, and click Add Products to Entitlement. The selected Products are added to the Entitlement. The Product specifications must be compatible with the Entitlement type. For example, you cannot add a Product that must be locked to a Sentinel HL key to an Entitlement for Sentinel SL keys. n

n

n

n

n

If the license terms have been defined for all the Features in the Product, the details are not displayed. You can click on the left of the Product to view the details. If the license term values for a Feature have not been defined, all the Feature details for the Product are displayed. The License Terms for Features with values that need to be defined are shown in orange. After the values are defined, the License Terms are shown in green. Configure rehosting for Products for which rehosting needs to be specified during Entitlement creation. For such Products, a drop-down list appears in the Rehost column. Select a value from the following: o

Enable—Enable rehosting for the Product.

o

Disable—Disable rehosting for the Product.

o

Leave as it is—Retain the value of rehost as is in the Protection key.

If you want to exclude a Feature from the Product, select the Exclude check box. Only Features that were specified as Excludable at the time the Product was created can be excluded. Select a Product and click Memory to display the Memory pop-up. For more information about editing memory data, see "Editing Memory Data during Entitlement Generation" on page 57.

4.4. Creating an Entitlement

53

14. For each Feature for which license term values have not been defined, an orange link appears in the License Terms column. Click this link to specify the required values for the Entitlement. After the values are defined the License Terms are shown in green. For multiple Features that require the same licensing details, select the Features and click Configure to display the Configure License Terms pop-up. For detailed information on specifying license terms, see "Defining License Terms" on page 39. The Entitlement can be: o

added to the production queue

o

produced

only after the license term values have been defined for all the Features in all the Products included in the Entitlement. 15. Save as Draft, Queue, or Produce the Entitlement: n

Save Draft—save the Entitlement in Draft state until it is ready to be added to the production queue.

n

Queue—make the Entitlement available for production.

n

Produce—produce the Entitlement immediately.

4.4.1. Adding Products to an Entitlement The Product Selection pop-up enables you to select a Product and add it to the current Entitlement. The Products displayed in the list relate to the Batch Code that is specified for the Entitlement. Provisional Products cannot be added to Entitlements and are therefore not included in the list of Products. The process of generating files containing Provisional Products is a Development task. To add a Product to the Entitlement: 1. Select the required Product. You can select multiple Products to include in the Entitlement. 2. Click OK. The Product is added to the Entitlement.

4.4.2. Define Entitlement Type and Other Details Specify the Entitlement details, depending on whether the Entitlement relates to Product Keys, Sentinel HL keys, or license updates for existing Sentinel protection keys. To define the details for the Entitlement type:

54

Chapter 4: Managing Entitlements 1. In the lower pane, select the Entitlement type: n

Product Key: Associates the Entitlement details with one or more Product Keys. If you selected Product Key-based: a. Enter the total number of Product Keys to be produced for this Entitlement. b. Enter the number of activations to be available on each Product Key. This is the number of machines on which each Product Key can be used. For example, if the Entitlement states that each Product Key can be used on a maximum of 3 machines, enter 3 as the number of activations. c. For Product Keys, a User Registration drop-down list is displayed. You need to specify a value for whether end user registration is required. Select a value from the following:

n

o

Mandatory—When the end user logs on using a Product Key, he must provide registration information once before he can proceed. Once registered, he is not asked about this info for further login. If he has already registered, he just needs to provide his e-mail to proceed.

o

Desired—The end user will be prompted to provide registration information. However, he can opt to register later.

o

Not Required—The user registration page will not appear.

Hardware Key: Writes (burns) the Entitlement details to the connected Sentinel HL key. If you selected Sentinel HL Keys: a. Type the total number of Sentinel HL keys to which the Entitlement is to be written.

n

Protection Key Update: Updates existing license details stored in Sentinel protection keys already deployed in the field. If you selected Protection Key Update: a. Click Locate. The Locate Sentinel Keys pop-up appears (see "Locating Sentinel Protection Keys for the Entitlement" on page 55). The Locate Sentinel Keys pop-up displays the total number of Sentinel protection keys selected for the Entitlement. You cannot select more keys than you specified as the total number of keys to which to write this Entitlement. You can only add the Entitlement to the production queue or produce it when the number of selected keys is equal to the number that is specified for the Entitlement. b. Select the specific Sentinel protection keys to be updated in this Entitlement.

2. If you select the Prompt for Confirmation check box, then while installing the V2C file, the Customer will be automatically prompted to return a C2V file to the vendor. This field is not available for Hardware Keys.

4.4. Creating an Entitlement

55

Locating Sentinel Protection Keys for the Entitlement

The Locate Sentinel Keys pop-up enables you to search for and select the specific keys that are to be updated with the Sentinel Update information defined in the Entitlement. The Customer who placed the order may have a number of Sentinel protection keys, not all of which require to be updated.

You can search for the keys by: n

Customer—The Sentinel protection keys held by the Customer are displayed.

n

Product Key—The Sentinel protection keys associated with the Product Key are displayed.

n

C2V file—The Sentinel protection keys specified in the C2V file are displayed.

n

Key ID—The Sentinel protection key with the specified ID is displayed.

When your search is successful, the located keys and their contents are displayed, and you can select the keys required for the update.

56

Chapter 4: Managing Entitlements 1. To search for Sentinel protection keys, select a option from the following: n

Customer a. Enter Customer name in the Customer field. b. Click Search and find the Customer using the Search Customer pop-up.

n

C2V file Browse and locate the C2V file containing the required information. You can select multiple C2V files.

n

Product Key Enter the Product Key associated with the keys to be updated.

n

Key ID Enter the ID of the Sentinel protection key to be updated.

2. Click Locate. 3. In the list of displayed Sentinel protection keys, You can click any key ID to view the contents of the key (see the following screen).

4. This screen displays the Products and Features already available in the key along with their License Terms. Click Close to return to the Locate Sentinel Keys screen. 5. Select any key ID and click Add to List. The key is added to the Sentinel Keys to Update field. 6. Repeat the above step for each key that is to be updated. To remove a key from the Keys to Update list, select the key and click Remove. 7. When you have finished selecting the keys that are to be updated, click OK to return to the Create Entitlement (or Edit Entitlement) pop-up. Viewing Located Protection Keys for Updates

The Located Sentinel Keys pop-up displays the Sentinel protection keys currently selected for an update.

4.4. Creating an Entitlement 1. In the Entitlements screen, select an Entitlement of type Protection Key Update (

57

).

2. Click the View link near the Number of updates field. The Located Sentinel Keys pop-up appears.

3. This screen displays the Protection keys located for the update. You can click any Key ID to view the contents of the key.

4.4.3. Editing Memory Data during Entitlement Generation The Edit Entitlement Memory pop-up enables you to edit contents of the memory data associated with the Product during Entitlement generation. For example, you may want to add Customerspecific memory data to the order. This data is written to the Sentinel protection keys. The segments in the memory in which data can be defined are already specified when the Product is created. While editing the memory during Entitlement generation, all the defined memory segments are displayed in the segment table. Memory segments that can be edited during Entitlement generation have the status Yes in the Specify column. If multiple Products in an Entitlement have the same memory offset, then addition of a Product will decide the text in the memory segment. Memory of the Product last added decides the actual memory. In case of overlap, the conjugate of the memory offset is displayed.

To edit data in memory:

58

Chapter 4: Managing Entitlements 1. Select the Product in an Entitlement for which you need to specify memory. 2. Select the type of memory segment that is required from the Memory Type drop-down list. 3. Select the required memory segment ID from the segment table. 4. If you prefer to use hexadecimal definitions instead of decimal definitions to view offset locations and addresses in memory, select the Hex addresses check box. 5. Enter the required data. When data is entered, the segment properties must match any predefined segment parameters. Alternatively, you can click Load to load a memory file. The Open dialog box appears. Navigate to the directory containing the required memory file, select a memory file and click Open. The selected memory segment is loaded. 6. To save a memory segment as a file, select it and click Save. The Save As dialog box appears. Navigate to the directory in which you want to save the file, specify the name for the file and click Save. The selected memory segment file is saved. 7. To view the memory map, click Map. The Memory Map pop-up appears.

Click Save to close the memory map. 8. Click OK to update the changes. The Edit Order Memory pop-up closes. If you load an incorrect file, you can click the (Undo) button to remove that memory data and restore the memory to its previous state.

4.4.4. Save as Draft, Queue, or Produce an Entitlement After all the necessary information has been specified for the Entitlement, it can be added to the production queue and produced. After an Entitlement has been added to the production queue,

4.5. Updating Entitlement Details

59

it cannot be changed. If you do not want to add it to the production queue at this stage, you can save it as draft with all its current information and add it to the production queue later. Save as Draft

If the Entitlement cannot be added to the production queue because some of the required information is not available, or if you prefer not to Queue at this stage for any reason, you can save the Entitlement as Draft with all the details that you have defined so far. To save the Entitlement as Draft, click Save Draft. The Entitlement is displayed in the Entitlements page with the status Draft. You will be able to view and edit the Entitlement later by opening it from the Entitlements page. Queue an Entitlement

If all the necessary information for the Entitlement has been specified, you can queue it. The Entitlement will be available for production and will be displayed with the status Queued in the Entitlements page. After you queue an Entitlement, you will be able to open the Entitlement to view its details, but you will not be able to change anything in the Entitlement. To queue the Entitlement, Click Queue. To make changes in an queued Entitlement, select the Entitlement from the Entitlements page and click Reopen. The status changes to Draft and the Entitlement can be edited. Produce an Entitlement

If all necessary information for the Entitlement has been specified, you can produce the Entitlement immediately. To produce the Entitlement, click Produce. The production pop-up for the relevant Entitlement type is displayed. For detailed information on producing an Entitlement, see: n

"Producing Product Keys for the Entitlement" on page 60

n

"Producing Sentinel HL Keys for the Entitlement" on page 61

n

"Producing Protection Key Update File for an Entitlement" on page 61 n

n

Before producing the Entitlement, click Cancel to return to the Production Entitlement pop-up to make changes in the Entitlement. After you produce an Entitlement, you will not be able to change any of the Entitlement details.

4.5. Updating Entitlement Details The Edit Entitlement screen enables you to update the details of an Entitlement. To edit an Entitlement:

60

Chapter 4: Managing Entitlements 1. On the main menu, click Entitlements. The Entitlements page appears. 2. In the Batch Code drop-down list select the Batch Code to which the Entitlement belongs. If you have permission on only one Batch Code or if Sentinel EMS has only one Batch Code, the Batch Code is displayed instead of the drop-down list. 3. Click

(Edit). The Edit Entitlement pop-up appears.

The Edit Entitlement screen is similar to the Create New Entitlement screen. Refer to "Creating an Entitlement" on page 51 for details. The Fields that you can edit depend on the status of the Entitlement. For Draft Entitlements, you can edit all fields except for the Protection Type. If the Entitlement has in any other status, you can change the Ref ID 1, Ref ID 2, and Description.

4.6. Producing Entitlements The production process differs depending upon whether you have chosen Product Keys, Sentinel HL Keys, or Protection Key Update. n

"Producing Product Keys for the Entitlement" on page 60

n

"Producing Sentinel HL Keys for the Entitlement" on page 61

n

"Producing Protection Key Update File for an Entitlement" on page 61

4.6.1. Producing Product Keys for the Entitlement The Produce Product Keys pop-up enables you to generate a file containing the Product Keys for the order. Up to 10,000 Product Keys can be produced at a time, and up to 10,000 activations can be specified for each key. To produce the Product Keys for the order: 1. Select the Entitlement to produce in the Entitlements page. 2. Click

(Action) > Produce. The File Download dialog box appears.

3. Save the file. In some browsers like Google Chrome and Internet Explorer 9 (IE9), the file download behavior may be different. Here are some examples. n

n

Chrome—By default Chrome downloads files to ..My Documents\Download folder. However, you can edit the browser settings to change this default location or you can instruct the browser to ask the location before download. IE9—If you are not able to download the file, try these steps. Click Tools > Internet Options. Click the Advanced tab. Clear the Do not save encrypted pages to disk check box. Click OK. Close all Internet Explorer windows and reopen.

The file contains the generated Product Keys. You can copy and paste the Product Key strings. The status of the Entitlement changes to Product Keys generated in the Entitlements page.

4.6. Producing Entitlements

61

4.6.2. Producing Sentinel HL Keys for the Entitlement To produce Sentinel HL keys, in the Entitlements page select a an Entitlement with Sentinel HL key ( ) type, then click (Action) > Produce). The Produce Sentinel HL Keys pop-up appears. This pop-up enables you to write (burn) an Entitlement to the connected Sentinel HL keys. You may be prompted to download and copy some files to a specified location. If you do not have appropriate permissions to copy the files to this location, your system administrator can help you to copy the files. Customer

Name of the Customer for whom the key is being burned.

E-mail

E-mail of the Customer.

Quantity

The number of Sentinel HL keys ordered.

Remaining

The number of Sentinel HL keys remaining to be produced.

Ref ID 1 and Ref ID 2

Information that identifies the order in a different system, for example, an order code in your company's ERP system.

Entitlement Comments

Text information related to the production of this Entitlement.

Products

All Products available in the order and their Locking Types are listed in a table.

Valid Keys

Graphic representations of the Sentinel HL key types that are valid for the order.

To produce the Sentinel HL keys: 1. Connect the valid Sentinel HL keys. 2. Click Refresh. The available keys are displayed below the Valid Keys graphic. To locate keys, click Blink. The LED of the selected keys blink for 5 seconds. 3. Select a key and click Burn. The order is written to the Sentinel HL key and the production totals (Quantity and Remaining) are updated. For Sentinel HL key for which orders are already pending (for example, if there are already V2C files for the key that have not been applied) the pending orders will be overwritten. 4. Remove the Sentinel HL keys.

4.6.3. Producing Protection Key Update File for an Entitlement The Produce Protection Key Update pop-up enables you to generate files containing the Protection Key Update information for the Entitlement. A separate file is generated for each Sentinel protection key that is to be updated. You can select to generate V2C files or EXE files containing V2C data. Customer

Name of the Customer for whom the key is being burned.

E-mail

E-mail of the Customer.

62

Chapter 4: Managing Entitlements

Activations The number of Sentinel HL keys ordered. Remaining The number of Sentinel HL keys remaining to be produced. Activations Ref ID 1 and information that identifies the order in a different system, for example, an order Ref ID 2 code in your company's ERP system. Entitlement Text information related to the production of this Entitlement. Comments Products

All Products available in the order and their Locking Types are listed in a table.

Clear key before applying updates

Select this to cancel all existing Products and Features in a key before the update is applied. This is useful, for example, if Features or Products have been discontinued. (This option does not clear data from the key memory.)

To produce the Protection Key Update file: 1. Select the Entitlement that is to be updated. 2. Click

(Action) > Produce. The Generate License pop-up appears.

3. Select the type of file to contain the Protection Key Update details for delivery to end users: n

Select V2C to produce files that can be used with the RUS.

n

Select EXE to produce executable files containing V2C data.

4.7. Deleting an Entitlement

63

4. Select Clear key before applying updates to cancel all existing Products and Features in a key before the update is applied. This is useful, for example, if Features or Products have been discontinued. (This option does not clear data from the key memory.) 5. Click Generate. The Activation Details for the keys are displayed in the lower pane.

6. Click the Download V2C File/Download All V2C Files link. 7. Save the V2C files. The name of each file includes the key ID for the Sentinel protection key that is to be updated. The status of the Entitlement changes to Completed in the Entitlements page.

4.7. Deleting an Entitlement You can delete an Entitlement only if its life cycle stage is Draft. To delete an Entitlement: 1. Select an Entitlement from the left pane. 2. Click

(Action) > Delete.

3. In the pop-up that appears, click Yes.

4.8. Changing the Entitlement Status 4.8.1. Modifying Draft Entitlements You can edit the details of an Entitlement only if it is in Draft state. 1. Select an Entitlement from the left pane. 2. Click

(Edit). The Edit Entitlement pop-up appears.

3. Edit the fields as required. 4. Save as Draft, Queue, or Produce the Entitlement. Click one of the following: n

Save Draft—save the Entitlement in Draft state until it is ready to be added to the production queue.

64

Chapter 4: Managing Entitlements

n

Queue—make the Entitlement available for production.

n

Produce—produce the Entitlement immediately.

4.8.2. Modifying Queued Entitlements (Reopening) To change the status of a Queued Entitlement to Draft (allowing the Entitlement to be modified), click

(Action) > Reopen.

Reopen can be used for Entitlements whose status is: n

Queued (Entitlement has been Queued).

n

Product Keys generated. Reopening this order cancels the generated Product Keys.

4.9. Checking in C2V File The Check in C2V pop-up enables you to process and store the Sentinel security key information that is contained in a Customer-to-Vendor (C2V) file. This information can be used in connection with Protection Key Update orders. In addition, it enables you to format a key, or to generate a file that you can send to a Customer to format a key that is already deployed.

4.9. Checking in C2V File

65

4.9.1. To Check in C2V Data 1. On the main menu, click Entitlements > Check In C2V. The Check In C2V pop-up appears. 2. Click Choose Files. The file Open dialog box appears. 3. Browse for the folder where the C2V file is located. Select the C2V file you wish to check-in and click Open. You can select multiple C2V files. The C2V data is processed and the identification information of the keys is displayed, including the C2V file name, Key ID, Batch Code, and the locking type of the key. Also, the Check In button is enabled. 4. Select a C2V and click Check In. If previous updates are pending for the C2V file, the file will not be checked in to the Sentinel EMS database, and "You have # pending updates" message is displayed. You will need to apply or remove the pending updates before checking in the C2V file. For additional information, see Removing/Applying Pending Updates. If the C2V file for a Sentinel SL key has been sent from a cloned machine, the C2V file will not be checked in to the Sentinel EMS database, and the Clear Clone button becomes active. Note that you can view the details of a C2V from a cloned machine by clicking View Details in the Check in C2V pop-up. For additional information about working with C2V files from cloned machines, see "Enabling Licenses that have been Disabled due to Clone Detection" on page 67. 5. To view the Feature and memory details in a file, click View Details.

4.9.2. Removing/Applying Pending Updates If previous updates are pending for a C2V file then you need to remove or apply these before applying new updates. To remove/apply pending updates: 1. Select a C2V file and click Check In. If previous updates are pending for the C2V file, "You have # pending updates" message is displayed. You will need to apply or remove the pending updates.

66

Chapter 4: Managing Entitlements

n

To remove all pending updates, click Remove.

n

To apply pending updates a. Click View. The Pending Updates dialog box appears.

b. Select the Product Key and click Generate to generate the V2C file for the pending updates.

4.9.3. Formatting a Sentinel Protection Key Formatting a key erases all license and memory data stored in the key and resets the data for that key in the EMS database. Formatting can be applied in the following ways: n

n

By formatting a locally connected Sentinel HL key By creating an update file (V2C) for a Sentinel protection key that is already deployed in the field. The file can be sent to an end user to apply locally using the Sentinel Remote Update System (RUS).

W ARN I N G : For m atting a Se ntine l pr ote c tion ke y de le te s all lic e nse data fr om the key. To format a locally connected Sentinel HL key:

When a Sentinel HL key is received from a customer, you need to check in the information, in order to make the data in the key available to Sentinel EMS. Next you can format the key. 1. Click Entitlements > Check In Key. 2. Select the key and click Check In. The key is checked in and the Format button is enabled. 3. Click Format. A message appears, warning that all license data will be deleted from the key. 4. Click Yes to confirm and continue. The key is formatted and a success message is displayed. To generate an update file (V2C) for formatting a remote Sentinel protection key:

When a C2V file is received from a Customer, you need to check in the information, in order to make the data in the file available to Sentinel EMS.

4.9. Checking in C2V File

67

1. Click Entitlements > Check In C2V. 2. Click Choose Files. The file Open dialog box appears. 3. Browse for the C2V file you wish to check-in, then click Open. The location of the C2V file is displayed and the Check In button is enabled. 4. Click Check In. The C2V file is checked in and the Format button is enabled. 5. Click Format. A message appears, warning that all Features will be deleted from the key and a Protection Key Update will be created to delete all license data from the remote key. 6. Click Yes to confirm and continue. The File Download dialog box appears. 7. Save the V2C file. The default name for the file is displayed as FormatKey_[unique ID of key].v2c. To apply the Format Key file to a Sentinel protection key at the end-user site:

1. Ensure that the Sentinel HL key is connected. 2. Navigate to and select the location where your RUS utility is stored. Double-click rus.exe. The Sentinel RUS pop-up appears. 3. Click the Apply License Update tab. (This might be the only tab displayed.) 4. Click Browse to navigate to the V2C file containing the license update that you received. Select the V2C file and click Open. The file name and path of the V2C file is displayed in the Update File field. 5. Click Apply Update to apply the new license data to your Sentinel Protection key.

4.9.4. Enabling Licenses that have been Disabled due to Clone Detection If Sentinel EMS detects that the licenses for one or more applications that are locked to a Sentinel SL Legacy key are running on a cloned machine, those applications will be disabled until the disabled licenses are cleared from the Sentinel SL Legacy key and new licenses applied. In order to clear disabled licenses, you can use the Clear Cone feature in the Check in C2V process to generate a special V2C file. Clearing a Sentinel SL Legacy key does not format the key. To create a V2C file to clear a Sentinel SL Legacy key that has been disabled due to clone detection: 1. On the main menu, click Entitlements > Check In C2V. The Check In C2V pop-up appears. 2. Click Choose Files. The file Open dialog box appears. 3. Browse for the folder where the C2V file is located. Select the C2V file and click Open. 4. Select the C2V and click Check In. If the C2V file has been sent from a cloned machine the Clear Clone button becomes active. you can view the details of a C2V from a cloned machine by clicking View Details in the Check in C2V pop-up. 5. Save the V2C file.

68

Chapter 4: Managing Entitlements

4.10. Checking in Key Data The Check In Key pop-up enables you to process and store the Sentinel security key information that is stored in a connected Sentinel HL key. This information can be used in connection with Protection Key Update orders. In addition, it enables you to format a key, or to generate a file that you can send to a Customer to format a key that is already deployed.

To check in Key Data 1. On the main menu, click Entitlements > Check In Key. The Check In Key pop-up appears. You may be prompted to download and copy some files to a specified location. If you do not have appropriate permissions to copy the files to this location, your system administrator can help you to copy the files. 2. Connect the Sentinel HL keys. The C2V data on all the connected Sentinel HL keys is processed and their identification information is displayed, including the Key ID, Key Type, and Batch Code. 3. Select a key from the list and click Check In. If previous updates are pending for a key, it will not be checked in to the Sentinel EMS database, and "You have # pending updates" message is displayed. You will need to apply or remove the pending updates before checking in the key (refer to the next section). 4. To view the Feature and memory details in a key, click View Details.

4.11. Recycling Keys

4.10.1. Removing/Applying Pending Updates If previous updates are pending for a key then you need to remove or apply these before applying new updates. To remove/apply pending updates: 1. Select a Key and click Check In. If previous updates are pending for the Key, "You have # pending updates" message is displayed. You will need to apply or remove the pending updates. n

To remove all pending updates, click Remove.

n

To apply pending updates a. Click View. The Pending Updates dialog box appears. b. Select the Key and click Generate to generate the pending updates.

4.11. Recycling Keys The Recycle Keys pop-up enables you to format one or more Sentinel HL protection keys for reuse, deleting all license data on each key. The following buttons are available: Recycle Recycles the selected keys by deleting all license data on the key and uncompleted order data in Sentinel LDK. Blink

Causes the LED of the selected keys to blink for 5 seconds.

Refresh Refreshes the list of keys displayed in the window. To format selected Sentinel protection keys: 1. On the main menu, click Entitlements > Recycle. The Recycle Keys pop-up appears. You may be prompted to download and copy some files to a specified location. If you do not have appropriate permissions to copy the files to this location, your system administrator can help you to copy the files. 2. From the Sentinel Key ID list, select the keys to be recycled 3. Click Recycle. All license and uncompleted order data is deleted.

69

5 Chapter 5: Managing Product Keys The Product Keys page displays information about the Product key and enables you to intervene in the activation status of a Product at a Customer's site. To reach the Product Keys page, on the main menu click Entitlements > Product Keys. The left pane displays a list of all Product keys and provides the following information about each Product key: Status

Indicates the current status of the Product Key. Enabled Disabled

Product Key The Product Key string. Customer

Name of the Customer who placed the order.

Remaining The remaining number of activations.

5.1. Filtering and Searching the Product Keys List 1. Select an option from the search drop-down list from Customer, E-mail, Product Key, Product, Ref ID 1, Ref ID 2, or EID. 2. Provide the complete or partial search string in the field that follows. 3. Click

. The list shows the relevant search results.

5.2. Viewing the Details of a Product Key You can display information about the activation status of the Product key, the Customer, and the order that was used to produce the Product key. To view the details of a Product Key, select a Product Key from the left pane. The details are displayed in the right pane.

5.3. Tasks for Managing Product Keys (Edit)

View or (where applicable) modify the details of the selected Product key. See "Modifying Product Key Details" on page 72 for details.

(Action) > Activate

Activate the selected Product Keys for the end user. See "Generating a V2C File to Manually Activate a Product" on page 72 for details.

72

Chapter 5: Managing Product Keys

(Action) > Previous Activations

View activations that are already performed for a Product key. This task appears for Product keys for which at least one activation has been performed. See "Viewing Previous Activations for a Product Key" on page 74 for details.

5.4. Modifying Product Key Details You can modify the Product key details such as the Customer and E-mail. You may also enable/disable a Product Key, and increase or decrease the number of activations corresponding a Product Key.

5.4.1. Enabling or Disabling a Product Key You can disable a Product key so that the Product cannot be activated (for example, if the Product key was lost). Similarly, you can enable a Product key that was disabled. To enable or disable a Product key: n

If the status Disabled is displayed, click Enable to enable the Product key.

n

If the status Enabled is displayed, click Disable to disable the Product key.

5.4.2. Increasing/Decreasing the Number of Activations for a Product Key You can increase/decrease the number of Activations available for a Product key (for example, if a Customer experienced a problem activating the Product). To increase/decrease the number of Activations: 1. Click the Increase (or Decrease) radio button. 2. Click Save. The Product Keys page appears, displaying the remaining activations for the Product Key.

5.5. Generating a V2C File to Manually Activate a Product You can generate a file that, when applied, enables a Customer to manually activate a Product. Before you can generate a manual Product activation file, you must receive the Product Key, and a C2V file for the Customer's Sentinel protection key. The output of the manual activation file generation process is a V2C file that can be sent to the Customer. Following application of the V2C file, you can request that the Customer creates and returns a C2V file to you to confirm that the Product has been activated.

5.5. Generating a V2C File to Manually Activate a Product

To generate a manual Product activation file: 1. There are two ways to reach the Generate License page. n

From the Product Key page. a. On the main menu click, Entitlements > Product Keys. b. Select the Product Key from the list. c. Click

n

(Action) > Activate.

From the Entitlements page. a. On the main menu click, Entitlements > Entitlements. b. Select the Entitlement to which the Product Key is related. c. Click

(Action) > Activate.

2. In the Upload C2V field click the browse button to select the C2V file received from the Customer. 3. In the Comments field you can put additional information. 4. Click Generate. The File Download dialog box appears. 5. Save the V2C file. The file name includes a unique ID and the date and time the file was created.

73

74

Chapter 5: Managing Product Keys

If the original C2V file, which was submitted by the Customer together with the Product Key, indicates that the Product is installed on a cloned machine, you will not be able to generate an activation V2C file. For information on clearing a Sentinel SL key on which cloning has been detected, see "Enabling Licenses that have been Disabled due to Clone Detection" on page 67.

5.6. Viewing Previous Activations for a Product Key The Previous Activations pop-up displays information about the activations that are already performed for a Product key. This task appears for Product keys for which at least one activation has been performed. To view the previous activations for a Product key: 1. On the main menu click, Entitlements > Product Keys. 2. Select the Product Key from the list. 3. Click

(Action) > Previous Activations. The Previous Activations pop-up appears.

The following information is displayed for the Product key: Product Key, Customer, E-mail, Activations, Remaining Activations, Ref ID 1, Ref ID 2, Entitlement Comments, Products, Product Locking Type, Key ID, Key Type, Activation Date, Comments

5.7. Activation by End User

75

You can perform the following task in this screen: Download V2C File—Download the V2C file for the listed Protection key IDs. The Customer can apply the V2C file using a tool like RUS.

5.7. Activation by End User The end user can log on to Sentinel EMS using the Product key provided to him. He can access the portal by using the following URL: http://:/ems/customerLogin.html Here, and stand for the domain name and port of Sentinel EMS server. After the end user logs on to Sentinel EMS, a registration page appears if it has been specified by the Entitlement Manager (see user registration). The end user needs to provide some basic information and click Save. The page that follows displays the Product key details. On that page, the end user gets two options to activate the Product key: n

n

Online Activation—The end user can activate the Product key in the same machine. The activation process is automatic and does not require any further action. Offline Activation—The end user can use this option to activate the Product key in some other machine. This process requires the end user to provide a C2V file generated on the target machine. After activation, the end user will have to apply the V2C file generated on the target machine using the RUS tool.

76

Chapter 5: Managing Product Keys

Steps for offline activation: 1. Clicks Offline Activation. The Generate License page appears.

2. Runs the RUS tool on the destination machine to generate a C2V file and brings the file to his machine. The RUS tool can be downloaded from the link provided in the pop-up. 3. Uploads the C2V file. 4. Clicks Generate. 5. The Download V2C File dialog box appears. 6. Downloads the V2C file and applies it on the destination machine using the RUS tool.

6 Chapter 6: Development Use Sentinel EMS to perform the development-related tasks necessary for protecting your software. The various development-related activities that can be performed include: n

"Generating a Bundle of Provisional Products" on page 77

n

"Exporting a List of Definitions" on page 78

n

"Branding the Remote Update System" on page 79

n

"Generating the RTE Installer" on page 80

6.1. Generating a Bundle of Provisional Products The Bundle Provisional Products pop-up enables you to define a bundle of one or more Provisional Products that can be distributed as trialware or for use during a grace period. It is also possible to produce a bundle of Provisional Products that do not have trialware or grace period attributes, but which must be immediately activated by the end user to enable the software to run. To generate this type of bundle, use the procedure for preparing a recipient machine for a detachable license. In the installation, include a prompt for the end user to register the Product Key in order to activate the application. After you have created the Provisional Products bundle, you produce an output file that contains the Provisional Product license and the Vendor DLL that is installed on the end-user machine.

To produce a bundle of Provisional Products:

78

Chapter 6: Development 1. On the main menu, click Developer > Bundle Provisional Products. The Bundle Provisional Products page appears. 2. From the Batch Code drop-down list, select a Batch Code. 3. Click Actions > Add. The Products pop-up appears, showing the list of Provisional Products that have been defined for the selected batch. 4. Select one or more Provisional Products to add to the bundle, and click OK. The selected Provisional Product is added to the Product Details list. 5. Produce the desired output file: n

Click Produce V2C to produce a file that can be used with RUS.

n

Click Produce EXE to produce an executable file containing V2C data.

The File Download dialog box appears. In order to generate a Sentinel Run-time Environment installer executable that uses this file, you must generate a V2C file. An EXE file containing V2C data cannot be used to generate a Sentinel Run-time Environment installer. 6. Save the file.

6.2. Exporting a List of Definitions The Export Definitions List pop-up enables you to create a file containing the Feature Name and Feature ID of all defined Features, together with the Product Names and Product IDs in which they are incorporated. You can select one of the following output file types: n

Metadata in Admin Control Center format (an XML file used to display metadata about Sentinel protection keys in Admin Control Center) For more information, refer to the Sentinel LDK Software Protection and Licensing Manual.

n

Features and Products in C-style header

n

Features and Products in CPP-style header

n

Features and Products in XML format

n

Features in CSV format

Click a file type in the list above to see an example of an output file containing a list of data.

To export definitions to a file:

6.3. Branding the Remote Update System

79

1. On the main menu, click Developer > Export Catalog Definitions. The Export Catalog Definitions pop-up appears. 2. From the Batch Code drop-down list, select a Batch Code. 3. In the Export File Type drop-down list, select the required file type. 4. Click Export. The File Download dialog box appears. 5. Save the file.

6.3. Branding the Remote Update System The Sentinel Remote Update System (RUS) is an executable utility that you can customize (brand), and send to your end users to enable secure, remote updating of the license and memory data of Sentinel protection keys after they have been deployed. RUS branding enables you to associate the RUS utility with the Batch Code of the keys that you want to update. You can also define, format, and preview the GUI that is to be displayed in the RUS.

To brand an RUS executable: 1. On the main menu, click Developer. The RUS Branding page appears. 2. From the Batch Code drop-down list, select a Batch Code. 3. Brand RUS by defining the text to be displayed when RUS is launched. n

You can format the text as required.

n

You can insert a link.

n

You can insert an image, which should be in PNG format.

4. If you select Limit to HL only, the generated RUS tool will only be available for HL keys. 5. If you select Replace default RUS file, the generated RUS tool will overwrite the default RUS tool of Sentinel EMS. The default RUS tool is available for download in the Generate License and Activation screens (for example, see "Generating a V2C File to Manually Activate a Product" on page 72).

80

Chapter 6: Development 6. Click Generate. The File Download dialog box appears. 7. Save the file.

6.4. Generating the RTE Installer The Generate Run-time Environment (RTE) Installer page enables you to create a Sentinel Run-time Environment executable or DLL file that simplifies the installation process at the end user sites. You can embed the RTE executable or DLL in your software setup to create a ready-to-run Sentinel LDK-protected and licensed application. The input to this process is a V2C file containing your vendor-specific data. For Provisional Products, the V2C file also contains the Provisional Product bundle data. When packaging a RTE installer with a V2C file for one or more Products in Sentinel EMS, you cannot include a Product that only has the locking type SL-UserMode.

To generate the RTE installer: 1. On the main menu, click Developer > RTE Installer. The RTE Installer page appears. 2. From the Batch Code drop-down list, select a Batch Code. 3. Select the type of file you want to generate in the Installer Type radio buttons: n

EXE: Creates a Run-time Environment command line installer.

n

DLL: Creates a DLL for use with the Run-time Environment Installer API.

n

n

Mac: Creates a Package (in a TAR archive) containing the Sentinel Run-time Installer GUI. Linux: Creates a Package (in a TAR archive) containing the Sentinel Run-time Installer GUI.

4. In the V2C File Location field, type or browse to the location of the V2C file that contains the relevant data, and select the file. 5. Click Generate. The File Download dialog box appears.

6.4. Generating the RTE Installer

81

6. Save the file. The file/package name is haspdinst.exe, haspds_windows.dll, Sentinel_Runtime.tar, or aksusbd-1.16.1-i386.tar depending on the file type and operating system you selected. After you have created the Sentinel Run-time Installer, you must sign it. For information about signing an .exe file, go to "Signing the RTE Installer" on page 81. For general information about driver signing, go to the following Microsoft link: http://www.microsoft.com/whdc/winlogo/drvsign/drvsign.mspx

6.4.1. Signing the RTE Installer Digital signatures allow administrators and end users who are installing the Run-time Environment (RTE) to know that the software is provided by a legitimate publisher. In addition, certain Windows operating systems enforce the use of digital signatures for some types of code. In these cases, installing unsigned software requires a higher authorization level. SafeNet highly recommends that you apply your digital signature to the RTE installer to simplify installation of the RTE by the end users and increase their confidence in the software. The procedure that follows describes how to apply your digital signature to an RTE installer .exe file. To apply your digital signature to the RTE installer (.exe file): 1. Obtain a digital signature from one of the certification authority providers. 2. Prepare a batch (.bat) file that contains the following command: signtool.exe sign /v /p /f /n "" /t http://timesta mp.verisign.com/scripts/timestamp.dll

where: n

password—password for opening the .PFX signature file

n

pfxSignatureFile—path and name of your signature file

n

subject—name of the subject of the signing certificate

n

rteInstallerExe—name of the RTE installer file

For example: signtool.exe sign /v /p pwN#%12A /f abcsoft.pfx /n "ABC Software Inc." /t http://timestam p.verisign.com/scripts/timestamp.dll haspdinst.exe

3. Place the batch file in the same directory as the signtool.exe program and the RTE installer. Execute the batch file. The signtool.exe program is provided by Microsoft as part of the Windows SDK. For more information about driver signing, go to the following Microsoft link: http://www.microsoft.com/whdc/winlogo/drvsign/drvsign.mspx

7 Chapter 7: Managing Customers and Channel Partners This section provides an overview on how you can manage Customers and Channel Partners. Following are few definitions: n

n

Customer—In Sentinel EMS a Customer refers to a current or potential buyer or user of your Products. Typically, you generate Entitlements for a Customer who has placed an order. Customers can be of two types: individual and organization. o

Company—Refers to a company as Customer with multiple users. You need to specify a default contact e-mail.

o

Individual—Refers to individuals or retail Customers who may buy your Products directly from you. For individual Customers you need to specify an e-mail.

Channel Partner—A Channel Partner can be an individual or company whom you allow to resell your Products. o

Company—Refers to a company as a Channel Partner with multiple users. You need to specify a default contact e-mail.

o

Individual—Refers to individual Channel Partners. For individual Channel Partners you need to specify an e-mail.

7.1. Managing Customers To reach the Customers page, on the main menu click Customers. The left pane displays a list of all Customers and provides the following information about each Customer: Status

The current status of the Customer. Enabled Disabled

Type

Indicates the Customer type: Individual Company

Name

The name of the Customer who placed the order.

Ref ID

Reference ID of the Customer in another system.

84

Chapter 7: Managing Customers and Channel Partners

7.1.1. Filtering and Searching the Customers List 1. Select an option from the search drop-down list from Customer, CRM ID, Ref ID, and Email Contains. 2. Provide the complete or partial search string in the field that follows. 3. Click

. The list shows the relevant search results.

7.1.2. Viewing the Details of a Customer To view the details of a Customer, select a Customer from the left pane. The details are displayed in the right pane.

7.1.3. Tasks for Managing Customers New Customer

Define a new Customer and its properties. Refer to "Creating a Customer" on page 85 for details.

(Edit)

View and edit the properties of the selected Customer.

(Action) > Delete

Delete the selected Customer. This task is listed only if no Entitlements exist for the Customer.

(Action) > Disable / Enable

Disable or enable a Customer. Entitlements cannot be created for disabled Customers.

7.1.4. Tasks for Managing Contacts (for Company-type Customers) For Company-type Customer, you can specify multiple Contacts and edit their details. The Contact Association pane appears at the bottom-right of the page.

New Contact

Create a Contact for a Company-type Customer. This task does not appear for Individual-type Customers. See "Creating/Updating a Contact for a Company-type Customer" on page 87.

(Action) > Disable / Enable

Disable or enable a Contact. Disabled Contacts cannot login to Sentinel EMS.

(Edit)

View and edit the properties of the selected Contact.

7.1. Managing Customers

See "Creating/Updating a Contact for a Company-type Customer" on page 87. (Action) > Delete Delete the selected Contact. You cannot delete Contacts for which Entitlements exist. (Action) > Set as Mark the selected Contact as the default Contact for the Customer. Default

7.1.5. Creating a Customer The Create Customer screen enables you to define a new Customer. 1. On the main menu, click Customers. The Customers page appears. 2. Click New Customer. The Create Customer screen appears. 3. Specify whether the Customer Type is Company or Individual. 4. For Company-type Customer provide the following information. o

Company Name—Enter a name for the company.

o

Telephone and Fax—Enter telephone and fax numbers.

o

CRM ID and Ref ID— Enter values for CRM ID and Ref ID if required.

o

Description—Enter a description for the Customer.

o

Batch Code—(Optional) Associate a Batch Code with the Customer. The Customer will be available for Entitlements in the same Batch Code.

o

Contact Information—The Contact Information pane appears for Company type customers. This is optional. However, if you provide values in any of the required (*) fields, then you need to fill all the required fields in this pane. Following fields are available:

85

86

Chapter 7: Managing Customers and Channel Partners o

First Name, Middle Name, and Last Name—Provide a name for the Contact.

o

E-mail—Enter the e-mail address of the Contact.

o

Locale—Select the preferred language for the Contact.

5. For Individual-type Customer provide the following information. o

First Name, Middle Name, and Last Name—Provide a name for the Customer.

o

E-mail—Enter the e-mail address of the Customer in the field.

o

Locale—Select the preferred language for the Customer.

o

Batch Code—(Optional) Associate a Batch Code with the Customer. The Customer will be available for Entitlements in the same Batch Code.

o

Telephone and Fax—Enter telephone and fax numbers.

o

CRM ID and Ref ID— Enter values for CRM ID and Ref ID if required.

6. In the Billing Details pane, enter the billing address. 7. To specify a shipping address same as the billing address ensure that the Shipping details are same as billing details check box is selected. To specify a different shipping address, clear this check box—the Shipping Details pane is displayed. Enter the shipping address. 8. Click Save.

7.1.6. Updating Details of a Customer 1. Select a Customer. 2. Click

(Edit). The Edit Customer pop-up appears.

3. Edit the fields as required. 4. Click Save.

7.1.7. Deleting a Customer You can delete a Customer only if there are no Entitlements for him. To delete a Customer: 1. Select a Customer from the left pane. 2. Click

(Action) > Delete.

3. In the pop-up that appears, click Yes.

7.1.8. Enabling/Disabling a Customer 1. Select a Customer from the left pane. 2. Click

(Action) > Enable (or Disable).

7.2. Managing Channel Partners

87

7.1.9. Creating/Updating a Contact for a Company-type Customer The Create Contact pop-up enables you to define a new Contact for a Customer. The Edit Contact pop-up is similar to this screen and allows you to update the details of an existing Contact.

To create/update a Contact: 1. On the main menu, click Customers. The Customers page appears. 2. Select a Company-type Customer ( ) from the left pane. 3. In the Contact Association pane do one of the following: n

n

To create a new Contact for this Customer, click New Contact. The Create Contact pop-up appears. To update the details of an existing Contact, select the Contact from the list and click (Edit). The Edit Contact pop-up appears.

The Create Contact and Edit Contact pop-up windows are similar. 4. Enter/update First Name, Middle Name (optional), and Last Name for the Contact. 5. Enter/update the e-mail address of the contact in the E-Mail field. 6. To change the preferred language for the Contact, select a language from the Locale dropdown list. 7. Click Save.

7.2. Managing Channel Partners To reach the Channel Partners page, on the main menu click Customers > Channel Partners. The left pane displays a list of all Channel Partners and provides the following information about each Channel Partner: Status

The current status of the Channel Partner. Enabled Disabled

Type

Indicates the Channel Partner type: Individual Company

88

Chapter 7: Managing Customers and Channel Partners

Name

The name of the Customer who placed the order.

Ref ID

Reference ID of the Channel Partner in another system.

7.2.1. Filtering and Searching the Channel Partners List 1. Select an option from the search drop-down list from Channel Partner, CRM ID, Ref ID, Email Contains. 2. Provide the complete or partial search string in the field that follows. 3. Click

. The list shows the relevant search results.

7.2.2. Viewing the Details of a Channel Partner To view the details of a Channel Partner, select a Channel Partner from the left pane. The details are displayed in the right pane.

7.2.3. Tasks for Managing Channel Partners New Channel Partner (Edit)

Define a new Channel Partner and its properties. Refer to "Creating a Channel Partner" on page 89. View and edit the properties of the selected Channel Partner. See "Updating the Details of a Channel Partner" on page 90.

(Action) > Delete

Delete the selected Channel Partner. This task is listed only if no Entitlements exist for the Channel Partner.

(Action) > Disable / Enable

Disable or enable a Channel Partner. Entitlements cannot be created for disabled Channel Partners.

(Action) > Create Contact

Create a Contact for a Company-type Channel Partner. This task does not appear for Individual-type Channel Partners.

7.2.4. Tasks for Managing Contacts (for Company-type Channel Partners) For Company-type Channel Partners, you can specify multiple Contacts and edit their details. The Contact Association pane appears at the bottom-right of the page.

New Contact

Create a Contact for a Company-type Channel Partner. This task does not

7.2. Managing Channel Partners

89

appear for Individual-type Channel Partners. See "Creating/Updating a Contact for a Company-type Channel Partner" on page 90 (Action) > Disable / Enable

Disable or enable a Contact. Disabled Contacts cannot login to Sentinel EMS. View and edit the properties of the selected Contact. See "Creating/Updating a Contact for a Company-type Channel Partner" on page 90.

(Edit)

(Action) > Delete

Delete the selected Contact. You cannot delete Contacts for which Entitlements exist.

(Action) > Set as Default

Mark the selected Contact as the default Contact for the Channel Partner.

7.2.5. Creating a Channel Partner The Create Channel Partner screen enables you to define a new Channel Partner. 1. On the main menu, click Customers > Channel Partners. The Channel Partners page appears. 2. Click New Channel Partner. The Create Channel Partner pop-up appears. 3. Specify whether the Channel Partner Type is Company or Individual. 4. For Company-type Channel Partner, provide the following information. o

Company Name—Enter a name for the company.

o

Telephone and Fax—Enter telephone and fax numbers.

o

CRM ID and Ref ID— Enter values for CRM ID and Ref ID if required.

o

Description—Enter a description for the Channel Partner.

o

Contact Information—The Contact Information pane appears for Company-type Channel Partners. This is optional. However, if you provide values in any of the required (*) fields, then you need to fill all the required fields in this pane. Following fields are available: o

First Name, Middle Name, and Last Name—Provide a name for the Contact.

o

E-mail—Enter the e-mail address of the Contact.

o

Locale—Select the preferred language for the Contact.

5. For Individual-type Channel Partner provide the following information. o

First Name, Middle Name, and Last Name—Provide a name for the Channel Partner.

o

Contact E-mail—Enter the e-mail address of the Channel Partner in the field.

90

Chapter 7: Managing Customers and Channel Partners o

Locale—Select the preferred language for the Channel Partner.

o

Telephone and Fax—Enter telephone and fax numbers.

o

CRM ID and Ref ID— Enter values for CRM ID and Ref ID if required.

6. In the Billing Details pane, enter the billing address. 7. To specify a shipping address same as the billing address ensure that the Shipping details are same as billing details check box is selected. To specify a different shipping address, clear this check box. The Shipping Details pane is displayed. Enter the shipping address. 8. Click Save.

7.2.6. Updating the Details of a Channel Partner 1. Select a Channel Partner. 2. Click

(Edit). The Edit Channel Partner pop-up appears.

3. Edit the fields as required. 4. Click Save.

7.2.7. Deleting a Channel Partner You can delete a Customer only if there are no Entitlements for him. To delete a Customer: 1. Select a Customer from the left pane. 2. Click

(Action) > Delete.

3. In the pop-up that appears, click Yes.

7.2.8. Enabling/Disabling a Channel Partner 1. Select a Channel Partner from the left pane. 2. Click

(Action) > Enable (or Disable).

7.2.9. Creating/Updating a Contact for a Company-type Channel Partner The Create Contact pop-up enables you to define a new Contact for a Channel Partner. The Edit Contact pop-up is similar to this screen and allows you to update the details of an existing Contact.

7.2. Managing Channel Partners

91

To create/update a Contact: 1. On the main menu, click Customers > Channel Partners. The Channel Partners page appears. 2. Select a Company-type Channel Partner ( ) from the left pane. 3. In the Contact Association pane do one of the following: n

n

To create a new Contact for this Channel Partner, click Create Contact. The Create Contact pop-up appears. To update the details of an existing Contact, select the Contact from the list and click Actions > Edit. The Edit Contact pop-up appears.

The Create Contact and Edit Contact pop-up windows are similar. 4. Enter/update First Name, Middle Name (optional), and Last Name for the Contact. 5. Enter/update the e-mail address of the contact in the E-Mail field. 6. To change the preferred language for the Contact, select a language from the Locale dropdown list. 7. Click Save.

8 Chapter 8: Working with Reports Sentinel EMS provides you with the ability to produce reports with valuable business information, based on data in the Sentinel EMS database. With this, managers can obtain data for analyzing how their software is used and the purchasing preferences of customers. The information can also be leveraged to maximize revenues from license renewals, to up-sell existing customers, and turn trial users into buyers. This chapter provides an overview of the Features and options available in the Reports functionality. Sentinel EMS reports provide access to selected current information from the Sentinel EMS database. Different predefined reports are available to meet various requirements. The reports provide information in tabular form and, where applicable, in a graphical chart. The Reports functionality can be accessed using the Reports tab in the main menu. On clicking this, a list of the available reports is displayed in the left pane, organized by category. This window enables you to specify parameters for a report and generate one for immediate viewing in the format specified. You can print the output file or save it for later use. The output format can be Comma Separated Values (CSV), Rich Text Format (RTF), Adobe Acrobat (PDF), HTML, or Microsoft Excel (XLS) files. The following n

"Available Reports" on page 93

n

"Generating a Report" on page 94

n

"Managing Scheduled Reports" on page 95

8.1. Available Reports Report Name

Input Parameters

Description

Entitlement Reports Customer Entitleme nt Report

n

Start Date

n

End Date

n

Customer Name

n

Partner Name

n

Enforcement (Sentinel LDK / Cloud)

Lists all Entitlements generated and summarizes them by Customer and date.

94

Chapter 8: Working with Reports

Report Name

Input Parameters n

Customer Activation Report

Total Entitleme nt Utilization

Output Format (HTML / PDF / Excel / RTF / CSV)

n

Start Date

n

End Date

n

Customer Name

n

Output Format (HTML / PDF / Excel / RTF / CSV)

n

Product

n

Customer Name

n

Description

Output Format (HTML / PDF / Excel / RTF / CSV)

Displays the Customer-wise Product activation report including the number of activations and the Products activated by each Customer.

Displays the Product-wise report for total number of activations, number of activations, and remaining activations.

License Reports License Expiration Report

n

Days Before Expiration

n

Start Date

n

End Date

n

Customer Name

n

Most Popular Products Ordered

n

number of days

Output Format (HTML / PDF / Excel / RTF / CSV)

n

Start Date

n

End Date

n

Partner Name

n

Enforcement (Sentinel LDK / Cloud)

n

Displays a list of licenses for which the end date falls within the specified n dates, or

Displays the Products that are used by the highest number of Customers.

Output Format (HTML / PDF / Excel / RTF / CSV)

Custom Reports If your Sentinel EMS administrator has defined some custom reports, these will be displayed at bottom of the left pane in the Reports page.

8.2. Generating a Report To generate a report 1. Click the Reports menu. 2. From the left pane, select a report. 3. In the right pane, enter the input parameters. 4. Select the output type from the Output Format drop-down list. 5. Click Generate Report.

8.3. Managing Scheduled Reports

95

The report is generated in the output format specified.

8.3. Managing Scheduled Reports To reach the Scheduled Reports page, on the main menu click Reports > Scheduled Reports. The Scheduled Reports page enables you to manage the scheduling and distribution of Sentinel EMS reports that are to be run automatically on a regular basis. The left pane displays a list of all scheduled reports and provides the following information about each report: Status

Scheduling status of the report. Possible values are: Active

The report will run as scheduled.

Suspended The report has been suspended and will not be returned to the schedule until it is resumed. Not Ready

The report has been created but a recipient has not been associated with it.

Report

Name of the report that is scheduled to run.

Frequency

When the report is scheduled to run.

8.3.1. Tasks for Managing Scheduled Reports You can perform the following tasks in the Scheduled Reports page: Define a new scheduled report. See "Scheduling a Report" on page 95.

Add

Modify the parameters and distribution list of the selected scheduled report. (Edit) Delete

Delete the selected scheduled report. The report will be removed from the schedule.

Add User Add a Sentinel LDK user as a recipient. See "Defining Recipients for a Scheduled Report" on page 97. Add Email

Add any e-mail address as recipient. See "Defining Recipients for a Scheduled Report" on page 97.

8.3.2. Scheduling a Report The Scheduled Reports page enables you to schedule a report to be periodically generated and distributed by e-mail to a distribution list. As part of the scheduling information, you specify: n

the report to use

n

output format of the report

n

report parameters

n

how often to generate the report

Each recipient receives the report in the selected format as an e-mail attachment or a link .

96

Chapter 8: Working with Reports

To schedule a report: 1. On the main menu, click Reports > Scheduled Reports. The Scheduled Reports page is displayed. 2. Click New Report. Or, to modify a previously scheduled report, select the report in the Scheduled Reports page and click (Edit). The Create Scheduled Report (or Edit Scheduled Report) pop-up appears. 3. From the Reports drop-list, select the report to generate. All pre-defined reports and custom reports appear in this list. One or more of the following fields are displayed depending upon the report you selected. n

n

Last—Select the duration of the report. For example, last day, last week, last month, etc. (You cannot select specific dates, since you are defining parameters to be reused on a periodic basis.) Customer Name—(Optional) Filter the report by a specified Customer. Type the first few characters of the Customer name. A list of matching names is populated. Select a name from the list. If you provide a Customer Name, the Contact Email Id drop-down list appears. You can also filter the report by this parameter.

n

n

n

Partner Name—(Optional) Filter the report by a specified Channel Partner. Type the first few characters of the Partner name. A list of matching names is populated. Select a name from the list. Product—(Optional) Filter the report by a specified Product. Days Before Expiration—(Optional) This field appears only for License Expiration Report. The licenses that are expiring within the specified number of days will be part of the report.

4. From the Output Format drop-down list, select the format in which the report should be generated. Available formats are PDF, Excel, RTF, HTML, and CSV. 5. Select the appropriate radio button for Delivery Type from the following: n

File—The recipient will receive an e-mail with the report file as an attachment.

n

Link—The recipient will receive an e-mail with a link to the report.

6. In the Expiration Period field, specify the number of days after which the report will expire. 7. In the Report Schedule pane, select the desired frequency, the time of day at which the report should be generated, and the time zone.

8.3. Managing Scheduled Reports

n

n

n

If you selected Daily, you must also select one or more specific days on which the report should be generated. If you selected Weekly, you must also select one specific day on which the report should be generated. If you selected Monthly, you can also select one specific day of the month on which the report should be generated. The default value is the first day of the month.

8. Click Save to save the scheduled report definition.

8.3.3. Defining Recipients for a Scheduled Report You can add either a Sentinel LDK user or any e-mail as a recipient. To add a Sentinel LDK user as a recipient:

1. Click Add User. The Add User pop-up appears. 2. Select one or more users to receive notifications. (Only users for whom an e-mail address was defined are listed.) 3. Click Save. Each selected user is added to the User Association pane. To add e-mail address for any other recipient:

1. Click Add E-Mail. The Add E-mail pop-up appears. 2. Enter a recipient name and e-mail address. 3. Click Save. The recipient is added to the User Association pane. 4. Repeat these steps for each recipient that you want to add to the list.

97

Glossary Base Product

An original Product that has been created from scratch from which other Products may be created. All Modification Products, Provisional Products and Cancellation Products are created from Base Products.

Batch Code

A code consisting of five characters that represent your company's unique Vendor Code. When you order Sentinel protection keys from SafeNet, you specify your Batch Code, which is then written to the keys before dispatch. In order to easily identify the batch to which a Sentinel HL key belongs, the Batch Code is written on the outside of each key. The Batch Code for Sentinel protection keys with a demo Vendor Code is DEMOMA.

Billing address

Billing address is the address registered on your credit card. In simple words, it is the address where you receive the statements for your credit card. For your order to be approved when shopping online, the billing address provided by you has to match this address.

C2V (Customer-toVendor) file

A file containing information on the actual status of one or more deployed Sentinel protection keys. C2V files are generated by end users using RUS, and can include data such as protected update counters, licenses, and memory images.

Caching Type

Specifies how your on-premise application requests and caches licenses from Cloud Connect Server. n Feature Level—Here, an application explicitly requests the required features. This type of on-premise licensing is primarily meant for applications running on client machines. The rights/licenses of a particular user are fetched from Cloud Connect and cached locally. A license request is fulfilled by Run-time either from local cache or by fetching it from Cloud Connect, if the license is not already present in local cache. A license is cached locally either at the time of first request for that license or explicitly when the application detaches the license from Cloud Connect for a specified interval of time. Since licenses for only the requested features are fetched to an on-premise machine based on a user identity, this type of licensing is called as Feature Level licensing

100

Glossary

n

Entitlement Level—Here, an application pulls an entire entitlement and all the products/features in it. This type of onpremise licensing is primarily meant for server applications. The protected application is hosted on an on-premise server machine, which is accessed by multiple thin clients. The Run-time fetches time-limited license slices and caches them locally. The licenses are fetched from Cloud Connect independent of the actual license requests made to Run-time. The Run-time always attempts to serve the individual license requests from the local cache. A license request never triggers a connection to Cloud Connect to fetch a license, even if the license request cannot be fulfilled locally. Since all features of an entitlement are fetched to an on-premise machine, this type of licensing is called Entitlement Level licensing.

Cancellation Product A Product that cancels the licensing details of another Product. A Cancellation Product can be used, for example: n To revoke a deployed license n

To cancel the license for a Product that has been returned before its license terms have expired

Catalog

Refers to the Features, and Products available in an EMS deployment.

Channel Partner

Refers to an company that is allowed to re-sell the publisher's Products. End users can buy directly from the publisher or from the channel partners.

Customer

Refers to the individual or company who places an order for your Products.

Demo Vendor Code

See DEMOMA

DEMOMA

Batch Code used for evaluation purposes with any Sentinel LDK application. Its corresponding Vendor Code is available in the VendorCodes folder of your Sentinel LDK installation.

Deployed

A Product (and the associated Features) for which Entitlements are created. A deployed Feature or Product cannot be deleted.

Detachable License

A Sentinel SL license that can temporarily be removed from a pool of network licenses and attached to a remote recipient machine for a defined period.

End Date

The date after which no operations, like login by Product Key and

101

(for an Entitlement) Activation are allowed on an Entitlement. Entitlement

A request for items to be shipped to a Customer, specifying one of the following: n One or more Products to be applied to Sentinel protection keys. The license terms of each Feature in the ordered Products can be specified when the Product is defined, or when the Entitlement is processed. n A Protection Key Update, specifying changes to be made to the license terms and/or data stored in one or more deployed Sentinel protection keys.

Entitlement status

The current status of an Entitlement: n Draft—The Entitlement is not yet ready to produce. It can be modified or deleted. n Queued—The Entitlement is ready to produce. n

n

n

n

Product Keys generated—In an Entitlement for one or more Sentinel Product Keys, the Product Keys have been generated. Produced—In an Entitlement that includes multiple Product Keys, at least one Product Key has been used to activate the protected software. The Entitlement contains additional Product Keys that have not yet been used. Completed—In an Entitlement for updates or for Sentinel HL keys, the entire Entitlement has been produced. In an Entitlement for Product Keys, all the Keys in the Entitlement have been used to activate the protected software. Acknowledged—Verification has been received that the Entitlement has been applied at the end user site.

Entitlements with status other than Draft cannot be modified or deleted. However, Entitlements with certain status can be reset to Draft. See Reopen.

Protection type

The way in which the Entitlement items (i.e., Products and Features available with the Entitlement) can be used: n Product Key—Associates the Entitlement items to one or more Product Keys. n Hardware Key—Writes the Entitlement items to one or more Sentinel HL keys. n Protection Key Update—Enables changes to be made to the license data stored in deployed keys.

Feature

An identifiable functionality of a software application that can be independently controlled by a license. In Sentinel, a Feature may be an

102

Glossary

entire application, a module or a specific functionality such as Print, Save or Draw. Features are combined to form Products. License terms are defined for each Feature in a Product. Feature ID

Unique identifier for a Feature in database.

Fulfillment

The complete process through which the Customer gets the Product and license.

Grace Period

A period of time during which a user may run software without activation. This allows end users to activate a Product when most convenient for them. During the grace period, and even after activation, end users can pass copies of their purchased software to as many friends as they wish. When a friend installs the software, it automatically reverts to a limited trial version for the entire grace period. After the grace period expires, the software can no longer run until it is activated with a Sentinel protection key. You can define a grace period for software protected with any Sentinel protection keys. For example, software protected with Sentinel HL keys can be purchased and delivered over the Internet while the Sentinel HL keys are shipped, and end users can start using the software while waiting for the arrival of their hardware key. To enable a grace period to be specified for a Product, the Product must be defined as Provisional.

License

Digital permit stored in a Sentinel protection key.

License planning

A task performed by business decision-makers, such as Product or Marketing Managers in an organization. The output of the license planning process is a repository of licensed Products that can be included in customer orders. Sentinel EMS can be used without a licensing plan.

License terms and license types

License terms are defined for each Feature in a Product, and consist of: n A license type n

A value for the license type

n

A value for concurrent use, if relevant

n

License accessibility settings

The following license types are available: n Execution Count—Specifies the maximum number of times the Feature can be used. n Expiration Date—Specifies the date on which the license expires.

103

Perpetual—Specifies that the license is valid for an unlimited period of time. n Time period—Specifies the number of days until the license expires, from the date of first use. The license term values for each Feature in a Product can be specified when the Product is defined, or when an order for the Product is processed. Network licenses that are locked to Sentinel SL keys may also be detachable. n

Locking Type

Determines the level of protection for a Product, according to the type of Sentinel protection key (HL or SL) supplied with the Product.

Memory data

Data, such as passwords, values used by the software, unique license terms, software version, site ID, and so on, that is specified in memory when a Product is defined or when an Entitlement is produced. This data is transferred to the Sentinel protection keys when: n A Sentinel HL key Entitlement for the Product is produced n

A Protection Key Update for the Product is applied

n

A Product is activated using a Sentinel SL key

Modification Product A modified version of another Product containing changes such as: n A software upgrade n

Extended license terms

n

Added or removed Features

For example, a Modification Product can be sent as a Protection Key Update, to an end user who has the original Product and wishes to replace it. Product

Product Group

A sellable item that contains one or more Features and/or data defined in memory for secure storage. License terms are defined for each Feature in a Product. A Product can be from any of the following types: n Base Products n

Modification Products

n

Provisional Products

n

Cancellation Products

Logical partitions within a Batch Code to contain Features and Products. Product Group has been deprecated from Sentinel EMS 6.3 onwards.

104

Glossary

Product Key

A string generated by Sentinel EMS and supplied to an end user for use as proof of purchase, for the following purposes: n Product Activation—The end user enters a Product Key that is sent to Sentinel EMS. A Sentinel SL key is sent back and installed on the users computer. n Update Activation—The end user enters a Product Key that is sent to Sentinel EMS. License updates and extensions are sent back to the connected Sentinel HL key or to the installed Sentinel SL key.

Product status

The current status of a Product: n Draft—The Product has been defined but has not yet been included in an Entitlement. It can be edited or deleted. n Complete—The Product has been included in at least one Entitlement. It is not possible to edit or delete the Product. n EOL (End of Life)—The Product is no longer available for Entitlements. The Product details are maintained for tracking purposes.

Production

The implementation of an Entitlement. Depending on the type of Entitlement, the production process involves one of the following: n Burning the ordered Products onto one or more Sentinel HL keys. n n

Generating a file containing the Product Keys for the Entitlement. Generating a file containing the Protection Key Update for the Entitlement.

Protect Once Deliver The concept of separating engineering and business processes, on which Sentinel is designed. Many Engineering processes (software protection) are performed by software engineers using Sentinel protection tools (Sentinel Envelope, Sentinel ToolBox, and the Sentinel Licensing API). Business processes (licensing and selecting the Sentinel protection key type) are performed by product managers using Sentinel EMS. Protection Key Update

Changes to the license terms and/or data stored in one or more deployed Sentinel protection keys. The new details are defined in an Entitlement for a Protection Key Update. A Protection Key Update can be applied remotely to Sentinel HL keys or Sentinel SL keys.

Provisional Product

A Product that can be used as trialware, or during a grace period. Provisional Products do not require a locking type, since they can be activated and used for a limited period without a Sentinel protection key. Products defined as Provisional cannot be included in Entitlements.

105

Producing bundles of Provisional Products is a Development task. Recipient Machine

The computer to which a detachable license is temporarily attached to enable use of an application for a defined time period.

Reference IDs

Information that identifies an entity in a different system, for example, a Product code or order ID in your company's ERP system.

Reopen

Changes the status of a Queued Entitlement to Draft (allowing the Entitlement to be modified).

Rehosting

Allowing the end user to transfer a Sentinel SL protection key from one computer to another. The rehost process is performed entirely by the end user, with no interaction from the vendor.

Reports

Sentinel EMS reports provide access to selected current information from the Sentinel EMS database. Different predefined reports are available to meet various requirements. The reports provide information in tabular form and, where applicable, in a graphical chart.

Run-time Environment (RTE)

Sentinel component that is installed on an end user's computer and that enables communication between a protected program and a Sentinel protection key

RUS

Sentinel Remote Update System. A utility that enables secure, remote updating of deployed Sentinel protection keys.

Scheduled Report

A scheduled report is a report that is generated at a predetermined time.

Sentinel HL key

The hardware-based protection and licensing component of Sentinel. One of the Sentinel protection key types.

Sentinel HL (Driverless configuration) key

Type of Sentinel HL key that does not require the Run-time Environment in order to protect an application on a Windows machine.

Sentinel HL key protection

The protection level assigned to a Product when the Sentinel HL locking type is selected. Sentinel HL key protection: n Offers the strongest enforcement for license terms, which are stored and protected inside the Sentinel HL key. n Enables portability—the software can be used on any computer to which the Sentinel HL key is connected.

106

Glossary

n

Does not require Internet connection for activation of the Product.

Sentinel Master key

A vendor-specific Sentinel HL key containing the confidential codes assigned by SafeNet. The key must be connected to Sentinel EMS.

Sentinel protection key

A Sentinel HL key or a Sentinel SL key, or both.

Sentinel SL key

The software-based protection and licensing component of Sentinel—a virtual Sentinel HL key. One of the Sentinel protection key types.

Sentinel SL Legacy

Sentinel SL keys that were generated with versions of Sentinel HASP prior to Sentinel LDK v.6.0

Sentinel SL key protection

The protection level assigned to a Product when the Sentinel SL locking type is selected. With Sentinel SL key protection: n Product activation is instantaneous. End users can immediately start using the software with its fully-licensed functionality. n The activation process for end users is convenient and transparent. n The online connection with end users can enable user registration data to be collected and used for marketing purposes.

Shipping address

The address where you want to receive your orders is called the Shipping Address. It could be your home or office.

Start Date The date before which no operations, like login by Product Key and (for an Entitlement) Activation are allowed on an Entitlement. Trialware

Software that can be distributed for end-user evaluation. Sentinel enables you to create, protect, and distribute secure trialware versions of software, and to invite users to download software from networks, share it with other users, and to give it away to their friends or colleagues (referred to as super-distribution). End users then have the option to turn their copy of trialware into a fully-functional version by activating it with a Sentinel protection key. To enable a Product to be used as trialware with a grace period, the Product must be defined as Provisional.

User

Refers to Sentinel LDK users.

107

User ID

A unique identifier for a user in Sentinel LDK.

User registration

The process by which the end user provides certain information when he logs on to EMS for the first time using Product Key. Behavior of this page differs with the value provided for the User Registration field during Entitlement creation. n Mandatory—The end user needs to provide some information before he can activate the Product Keys. n Desired—The User Registration page appears, but the end user can choose to skip this page by clicking Register Later. n Not Required—The User Registration page does not appear.

V2C (Vendor-toCustomer) file

A file that contains Protection Key Update data for delivery to end users. This data can include detailed changes to the license terms and/or data to be stored in the end user’s Sentinel protection keys. The V2C file is generated by Sentinel EMS and can be deployed using RUS or the Sentinel Licensing API. The file name includes an ID, and the date and time it was created.

Vendor Code

A confidential, vendor-unique string that enables access to the vendorspecific Sentinel protection keys. The Vendor Code contains vendor-specific secrets and applies to both Sentinel HL keys and to Sentinel SL keys.

Index Index

A Activating Products manually 72 Activations notification threshold before depletion 14 reports 93 Administration functions creating a User 8 deleting a User 10 editing User details 9 managing Users 7 Administration role 8 Apply Licenses task 14 Authorizing users 8

B Batch Codes customizing for RUS 77 for Entitlements 51 for Features 21-22 for Products 24 introducing 77 Branding RUS 79 Bundle of Provisional Products 77 Burning Sentinel HL keys 60

C C Header File 78 C2V data 65 checking in 64 for manual Product activation 71 for Protection Key Updates 53 for Sentinel LDK license renewal 14 from cloned machine 65, 67 viewing 64 Canceling licenses 24, 37 Cancellation Products 24, 37

Channel Partners creating a new 51 search 51 Cloning re-enabling disabled licenses 67 Concurrent instances of license 25, 39 CSV file 78 custom reports 15, 94 Customer-to-Vendor (C2V) 64 Customers creating 85, 87 creating a new 51 reports 93 search 51 Customizing RUS 79

D Detachable license, working with 42 Development 77 Development tasks 77 DLL for RTE installer 80 Duplicating Products 24

E E-mail notifications for expiring license 14 Entitlement Ref ID 51 specifying a Channel Partner 51 specifying a Customer 51 Entitlement management 49 Entitlement Management functions 60 Entitlements 60 Channel Partners 87 creating an Entitlement 51 Customers 85 defining Entitlement details 51 Entitlement ID 60 license term values 51

110

Index

producing 60 reports 93 Entitlements page 50 Excluding Features 25, 30, 34, 52 EXE file 80 Export Definitions 78 Feature list 77-78 Extending licenses 30

F Features 22, 25, 39, 51, 78 defining a new Feature 22 defining Feature properties 22 defining license terms 25, 39 editing Feature properties 23 exporting Feature list 77-78 Feature ID 22 in Products 25, 30, 37 license values for Entitlements 51 license values for orders 39 managing 21 Formatting Sentinel HL keys 64, 69

G Grace periods 25

K Keys Master keys 11 Product Keys 51, 53 recycling 69 Sentinel SL keys 26, 32, 35, 77 Vendor keys 11

L License renewal notification before expiration 14 License terms 39 canceling 37 defining 39 defining values for Entitlement 51 for Modification Products 30 Locating Sentinel protection keys 55 Locking types 24-25

M Master keys 14 maintaining 11 notification before expiration 14 Memory data 25, 45, 51 editing at order time 57 Modification Products 30 defining 30 license terms 39

N Network 40 Notifications for expiring license 14

O Order Licenses task 14 Orders customers 86 editing memory 57 license term values 39

P Producing Entitlements 60 Product activation (manual) 71 Product Keys 51, 53 activating a Product 71 creating an Entitlement 51 enabling/disabling 71 producing 60 viewing information about 71 Product Management functions 21, 24 Products 38 adding to Entitlement 51, 53 Cancellation Products 37 defining a new Product 25 defining Product properties 25 defining Provisional Products 34 duplicating 30 for trial or grace period 25, 77 managing 24 Modification Products 30 protection levels 25 Provisional Products 77 reports 93

Index

Protection Key Updates producing 60 Protection levels 25 Provisional Products 25, 77

R Read-only memory 45 Read/write memory 45 Recycling Sentinel HL keys 69 Remote Desktop 42 Remote Update System 66 Renewing Sentinel LDK license 14 Reports about 93 description of available reports 93 managing scheduling of 95 Role Batch Code Admin 10 Customer Services 10 Development 10 Entitlement Manager 10 Product Manager 10 Production 10 Report Generation 10 Super User 10 Roles and their functions 10 Development 77 Entitlement Management 49, 60 Product Management 21, 24 Run-time Environment (RTE) 77, 80-81 RUS (Sentinel Remote Update System) 64 Branding 79

recycling 69 Sentinel SL keys 26, 32, 35, 77 Sentinel Updates 51, 53 defining Entitlement 53 defining orders 51 locating Sentinel protection keys 51, 53 Signing the RTE installer 81 Superuser 8

T Terms 39 Trial period for Product 25

U Update license 64 Updates 51, 53 User 8 deleting a User 10 editing User details 9 User roles 10 Users 7 Sentinel LDK user 11

V V2C files manual Product activation 72 Protection Key Updates 53, 64 RTE installer 80 Vendor keys 11 Virtual Machines allowing use of 39

X

S Scheduled Reports 95 about 93 Seats notification threshold before depletion 14 Sentinel HL keys burning 60 C2V data 65 creating an Entitlement 51 locking 26 producing 60 protection 25, 51

111

XML file 78