Migration Guide

Sentinel HASP to Sentinel LDK

Migration Guide: Sentinel HASP Sentinel LDK 2

Copyrights and Trademarks

Copyright © 2014 SafeNet, Inc. All rights reserved.
HARDLOCK, HASP, SENTINEL, SUPERPRO and ULTRAPRO are registered trademarks of SafeNet, Inc. and/or its subsidiaries and may
not be used without written permission.
All other trademarks are property of their respective owners.

Disclaimer
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.

November 2014 Sentinel LDK v.7.3 Revision 1411-2

Migration Guide: Sentinel HASP Sentinel LDK 3

Contents
Introduction .............................................................................................................................. 5

About Sentinel LDK ............................................................................................................... 5

About This Guide................................................................................................................... 5
Migration Options .................................................................................................................. 6
Migrating the Business Studio Server Database to Sentinel EMS Database .................... 7

Overview ............................................................................................................................... 7
Migration Paths for HASP SRM and Sentinel HASP ............................................................ 7
Target Audience .................................................................................................................... 7
Summary of the Migration Process ....................................................................................... 8
Migrating a Large BSS Database.......................................................................................... 8
Changes at Customer Sites .................................................................................................. 8
Replacing the Sentinel HASP Activation Server ................................................................... 9
Method A: Modify the DNS Address ................................................................................. 9
Method B: Change the Sentinel EMS Port Number.......................................................... 9
Working with Business Studio Server API ............................................................................ 9
Which Data is Migrated? ..................................................................................................... 10
Limitations and Workarounds .............................................................................................. 10
Distribution Channel Functionality .................................................................................. 10
Reports ............................................................................................................................ 10
User Name ...................................................................................................................... 11
Customer Attributes ........................................................................................................ 11
Miscellaneous Field Reassignments .............................................................................. 11
Migration of Orders for HASP HL Max Micro Keys ......................................................... 12
Migration of Products That Do Not Contain Features ..................................................... 12
Migration of Completed Orders in the Demo Database .................................................. 12
Performing a Trial Migration ................................................................................................ 12
Preparing for Migration ........................................................................................................ 13
Estimate Time Required for Migration ............................................................................ 13
Install Sentinel EMS ........................................................................................................ 13
Set Up Sentinel LDK Data Migration Tool ...................................................................... 13
Determine Batch Codes to be Migrated .......................................................................... 14
Ensure That Sentinel EMS and BSS Database Services are Active .............................. 14
Ensure That the Required Master Keys are Connected ................................................. 14
Back Up Sentinel EMS Database and BSS Database (Optional) .................................. 14
Migrating the BSS Database ............................................................................................... 15
Run the Sentinel LDK Data Migration Tool ..................................................................... 15
Reintroduce the Master Keys .......................................................................................... 17
Verifying the Success of the Migration Process .................................................................. 18
Migration Guide: Sentinel HASP Sentinel LDK 4

Stopping the SQL Service for the BSS Database ............................................................... 18

Migrating Backend Systems That Use BSS API ................................................................. 18
Performing BSS and Sentinel EMS Database Rollback in Case of Failure ........................ 19
Implementing the Business Studio Server API for Sentinel EMS .................................... 20

Overview ............................................................................................................................. 20
Prerequisites ....................................................................................................................... 20
Functionality Changes ......................................................................................................... 20
AddProductsToOrder Method ......................................................................................... 20
InsertCustomer Method .................................................................................................. 21
Retrieving Orders Based on Order ID ............................................................................. 21
Retrieving Customers Based on Customer ID ................................................................ 21
Other Changes to BSS API Functions ............................................................................ 22
Setting Up Business Studio Server API for Sentinel EMS .................................................. 22
As an ASP.NET SOAP Web Service .............................................................................. 22
Local (As a .NET DLL) .................................................................................................... 25
Appendix A: Working With the Sentinel EMS Web Interface ............................................ 27
Appendix B: Troubleshooting .............................................................................................. 29

Migration Tool Fails to Back Up BSS Database or EMS Database .................................... 29

Migration Tool Freezes During the Pre-migration Process ................................................. 29
BSS API for EMS Fails to Generate Log Files .................................................................... 30
Migration Guide: Sentinel HASP Sentinel LDK 5

Introduction

About Sentinel LDK

®
Sentinel LDK is a Software Digital Rights Management (DRM) solution that delivers strong copy protection,
protection for Intellectual Property, and secure and flexible licensing. Sentinel LDK is an all-in-one Software
DRM solution that enables you to choose a hardware- or software-based protection key, based on business
considerations. Sentinel LDK software engineering and business processes are completely separate to ensure:
• Effective and efficient product development
• Quick time to market
• Immediate addressing of customer and market needs
• Comprehensive support throughout the software product’s protection and licensing life cycle
The level of protection for your software is determined by the locking type you choose—hardware-based or
software-based. Sentinel LDK hardware-based protection, which utilizes Sentinel HL keys, provides the
safest and strongest level of protection.

About This Guide

This guide is intended for the following types of software vendors:
• Vendors who currently use the (Sentinel HASP) Business Studio Server database to manage orders and
licenses for Sentinel HASP. This guide describes how to migrate to the Sentinel EMS database and
Sentinel LDK. For more information, see “Migrating the Business Studio Server Database to Sentinel EMS
Database” on page 7.
• Vendors who currently use the Sentinel HASP Business Studio Server API. You can implement a modified
version of the Business Studio API that allows your CRM and ERP applications to access the Sentinel EMS
database using existing Business Studio API function calls. This avoids the need to convert your
applications to use Sentinel Web Services. For more information, see “Implementing the Business Studio
Server API for Sentinel EMS” on page 20.
Migration Guide: Sentinel HASP Sentinel LDK 6

Migration Options
The following types of Sentinel HL keys are available, replacing the HASP HL keys that were provided until
now:
• Sentinel HL (HASP configuration) keys
These keys are fully compatible with existing HASP HL keys and with older generations of HASP keys.
These keys can work with your existing API libraries and Run-time Environment, and you can work with
your current backend environment. These keys can be upgraded at the customer site to Sentinel HL
(Driverless configuration) keys and can thus provide all the benefits provided by the Driverless keys.
For information on upgrading Sentinel HL (HASP configuration) keys to the Driverless configuration,
see the Sentinel LDK Software Protection and Licensing Guide.
• Sentinel HL (Driverless configuration) keys
These keys make use of HID drivers (included in the Windows operating system) instead of SafeNet
drivers. These keys can be used without installing the Runtime Environment. To use these keys, your
protected application must include the Licensing API libraries from Sentinel LDK v.7.1, and you must be
working with the backend from Sentinel LDK v.7.1.
Vendors who are currently working with Sentinel HASP (or HASP SRM) have the following options:
• Remain with their current (Business Studio Server) back end, Run-time Environment and Run-time API
libraries, and order Sentinel HL (HASP configuration) keys.
• Migrate to Sentinel LDK (as described in this migration guide), but order Sentinel HL (HASP
configuration) keys. It is not necessary to replace their current AP libraries or Run-time Environment.
• Migrate to Sentinel LDK (as described in this migration guide), and order Sentinel HL (Driverless
configuration) keys. It is necessary in this case to replace their current AP libraries and Run-time
Environment.
Migration Guide: Sentinel HASP Sentinel LDK 7

Migrating the Business Studio Server Database to

Sentinel EMS Database

Overview
Sentinel EMS introduces a new database that is different from the database used by Sentinel HASP.
The Sentinel LDK Data Migration Tool migrates the data from an existing Sentinel HASP Business Studio
Server database (BSS database) to a Sentinel EMS database.
Using this tool, you can handle the transition from Sentinel HASP BSS to Sentinel EMS with a relatively small
effort. Wherever possible, the Data Migration Tool creates required new entities automatically or coverts
existing entities as required.
This section describes how to use the Sentinel LDK Data Migration Tool to perform this process.
Note: The migration process is not reversible. No procedure is provided to migrate data from the Sentinel
EMS database to the Sentinel HASP BSS database.

Migration Paths for HASP SRM and Sentinel HASP

This section describes the paths for migrating from earlier versions of HASP SRM and Sentinel HASP to
Sentinel LDK.
• To migrate from Sentinel HASP v.5.0, v.5.10 or v.5.12:
o Follow the procedures in this migration guide.
• To migrate from HASP SRM v.3.x or v.4.x:
o First upgrade to Sentinel HASP 5.12. Refer to the Sentinel HASP v.5.12 Installation Guide for
information on how to upgrade from earlier versions of HASP SRM.
o After upgrading to Sentinel HASP v.5.12, follow the procedures in this migration guide.

Target Audience
The migration process is appropriate for software vendors who are currently using Sentinel HASP v.5.0,
v.5.10 or v.5.12 and who want to advance to Sentinel LDK v.7.1.
For vendors who require Language Packs for Sentinel EMS and Sentinel LDK Vendor Tools: Language Packs
will be made available several months after Sentinel LDK v.7.1 is released. For more information, contact
your SafeNet sales representative.
Migration Guide: Sentinel HASP Sentinel LDK 8

Summary of the Migration Process

The migration process consists of the sequence of procedures that follows. Each of these procedures is
describes in this migration guide.
1. Install Sentinel EMS.
2. Set up Sentinel EMS Data Migration Tool.
3. Select the Batch Codes to be migrated.
4. Review the limitations and workarounds. Determine which issues will require corrective actions. If
necessary, perform pre-migration modifications to the Business Studio Server database.
5. In parallel, if you work with Business Studio Server API, prepare modifications to your current ERP and
CRM systems to work with Business Studio Server API for Sentinel EMS.
6. Perform a trial migration. Review the results to ensure that you are satisfied with the migrated
Sentinel EMS database.
7. When you are satisfied with the migration process, perform the migration of your production
database:
a. (If you use the Sentinel HASP Activation API to activate licenses online) Disconnect the Activation
Server from the Internet.
b. Migrate your Business Studio Server database to the Sentinel EMS database. Reintroduce your
Master keys.
c. Verify the success of the migration.
d. Enable Product activation.
8. Migrate the backend systems that use Business Studio Server API.

Migrating a Large BSS Database

To migrate a large BSS database, be sure to install the appropriate edition of Microsoft SQL Server:
• Microsoft SQL Server Express Edition database size is limited to 4GB.
• Microsoft SQL Server 2008 R2 Express Edition database size is limited to 10 GB.
• Microsoft SQL Server Standard and Enterprise Editions have much larger database size limit.

Changes at Customer Sites

If you work with HASP SL licenses, you must ensure that customers who receive new or updated HASP SL
keys install Sentinel LDK Run-time Environment v.6.23 or later.
Once the Run-time Environment v.6.23 or later is installed, HASP SL keys that were created with Sentinel
HASP Business Studio will appear in the Sentinel Admin Control Center as "SL-Legacy" keys. Any SL-Legacy
key for which you issue an update using Sentinel LDK can be optionally changed to an “SL-AdminMode” key.
For information on the different types of HASP SL keys used in Sentinel LDK, see the Sentinel LDK Software
Protection and Licensing Guide.
Migration Guide: Sentinel HASP Sentinel LDK 9

Replacing the Sentinel HASP Activation Server

If you currently use the Sentinel HASP Activation API to activate licenses online, you must plan for a period
of downtime, followed by a changeover from the Sentinel HASP Activation Server to Sentinel EMS.
The change from Sentinel HASP Activation Server to Sentinel EMS is accomplished using one of the methods
described in this section.

Method A: Modify the DNS Address

The protected applications that you distribute to customers contain a URL that points to the Activation
Server DNS address.
At the start of the migration process, disconnect the Activation Server machine from the internet so that
customers do not perform activations during the migration.
At the end of the migration process, after you determine that the conversion was successful, modify the
DNS address to point to the Sentinel EMS computer.

Method B: Change the Sentinel EMS Port Number

By default, the protected applications that you distribute to customers communicate with the Activation
Server using port 443.
Install Sentinel EMS on the machine that contains the Sentinel HASP Activation Server. The installation must
be performed using the Advanced setup type, and you must select the Use SSL option in EMS Host
Configuration. In addition, you must use a different port than the port used by Business Studio Server.
At the start of the migration process, disconnect the Activation Server machine from the internet so that
customers do not perform activations during the migration.
At the end of the conversion process, after you determine that the conversion was successful, disable the
Business Studio Server service. Modify Sentinel EMS to use the same port that was used for the Activation
Server.
Restart Sentinel EMS. Reconnect the machine to the internet.

Working with Business Studio Server API

If you currently use the Business Studio Server API to perform functions in Sentinel HASP, note that Sentinel
LDK provides a comparable web services interface to perform actions in Sentinel EMS.
However, to protect your investment in your current ERP and CRM systems and provide backwards
compatibility, Sentinel LDK provides Business Studio Server API for Sentinel EMS. This is an updated version
of Business Studio Server API that translates API function calls into the equivalent Sentinel EMS web
services. Thus, after migration to Sentinel EMS, you can continue to use your existing backend systems with
practically no modification.
Note that certain Business Studio Server API function calls are not supported or may require some
modification.
Migration Guide: Sentinel HASP Sentinel LDK 10

Before you undertake the migration of your BSS database to Sentinel EMS, you must be ready to implement
Business Studio Server API for Sentinel EMS in your backend systems. This is necessary so that your backend
systems will be ready to work with the Sentinel EMS database as soon as the migration is completed.
For more information, see “Implementing the Business Studio Server API for Sentinel EMS” on page 20.

Which Data is Migrated?

By default, each entity that exists in the BSS database will be migrated to the Sentinel EMS database. (You
can limit the Batch Codes for which data is migrated. See “Determine Batch Codes to be Migrated” on
page 14.)
You can run the Data Migration Tool more than once for a given set of databases. However, in subsequent
executions of the Migration Tool, only items that do not already exist in the Sentinel EMS database will be
migrated. Thus, for example:
• A Feature that has been migrated to the Sentinel EMS database will not be migrated a second time even
if the Feature was modified in the BSS database after the first migration.
• A user account that:
 is associated with two Batch Codes, and
 was migrated together with data for the first Batch Code
is not migrated a second time if data for the second Batch Code is migrated in a separate execution of
the Migration Tool. If the user account was modified between the two executions of the Migration Tool,
the modifications will not be present in the Sentinel EMS database.

Limitations and Workarounds

While Sentinel EMS provides significant advantages over Business Studio Server, some functionality that
exists in Business Studio Server is not present in Sentinel EMS. This section describes these limitations and
any available workarounds.

Distribution Channel Functionality

The Distribution Channel functionality that exists in Sentinel HASP is not supported in Sentinel LDK.
Distribution Channel users will be migrated to Sentinel EMS as “disabled” and can be enabled manually in
Sentinel EMS. However, Sentinel EMS does not place any restrictions on the users based on Distribution
Channel Products. If these users are enabled, they will have access to all Products and to Entitlements for all
Products that are a part of the vendor’s Batch Code.

Reports
Sentinel EMS does not provide the same business intelligence reports that exist in Business Studio. (Note,
however, that you can define custom reports in Sentinel EMS.)
Migration Guide: Sentinel HASP Sentinel LDK 11

User Name
In Sentinel HASP, a Business Studio user name can contain the characters “-”, “&”, and space. A Sentinel
EMS user name cannot contain these characters. Therefore, any of these characters in a user name is
converted to “_”.
A Sentinel EMS user must have an email address. If a Business Studio user does not have an email address,
the Migration Tool assigns the email address [email protected] to the migrated Sentinel EMS
user.

Customer Attributes
The Migration Tool converts all customers from the BSS database to customers of type Company in Sentinel
EMS. The value from the Name field in BSS is migrated to the Company Name field in Sentinel EMS.
E-mail address and Contact Name must always be provided together in Sentinel EMS, and E-mail address
must be unique. These requirements do not exist in Sentinel HASP. Therefore, if either of these does not
exist in the BSS database, or if the E-mail address is not unique, the Migration Tool places whichever
information is available in the Description field in the Sentinel EMS database.
The table that follows indicates how the Name, E-mail and Contact Person fields from the BSS database are
migrated to the Sentinel EMS database.

Business Studio Server (BSS) Sentinel EMS Database

Database For all migrated customers: (Customer) Type = Company

(Customer) (Customer) Contact Company Contact Contact Name Description Field

Name Field E-mail Person Name Field E-mail Field Field
Field Field

Unique or None None (Customer) None None

Duplicate Provided Name from None None Contact Person: BSS Contact Person
BSS
Unique None E-mail from (Customer)
BSS Name from
BSS

Provided E-mail from Contact

BSS Person from
BSS
Duplicate None None None Duplicate Email: BSS Email

Provided None None Duplicate Email: BSS Email

Contact Person: BSS Contact Person

Miscellaneous Field Reassignments

Most data fields from the BSS database are migrated to fields with equivalent names in the Sentinel EMS
database.
Exceptions are listed in the table that follows.
Migration Guide: Sentinel HASP Sentinel LDK 12

BSS Database Field Sentinel EMS Database Field Notes

(Order) Order ID (Entitlement) Ref ID 2 After migration, the field value in Sentinel
EMS is: HASP_OrderID_originalValue

(Customer) Customer ID (Customer) CRM ID After migration, the field value in Sentinel
EMS is: HASP_CustomerID_originalValue

(Customer) Street, City, Zip (Customer) Street In Sentinel EMS, the values of the three
fields are combined in the Street Field.

(User) Full Name (User) Ref ID 1

(User) Description (User) Ref ID 2

Migration of Orders for HASP HL Max Micro Keys

Once an order in Business Studio has been associated with a HASP HL Max Micro key, the key will appear in
the entitlement in Sentinel EMS as HL-Max instead of HL-Max-Micro.
(Note that the Max key and Max Micro key are functionally equivalent.)

Migration of Products That Do Not Contain Features

It is possible for a Product to contain memory content for a protection key, but no Features. If a Product
with no Features is migrated from the BSS database to Sentinel EMS, the Product will be assigned a new
Product ID – it will not receive the original product ID.
Note: This same behavior occurs when a Sentinel HL key that contains a Product with no Features is
checked into a different BSS database – the Product is assigned a new Product ID.

Migration of Completed Orders in the Demo Database

Data for completed orders that is installed with the Demo database as part of the Sentinel HASP installation
process is, in part, not well-formed. As a result, if you choose to migrate the Demo database, it will not be
possible in Sentinel EMS to download V2C files for completed orders that exist in the Demo database.
However, for orders that you entered and completed yourself in the Demo database, no such limitation
applies.
This issue has no bearing on your production database.

Performing a Trial Migration

SafeNet has attempted to anticipate and handle any problems that may arise during the migration process.
However, to ensure uninterrupted service for your production environment, SafeNet highly recommends
that you perform a trial migration and validation of your BSS database in a test environment using the
Migration Guide: Sentinel HASP Sentinel LDK 13

procedures described below. After you complete a trial migration process, perform the validation steps
described later in this document (see “Verifying the Success of the Migration Process” on page 18).
As part of your trial migration, be sure to test your implementation of Business Studio Server API for
Sentinel EMS (if you use Business Studio Server API in your current production environment).
After you are satisfied that the migration proceeds as expected and that you are prepared to handle any
resulting changes, you are ready to perform migration for your production environment.

Preparing for Migration

Estimate Time Required for Migration

Various factors, such as the connection speed to the databases, affect the amount of time required for
migration of the BSS database to Sentinel EMS.
The size of the BSS database is the primary factor that determines the amount of time required. The
migration process requires approximately one hour for each gigabyte of data to be migrated.

Install Sentinel EMS

Install Sentinel EMS v.7.1 from the Sentinel LDK v.7.1 Installation DVD. SafeNet recommends that you install
Sentinel EMS on the computer where Business Studio Server is installed. For more information, see the
Sentinel LDK v.7.1 Installation Guide.
Note: If you want to migrate data for the DEMOMA Batch Code from Sentinel HASP to Sentinel EMS, be
sure that during Sentinel EMS installation, in the Sentinel EMS Database Configuration screen, you
clear the Fill Demo Data check box for installing demo data.
If Sentinel EMS v.2.1 (from Sentinel LDK 6.0) is present on the computer where you will install Sentinel EMS
v.7.1, refer to the upgrade instructions in the Installation Guide.
Note: Sentinel LDK Data Migration Tool provides a built-in function to back up the Sentinel EMS database.
You can only use this function if the Sentinel EMS database is located on the computer where you
run the Migration Tool.

Set Up Sentinel LDK Data Migration Tool

1. Locate the following directory on the computer where Sentinel LDK Vendor Tools are installed:
%SystemDrive%\Program Files (x86)\SafeNet Sentinel\Sentinel LDK\VendorTools\Utilities
\BusinessStudioServer-Migration\
(For Windows x86, use %SystemDrive%\Program Files\...)
2. Copy the BusinessStudioServer-Migration directory and all of its contents to the computer that
contains Business Studio Server.
Note: If your installation of Business Studio Server was split into separate installations of the
Activation Server and Management Server, copy the BusinessStudioServer-Migration directory
to the computer where the Management Server was installed.
Migration Guide: Sentinel HASP Sentinel LDK 14

3. If you did not install Sentinel EMS on the same computer as Business Studio Server, ensure that Java
Runtime Environment 7 (JRE 7) is present on the Business Studio Server computer. JRE 7 is available
from:
http://www.oracle.com/technetwork/java/javase/downloads/java-se-jre-7-download-432155.html

Determine Batch Codes to be Migrated

If your BSS database contains data for several Batch Codes, then by default, the Migration Tool migrates the
data for all Batch Codes to the Sentinel EMS database. (Data for the DEMOMA Batch Code is only migrated if
you specifically request this in the Migration Tool.)
If you use multiple Batch Codes (besides DEMOMA) in your BSS database, and you want to migrate only
selected Batch Codes to the Sentinel EMS database, do the following:
1. Create a text file named vendors_blacklist.cfg in the directory that contains the Migration Tool on the
Business Studio Server machine.
2. For each Batch Code that should not be migrated, add a line that contains the name of the Batch Code
to the vendors_blacklist.cfg file.

Ensure That Sentinel EMS and BSS Database Services are

Active
The SQL service for the BSS database must be active and accessible to the Migration Tool during the
migration process. However, Sentinel HASP applications such as Business Studio or the Activation Server
must not be in use.
The SQL service for the Sentinel EMS database must be active and accessible to the Migration Tool during
the migration process.

Ensure That the Required Master Keys are Connected

The Sentinel Master Key for each Batch Code that will be migrated must be connected to the Business
Studio Server computer during the migration process. No Master key is required for the DEMOMA Batch
Code or for any Batch Code in the Blacklist file.

Back Up Sentinel EMS Database and BSS Database (Optional)

The Migration Tool can back up the BSS database or Sentinel EMS database (or both) for you during the
migration process. However, this built-in backup functionality can only be used when the database is
located on the computer where you run the Migration Tool (that is, on the Business Studio Server machine).
If either database is located on a remote computer, manually back up that database now.
Migration Guide: Sentinel HASP Sentinel LDK 15

Migrating the BSS Database

Run the Sentinel LDK Data Migration Tool

Note: You must have administrator rights on the computer to run the Migration Tool.
Run the Sentinel LDK Data Migration Tool as follows:
1. Switch to the directory that contains the Migration Tool on the Business Studio Server computer.
2. Double-click MigrationTool.jar.

OR

(For Windows Vista, Windows 7, or Windows 2008) Open a Command window as an administrator and
enter:
Java –jar migrationTool.jar

Note: If the size of the BSS database is greater than 500 MB, do not double-click MigrationTool.jar.
Open a Command window as an administrator and enter the following command to run the Migration
Tool with an increased heap size:
Java –Xms256m –Xmx1024m –jar MigrationTool.jar
The Migration Tool starts. The following screen is displayed:

3. If you want to migrate demo data (DEMOMA Batch Code) from the BSS database to the Sentinel EMS
database, select the Migrate demo data check box.
4. Click Next.
Migration Guide: Sentinel HASP Sentinel LDK 16

A screen similar to the following is displayed:

The User Name field should contain the name of a user who has full administrator privileges for the
BSS database.
5. Click Test Connection to confirm that the Migration Tool can connect to the database.
6. If you have not yet backed up the BSS database, you can click Back Up Database now to back it up.
(This function can only be used if the BSS database is located on the local machine.)
Note: If the database backup fails, refer to “Appendix B: Troubleshooting” on page 29.
7. Click Next to continue. A screen similar to the following is displayed:

8. If Sentinel EMS is installed on a remote computer, enter the connection parameters. The User Name
field should contain the name of a user who has full administrator privileges for the Sentinel EMS
database. If necessary, modify firewall settings so that the Migration Tool can communicate with the
Sentinel EMS database server.
Migration Guide: Sentinel HASP Sentinel LDK 17

9. Click Test Connection to confirm that the Migration Tool can connect to the database.
10. If you have not yet backed up the Sentinel EMS database, you can click Back Up Database now to back
it up. (This function can only be used if the Sentinel EMS database is located on the local machine.)
Note: If the database backup fails, refer to “Appendix B: Troubleshooting” on page 29.
11. Click Next to continue.
The migration process begins. This process may require several hours. Progress screens are displayed
during this process.
Note: If the database preparation phase of the process freezes, refer to “Appendix B: Troubleshooting”
on page 29.
Upon completion of the migration process:
• A detailed report of the migration process is displayed in a browser window. The complete
contents of this report can also be found in:
\BusinessStudioServer-Migration\migration_date_time.html.
• A screen similar to the following is displayed:

You can click View Report to reopen the detailed report of the migration process.

Reintroduce the Master Keys

The Sentinel Master key for each Batch Code that was migrated to Sentinel EMS must be reintroduced.
If Sentinel EMS is installed on different computer from Business Studio Server, move the relevant Master
keys to the Sentinel EMS computer.
Perform the procedure for introducing Master keys in Sentinel EMS. (This must be done even if Business
Studio Server and Sentinel EMS are installed on the same computer.) This procedure is described in the
Sentinel LDK Installation Guide.
Migration Guide: Sentinel HASP Sentinel LDK 18

Verifying the Success of the Migration Process

After completion of the migration process, confirm that the data from Sentinel HASP was successfully
migrated to the Sentinel EMS database and that Sentinel EMS is handling the data correctly.
Perform the following activities:
• Review the contents of the migration report (described earlier). Determine if any adjustments are
required to the migrated data or if any warning require your attention.
• Examine samples of the various entities (such as Features, Products, customers and entitlements) in
Sentinel EMS and verify that the information displayed matches the data that exists in Sentinel HASP.
• Generate reports that are available in Sentinel EMS. Review the reports to ensure that the contents are
consistent with the expected results.
• Perform sample transactions in Sentinel EMS and verify that the transactions complete as expected.
Among the transaction you perform, SafeNet recommends that you do the following:
 Download an existing update for a protection key
 Generate a new update for an existing protection key.
 Activate a migrated entitlement.
 Perform a HASP update.
For assistance in performing the validation activities, see “Appendix A: Working With the Sentinel EMS Web
Interface” on page 27.

Stopping the SQL Service for the BSS Database

Once the migration process has completed, stop the SQL service for the BSS database to ensure that no
further attempts are made to enter or modify data in the BSS database. Ensure that the Business Studio
Server service is stopped and that its Startup Type is set to Disabled.

Migrating Backend Systems That Use BSS API

For vendors that work with Business Studio Server API: When you are satisfied that your BSS database has
been successfully migrated to the Sentinel EMS database, be sure to perform the necessary steps to prepare
your CRM and ERP systems to use the Business Studio Server API for Sentinel EMS.
For more information, see “Implementing the Business Studio Server API for Sentinel EMS” on page 20.
Migration Guide: Sentinel HASP Sentinel LDK 19

Performing BSS and Sentinel EMS Database Rollback in

Case of Failure
The migration process changes both the BSS database and the Sentinel EMS database. If the migration from
Sentinel HASP to Sentinel EMS does not succeed, perform the following steps for each database to roll back
the database to its original state.
1. Stop the database server.
2. Restore the database.
3. Start the database server.
The migration process adds certain files in the directory containing the BSS database. These files can be
ignored. They will not interfere when you run the migration process again after resolving the problems
encountered.
Migration Guide: Sentinel HASP Sentinel LDK 20

Implementing the Business Studio Server API for

Sentinel EMS

Overview
Sentinel LDK provides a Web Services interface to perform CMR or ERP actions in Sentinel EMS.
However, vendors who are working with the Sentinel HASP Business Studio Server API (BSS API) have
typically invested extensive time and effort to integrate the API with their existing ERP and CRM
infrastructure.
Business Studio Server API for Sentinel EMS (BSS API for EMS) allows you to take advantage of the benefits
provided by Sentinel EMS while continuing to use the API calls in the BSS API. Thus, after migration to
Sentinel LDK, you can continue to use your existing backend systems with a minimum of modification.
Note: In your applications, you have the option of calling functions both in the BSS API for EMS and in
Sentinel EMS Web Services. This enables you to take advantage of any new functionality that is not
supported in the BSS API.

Prerequisites
You must be using Sentinel EMS v.7.1 (this is provided with Sentinel LDK v.7.1).
Your backend applications must be compatible with Sentinel Business Studio Server API v.5.0 or later.

Functionality Changes
This section describes changes in the behavior of certain methods in BSS API for EMS.
For more information regarding the methods described in this section, see the
business_studio_server_api_en-US.chm help file. This can be found on the computer where Sentinel LDK
Vendor Tools are installed, under:
%SystemDrive%\Program Files (x86)\SafeNet Sentinel\Sentinel LDK\Legacy\API\BusinessStudioServer\
(For Windows x86, use %SystemDrive%\Program Files\...)

AddProductsToOrder Method
In Sentinel HASP BSS API, this method adds new Products to an existing order.
In BSS API for EMS, this method replaces all the products in the entitlement with the Products contained in
the inProducts array.
Thus, to add Products to an entitlement, the in Products array must contain both the Products that exist in
the entitlement and the Products to add to the entitlement.
Note that this change in the functionality enables you to use the AddProductsToOrder method to remove
Products from an existing entitlement.
Migration Guide: Sentinel HASP Sentinel LDK 21

InsertCustomer Method
In BSS API for EMS, this method will always insert a customer of type Company (rather than Individual).
Additional parameters are mapped as follows:
Parameter in Parameter is Parameter in BSS API for EMS
Sentinel HASP BSS API Mandatory
Address No Street
Contact Mandatory if Email is Contact Information: First Name, Last Name,
provided. Middle Name
Email Mandatory if Contact Contact E-mail
is provided.
Fax No Fax
Name Yes Company Name
Phone No Telephone
Reference No Ref ID
Status No Enabled: Yes or No
Zip Code No Zip Code
(If you want to insert a customer of type Individual, you can use the functions available in the Sentinel EMS
Web Services.)

Retrieving Orders Based on Order ID

The GetAllOrders, GetNewOrders, and GetProductionOrders methods search both Ref ID 1 and Ref ID 2
fields in entitlements for the value specified by the inReference parameter. These methods will retrieve
orders for which either of these fields contains the specified value. However, the value for the Ref ID 2 field
cannot be retrieved using BSS API. After migration from Sentinel HASP to Sentinel EMS, the Order ID value is
contained in the Ref ID 2 field. (For more information, see “Miscellaneous Field Reassignments” on page
11.)
Therefore, when you use one of these methods to search for entitlements based on the value of Order ID,
the method will appear to retrieve entitlements that do not contain the specified value, even though the
value is present.

Retrieving Customers Based on Customer ID

The GetCustomers method searches both Ref ID and CRM ID fields in customer records for the value
specified by the inReference parameter. This method will retrieve customers for which either of these fields
contains the specified value. However, the value for the CRM ID field cannot be retrieved using BSS API.
After migration from Sentinel HASP to Sentinel EMS, the customer ID value is contained in the CRM ID field.
(For more information, see “Miscellaneous Field Reassignments” on page 11.)
Therefore, when you use this method to search for customers based on the value of customer ID, the
method will appear to retrieve customers that do not contain the specified value, even though the value is
present.
Migration Guide: Sentinel HASP Sentinel LDK 22

Other Changes to BSS API Functions

The following items are not supported in BSS API for EMS:
• GetProvisionalOrders (method)
• ProduceProvisionalOrder (method)
• ClearClonedHaspSLKey (method)
• OrderType.PROVISIONAL ( enum item)
• KeyOrders.FormatType (field)
• KeyOrders.FormatDate (field)
The changes below were implemented in BSS API for EMS:
• EOL state of entitlement in Sentinel EMS does not exist in Sentinel HASP. Therefore, EOL state is
mapped to OrderStatus.None in BSS API for EMS.
• ProductProvisionalOrders method is not supported. Therefore, public HaspBssStatus
GetProvisionalOrders(int inBatchID, string inReference, out Order[] outOrders) returns
HaspBssStatus.HASP_BA_NO_ORDERS in BSS API for EMS.
• ProduceProvisionalOrder method is not supported. Therefore, public HaspBssStatus
ProduceProvisionalOrder(int inOrderID, out string outV2C) returns
HaspBssStatus.HASP_BA_UNSPECIFIED in BSS API for EMS.
• ClearClonedHaspSLKey method is not supported. Therefore, public HaspBssStatus
ClearClonedHaspSLKey(string inC2V, out string outV2C) returns HaspBssStatus.HASP_BA_UNSPECIFIED
in BSS API for EMS.

Setting Up Business Studio Server API for Sentinel EMS

BSS API for EMS can be set up either as an ASP.NET SOAP web service or locally (as a .NET DLL).

As an ASP.NET SOAP Web Service

You can install BSS API for EMS as a Web Service, either on the computer where you installed Sentinel EMS
or on a separate computer in the same network.
This section describes the prerequisites and the procedure for performing this installation.
Ensure Prerequisites
The computer on which you install BSS API for EMS as a Web Service must satisfy the following
prerequisites:
• Microsoft Windows XP, Windows Vista, Windows 2003, Windows 2008, or Windows 7
• Microsoft .NET Framework version 2.0 or later
Migration Guide: Sentinel HASP Sentinel LDK 23

• Windows Internet Information Services (IIS) version 5.0 or later

• Windows MSI Installer version 3.1 or later
When you launch the setup executable, the application checks to ensure that the computer satisfies the
prerequisites.
• If the presence of the .NET Framework and MSI Installer is not detected, these components are
automatically downloaded and installed.
• If the IIS component is not detected, you are prompted to install it manually, and the setup application
terminates.
Configure IIS
Depending on the operating system of the computer on which you plan to install BSS API for EMS, if you
have installed IIS 7 or IIS 7.5, the following configuration is required to enable compatibility with the IIS 6
metabase:
• Windows Vista: Under Programs & Features, go to IIS > Web Management Tools > IIS 6 Management
Compatibility and select IIS Metabase & IIS 6 Configuration Compatibility.
• Windows 7: Under Programs & Features, go to Turn Windows features on or off > Internet Information
Services > Web Management Tools > IIS 6 Management Compatibility and select IIS Metabase and IIS
6 configuration compatibility.
• Windows 2008 Server:
a. Under Programs & Features, go to Turn Windows features on or off.
b. In the Server Manager screen - Roles Summary pane, click Go to Roles > Add Roles.
c. In the Add Roles wizard, click Server Roles in the navigation panel.
d. Select the Web Server (IIS) check box.
e. Click Add Required Features.
f. Click Next.
g. Click Next.
h. Select IIS 6 Management Compatibility.
i. Click Next.
j. Click Install.
Install Business Studio Server API for Sentinel EMS
To install BSS API for EMS as a Web service:
1. Navigate to the following location on the computer where Sentinel LDK Vendor Tools are installed:
%SystemDrive%\Program Files (x86)\SafeNet Sentinel\Sentinel LDK
\Legacy\API\BusinessStudioServer\WebSetup\
(For Windows x86, use %SystemDrive%\Program Files\...)
Migration Guide: Sentinel HASP Sentinel LDK 24

Double-click setup.exe.
The BSS API for EMS installation wizard starts.
2. Proceed through the installation wizard. You can accept all defaults or make changes as required.
3. (Optional) Confirm that the Web service was installed correctly by accessing the following URL:
http://localhost/BusinessAPI/BusinessAPIService.asmx
If a page describing the Sentinel HASP Business Studio Server API is displayed, the Web Service was
installed correctly.
4. In your application, be sure to modify the call to the Initialize method in the BSS API as necessary in
order to connect to the Sentinel EMS server.
Configure Use of SSL

By default, Sentinel EMS Service is configured to operate without using SSL. If you have set up Sentinel EMS
Service to use SSL, you must also set up BSS API for EMS to use SSL.
You can set up BSS API for EMS to use SSL:
• By modifying the useSSL parameter in the IIS management console.
• By directly modifying the useSSL parameter in the web.config file.
To modify the useSSL parameter in the IIS management console:
1. Start the Internet Information Services (IIS) management console using the method that is appropriate
for your operating system.
2. Under the entry for the relevant computer, choose Site (or Web Site). Under Default Web Site, select
BusinessAPI > ASP.NET > BusinessAPI > Application Settings. In the Application Settings properties,
find the UseSSL key. Change the values for the key to true (to enable SSL).
To modify the useSSL parameter directly in the web.config file:
1. Open the file Web.config in a text editor. This file is typically located in the directory:
%SystemDrive%/Inetpub/wwwroot/BusinessAPI/
2. Locate the following line in the file:
<add key="useSSL" value="false" />
3. To set up BSS API for EMS to use SSL, change the value from false to true.
4. Save the file.
Configure Log File Generation (Optional)

By default, BSS API for EMS does not generate log file entries. You can enable generation of log file entries
and set the verbosity level of the API as follows:
1. Open the file Web.config in a text editor. This file is typically located in the directory:
%SystemDrive%/Inetpub/wwwroot/BusinessAPI/
2. Locate the following line in the file:
globalThreshold="Off"
Migration Guide: Sentinel HASP Sentinel LDK 25

3. Change the value Off to the desired log verbosity level. Possible log verbosity levels are:
Debug – Generate verbose log entries. This also includes messages from the Error and Fatal
levels.
Error – Generate log entries for errors only. This also includes messages from the Fatal level.
Fatal – Generate log entries for fatal errors only.
4. Locate the following line in the file:
<logger name="*"minlevel="Fatal" writeTo="file" />
5. Change the value assigned to minlevel so that it matches the verbosity level assigned to
globalTheshold.
6. Save the file.
(To disable generation of log entries, change just the value for globalTheshold back to Off.)
Note: If BSS API for EMS fails to generate log files after it was properly configured, see the troubleshooting
section on page 29.

Local (As a .NET DLL)

This section describes how to set up the BSS API as a .NET DLL.
1. Navigate to the following location on the computer where Sentinel LDK Vendor Tools are installed:
%SystemDrive%\Program Files (x86)\SafeNet Sentinel\Sentinel LDK
\Legacy\API\BusinessStudioServer\bin\
(For Windows x86, use %SystemDrive%\Program Files\...)
2. Copy the following files from the bin directory to your DLL directory (all the files must be in the same
directory):
• HaspBusinessStudioServer.dll
• Nlog.dll
• HaspBusinessStudioServer.dll.config
• NLog.config

3. Ensure that HaspBusinessStudioServer.dll and System.Web.Services.dll are referenced in your .NET

application.
4. If Sentinel EMS is configured to use SSL, modify HaspBusinessStudioServer.dll.config as follows:
a. Locate the following line in the file:
<add key="useSSL" value="false" />
b. Change the value false to true.
c. Save the file.
Migration Guide: Sentinel HASP Sentinel LDK 26

5. By default, BSS API for EMS does not generate log file entries. You can enable generation of log file
entries and set the verbosity level of the API . Modify Nlog.config as follows:
a. Locate the following line in the file:
globalThreshold="Off"
b. Change the value Off to the desired log verbosity level. Possible log verbosity levels are:
Debug – Generate verbose log entries. This also includes messages from the Error and
Fatal levels.
Error – Generate log entries for errors only. This also includes messages from the Fatal
level.
Fatal – Generate log entries for fatal errors only.
c. Locate the following line in the file:
<logger name="*"minlevel="Fatal" writeTo="file" />
d. Change the value assigned to minlevel so that it matches the verbosity level assigned to
globalTheshold.
e. Save the file.
(To disable generation of log entries, change just the value for globalTheshold back to Off.)
6. In your application, be sure to modify the call to the Initialize method in the BSS API as necessary in
order to connect to the Sentinel EMS server.
7. Recompile your .NET application.
Migration Guide: Sentinel HASP Sentinel LDK 27

Appendix A: Working With the Sentinel EMS Web Interface

Vendors who have been working with the Business Studio user interface may require some time to become
familiar with the Sentinel EMS Web interface.
The Sentinel EMS Web interface includes a complete online help system. An overview of the Web interface
is also provided in the Sentinel LDK Software Protection and Licensing Guide.
To assist you in becoming familiar with the Sentinel EMS Web interface, the table below lists the major
activities in Business Studio and provides the equivalent activities in Sentinel EMS.
Business Studio Activity Sentinel EMS Activity Notes
Customers > Define New Customers > New Customer
Customers > Manage Activation of a Entitlements > Product Keys > Edit
Product
Customers > Modify Customers > Edit
Customers > Obsolete Customers > Disable
Customers > Restore Customers > Enable
Development Tasks > Export Developer > Export Catalog
Definition Data Definitions
Development Tasks > Generate Developer > Bundle Provisional
Bundle of Provisional Products Products
Development Tasks > Generate Run- Developer > RTE Installer
time Environment Installer
Development Tasks > RUS Branding Developer > RUS Branding
Distribution Channels (Not supported)
Manage Features > New Catalog > Features > New Feature
Manage Features > Obsolete Catalog > Features > Action >
Obsolete
Manage Features > Open Catalog > Features > Actions > Edit
Manage Orders > Check in C2V Entitlements > Check in C2V
Manage Orders > Delete Entitlements > Actions > Delete
Manage Orders > New Entitlements > New Entitlement
Manage Orders > Open Entitlements > Actions > Edit
Manage Orders > Reopen (Change Entitlements > Actions > Reopen
status to On Hold)
Manage Products > Delete Catalog > Product > Actions >
Delete
Manage Products > Duplicate Catalog > Product > Actions > Copy
Manage Products > New Catalog > Products > New Product
Manage Products > New Catalog > Product > Actions >
Cancellation Cancellation
Manage Products > New Catalog > Product > Actions >
Modification Modification
Manage Products > New Provisional Catalog > Product > Actions >
Provisional
Manage Products > Obsolete Catalog > Product > Actions > End
of Life
Migration Guide: Sentinel HASP Sentinel LDK 28

Business Studio Activity Sentinel EMS Activity Notes

Manage Products > Open Catalog > Product > Actions > Edit
Manage Products > Restore Catalog > Product > Actions >
Complete
Master Keys > Apply Licenses to Administration > Master > Update
Master Key Master
Master Keys > Configure Email Administration > Master > E-mail
Notification Notification
Master Keys > Editing Batch Code (Not supported)
Properties
Master Keys > Introducing Start Menu > Programs > SafeNet
Sentinel > Sentinel LDK > Tools >
Sentinel Master Wizard
Master Keys > Order Licenses Administration > Master > Collect
Information
Master Keys > View Master Key Administration > Master Select the Master
License Details key to view.
Production > Check in C2V and Key Entitlements > Check In Key
data
Production > Define Production Entitlements > Actions > New
Order
Production > Edit Memory at order Entitlements > New Entitlement >
time Memory
Production > Produce Entitlements > Actions > Produce
Production > Recycle Keys Entitlements > Recycle
Production > View Entitlements Select the
Entitlement to view.
Reports > Generate Reports Reports > Generate Report
Reports > Scheduling Reports > Scheduled Reports
Users > Change Password (for Administration > Users > Edit >
another user) Change Password
Users > Change Password (for your Change Password (from main
own password) screen)
Users > Defining Administration > Users > New User
Users > Modifying Administration > Users > Edit
Migration Guide: Sentinel HASP Sentinel LDK 29

Appendix B: Troubleshooting
This appendix describes possible solutions to certain issues that may occur during the migration process or
when attempting to work with BSS API for EMS.

Migration Tool Fails to Back Up BSS Database or EMS Database

When you click the Back up Database button in the Migration Tool, the backup process may fail with the
following message:
The backup file cannot be saved to the specified location – access was denied. Choose a different
location.
This error may occur if the SQL service that is used to back up the database does not have the required
authorization to write to the directory chosen as the backup location.
To resolve this problem:
1. Open the Services window on the local computer.
2. Display the Properties screen for the SQL Server service
3. On the Log On tabbed page, select Log on as Local System account.
4. Click OK.
5. Click the Back Up Database button again.

Migration Tool Freezes During the Pre-migration Process

The Migration Tool may stop responding while it prepares the BSS database for migration. The following
window is displayed for an extended period of time (approximately 20 minutes):
Migration Guide: Sentinel HASP Sentinel LDK 30

If this occurs, click Cancel and restart the Migration Tool. It is not necessary to back up the BSS database or
Sentinel EMS database again at this point.
If the same problem continues to occur after one or two retries, clean up the BSS database and restart the
process.
To clean up the BSS database:
1. Click Cancel to stop the Migration Tool.
2. Connect to the BSS database using SQL Server Management Studio and do the following:
a. Back up the BSS database.
b. Run CleanKeyOrderForMigration.sql. This can be found in the directory:

\BusinessStudioServer-Migration\bss\Handler\HASPProductionManageMigration\sql\mssql\
3. Restart the Migration Tool.

BSS API for EMS Fails to Generate Log Files

Under certain operating systems (such as Windows Vista, Windows 7, Windows 2008) BSS API for EMS may
fail to generate log files even if properly configured.
This problem will occur if the user account under which the ASP.NET process runs does not have write
access to the directory that contains the log files for the API.
To resolve this problem, ensure that the user account under which the ASP.NET process runs has the
necessary write access.
By default, the log files are written to the directory where BSS API for EMS is installed. By default, this
directory is: %SystemDrive%/Inetpub/wwwroot/BusinessAPI/
If the user account for the ASP .NET process does not have write access to the directory above, you can
assign a different directory to contain the log files.
To change the directory to contain the BSS API for EMS log files:
4. Open the file Web.config in a text editor. This file is typically located in the directory:
%SystemDrive%/Inetpub/wwwroot/BusinessAPI/
5. Locate the following line in the file:
fileName="${basedir}/logs/${shortdate}.log"
6. Replace ${basedir} with the directory to contain the log files. For example, if you want the log files
to be written to the subdirectory logs under c:\temp, change the line as follows:
fileName="c:\temp/logs/${shortdate}.log"
7. Save the file.
8. Ensure that the specified directory (in this example, c:\temp) exists.