Migration Guide

Sentinel HASP to Sentinel LDK

Migration Guide: Sentinel HASP to Sentinel LDK

Copyrights and Trademarks
Copyright © 2013 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.

August 2013 Sentinel LDK v.7.0

Revision 1308-1

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 Changes at Customer Sites .................................................................................................. 8 Replacing the Sentinel HASP Activation Server ................................................................... 8 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 Visibility of Automatically-created Features and Products .............................................. 10 Distribution Channel Functionality .................................................................................. 10 Reports ............................................................................................................................ 11 User Name ...................................................................................................................... 11 Clone Protection ............................................................................................................. 11 Customer Attributes ........................................................................................................ 11 Miscellaneous Field Reassignments .............................................................................. 12 Migration of Orders for HASP HL Max Micro Keys ......................................................... 13 Migration of Products That Do Not Contain Features ..................................................... 13 Migration of Completed Orders in the Demo Database .................................................. 13 Performing a Trial Migration ................................................................................................ 13 Preparing for Migration ........................................................................................................ 13 Estimate Time Required for Migration ............................................................................ 13 Install Sentinel EMS ........................................................................................................ 14 Set Up Sentinel LDK Data Migration Tool ...................................................................... 14 Determine Batch Codes to be Migrated .......................................................................... 14 Ensure That Sentinel EMS and BSS Database Services are Active .............................. 15 Ensure That the Required Master Keys are Connected ................................................. 15 Back Up Sentinel EMS Database and BSS Database (Optional) .................................. 15 Migrating the BSS Database ............................................................................................... 15 Run the Sentinel LDK Data Migration Tool ..................................................................... 15 Reintroduce the Master Keys .......................................................................................... 18 Verifying the Success of the Migration Process .................................................................. 18

............................................................................................................................................ 21 Retrieving Orders Based on Order ID .................................................... 20 Overview .................................... 19 Migrating Backend Systems That Use BSS API .............Migration Guide: Sentinel HASP Sentinel LDK Stopping the SQL Service for the BSS Database ......................................................... 27 Appendix B: Troubleshooting ................................................ 29 Migration Tool Freezes During the Pre-migration Process ...................................................................................... 20 AddProductsToOrder Method ................................................................................................................................................................................................................. 19 Performing BSS and Sentinel EMS Database Rollback in Case of Failure ..............................................................................NET DLL) .................................... 20 InsertCustomer Method ................................................................................. 29 BSS API for EMS Fails to Generate Log Files ................. 19 Implementing the Business Studio Server API for Sentinel EMS ........................................................................................ 20 Prerequisites ..................... 21 Other Changes to BSS API Functions ................ 21 Retrieving Customers Based on Customer ID .............................................................................. 22 As an ASP........... 22 Local (As a .................................................................................................................................................................................. 30 4 ..................NET SOAP Web Service ..................................................... 22 Setting Up Business Studio Server API for Sentinel EMS ................... 20 Functionality Changes .................................. 29 Migration Tool Fails to Back Up BSS Database or EMS Database ................................................................................. 25 Appendix A: Working With the Sentinel EMS Web Interface .............

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. This guide describes how to migrate to the Sentinel EMS database and Sentinel LDK. This avoids the need to convert your applications to use Sentinel Web Services. which utilizes HASP HL keys. For more information. About This Guide This guide is intended for the following types of ISVs: • ISVs who currently use the (Sentinel HASP) Business Studio Server database to manage orders and licenses for Sentinel HASP. and secure and flexible licensing. For more information. ISVs who currently use the Sentinel HASP Business Studio Server API.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. Sentinel LDK is an all-in-one Software DRM solution that enables you to choose a hardware. see Migrating the Business Studio Server Database to Sentinel EMS Database on page 7. provides the safest and strongest level of protection. Sentinel LDK hardware-based protection. protection for Intellectual Property.or software-based protection key. based on business considerations. see “Implementing the Business Studio Server API for Sentinel EMS” on page 20. • . 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.

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.Migration Guide: Sentinel HASP Sentinel LDK 6 Migration Options The following types of Sentinel HL keys are available. your protected application must include the Licensing API libraries from Sentinel LDK v. These keys can be used without installing the Runtime Environment. and you must be working with the backend from Sentinel LDK v.0. These keys can work with your existing API libraries and Run-time Environment. and you can work with your current backend environment. see the Sentinel LDK Software Protection and Licensing Guide. but order Sentinel HL (HASP configuration) keys. • Sentinel HL (Driverless configuration) keys These keys make use of HID drivers (included in the Windows operating system) instead of SafeNet drivers. Run-time Environment and Run-time API libraries. and order Sentinel HL (HASP configuration) keys.7. To use these keys. Migrate to Sentinel LDK (as described in this migration guide). 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.7. . Migrate to Sentinel LDK (as described in this migration guide). and order Sentinel HL (Driverless configuration) keys. It is not necessary to replace their current AP libraries or Run-time Environment. For information on upgrading Sentinel HL (HASP configuration) keys to the Driverless configuration.0. It is necessary in this case to replace their current AP libraries and Run-time Environment. ISVs who are currently working with Sentinel HASP (or HASP SRM) have the following options: • • • Remain with their current (Business Studio Server) back end.

Refer to the Sentinel HASP v.0 is released. v.5. contact your SafeNet sales representative.0.0. After upgrading to Sentinel HASP v.5.5.12.5.5. This section describes how to use the Sentinel LDK Data Migration Tool to perform this process.x or v. . Using this tool. you can handle the transition from Sentinel HASP BSS to Sentinel EMS with a relatively small effort. 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. For more information. follow the procedures in this migration guide.7.5.12.0.10 or v. Wherever possible.5. 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.x: o o Target Audience The migration process is appropriate for ISVs who are currently using Sentinel HASP v. v.7.12 Installation Guide for information on how to upgrade from earlier versions of HASP SRM.10 or v. • To migrate from Sentinel HASP v. To migrate from HASP SRM v.5. the Data Migration Tool creates required new entities automatically or coverts existing entities as required. No procedure is provided to migrate data from the Sentinel EMS database to the Sentinel HASP BSS database. Note: The migration process is not reversible. For ISVs who require Language Packs for Sentinel EMS and Sentinel LDK Vendor Tools: Language Packs will be made available several months after Sentinel LDK v.3.12 and who want to advance to Sentinel LDK v.4.12: o • Follow the procedures in this migration guide.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. First upgrade to Sentinel HASP 5.

perform pre-migration modifications to the Business Studio Server database. (If you use the Sentinel HASP Activation API to activate licenses online) Disconnect the Activation Server from the Internet. b. see the Sentinel LDK Software Protection and Licensing Guide. followed by a changeover from the Sentinel HASP Activation Server to Sentinel EMS. In parallel. Review the limitations and workarounds. The change from Sentinel HASP Activation Server to Sentinel EMS is accomplished using one of the methods described in this section. Replacing the Sentinel HASP Activation Server If you currently use the Sentinel HASP Activation API to activate licenses online. Once the Run-time Environment v. When you are satisfied with the migration process. perform the migration of your production database: a. 6. c. 2. For information on the different types of HASP SL keys used in Sentinel LDK. Each of these procedures is describes in this migration guide. Reintroduce your Master keys Verify the success of the migration. Migrate your Business Studio Server database to the Sentinel EMS database. Enable Product activation. . 5. HASP SL keys that were created with Sentinel HASP Business Studio will appear in the Sentinel Admin Control Center as "SL-Legacy" keys. 1. 4. Any SL-Legacy key for which you issue an update using Sentinel LDK can be optionally changed to an “SL-AdminMode” key. Set up Sentinel EMS Data Migration Tool. 8. Determine which issues will require corrective actions.6. you must plan for a period of downtime. d. Changes at Customer Sites If you work with HASP SL licenses.6.23 or later. prepare modifications to your current ERP and CRM systems to work with Business Studio Server API for Sentinel EMS. Perform a trial migration. you must ensure that customers who receive new or updated HASP SL keys install Sentinel LDK Run-time Environment v. if you work with Business Studio Server API. If necessary. 7.Migration Guide: Sentinel HASP Sentinel LDK 8 Summary of the Migration Process The migration process consists of the sequence of procedures that follows. Install Sentinel EMS. Select the Batch Codes to be migrated. 3. Migrate the backend systems that use Business Studio Server API.23 or later is installed. Review the results to ensure that you are satisfied with the migrated Sentinel EMS database.

Working with Business Studio Server API If you currently use the Business Studio Server API to perform functions in Sentinel HASP. disable the Business Studio Server service.Migration Guide: Sentinel HASP Sentinel LDK 9 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. For more information. see “Implementing the Business Studio Server API for Sentinel EMS” on page 20. At the end of the conversion process. Modify Sentinel EMS to use the same port that was used for the Activation Server. and you must select the Use SSL option in EMS Host Configuration. Method B: Change the Sentinel EMS Port Number By default. after you determine that the conversion was successful. Note that certain Business Studio Server API function calls are not supported or may require some modification. Thus. Reconnect the machine to the internet. 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. . However. Install Sentinel EMS on the machine that contains the Sentinel HASP Activation Server. the protected applications that you distribute to customers communicate with the Activation Server using port 443. 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. note that Sentinel LDK provides a comparable web services interface to perform actions in Sentinel EMS. At the start of the migration process. to protect your investment in your current ERP and CRM systems and provide backwards compatibility. disconnect the Activation Server machine from the internet so that customers do not perform activations during the migration. The installation must be performed using the Advanced setup type. At the end of the migration process. Before you undertake the migration of your BSS database to Sentinel EMS. Sentinel LDK provides Business Studio Server API for Sentinel EMS. you must be ready to implement Business Studio Server API for Sentinel EMS in your backend systems. In addition. you must use a different port than the port used by Business Studio Server. modify the DNS address to point to the Sentinel EMS computer. after migration to Sentinel EMS. This is an updated version of Business Studio Server API that translates API function calls into the equivalent Sentinel EMS web services. you can continue to use your existing backend systems with practically no modification. Restart Sentinel EMS. after you determine that the conversion was successful.

See “Determine Batch Codes to be Migrated” on page 14. Visibility of Automatically-created Features and Products When a Sentinel HASP protection key or C2V file is checked in to the Sentinel EMS (or Business Studio Server) back end. . Distribution Channel Functionality The Distribution Channel functionality that exists in Sentinel HASP is not supported in Sentinel LDK.Migration Guide: Sentinel HASP Sentinel LDK 10 Which Data is Migrated? By default. in subsequent executions of the Migration Tool. 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. some functionality that exists in Business Studio Server is not present in Sentinel EMS. and the key or C2V file contains Features or Products that are not recognized by the back end. each entity that exists in the BSS database will be migrated to the Sentinel EMS database. If these users are enabled. However. 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. Sentinel HASP can be configured to hide or display these automatically-created Features and Products. Limitations and Workarounds While Sentinel EMS provides significant advantages over Business Studio Server. Distribution Channel users will be migrated to Sentinel EMS as “disabled” and can be enabled manually in Sentinel EMS. the modifications will not be present in the Sentinel EMS database. This section describes these limitations and any available workarounds. However. (You can limit the Batch Codes for which data is migrated. the back end automatically creates the unrecognized Features or Products in the database.) You can run the Data Migration Tool more than once for a given set of databases. only items that do not already exist in the Sentinel EMS database will be migrated. Thus. No functionality exists in Sentinel EMS to hide these items. Automatically-created Features and Products that are migrated from Sentinel HASP will always be visible in Sentinel EMS. If the user account was modified between the two executions of the Migration Tool. they will have access to all Products and to Entitlements for all Products that are a part of the ISV Batch Code. Sentinel EMS does not place any restrictions on the users based on Distribution Channel Products.

all Products licensed by that HASP SL key become disabled. The table that follows indicates how the Name. the Migration Tool places whichever information is available in the Description field in the Sentinel EMS database. In Sentinel LDK. a Business Studio user name can contain the characters “-”. Customer Attributes The Migration Tool converts all customers from the BSS database to customers of type Company in Sentinel EMS. Clone Protection In Sentinel HASP.com to the migrated Sentinel EMS user. If a cloned HASP SL key is detected. If a Business Studio user does not have an email address. (Note.email. The value from the Name field in BSS is migrated to the Company Name field in Sentinel EMS. or if the E-mail address is not unique. If cloning is detected for an SL Legacy key that was migrated from Sentinel HASP to Sentinel EMS. a new SL (AdminMode) activation must be performed. that you can define custom reports in Sentinel EMS.) User Name In Sentinel HASP. “&”. and E-mail address must be unique.Migration Guide: Sentinel HASP Sentinel LDK 11 Reports Sentinel EMS does not provide the same business intelligence reports that exist in Business Studio. and space. if either of these does not exist in the BSS database. any activated (or locked) HASP SL key is clone-protected. any of these characters in a user name is converted to “_”. E-mail address and Contact Name must always be provided together in Sentinel EMS. A Sentinel EMS user must have an email address. A Sentinel EMS user name cannot contain these characters. These requirements do not exist in Sentinel HASP. . E-mail and Contact Person fields from the BSS database are migrated to the Sentinel EMS database. however. the Migration Tool assigns the email address userName@needs. Therefore. clone protection can be enabled or disabled for each Product. Therefore.

the field value in Sentinel EMS is: HASP_CustomerID_originalValue In Sentinel EMS. the values of the three fields are combined in the Street Field. (Customer) Customer ID (Customer) CRM ID (Customer) Street. Zip (Customer) Street (User) Full Name (User) Description (User) Ref ID 1 (User) Ref ID 2 . the field value in Sentinel EMS is: HASP_OrderID_originalValue After migration.Migration Guide: Sentinel HASP Sentinel LDK 12 Business Studio Server (BSS) Database (Customer) Name Field (Customer) E-mail Field Unique or Duplicate Unique None Contact Person Field None Sentinel EMS Database For all migrated customers: (Customer) Type = Company Company Contact Contact Name Description Field Name Field E-mail Field Field (Customer) None None Contact Person: BSS Contact Person Provided Name from None None BSS E-mail from (Customer) None BSS Name from BSS Provided E-mail from Contact BSS Person from BSS Duplicate None Provided None None None None Duplicate Email: BSS Email 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. BSS Database Field (Order) Order ID Sentinel EMS Database Field (Entitlement) Ref ID 2 Notes After migration. Exceptions are listed in the table that follows. City.

Migration Guide: Sentinel HASP Sentinel LDK 13 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. 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). such as the connection speed to the databases. 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. the key will appear in the entitlement in Sentinel EMS as HL-Max instead of HL-Max-Micro.) Migration of Products That Do Not Contain Features It is possible for a Product to contain memory content for a protection key. to ensure uninterrupted service for your production environment. However. After you complete a trial migration process. but no Features. If a Product with no Features is migrated from the BSS database to Sentinel EMS. (Note that the Max key and Max Micro key are functionally equivalent. it will not be possible in Sentinel EMS to download V2C files for completed orders that exist in the Demo database. 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. This issue has no bearing on your production database. After you are satisfied that the migration proceeds as expected and that you are prepared to handle any resulting changes. Preparing for Migration Estimate Time Required for Migration Various factors. in part. affect the amount of time required for migration of the BSS database to Sentinel EMS. you are ready to perform migration for your production environment. As part of your trial migration. As a result. if you choose to migrate the Demo database. the Product will be assigned a new Product ID – it will not receive the original product ID. no such limitation applies. SafeNet highly recommends that you perform a trial migration and validation of your BSS database in a test environment using the procedures described below. Performing a Trial Migration SafeNet has attempted to anticipate and handle any problems that may arise during the migration process. perform the validation steps described later in this document (see “Verifying the Success of the Migration Process” on page 18). . for orders that you entered and completed yourself in the Demo database. not well-formed. However.

cfg file.com/technetwork/java/javase/downloads/java-se-jre-7-download-432155.2.1 (from Sentinel LDK 6. add a line that contains the name of the Batch Code to the vendors_blacklist. Locate the following directory on the on the Sentinel LDK Installation DVD: \Windows\Installed\VendorTools\Utilities\BusinessStudioServer-Migration\ Copy the BusinessStudioServer-Migration directory and all of its contents to the computer that contains Business Studio Server. For each Batch Code that should not be migrated.7.cfg in the directory that contains the Migration Tool on the Business Studio Server machine.) If you use multiple Batch Codes (besides DEMOMA) in your BSS database. If you did not install Sentinel EMS on the same computer as Business Studio Server. 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.0 Installation Guide. For more information. copy the BusinessStudioServer-Migration directory to the computer where the Management Server was installed. see the Sentinel LDK v. Note: If your installation of Business Studio Server was split into separate installations of the Activation Server and Management Server. JRE 7 is available from: http://www. If Sentinel EMS v. 2. The migration process requires approximately one hour for each gigabyte of data to be migrated. you clear the Fill Demo Data check box for installing demo data. Install Sentinel EMS Install Sentinel EMS v. ensure that Java Runtime Environment 7 (JRE 7) is present on the Business Studio Server computer.Migration Guide: Sentinel HASP Sentinel LDK 14 The size of the BSS database is the primary factor that determines the amount of time required.0. the Migration Tool migrates the data for all Batch Codes to the Sentinel EMS database. 2.0 Installation DVD. then by default.7. and you want to migrate only selected Batch Codes to the Sentinel EMS database.html Determine Batch Codes to be Migrated If your BSS database contains data for several Batch Codes. Note: Sentinel LDK Data Migration Tool provides a built-in function to back up the Sentinel EMS database.7. SafeNet recommends that you install Sentinel EMS on the computer where Business Studio Server is installed.0 from the Sentinel LDK v.7. Create a text file named vendors_blacklist.0) is present on the computer where you will install Sentinel EMS v. refer to the upgrade instructions in the Installation Guide. Note: If you want to migrate data for the DEMOMA Batch Code from Sentinel HASP to Sentinel EMS. in the Sentinel EMS Database Configuration screen. (Data for the DEMOMA Batch Code is only migrated if you specifically request this in the Migration Tool. be sure that during Sentinel EMS installation.oracle. 3. . do the following: 1.

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. 2. Switch to the directory that contains the Migration Tool on the Business Studio Server computer. Double-click MigrationTool. Run the Sentinel LDK Data Migration Tool as follows: 1.jar. manually back up that database now. No Master key is required for the DEMOMA Batch Code or for any Batch Code in the Blacklist file. Windows 7. However. 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.jar . 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. However. on the Business Studio Server machine). 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. If either database is located on a remote computer. 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.Migration Guide: Sentinel HASP Sentinel LDK 15 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. or Windows 2008) Open a Command window as an administrator and enter: Java –jar migrationTool. OR (For Windows Vista.

If you want to migrate demo data (DEMOMA Batch Code) from the BSS database to the Sentinel EMS database. you can click Back Up Database now to back it up. The following screen is displayed: 3. If you have not yet backed up the BSS database. . 6. 5. 4. 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.) Note: If the database backup fails.Migration Guide: Sentinel HASP Sentinel LDK 16 The Migration Tool starts. refer to “Appendix B: Troubleshooting” on page 29. Click Next. (This function can only be used if the BSS database is located on the local machine. select the Migrate demo data check box. Click Test Connection to confirm that the Migration Tool can connect to the database.

Click Next to continue. If you have not yet backed up the Sentinel EMS database. Note: If the database preparation phase of the process freezes. . refer to “Appendix B: Troubleshooting” on page 29. The migration process begins. 10. A screen similar to the following is displayed: 8. If necessary. (This function can only be used if the Sentinel EMS database is located on the local machine. The complete contents of this report can also be found in: \BusinessStudioServer-Migration\migration_date_time. Upon completion of the migration process: • A detailed report of the migration process is displayed in a browser window.html. Click Test Connection to confirm that the Migration Tool can connect to the database. Progress screens are displayed during this process. enter the connection parameters. you can click Back Up Database now to back it up. Click Next to continue. If Sentinel EMS is installed on a remote computer. 11. refer to “Appendix B: Troubleshooting” on page 29. The User Name field should contain the name of a user who has full administrator privileges for the Sentinel EMS database. modify firewall settings so that the Migration Tool can communicate with the Sentinel EMS database server.Migration Guide: Sentinel HASP Sentinel LDK 17 7.) Note: If the database backup fails. 9. This process may require several hours.

Examine samples of the various entities (such as Features. Perform the following activities: • • • Review the contents of the migration report (described earlier). Verifying the Success of the Migration Process After completion of the migration process. Review the reports to ensure that the contents are consistent with the expected results. customers and entitlements) in Sentinel EMS and verify that the information displayed matches the data that exists in Sentinel HASP. Determine if any adjustments are required to the migrated data or if any warning require your attention. If Sentinel EMS is installed on different computer from Business Studio Server. Perform the procedure for introducing Master keys in Sentinel EMS. move the relevant Master keys to the Sentinel EMS computer.Migration Guide: Sentinel HASP Sentinel LDK 18 • A screen similar to the following is displayed: You can click View Report to reopen the detailed report 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. (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. Reintroduce the Master Keys The Sentinel Master key for each Batch Code that was migrated to Sentinel EMS must be reintroduced. . Generate reports that are available in Sentinel EMS. Products.

Restore the database. 2. Performing BSS and Sentinel EMS Database Rollback in Case of Failure The migration process changes both the BSS database and the Sentinel EMS database. perform the following steps for each database to roll back the database to its original state. Migrating Backend Systems That Use BSS API For ISVs that work with Business Studio Server API: When you are satisfied that your BSS database has been successfully migrated to the Sentinel EMS database. see Implementing the Business Studio Server API for Sentinel EMS on page 20. see Appendix A: Working With the Sentinel EMS Web Interface on page 27. Among the transaction you perform. Stopping the SQL Service for the BSS Database Once the migration process has completed. For more information.Migration Guide: Sentinel HASP Sentinel LDK 19 • Perform sample transactions in Sentinel EMS and verify that the transactions complete as expected. For assistance in performing the validation activities. The migration process adds certain files in the directory containing the BSS database. . 3. Perform a HASP update. Ensure that the Business Studio Server service is stopped and that its Startup Type is set to Disabled. Start the database server. If the migration from Sentinel HASP to Sentinel EMS does not succeed. be sure to perform the necessary steps to prepare your CRM and ERP systems to use the Business Studio Server API for Sentinel EMS. Activate a migrated entitlement. SafeNet recommends that you do the following:     Download an existing update for a protection key Generate a new update for an existing protection key. These files can be ignored. They will not interfere when you run the migration process again after resolving the problems encountered. 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. Stop the database server. 1.

For more information regarding the methods described in this section. Thus.0 or later. this method adds new Products to an existing order.chm help file. Functionality Changes This section describes changes in the behavior of certain methods in BSS API for EMS. see the business_studio_server_api_en-US.7. to add Products to an entitlement.0). this method replaces all the products in the entitlement with the Products contained in the inProducts array.5. 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.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. Your backend applications must be compatible with Sentinel Business Studio Server API v. This can be found on the Sentinel LDK Installation DVD. you have the option of calling functions both in the BSS API for EMS and in Sentinel EMS Web Services.7. under: \Windows\Installed\Legacy\API\BusinessStudioServer\ AddProductsToOrder Method In Sentinel HASP BSS API. after migration to Sentinel LDK. you can continue to use your existing backend systems with a minimum of modification. . This enables you to take advantage of any new functionality that is not supported in the BSS API. However. the in Products array must contain both the Products that exist in the entitlement and the Products to add to the entitlement.0 (this is provided with Sentinel LDK v. ISVs 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. Prerequisites You must be using Sentinel EMS v. Note that this change in the functionality enables you to use the AddProductsToOrder method to remove Products from an existing entitlement. In BSS API for EMS. Note: In your applications. Thus.

Migration Guide: Sentinel HASP Sentinel LDK 21 InsertCustomer Method In BSS API for EMS. Middle Name Contact E-mail Fax Company Name Telephone Ref ID Enabled: Yes or No Zip Code (If you want to insert a customer of type Individual. see “Miscellaneous Field Reassignments” on page 12. see “Miscellaneous Field Reassignments” on page 12.) Therefore. (For more information. 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. Last Name. and GetProductionOrders methods search both Ref ID 1 and Ref ID 2 fields in entitlements for the value specified by the inReference parameter. when you use this method to search for customers based on the value of customer ID. the value for the Ref ID 2 field cannot be retrieved using BSS API. you can use the functions available in the Sentinel EMS Web Services. the method will appear to retrieve customers that do not contain the specified value. Mandatory if Contact is provided. the customer ID value is contained in the CRM ID field. when you use one of these methods to search for entitlements based on the value of Order ID. the Order ID value is contained in the Ref ID 2 field. (For more information. This method will retrieve customers for which either of these fields contains the specified value. However. However.) Therefore. No Yes No No No No Parameter in BSS API for EMS Street Contact Information: First Name. this method will always insert a customer of type Company (rather than Individual). the method will appear to retrieve entitlements that do not contain the specified value. .) Retrieving Orders Based on Order ID The GetAllOrders. After migration from Sentinel HASP to Sentinel EMS. even though the value is present. GetNewOrders. the value for the CRM ID field cannot be retrieved using BSS API. These methods will retrieve orders for which either of these fields contains the specified value. After migration from Sentinel HASP to Sentinel EMS. even though the value is present. Additional parameters are mapped as follows: Parameter in Sentinel HASP BSS API Address Contact Email Fax Name Phone Reference Status Zip Code Parameter is Mandatory No Mandatory if Email is provided.

HASP_BA_NO_ORDERS in BSS API for EMS. Windows 2003. EOL state is mapped to OrderStatus.FormatType (field) KeyOrders.NET SOAP web service or locally (as a . either on the computer where you installed Sentinel EMS or on a separate computer in the same network.NET SOAP Web Service You can install BSS API for EMS as a Web Service. Ensure Prerequisites The computer on which you install BSS API for EMS as a Web Service must satisfy the following prerequisites: • • Microsoft Windows XP.PROVISIONAL ( enum item) KeyOrders. This section describes the prerequisites and the procedure for performing this installation. out string outV2C) returns HaspBssStatus. Therefore. Therefore. public HaspBssStatus ProduceProvisionalOrder(int inOrderID. public HaspBssStatus ClearClonedHaspSLKey(string inC2V.None in BSS API for EMS. Windows 2008. or Windows 7 Microsoft . string inReference. As an ASP. Therefore.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. public HaspBssStatus GetProvisionalOrders(int inBatchID. ProductProvisionalOrders method is not supported.HASP_BA_UNSPECIFIED in BSS API for EMS.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. Windows Vista.HASP_BA_UNSPECIFIED in BSS API for EMS. out Order[] outOrders) returns HaspBssStatus.0 or later . out string outV2C) returns HaspBssStatus.NET Framework version 2. ClearClonedHaspSLKey method is not supported. • • Setting Up Business Studio Server API for Sentinel EMS BSS API for EMS can be set up either as an ASP. ProduceProvisionalOrder method is not supported.NET DLL). Therefore.

j. You can accept all defaults or make changes as required. e. Select the Web Server (IIS) check box. you are prompted to install it manually.1 or later When you launch the setup executable.Migration Guide: Sentinel HASP Sentinel LDK 23 • • Windows Internet Information Services (IIS) version 5. • • If the presence of the . Windows 7: Under Programs & Features. In the Add Roles wizard. d. click Server Roles in the navigation panel. c. click Go to Roles > Add Roles. Click Next. the following configuration is required to enable compatibility with the IIS 6 metabase: • • Windows Vista: Under Programs & Features.NET Framework and MSI Installer is not detected. In the Server Manager screen . g. Click Add Required Features. Click Next. and the setup application terminates. .Roles Summary pane. Configure IIS Depending on the operating system of the computer on which you plan to install BSS API for EMS.0 or later Windows MSI Installer version 3. Select IIS 6 Management Compatibility. The BSS API for EMS installation wizard starts. go to Turn Windows features on or off. Windows 2008 Server: a. go to IIS > Web Management Tools > IIS 6 Management Compatibility and select IIS Metabase & IIS 6 Configuration Compatibility. Click Install.exe. i. Navigate to the following location on the Sentinel LDK Installation DVD: \Windows\Installed\Legacy\API\BusinessStudioServer\WebSetup\ Double-click setup. 2. the application checks to ensure that the computer satisfies the prerequisites. h. If the IIS component is not detected. these components are automatically downloaded and installed. if you have installed IIS 7 or IIS 7. Click Next. f.5. b. Proceed through the installation wizard. • Install Business Studio Server API for Sentinel EMS To install BSS API for EMS as a Web service: 1. 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. Under Programs & Features.

You can enable generation of log file entries and set the verbosity level of the API as follows: 1.config in a text editor.config file. This file is typically located in the directory: %systemDrive%/Inetpub/wwwroot/BusinessAPI/ Locate the following line in the file: <add key="useSSL" value="false" 3. By modifying the useSSL parameter in the IIS management console. you must also set up BSS API for EMS to use SSL. Open the file Web.asmx If a page describing the Sentinel HASP Business Studio Server API is displayed. To modify the useSSL parameter in the IIS management console: To modify the useSSL parameter directly in the web. This file is typically located in the directory: %systemDrive%/Inetpub/wwwroot/BusinessAPI/ Locate the following line in the file: globalThreshold="Off" . 2. If you have set up Sentinel EMS Service to use SSL. Under Default Web Site. In your application. In the Application Settings properties. Open the file Web.config file: 1. find the UseSSL key.config in a text editor. Change the values for the key to true (to enable SSL). the Web Service was installed correctly.Migration Guide: Sentinel HASP Sentinel LDK 24 3. Save the file. (Optional) Confirm that the Web service was installed correctly by accessing the following URL: http://localhost/BusinessAPI/BusinessAPIService. Sentinel EMS Service is configured to operate without using SSL. 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. change the value from false to true. Start the Internet Information Services (IIS) management console using the method that is appropriate for your operating system. 2. 4. Configure Log File Generation (Optional) By default. choose Site (or Web Site).NET > BusinessAPI > Application Settings. BSS API for EMS does not generate log file entries. /> To set up BSS API for EMS to use SSL. select BusinessAPI > ASP. 4. By directly modifying the useSSL parameter in the web. You can set up BSS API for EMS to use SSL: • • 1. Under the entry for the relevant computer. 2.

NET DLL) This section describes how to set up the BSS API as a .dll HaspBusinessStudioServer.NET DLL. (To disable generation of log entries. Change the value Off to the desired log verbosity level. Fatal – Generate log entries for fatal errors only.dll. /> 4. This also includes messages from the Fatal level. 4.NET application. c.dll and System. 5.) Note: If BSS API for EMS fails to generate log files after it was properly configured. Possible log verbosity levels are: Debug – Generate verbose log entries. b.config Ensure that HaspBusinessStudioServer. If Sentinel EMS is configured to use SSL. Locate the following line in the file: <add key="useSSL" value="false" Change the value false to true.dll.Migration Guide: Sentinel HASP Sentinel LDK 25 3. Error – Generate log entries for errors only. 2. Locate the following line in the file: <logger name="*"minlevel="Fatal" writeTo="file" /> Change the value assigned to minlevel so that it matches the verbosity level assigned to globalTheshold. Local (As a . see the troubleshooting section on page 29. Navigate to the following location on the Sentinel LDK Installation DVD: \Windows\Installed\Legacy\API\BusinessStudioServer\bin\ Copy the following files from the bin directory to your DLL directory (all the files must be in the same directory): • • • • 3. .config as follows: a.Web. change just the value for globalTheshold back to Off.config NLog. 6.Services.dll Nlog. HaspBusinessStudioServer. 1. Save the file. modify HaspBusinessStudioServer.dll are referenced in your . Save the file. This also includes messages from the Error and Fatal levels.

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

An overview of the Web interface is also provided in the Sentinel LDK Software Protection and Licensing Guide. Business Studio Activity Customers > Define New Customers > Manage Activation of a Product Customers > Modify Customers > Obsolete Customers > Restore Development Tasks > Export Definition Data Development Tasks > Generate Bundle of Provisional Products Development Tasks > Generate Runtime Environment Installer Development Tasks > RUS Branding Distribution Channels Manage Features > New Manage Features > Obsolete Manage Features > Open Manage Orders > Check in C2V Manage Orders > Delete Manage Orders > New Manage Orders > Open Manage Orders > Reopen (Change status to On Hold) Manage Products > Delete Manage Products > Duplicate Manage Products > New Manage Products > New Cancellation Manage Products > New Modification Manage Products > New Provisional Manage Products > Obsolete Sentinel EMS Activity Customers > New Entitlements > Product Keys > Edit Customers > Edit Customers > Disable Customers > Enable Developer > Export Catalog Definitions Developer > Bundle Provisional Products Developer > RTE Installer Developer > RUS Branding (Not supported) Catalog > Features > New Catalog > Features > Action > Obsolete Catalog > Features > Actions > Edit Entitlements > Check in C2V Entitlements > Actions > Delete Entitlements > New Entitlements > Actions > Edit Entitlements > Actions > Reopen Catalog > Product > Actions > Delete Catalog > Product > Actions > Copy Catalog > Products > New Catalog > Product > Actions > Cancellation Catalog > Product > Actions > Modification Catalog > Product > Actions > Provisional Catalog > Product > Actions > End of Life Notes . To assist you in becoming familiar with the Sentinel EMS Web interface.Migration Guide: Sentinel HASP Sentinel LDK 27 Appendix A: Working With the Sentinel EMS Web Interface ISVs 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. the table below lists the major activities in Business Studio and provides the equivalent activities in Sentinel EMS.

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

select Log on as Local System account. Migration Tool Fails to Back Up BSS Database or EMS Database When you click the Back up Database button in the Migration Tool. Display the Properties screen for the SQL Server service 3. Choose a different location. To resolve this problem: 1. Migration Tool Freezes During the Pre-migration Process The Migration Tool may stop responding while it prepares the BSS database for migration. On the Log On tabbed page. 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. Click OK.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. The following window is displayed for an extended period of time (approximately 20 minutes): . 2. 4. Click the Back Up Database button again. the backup process may fail with the following message: The backup file cannot be saved to the specified location – access was denied. 5. Open the Services window on the local computer.

log" 7. click Cancel and restart the Migration Tool. the log files are written to the directory where BSS API for EMS is installed. c:\temp) exists. Click Cancel to stop the Migration Tool. For example.config in a text editor. Windows 7. To resolve this problem. you can assign a different directory to contain the log files. 6. Ensure that the specified directory (in this example. By default. Restart the Migration Tool. To change the directory to contain the BSS API for EMS log files: 4. This file is typically located in the directory: %systemDrive%/Inetpub/wwwroot/BusinessAPI/ Locate the following line in the file: fileName="${basedir}/logs/${shortdate}. This can be found in the directory: \BusinessStudioServer-Migration\bss\Handler\HASPProductionManageMigration\sql\mssql\ 3. Save the file. this directory is: %systemDrive%/Inetpub/wwwroot/BusinessAPI/ If the user account for the ASP . . clean up the BSS database and restart the process. if you want the log files to be written to the subdirectory logs under c:\temp.NET process does not have write access to the directory above. If the same problem continues to occur after one or two retries. change the line as follows: fileName="c:\temp/logs/${shortdate}. Windows 2008) BSS API for EMS may fail to generate log files even if properly configured.NET process runs has the necessary write access.sql. 2. Run CleanKeyOrderForMigration. b.Migration Guide: Sentinel HASP Sentinel LDK 30 If this occurs. 5. 8. By default. Open the file Web.NET process runs does not have write access to the directory that contains the log files for the API. Back up the BSS database. It is not necessary to back up the BSS database or Sentinel EMS database again at this point.log" Replace ${basedir} with the directory to contain the log files. To clean up the BSS database: 1. BSS API for EMS Fails to Generate Log Files Under certain operating systems (such as Windows Vista. Connect to the BSS database using SQL Server Management Studio and do the following: a. ensure that the user account under which the ASP. This problem will occur if the user account under which the ASP.