Sentinel Cloud V.3.6 Quick Start Guide
2 Sentinel Cloud Quick Start Guide Software Version This documentation is applicable for Sentinel Cloud 3.6. Document Revision History Part Number 007-012143-001 Revision J Document Revision Change Date A Sentinel Cloud version 3.0 Release December 2012 B Sentinel Cloud 3.1 release. April 2013 C Sentinel Cloud 3.2 release. June 2013 D Sentinel Cloud 3.3 release. September 2013 E Sentinel Cloud 3.3 release with on-premise support on Linux October 2013 F Sentinel Cloud 3.4 release December 2013 H Sentinel Cloud 3.5 release July 2014 J Sentinel Cloud 3.6 Release May 2015 Disclaimer and Copyrights Copyright 2015, SafeNet, Inc. All rights reserved. http://www.safenet-inc.com/ We have attempted to make these documents complete, accurate, and useful, but we cannot guarantee them 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 and Sentinel are registered trademarks of SafeNet, Inc. All other product names referenced herein are trademarks or registered trademarks of their respective manufacturers. Confidential Information The Sentinel Cloud Services system is designed to protect your applications from unauthorized use. The less information that unauthorized people have regarding your security system, the greater your protection. It is in your best interest to protect the information herein from access by un-authorized individuals.
Introduction 3 Introduction This document provides an overview of Sentinel Cloud and contains instructions on how to quickly start using Sentinel Cloud licensing. In this document: Get Familiar with Sentinel Cloud Licensing Install Sentinel Cloud SDK Create Features, Products, and Entitlements in EMS Compile and Run Integration Samples View Usage Reports Where to Go Next?
4 Sentinel Cloud Quick Start Guide Get Familiar with Sentinel Cloud Licensing What is Sentinel Cloud? Sentinel Cloud provides a cloud-based licensing solution for Independent Software Vendors (ISVs) who want ongoing control over license terms of customers and who want to track the usage of features by the customers. Sentinel Cloud is suitable both for SaaS (Software as a Service) applications that are hosted in the cloud and for on-premise applications that are installed at the customer's site. Using Sentinel Cloud, you can enable feature-level authorization of your applications and leverage a wide range of feature and product packaging options ranging from simple subscription to complex usage-based models. In this way, you can maximize return on investment through greater product versatility and simplified operations. Sentinel Cloud licensing simplifies your billing process management by providing automated metering and export of usage data for billing. How Does Sentinel Cloud Licensing Work? Before you start, we recommend that you read the information below to familiarize yourself with Sentinel Cloud Licensing and its basic terms. Using Sentinel EMS, you define the products that you want to license. For each product, you define the features to be licensed and the licensing scheme to be used. You integrate your application with Sentinel Cloud in one of the following ways: Using Cloud Run-time. You insert Run-time API calls into your application. Using Sentinel Cloud Connect Web Services. You insert Web service calls into your application. This provides Sentinel Cloud Licensing capabilities for direct use by the application. Web Services can be used for applications on platforms that are not supported by Cloud Runtime.
How Does Sentinel Cloud Licensing Work? 5 Your application can be deployed in either of two ways: Cloud: The application is hosted on a cloud server, from where the customer can access the application. The server is managed either by the ISV or by an external provider contracted by the ISV. On-premise: The application is installed on machines of ISV's customers. The manner in which licenses are stored, consumed, and enforced is defined by Feature Caching Mode, as explained below: Entitlement Level: In this mode, the application pulls the entire entitlement to a machine and license enforcement happens locally. The core characteristics of this mode are: The number of machines that can consume an entitlement is defined. A machine must be registered with the entitlement before the entitlement can be consumed. Entitlement is pulled from cloud for a specified duration before licenses can be consumed locally. License resides on local machine and enforcement also happens locally. Concurrency is managed locally on the machine. You can fetch time-sliced licenses to a machine that can be refreshed periodically from Cloud. Feature Level: In this mode, the licenses reside in cloud and the license enforcement including concurrency happens from cloud. The core characteristics of this mode are: Once an entitlement is created in EMS, its licenses are available for consumption instantly. There is no need of pulling an entitlement to a machine before consuming features. Machine registration is optional. It is used for whitelisting where the use of licenses is restricted to a set of machines. Licenses reside on cloud and enforcement also happens on cloud. Concurrency is managed on cloud, providing a global view. To work offline, features can be detached for a specified period.
6 Sentinel Cloud Quick Start Guide You use Sentinel EMS to create entitlements for your customers to access the features in your application. The entitlements are deployed on Sentinel Cloud Connect. This component is hosted in the cloud, managed by SafeNet. When your customers attempt to use a feature in your application, the licensed application sends queries to Sentinel Cloud Connect for license-serving decisions. Sentinel Cloud Connect also accumulates usage data for the features in your application. This can be used for billing and metering purposes. This data also provides you with valuable insight into how your customers are working with your application. You can access this information using the Sentinel EMS user interface or Sentinel EMS web services. Getting Started In the subsequent sections, you will learn about the following steps in detail that will help you familiarize with Sentinel Cloud system and gain a clear understanding of its features:
Install SDK 7 Install SDK Before you follow the instructions mentioned in this document, you must have Sentinel Cloud Services installed. The link to download Sentinel Cloud Services SDK is sent to you in an e-mail from SafeNet. The downloaded SDK contains Installation Guide that you can refer for installation details.
8 Sentinel Cloud Quick Start Guide Create Features, Products, and Entitlements in EMS (Tutorial) You can use EMS for defining product catalog and creating entitlements. Given below is a tutorial that outlines the basic steps required in defining a product catalog and creating entitlements by using EMS interface. After going through this tutorial, you will be able to perform the following tasks in EMS: 1. Login to EMS 2. Create namespace with the name DemoNamespace. 3. Create feature with name DemoFeatureOne, feature Id 999, and license model Postpaid. 4. Create product with the name DemoProductOne. 5. Create customer with the name DemoCustomerOne. 6. Create entitlements for On-premise and Cloud deployment types. Only the mandatory steps required to complete tasks have been included. The data validations, optional fields, and other additional details have not been mentioned to keep this tutorial short and easy to follow. The values (such as those of feature name, product name, etc.) used in this tutorial are the same as used in the various samples available with SDK.
Step 1: Login 9 Step 1: Login When you subscribe for Sentinel Cloud Services, an EMS Server instance is configured for you and its details are provided to you in an e-mail. Use the URL and credentials given in e-mail to access EMS. Type the URL in web browser, enter User ID and Password, and click Login.
10 Sentinel Cloud Quick Start Guide Step 2: Create Namespace 1. Click Catalog>Namespaces, and then click New on the page that appears. 2. Enter a name for the namespace in the Name field, say DemoNamespace. 3. Click Submit.
Step 3: Create Feature 11 Step 3: Create Feature 1. Click Catalog>Features. Click New on the page that appears. The Add Feature pop-up appears. 2. Select the namespace, DemoNamespace, from the Namespace drop-down list. 3. Enter a unique name for the feature in the Feature Name field, say DemoFeatureOne. 4. Clear the Auto Generate Feature Id check box, and enter unique feature ID in the Feature Id text box, say 999. 5. Associate license models with the feature. Select at least one license model, say Postpaid, from the License Models Available list and click. The license model will be added to the License Models Associated list. 6. Click Submit.
12 Sentinel Cloud Quick Start Guide Step 4: Create Product 1. Click Catalog > Products, and then click New on page that appears. The Add Product pop-up appears. 2. Select the DemoNamespace namespace from the Namespace drop-down list. 3. Enter a name for the product in the Product Name field, say DemoProductOne. 4. Enter a version number in the Version field, say 1.0. 5. Select Service Agreement Template from the Service Agreements drop-down list. 6. Select the DemoFeatureOne feature that you created above from the Features Available list, and click. The feature will be added to the Features Associated list. 7. Click Submit. The Products page is displayed showing details of newly-created product, with lifecycle stage as Draft. 8. Click Complete. This will change the lifecycle stage to Complete. Now the product that you have
created can be included in entitlements. Step 4: Create Product 13
14 Sentinel Cloud Quick Start Guide Step 5: Create Customer 1. Click Customers> Customers, and then click New on the page that appears. The Create New Customer pop-up appears. 2. Keep Customer Ref ID as GUID. 3. Select the Create Contact check box. The popup will expand to display Contact Details, Billing Details, and Shipping Details panes.
Step 6: Create Entitlement 15 4. Enter the e-mail address of the contact in the Contact E-Mail field, and enter a name for the contact in the Contact Name field. 5. Click Submit. Step 6: Create Entitlement Based on the deployment type for which you want to evaluate Sentinel Cloud, choose an option from the following: Deployment Type "On-premise" and Feature Caching Mode "Entitlement Level" Deployment Type "On-premise" and Feature Caching Mode "Feature Level" Deployment Type "Cloud"
16 Sentinel Cloud Quick Start Guide Deployment Type "On-premise" and Feature Caching Mode "Entitlement Level" 1. Click Entitlements, and then click New on the Entitlements page that appears. The New Entitlement pop-up appears. 2. Keep defaults for Start Date and End Date fields. 3. Specify the Deployment Type as On-Premise. 4. Type the first few characters of the customer name (say D) in the Customer Name auto-complete field. A list appears from which you can select the DemoCustomerOne customer name, which you created in steps above. In the Search Customers pop up window that appears, click OK. 5. Select a contact from the Contact E-mail drop-down list.
Deployment Type "On-premise" and Feature Caching Mode "Entitlement Level" 17 6. Click Submit.The Add product pop-up is displayed.
18 Sentinel Cloud Quick Start Guide 7. From the Mode drop-down, select Entitlement Level. 8. Keep the defaults for Detach Interval, Station Count, Collect Usage, VM Enabled, and Clone Protection fields. 9. Select the DemoProductOne product from the Select Product pane. Its features, such as DemoFeatureOne, will be displayed. 10. Click Submit. The Entitlements screen in displayed. 11. Click Commit to commit the entitlement.
Deployment Type "On-premise" and Feature Caching Mode "Feature Level" 19 An on-premise entitlement with Feature caching mode as Entitlement level is created and deployed on Cloud Connect for consumption. Deployment Type "On-premise" and Feature Caching Mode "Feature Level" 1. Click Entitlements, and then click New on the Entitlements page that appears. The New Entitlement pop-up appears. 2. Keep defaults for Start Date and End Date fields. 3. Specify the Deployment Type as On-Premise. 4. Type the first few characters of the customer name (say D) in the Customer Name auto-complete field. A list appears from which you can select the DemoCustomerOne customer name,
20 Sentinel Cloud Quick Start Guide which you created in steps above. In the Search Customers pop up window that appears, click OK. 5. Select a contact from the Contact E-mail drop-down list. 6. Click Submit.The Add product pop-up is displayed.
Deployment Type "On-premise" and Feature Caching Mode "Feature Level" 21 7. From the Mode drop-down, select Feature Level. 8. Keep the defaults for Detach Interval and Cache Interval fields. 9. Select the DemoProductOne1 product from the Select Product pane. Its features, such as DemoFeatureOne, will be displayed. 10. Click Submit. The Entitlements screen in displayed. 11. Click Commit to commit the entitlement.
22 Sentinel Cloud Quick Start Guide An on-premise entitlement with Feature caching mode as Feature level is created and deployed on Cloud Connect for consumption. Deployment Type "Cloud" 1. Click Entitlements, and then click New on the Entitlements page that appears. The New Entitlement pop-up appears. 2. Keep defaults for Start Date and End Date fields. 3. Specify the Deployment Type as Cloud. 4. Select Enterprise.
Deployment Type "Cloud" 23 5. Type the first few characters of the customer name (say D) in the Customer Name auto-complete field. A list appears from which you can select the DemoCustomerOne customer name, which you created in steps above. In the Search Customers pop up window that appears, click OK. 6. Select a contact from the Contact E-mail drop-down list. 7. Click Submit.The Add product pop-up is displayed. 8. Select the DemoProductOne product from the Select Product pane. Its features, such as DemoFeatureOne, will be displayed.
24 Sentinel Cloud Quick Start Guide 9. Click Submit. The Entitlements screen in displayed. 10. Click Commit to commit the entitlement. A cloud entitlement is created and deployed on Cloud Connect for consumption.
Execute Integration Samples 25 Execute Integration Samples After you have created an entitlement for the preferred deployment type, we recommend that you compile and run samples to understand how Sentinel Cloud licensing is integrated in your application for that deployment type. A number of samples for learning about Sentinel Cloud are available. These are placed in the SDK installation directory. You can choose the sample that is most appropriate for your requirements. Samples are available for Run-time and Cloud Connect web services. Run-time Samples The Run-time samples are simple console-based applications calling Sentinel Cloud Run-time APIs in an application. These samples demonstrate the usage of Cloud Run-time APIs across various licensing stages, such as license availability,requesting a license,and releasing a license. You can choose the sample that best suits your application's programming language and deployment type. Samples are available for the following programming languages: C Java.NET Cloud Connect Web Services Sample This sample demonstrates how to implement Sentinel Cloud Connect Web Service calls in an application. Sample is available for the following language: Python These samples are meant for demonstration purpose only. In the production setup, you will need to integrate APIs or web services in your application source code according to business requirements.
26 Sentinel Cloud Quick Start Guide View Usage Reports After an entitlement and its features have been consumed by an application, you can use EMS to generate and view a variety of usage reports. The reports offered by EMS allow you to more accurately forecast your renewal, upgrade, and budgeting figures, as well as determine how products are being deployed and used. Login to EMS and click Reports on main menu. A list of the available reports is displayed in the left pane, organized under various categories. You can expand a category (say Usage Reports), select the report that you want to generate, specify parameters, and click Generate Report. You can print the output or save it for later use. Below is an example of generating Feature Usage Report:
Where to Go Next? 27 Where to Go Next? Refer to these documents for more details. Document Release Notes Installation Installation Guide Getting Started Quick Start Guide Entitlement Management EMS User s Guide EMS Web Services Guide EMS Web Services Cheatsheet Run-time APIs Cloud Run-time Guide Cloud Connect Web Services Cloud Connect Web Services Guide Samples Run-time C Samples ReadMe Run-time Java Samples ReadMe Run-time.NET Samples ReadMe Cloud Connect Web Services Python Sample ReadMe Fingerprint Management Utilities ReadMe What's in it? Contains summary of new features and enhancements. Contains installation information Document to help you quickly start with Sentinel Cloud. Reference for using the EMS web portal for Sentinel Cloud Services Reference for using the Sentinel EMS web services A quick reference document that summarizes all the available EMS web services Sentinel Cloud Run-time API reference Reference for using the Sentinel Cloud Connect Web services Sample reference for using the Run-time APIs in C Sample reference for using the Run-time APIs in Java Sample reference for using the Run-time APIs in.net Sample reference for using the Cloud Connect web services in Python.NET Utilities that demonstrate how to use getinfo API and EMS Web services for performing fingerprint management functions.