GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

All information herein is either public information or is the property of and owned solely by Gemplus S.A. who shall have and keep the sole right to file patent applications or any other kind of intellectual property protection in connection with such information. Nothing herein shall be construed as implying or granting to you any rights, by license, grant or otherwise, under any intellectual and/or industrial property rights of or concerning any of Gemplus’ information. This document can be used for informational, non-commercial, internal and personal use only provided that: •

The copyright notice below, the confidentiality and proprietary legend and this full warning notice appear in all copies.

•

This document shall not be posted on any network computer or broadcast in any media and no modification of any part of this document shall be made.

Use for any other purpose is expressly prohibited and may result in severe civil and criminal liabilities. The information contained in this document is provided “AS IS” without any warranty of any kind. Unless otherwise expressly agreed in writing, Gemplus makes no warranty as to the value or accuracy of information contained herein. The document could include technical inaccuracies or typographical errors. Changes are periodically added to the information herein. Furthermore, Gemplus reserves the right to make any change or improvement in the specifications data, information, and the like described herein, at any time. Gemplus hereby disclaims all warranties and conditions with regard to the information contained herein, including all implied warranties of merchantability, fitness for a particular purpose, title and non-infringement. In no event shall Gemplus be liable, whether in contract, tort or otherwise, for any indirect, special or consequential damages or any damages whatsoever including but not limited to damages resulting from loss of use, data, profits, revenues, or customers, arising out of or in connection with the use or performance of information contained in this document. Gemplus does not and shall not warrant that this product will be resistant to all possible attacks and shall not incur, and disclaims, any liability in this respect. Even if each product is compliant with current security standards in force on the date of their design, security mechanisms' resistance necessarily evolves according to the state of the art in security and notably under the emergence of new attacks. Under no circumstances, shall Gemplus be held liable for any third party actions and in particular in case of any successful attack against systems or equipment incorporating Gemplus products. Gemplus disclaims any liability with respect to security for direct, indirect, incidental or consequential damages that result from any use of its products. It is further stressed that independent testing and verification by the person using the product is particularly encouraged, especially in any application in which defective, incorrect or insecure functioning could result in damage to persons or property, denial of service or loss of privacy. © Copyright 2001-2003 Gemplus S.A. All rights reserved. Gemplus and the Gemplus logo are trademarks and service marks of Gemplus S.A. and are registered in certain countries. All other trademarks and service marks, whether registered or not in specific countries, are the property of their respective owners. GEMPLUS, B.P. 100, 13881 GEMENOS CEDEX, FRANCE. Tel: +33 (0)4.42.36.50.00 Fax: +33 (0)4.42.36.50.90 Printed in France.

Document Reference: DOC108467A2 June 19, 2003

Contents About this Guide

vii

What’s New in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii For More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii Contact our Hotline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Chapter 1

Introduction

1

Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Applets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Campaigns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Chapter 2

Getting Started

5

Step 1: Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Step 2: Configure the Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Step 3: Create Profiles and Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Step 4: Creating Card Entities in the Card Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Step 5: Provide Standard Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Step 6: Create Applet Entities in the Applet Database . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Step 7: Logging Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Chapter 3

Platform Management

9

Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Displaying Product Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Managing a Product's Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Configuring the Logging Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Configuring the Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Configuring Billing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Managing the SNMP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Chapter 4

Managing User Profiles and Accounts

23

Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Profile List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Creating an Administrator Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

iii

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Creating a Customer Care Agent Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Creating a Subscriber Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Viewing, Updating, and Deleting a User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . 31 User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Using the Account Search Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Creating a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Viewing, Updating, and Deleting a User Account . . . . . . . . . . . . . . . . . . . . . . . . . 37 Chapter 5

Managing Applets

41

Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Defining Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Cards Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Managing Card Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Managing Card Virtual Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Managing Card Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Creating a New Card Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Updating or Deleting a Card Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Applet Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Provider List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Creating a New Applet Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Updating or Deleting a Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 STK Applets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Card Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Using the STK Applet Search Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Uploading an STK Applet to the Applet Database . . . . . . . . . . . . . . . . . . . . . . . . . 59 Viewing, Updating, and Deleting STK Applets . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Viewing, Adding, and Deleting STK Applet Files . . . . . . . . . . . . . . . . . . . . . . . . . 65 Viewing, Updating, and Deleting STK Applet Configuration Files . . . . . . . . . . . . 66 Viewing, Updating, Adding, and Deleting STK Applet Services . . . . . . . . . . . . . . 67 Viewing, Updating, Adding, and Deleting STK Applet Incompatibilities . . . . . . . 70 Java Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Using the Java Package Search Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Uploading, Viewing, Updating, and Deleting Java Packages . . . . . . . . . . . . . . . . . 74 Viewing, Adding, and Deleting Java Package Files . . . . . . . . . . . . . . . . . . . . . . . . 77 Updating the Java Packages Required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Viewing and Updating Java Package Incompatibilities . . . . . . . . . . . . . . . . . . . . . 79 Viewing and Updating Java Package Java Applets . . . . . . . . . . . . . . . . . . . . . . . . 80 Chapter 6

Managing Card Entities in the Card Database

83

Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Card Manager Interface Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Managing Card Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Card Vendor List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Creating a Card Vendor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Viewing, Updating, and Deleting Card Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Managing Card Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Card Definition List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Creating a Card Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Viewing, Updating and Deleting Card Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 89 Managing Card Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

iv

Contents

Card Structure List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Creating Card Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Creating a Card Structure with Minimum Security Levels (MSL) . . . . . . . . . . . . . 93 Viewing, Updating and Deleting Card Structure Files . . . . . . . . . . . . . . . . . . . . . . 98 Managing Card Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Card Profile List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Creating Card Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Viewing, Updating and Deleting Card Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Managing Card Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Card Application List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Creating Card Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Updating and Deleting Card Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Managing Transport Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Listing Transport Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Creating a Transport Key Entry in the Card Manager Database . . . . . . . . . . . . . . 116 Chapter 7

Managing Card Instances in the Card Database

119

Managing Card Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Using the Searching Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Creating a New SIM Card Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Viewing and Updating the Content of Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Managing Card Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Using the Search Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Viewing, Updating, and Deleting Card Security Data . . . . . . . . . . . . . . . . . . . . . 127 Chapter 8

Managing Card Services

131

Loading the Standard Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Loading Non-Standard Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Creating (Declaring) a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Viewing, Updating, and Deleting Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Creating a Service Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Viewing, Updating, and Deleting a Service Implementation . . . . . . . . . . . . . . . . . . . 140 Chapter 9

Managing Campaigns

143

Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Campaign Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Scenario List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Creating a Campaign Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Viewing and Updating a Campaign Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Deleting Campaign Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Scheduling a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Monitoring Campaigns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 The Campaign Monitor Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Displaying the Details of a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Pausing a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Restarting a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Aborting a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Purging a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

v

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Chapter 10

Managing Channel Drivers

159

Driver Management Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Adding and Modifying a Channel Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Activating, Deactivating, and Deleting a Channel Driver . . . . . . . . . . . . . . . . . . . . . . 163 Activating and Deactivating Round Robin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Activating and Deactivating CRPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Chapter 11

Monitoring Requests

165

Request Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Searching For Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Defining Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Building a Query Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 The Request Viewing Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Suppressing a Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Checking the Details of a Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Purging the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Appendix A

Additional Information

173

Using the Batch Load Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 File and Storage Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 STK Applets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Java Package Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 CAP file (with extention .cap) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Properties file (with extension .props) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Channel Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Format of the InitString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Channel Driver Velocity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Optional Channel Driver Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Using Personalization Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Appendix B

Error Messages

193

General Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 Base System Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Communication Interface Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 RCA Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 SAS Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Channel Driver Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

vi

About this Guide

This guide is intended for GemXplore Suite system administrators, and describes how to perform management tasks for the GemXplore Suite products.

What’s New in This Guide This guide contains new or updated information about the following functions that already exist or that have been added for version 1.3.1 of the GemXplore Suite: •

The function Campaign Management has been added.

For More Information For more information on the use or development of GemXplore Suite version 1.3.1, refer to the following documents: Document

Description

Technical Overview

Provides an introduction to the architecture of the GemXplore Suite platform.

Installation and Migration Guide

Describes the prerequisites and procedure for installing the GemXplore Suite platform and channel drivers, and for migrating from version 1.3.

Network Administrator’s Guide

Explains how to keep the GemXplore Suite platform running and connected to other systems.

Administrator’s Guide (this guide)

Describes the administration tasks that are performed within the Customer Care Interface to manage the GemXplore Suite platform.

Customer Care Agent’s Guide

Explains how to use the Customer Care Interface to change the functionality of subscribers’ SIM cards.

Customizer’s Guide

Describes how to program a new service and add it to GemXplore Suite, and how to internationalize the interface.

Integrator’s Guide

Provides details of GemXplore Suite methods and parameters so that other applications can communicate with the platform.

vii

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Document

Description

Developer’s Guide

Gives information on expanding the GemXplore Suite functionality by developing new Framework products.

Glossary

Provides a list of terminology and abbreviations.

Contact our Hotline If you don’t find the information you need in this manual, or if you find errors, contact the Gemplus hotline by phone, fax, or email. In your email, please include the document reference number, your job function, and the name of your company. (You will find the document reference number at the bottom of the legal notice on the inside front cover.)

Corporate and EMEA Hotline: +33 (0)4 42 36 50 50 Hot Fax: +33 (0)4 42 36 50 98 Email: [email protected]

Americas Hotline: 1 (877) 436-7233 Hot Fax: 1 (215) 390-1586 Email: [email protected]

From our Web Site http://www.gemplus.com

viii

1 Introduction

GemXplore Suite consists of the following products: •

Framework, which manages the GemXplore Suite products. It provides a common access point for the products using a set of common services, tools, and functions, and handles the interchange between the products an functional facilities, such as logging, audit trail, and SNMP traps.

•

Card Manager, which offers over-the-air data management services for a portfolio of SIM cards. The Card Manager automatically chooses the channel that is best suited to deliver messages intended for the cards. Other features include request management and card-specific security.

•

Applet Manager, which handles the downloading of applets onto cards and their life cycle. It supports security functions specific to the applets, as well as service monitoring.

Access Control Access to the various functions of GemXplore Suite is controlled by user profiles and user accounts. Each user has an account that is associated with a profile. In this way only those functions a user is authorized to use are displayed on the GemXplore Suite Graphical User Interface (GUI). There are three types of user defined in GemXplore Suite: •

administrators who have access to all functionalities

•

customer care agents who have access to those functions related to subscribers

•

subscribers who have access to functions related to their own cards

The GUI presented to an administrator is the GemXplore Suite management interface and the GUI presented to a customer care agent is the GemXplore Suite Customer Care Interface (CCI). No interface is provided for subscribers. This must be created by the service operator.

Cards GemXplore Suite allows you to: •

add new cards to the card database

•

display an image of the file structure and content of the cards

1

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

•

set up card security

•

download applets onto cards after issuance

•

update off-the-shelf card services, such as, update ADN and switch ADN/FDN on cards after issuance either over the air (OTA) or using a Wired Internet Reader (WIR)

The following cards are supported: •

GemXplore 98

•

GemXplore 98 U Choose

•

GemXplore ‘Xpresso V2 and V3

Services GemXplore Suite provides the following standard services that can be updated on the card after issuance, either over the air (OTA) or using a Wired Internet Reader (WIR). These services are: –

Update ADN, Update FDN, Switch ADN/FDN

–

Update MSISDN, Update PLMN, Update ACC

–

Update CBMI, Update IMSI, Update LP

–

Update SDN, Update SST, Update SPN

–

Update FPLMN, Update SST, Update HPLMN

–

Update BDN, Update ONS, Update SMSP

–

Update URS, Applet Download, Applet Deletion

Applets GemXplore Suite supports two types of applet: •

STK applets. An STK applet is an STK application with associated file structure. STK applets are linked to an applet provider, such as Gemplus, and the definition of a card (card type, card definition, and operating system). An STK applet is identified in the SIM by a dedicated file (DF) and consists of several electrical files (EFs). STK applets contain several STK services. STK services consist of a collection of STK applet files and STK configuration files. The STK applet files are script files that represent the electrical files (EFs) and their contents for the applets and services. The STK configuration files store the data for an applet or its services. The files contain a list of records for linear electrical files whose type are either global or service data Java applets. A Java applet consists of Java packages containing Java card classes. A Java package is linked to an applet provider, such as Gemplus, and the definition of a card (card type, card definition, operating system, and virtual machine).

2

Introduction

Campaigns A campaign allows a chain of value added services to be applied over-the-air to a large number of cards. The chain of value added services to be executed, together with their relevant parameters, is contained in a campaign scenario. Unitary tasks can be executed for a particular value added service for a card within the campaign scenario set of cards. Campaigns can be scheduled in push mode or on-event mode. In both cases, the scenarios are broken down into unitary tasks. A unitary task consists of one service call for one card. In push mode, each unitary task is scheduled with daily time constraints. In on-event mode, the campaign is activated on a specified start date, but unitary tasks are only run when an external event is received. The following parameters can be specified for a campaign: •

A start and end date for the overall campaign

•

Up to three daily time frames when value added services can run (push mode only)

•

A priority level for the overall campaign

•

A retry policy with a maximum number of retries

•

Campaign-specific billing tickets

The interface includes a monitoring window that displays the statistics for each campaign. •

a card (card type, card definition, operating system, and virtual machine).

Requests The GemXplore Suite management interface allows you to monitor requests sent by customer care agents to subscriber’s cards. The monitoring function allows you to: •

select filtering criteria for request status, such as created, failed, completed

•

specify which request information is displayed in the list, such as user, service, submit date

•

specify whether the list is to be displayed in ascending or descending order

•

select query criteria such as all destinations

3

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

4

2 Getting Started

This guide is intended for GemXplore Suite system administrators, and describes how to perform management tasks for the GemXplore Suite products. Version 1.3 of the GemXplore Suite comprises the following products: •

Framework

•

Card Manager

•

Applet Manager

The first time you have to manage the GemXplore Suite, you must follow the steps described in this chapter. These steps are necessary to manage the GemXplore Suite for the first time only. To do this, you must complete the prerequisites and perform the following tasks: 1. Log in to GemXplore Suite 2. Configuring the Platform 3. Creating Profiles and Accounts 4. Create Card Entities and Instances 5. Log out

Step 1: Logging In Once the platform is running (indicated by Framework ready in the startup status window), you can start the GemXplore Suite software: that is, the product instances for the Card manager and Applet Manager. Perform the following tasks: 1. Use a browser; for example, MS Internet Explorer or Netscape 6, to find the following URL address depending on your operating system: http://:/CCI http:///CCI

5

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

The GemXplore Suite Login window is displayed.

Figure 1 - GemXplore Suite Login Window 2. Enter the administrator account name in the Login field, and the corresponding password in the Password field. These are initial values defined during installation of GemXplore Suite and must be retrieved from the installer. Note: If you try to log in three times to the GemXplore Suite and are unsuccessful, a message is displayed notifying you that your account is locked. If your administrator account become locked, contact [email protected]. 3. Click Login. The Management Interface Welcome window is displayed.

Figure 2 - GemXplore Suite Welcome Window

6

Getting Started

Step 2: Configure the Platform Configuring the platform consists of: •

Starting the Card Manager and Applet Manager product.

•

Configuring the logging, audit trail, and billing facilities

•

Configuring SNMP

To do this, see “Platform Management”.

Step 3: Create Profiles and Accounts This involves creating administrator, customer care agent, and subscriber profiles and associating user accounts to them. To do this, see “Managing User Profiles and Accounts”

Step 4: Creating Card Entities in the Card Database To populate the GemXplore Suite card database with a set of cards, you must start the Card Manager and select its management interface. Using the management interface you need to create entities in the Card Manager database for the following: –

Card definitions

–

Card structures

–

Card profiles

–

Card applications

–

Card vendors

Each of these entities can be created individually, or you can use the batch load facility which uploads XML files contain definitions for several entities. For information on performing these tasks, refer to “Managing Card Entities in the Card Database”.

Step 5: Provide Standard Services To provide standard services, such as UpdateADN, UpdateFDN and SwitchFDN/ADN involves: •

Loading a service implementation

•

Declaring and activating the service

•

Associating the service to a card profile

•

Loading card instances for the card

For information on performing these tasks, refer to “Managing Card Services”.

7

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Step 6: Create Applet Entities in the Applet Database To create applet entities, you must start the Applet Manager as described in “Managing a Product's Life Cycle”. The tasks required to create applet entities are as follows: •

Creating card types

•

Creating card operating systems

•

Creating card virtual machines

•

Creating card definitions

•

Creating providers

•

Uploading Java packages

•

Uploading STK applets

For information on performing these tasks, refer to “Managing Applets”.

Step 7: Logging Out The Logging Out function allows the you to disconnect from GemXplore Suite. 1. In the Platform Management window, click Logout. The User Disconnection window is displayed.

2. In this window, confirmation is required if you want to log out of Framework. Click Logout. You are now disconnected from GemXplore Suite, and are returned to the GemXplore Suite Login window.

8

3 Platform Management

The following platform management tasks can be performed from the GemXplore Suite user interface: •

“Displaying Product Status”

•

“Managing a Product's Life Cycle”

•

“Configuring the Logging Function”

•

“Configuring the Audit Trail”

•

“Configuring Billing”

•

“Managing the SNMP Configuration”

Logging In If not already logged in, log in as described in “Step 1: Logging In” in “Getting Started”

Displaying Product Status To display information about the current status of the GemXplore Suite products: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window

2. On the left frame of the Platform management window, click Product configuration. The Product list window is displayed.

9

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Figure 3 - Product List Window

Managing a Product's Life Cycle When managing the life cycle of a GemXplore Suite product, you can perform any of the following actions: •

Start the product

•

Shutdown the product

•

Kill the product

•

Activate or deactivate billing

To manage a GemXplore Suite product: From the Product List window, select the product and click Configure. The Product configuration and General information windows for that product are displayed.

Figure 4 - Product Configuration Window

10

Platform Management

Figure 5 - General Information Window On the Product configuration windows you can: •

start, stop, and kill the product

•

display the product parameters

•

edit the trace level

•

edit the product parameters

In the General information window, information regarding the version of the software is shown, for example; version 1.3 where: 1 represents a major version and .3 represents a minor version of the software On the General information window you can also activate or deactivate the billing and SNMP trap raising functions.

Starting a product Before starting a product, the state of the product is NOT RUNNING. To start the product, click Start on the Product configuration window. The status changes from NOT RUNNING to ACTIVE.

Stopping a Product To stop a product, click Shutdown on the Product configuration window to stop the product and allow all processes to finish running. Associated processes running as part of the platform will not be stopped. The status changes from ACTIVE to NOT RUNNING.

Killing a Product The following task can also be performed, as an emergency action only. It is NOT recommended for normal operation. To immediately stop the product and interrupt any processes that are running, click Kill on the Product configuration window. This will interrupt any other associated processes running as part of the platform. The status changes from ACTIVE to NOT RUNNING.

11

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Activating and Deactivating Billing To activate or deactivate the billing function, on the Product configuration window click the On radio button (activates billing) or the Off radio button (deactivates billing) and click Update. Caution: For billing information to be recorded, either File mode or Host mode must be activated in the “Billing Configuration Window”.

Editing the Trace Level Trace information in the GemXplore Suite is produced by the product. Each product defines "Domains". At product initialization, a "Root" domain is automatically created and a specific trace level assigned. As well as this root domain, there can also be sub-domains. Four trace levels are available that can also be combined, and which produce information that corresponds to the following:

12

•

Errors: Errors

•

Init: Initialization phase

•

Method: Method functioning

•

Info: General information

Platform Management

To edit the trace level set for a specific product: 1. On the Product configuration window, click Edit trace level. The Logging - List of domains window is displayed.

Figure 6 - Logging: List of Domains Window 2. Click the down arrow and select the domain group you want to use for the trace, from the drop-down list, then click the check box to the right for the type of information required; for example, Error. 3. Click Single (for a trace on the domain only) or All (for a trace on the domain and all of the sub-domains). The trace information is created and stored in a file on the filesystem pointed to by the “Logging Configuration Window”.

13

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Modifying the Current Parameters for a Product Information on how to change the parameter values, plus complete lists of the parameters with descriptions, are given in the Customizer’s Guide.

Configuring the Logging Function The Logging function provides a history of a product's activity. It can also be used as an aid for debugging, in both development and production environments. You can manage the logging function in the following way: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite interface window.

2. On the left frame of the Platform management window, click Logging. The File mode/Storage mode and Host mode windows are displayed.

Figure 7 - Logging Configuration Windows

14

Platform Management

Information relating to the current log file's configuration parameters is displayed. Parameter Name

Description File mode area

Directory location

Directory path location in which the log files are stored. By default, an absolute path to the Logs subdirectory is given. You can enter either an absolute path or a relative path defined relative to the directory /bin.

Allocated space

Maximum allocated space allowed. Default is 1 megabyte.

Data format

ASCII format used in the log file: CSV (Comma Separated Values) or XML (Extended Markup Language). Storage mode area

Storage directory name

Directory location where the "written" log files are stored, according to a specified period. By default, an absolute path to the arch subdirectory is given. You can enter either an absolute path or a relative path defined relative to the directory /bin.

Storage period

Storage period indicator of which one of the following must be selected: - Quarter day - Half day - Full day - Week Host mode area

Remote hostname

Name of the remote server on which the log records are sent.

Port number

Port used on the log file server.

Data format

ASCII format used in the log file: CSV (Comma Separated Values) or XML (Extended Markup Language).

You can select one of the following options to activate or deactivate the status of a file mode: –

Click Activate for Host mode and Deactivate for File mode.

–

Click Activate for both the File mode and the Host mode.

–

Click Deactivate for both the File mode and the Host mode.

–

Click Deactivate for the Host mode and Activate for the File mode.

–

Click Activate for Storage mode to activate management of the storage repository.

–

Click Deactivate for Storage mode to deactivate management of the storage repository.

Note: File mode and Storage mode are linked. Therefore, if File mode is deactivated, Storage mode is also deactivated. 3. Select CSV or XML for the format that you want used for the log file.

15

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

For further information on the File and Storage Modes, see “File and Storage Modes” in “Appendix A - Additional Information”. The following is an example of a logging file. Example: Log File (CSV Format) LOGGING_FILE,2001/01/24 08:31:24 EST Applet Manager,2001/01/24 15:02:11.147,15,,Applet Manager:ProductManager: getStatus,-1,Applet Manager,0,getStatus by user : admgemplus For a detailed description of each of the log file fields, see Logging Facility (Log File Format) in the GemXplore Suite Developer’s Guide.

Configuring the Audit Trail The Audit Trail function provides services for generating a trace of the actions performed by the users of the system. You can manage the Audit Trail function in the following way: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window.

1. On the left frame of the Platform management window, click Audit Trail and click Add. The File mode/Storage mode and Host mode windows are displayed.

16

Platform Management

Figure 8 - Audit Trail Configuration Windows Information relating to the current audit trail file's configuration parameters is displayed: Parameter Name

Description File mode area

Directory location

Directory path location in which the audit trail files are stored. By default, an absolute path to the Trails subdirectory is given. You can enter either an absolute path or a relative path defined relative to the directory /bin.

Allocated space

Maximum allocated space allowed. Default is 1 megabyte.

Data format

ASCII format used in the log file: CSV (Comma Separated Values) or XML (Extended Markup Language). Storage mode area

Storage directory name

Directory location where the "written" audit trail files are stored, according to a specified period. By default, an absolute path to the arch subdirectory is given. You can enter either an absolute path or a relative path defined relative to the directory /bin.

Storage period

Storage period indicator of which one of the following must be selected: - Quarter day - Half day - Full day - Week Host mode area

Remote hostname

Name of the remote host on which the audit trail is sent.

Port number

Port used on the remote host.

Data format

ASCII format used in the log file: CSV (Comma Separated Values) or XML (Extended Markup Language).

17

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

You can also select one of the following options to activate or to deactivate the status of a file mode: –

Click Activate for Host mode and Deactivate for File mode.

–

Activate the Host mode and deactivate the File mode.

–

Activate both the File mode and the Host mode.

–

Deactivate both the File mode and the Host mode.

–

Deactivate the Host mode and Activate for the File mode.

–

Click Activate for Storage mode to activate management of the storage repository.

–

Click Deactivate for Storage mode to deactivate management of the storage repository.

Note: Both File mode and Storage mode are linked. Therefore, if File mode is deactivated, Storage mode is also deactivated. 2. Select CSV or XML for the format to be used for the Audit Trail file. For further information on the File and Storage Modes, see “File and Storage Modes” in “Appendix A - Additional Information”.

Configuring Billing The Billing function manages storage of billing information for each of the GemXplore Suite products. To manage the current platform's billing configuration: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window.

2. On the left frame of the Platform management window, click Billing. The File mode/Storage mode and Host mode windows are displayed:.

18

Platform Management

Figure 9 - Billing Configuration Windows Information relating to the current billing file's configuration parameters is displayed. Parameter Name

Description File mode area

Directory location

Directory path location in which the billing files are stored. By default, an absolute path to the Billing subdirectory is given. You can enter either an absolute path or a relative path defined relative to the directory /bin.

Allocated space

Maximum allocated directory space. Default: 1 megabyte. Storage mode area

Storage directory name

Directory location where the "written" billing files are stored, according to a specified period. By default, an absolute path to the arch subdirectory is given. You can enter either an absolute path or a relative path defined relative to the directory / bin.

Storage period

Storage period indicator of which one of the following must be selected: - Quarter day - Half day - Day - Week Hostmode area

Remote hostname

Name of the host to which billing data is sent.

Port number

Port used on the billing server.

19

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

3. Perform the following, as appropriate: –

Click Activate for File mode to allow you to reset the maximum number of billing files and records per file and to start the billing.

–

Click Activate for Host mode to start billing via the host TCP.

–

Click Activate for Storage mode to activate management of the storage repository.

–

Click Deactivate Storage mode to deactivate management of the storage repository.

Caution: For billing information to be recorded, either File mode or Host mode must be activated. If neither is activated, no billing information will be recorded even if Billing is turned on in the “Product Configuration (rca) Window”. Note that File mode and Storage mode are linked. Storage mode can only be activated if File mode is activated. (File Mode, however, can be activated without Storage Mode.) If File mode is deactivated, Storage mode is also deactivated. For further information on the File and Storage Modes, see “File and Storage Modes” in “Appendix A - Additional Information”.

Managing the SNMP Configuration The SNMP function allows the GemXplore Suite platform to notify problems, generate and send alarms to a management platform, via the SNMP Trap format. Each alarm contains the following information: •

Code: uniquely identifies the alarm.

•

Timestamp:

•

Severity level: (critical, major, minor, warning, cancel).

•

SenderName: name of the sender.

•

Description: contextual message (if available).

To manage the SNMP configuration: 1. On the left frame of the Platform Management window, click SNMP. The SNMP Configuration window is displayed.

20

Platform Management

Figure 10 - SNMP Configuration Window 2. On the SNMP Configuration window, enter values for parameters shown in the following table and click Update: Parameter Name

Description SNMP agent configuration area

Activate/Deactivate buttons

Buttons that allow the SNMP traps to be actvated or deactivated during runtime, at Framework level.

Manager agent port

UDP port number of the SNMP manager. Default value is 3162. (maximum of 4 digits). SNMP manager configuration area

SNMP manager port

UDP port number of the SNMP manager. Default value is 162. (maximum of 4 digits).

Manager address

List of addresses of network manager software that listen for traps. To add an address to the list, enter the new address in the New manager address field and click Add. To delete an address from the list, select the address and click Delete selected item(s).

21

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

22

4 Managing User Profiles and Accounts

The GemXplore Suite Customer Care Interface allows you to create and manage user profiles and user accounts. The following types of user are defined: •

Administrator. An administrator has access to all GemXplore Suite interface functions: –

user management (creating and managing account types and profiles, and subscriber provisioning)

–

card management (managing cards and applets, and provisioning)

–

platform management (product configuration, administration, logging, audit trail, billing and tuning)

–

request management (monitoring and managing all requests, and group management

–

campaign management)

Note: A default administrator profile administratorProfile is created during the.installation of GemXplore Suite •

Customer Care Agent. A customer care agent has no access to platform or card management, but has access to: –

user management (for subscribers only)

–

request management (submission and monitoring of own requests, group management, and submission of request for all cards defined in the database

–

campaign management (campaign senarios, campaign scheduling, and campaign monitoring))

Note: A default customer care agent profile CCAProfile is created during the installation of GemXplore Suite •

Subscribers who can manage their own OTA services and send SMSs to other destinations.

Users are defined by: •

an account containing authentication information and specific characteristics such as account status, and expiry date

23

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

•

a profile specifying access right and quality of service parameters

Note: If any modifications are made to an existing user’s access rights or a user is removed, these will not take effect until the modified user logs out then back in again.

Logging In If not already logged in, log in as described in “Step 1: Logging In” in “Getting Started”

Profiles The following profiles can be created: •

Administrator

•

Customer care agent

•

Subscriber

Depending on which type of profile you are creating, only the functions and fields related to that type of profile are displayed on the Profile window.

Profile List Window The Profile list window dispays all the profiles in the database. On this window, you can create, update, view, or delete profiles. To display the Profile list window, do the following 1. Do either of the following:

24

–

On the GemXplore Suite Welcome window, click User management

–

Click User on any other GemXplore Suite management interface window.

Managing User Profiles and Accounts

2. On the left frame of the User management window, click Profile. The Profile list window is displayed with a list of all existing administrator, customer care agent, and subscriber profiles.

Figure 11 - Profile List Window 3. Click on the Administrator, Customer Care Agent, or Subscriber radio buttons as required to display a list of only those profiles.

25

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Creating an Administrator Profile 1. On the Profile list window, click Create. The Profile window for an administrator is displayed.

Figure 12 - Administrator Profile Window 2. On the Profile window, enter profile parameters as described in the following table, and click Create. Parameter

Description Profile description area

Identifier

A unique ID used to identify the profile (maximum of 20 characters).

Profile type

Radio buttons to select the type of profile. Valid values:

• • • Max. access duration

26

Administrator Customer Care Agent Subscriber

Maximum time (in minutes) the administrator has access to the interface per session. For unlimited access, select the check box No access duration.

Managing User Profiles and Accounts

Parameter

Description List of platform functionalities area

Card

Check boxes to specify access to platform functionalities related to cards. Valid values:

• • • •

Applet management (add, update, and delete applets) Card editing (adding and deleting files) Card provisioning (card instance, card security, channel driver management) Services management (card service definitions)

Note: Card provisioning and Services management can be done only when the Platform functionality Platform management is set. User

Check boxes to specify access to platform functionalities related to users. Valid values:

• •

Account management (add, update, and delete user accounts) Profile management (add, update, and delete profiles)

Platform

Check boxes to specify access to platform functionality Platform management (platform life cycle, such as start and shutdown, and associated component configuration such as, logging, audit trail, and billing)

Request

Check boxes to specify access to platform functionality Request management and Campaign management.

Creating a Customer Care Agent Profile 1. To create a profile for a customer care agent: a) On the Profile list window, click Create. b) On the Profile window, click the Customer Care Agent radio button. Note: If you are already using the Profile window, simply click the Customer Care Agent radio button The Profile window for a customer care agent is displayed:

27

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Figure 13 - Customer Care Agent Profile Window 2. On the Profile window, enter profile parameters as described in the following table, and click Create. Parameter

Description Profile description area

Identifier

A unique ID used to identify the profile (maximum of 20 characters).

Profile type

Radio buttons to select the type of profile. Valid values:

• • • Max. access duration

Administrator Customer Care Agent Subscriber

Maximum time (in minutes) the customer care agent has access to the interface per session. For unlimited access, select the check box No access duration. List of value added services area

28

Available services

A list of available services, such as Update ADN, Update, and Download applet.

Selected services

Select the required value added services from the Available services pane and move them to the Selected services pane by clicking the > button. To deselect a service, click the < button. To move all services to the Selected services pane, click the >> button. To deselect all services, click the button. To deselect a service, click the < button. To move all services to the Selected services pane, click the >> button. To deselect all services, click the button. To move all services to the Selected services pane, click the >> button. To deselect all services, click the Card type.

Figure 22 - Card Type List Window

Creating a New Card Type To create a new card type: 3. On the Card type list window, click Create.The Card type creation window is displayed.

Figure 23 - Card Type Creation Window

42

Managing Applets

4. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Commercial Name

The commercial name of the card.

Vendor

The name of the card vendor. For example, Gemplus, Schlumberger.

Contact Type

The type of contact. Valid values:

• •

contact contactless

To display information about a card type: 1. On the Card type list window, select the card in the list and click View. The Card type definition window for the selected card is displayed On this window, you can update or delete the card type.

Figure 24 - Card Type Definition Window 2. Click Back when you want to return to the Card type list window.

Updating or Deleting a Card Type To update the card type: 1. On the Card type definition window, click Update. The Card type update window is displayed.

Figure 25 - Card Type Update Window

43

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

2. In the window, change the values for the following and click Update. Parameter Name

Description

Commercial Name

The new commercial name of the card.

Vendor

The name of the card vendor. For example, Gemplus, Schlumberger.

Contact Type

The type of contact. Valid values:

• •

contact contactless

3. Click Back when you want to return to the previous window. To delete the card type: 1. Do either of the following: –

On the Card type definition window, click Delete.

–

On the Card type list window, select the card type and click Delete.

2. On the Delete Prompt window, click OK to confirm the delete.

Managing Card Operating Systems The following provides information about card operating systems which are required to control the data transfer, memory management and information processing. They administrate the resources and supply all necessary functions for operations and administration of any number of applications in the smart card.

Card Operating System List Window The Card Operating System List window displays a list of existing card operating system entities in the applet manager database. 1. To display the Card Operating System List window, do either of the following:

44

–

On the GemXplore Suite Welcome window, click Applet management

–

Click Applet on any other GemXplore Suite Interface window.

Managing Applets

2. On the left frame, select Card definition -> Card operating system. The Card operating system list window is displayed. On this window, you can create, view, update, or delete card operating system entities.

Figure 26 - Card Operating System List Window

Creating a New Card Operating System To create a new card operating system (OS): 1. On the Card operating list window, click Create. The Card operating system creation window is displayed.

Figure 27 - Card Operating System Creation Window 2. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

The name of the operating system (maximum of 15 characters).

Version

The operating system version (maximum of 20 characters).

3. Click Back when you want to return to the previous window.

45

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

To display information about a card operating system: 1. Select the card operating system in the list, and click View. The Card operating system definition window is displayed for the select card operating system. On this window, you can update or delete the card operating system.

Figure 28 - Card Operating System Definition Window 2. Click Back when you want to return to the previous window.

Updating or Deleting a Card Operating System To update the card operating system: 1. Do one of the following: –

On the Card operating system list window, select the card operating system and click Update.

–

On the Card operating system definition window, click Update.

The Card operating system update window is displayed.

Figure 29 - Card Operating System Update Window 2. In the window, enter values for parameters shown in the following table and click Update. Parameter Name

Description

Name

The new name of the operating system (maximum of 15 characters).

Version

The new operating system version (maximum of 20 characters).

3. Click Back when you want to return to the previous window. To delete the card operating system: 1. Do one of the following: –

46

On the Card operating systems list window, select the card operating system and click Delete.

Managing Applets

–

On the Card operating systems characteristics window, click Delete.

2. On the Delete Prompt window, click OK to confirm the delete.

Managing Card Virtual Machines The following provides information on card virtual machines. A virtual machine is required on a card to enable Java applets to run.

Card Virtual Machine List Window The Virtual machine list window displays a list of virtual machine entities in the applet manager database. 1. To display the Virtual machine list window, do either of the following: –

On the GemXplore Suite Welcome window, click Applet management

–

Click Applet on any other GemXplore Suite Interface window.

2. On the left frame, select Card definition -> Virtual machine. The Virtual machine list window is displayed. On this window, you can create, view, update and delete virtual machines.

Figure 30 - Virtual Machine List Window

47

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Creating a New Virtual Machine To create a new virtual machine: 3. On the Virtual machine list window, click Create. The Virtual Machine creation window is displayed.

Figure 31 - Virtual Machine Creation Window 4. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

The name of the virtual machine (maximum of 15 characters).

Version

The virtual machine version (maximum of 20 characters).

Origin

The origin of the virtual machine (maximum of 15 characters).

5. Click Back when you want to return to the previous window. To display information about a virtual machine: On the Virtual Machine list window, select the virtual machine in the list and click View. The Virtual Machine definition window for the selected virtual machine is displayed. On this window, you can update or delete the virtual machine.

Figure 32 - Virtual Machine Definition Window

Updating or Deleting a Card Virtual Machine To update the virtual machine: 1. Do on e of the following: –

48

On the Virtual machine list window, select the virtual machine and click Update.

Managing Applets

–

On the Virtual machine definition window, click Update.

The Virtual machine update window is displayed.

Figure 33 - Virtual Machine Update Window 2. In the window, enter values for parameters shown in the following table and click Update. Parameter Name

Description

Name

The name of the virtual machine (maximum of 15 characters).

Version

The virtual machine version (maximum of 20 characters).

Origin

The origin of the virtual machine (maximum of 15 characters).

3. Click Back when you want to return to the previous window. To delete the virtual machine: 1. Do one of the following: –

On the Virtual machine list window, select the virtual machine and click Delete.

–

On the Virtual machine definition window, click Delete.

2. On the Delete Prompt window, click OK to confirm the delete.

Managing Card Definitions Card Definition List Window The Card definition list window displays all the card definition entities in the applet manager database. To list card definitions: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Applet management

–

Click Applet on any other GemXplore Suite Interface window.

49

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

2. On the left frame, select Card -> Card definition. The Card definition list search window is displayed. On this window, you can create, view, or delete card definition entities.

Figure 34 - Card Definition List

Creating a New Card Definition To create a new card definition: 1. On the Card definition list window, click Create. The Card definition creation window is displayed.

Figure 35 - Card Definition Creation

50

Managing Applets

2. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

Name of the Java virtual machine (20 characters maximum).

Card type

The card type. Click the down arrow and select from the list.

Card OS

The name of the card operating system. Click the down arrow and select from the list.

Virtual Machine

The name of the card virtual machine. Click the down arrow and select from the list.

Custom characteristics

Free text (maximum of 200 characters, truncated to fit the page).

3. Click Back when you want to return to the previous window. To display information about a card definition: 1. On the Card definition list window, select the card definition in the list and click View. The Card definition window for the selected card definition is displayed. On this window, you can update or delete the card definition.

2. Click Back when you want to return to the previous window. Figure 36 - Card Definition Window

Updating or Deleting a Card Definition To update the card definition: 1. Do one of the following: –

On the Card definition list window, select the card definition and click Update.

–

On the Card definition window, click Update.

51

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

The Card definition update window is displayed.

Figure 37 - Card Definition Update Window 2. In the window, enter values for parameters shown in the following table and click Update. Parameter Name

Description

Name

The new name for the definition.

Card type

The type of card. Click the down arrow and select from the list.

Card OS

The name of the operating system. Click the down arrow and select from the list.

Virtual Machine

The name of the virtual machine. Click the down arrow and select from the list.

Custom characteristics

Free text.

3. Click Back when you want to return to the previous window. To delete the card definition: 1. Do one of the following: –

On the Card definition list window, select the card definition and click Delete.

–

On the Card definition window, click Delete.

2. On the Delete Prompt window, click OK to confirm the delete.

Applet Providers The following provides information for managing applet providers.

Provider List Window The Provider list window displays a list of all applet provider entities in the applet manager database. To list card providers:

52

Managing Applets

1. To display the Provider list window, do either of the following: –

On the GemXplore Suite Welcome window, click Applet management

–

Click Applet on any other GemXplore Suite Interface window.

2. On the left frame, click Provider. The Provider list window is displayed. On this window, you can create, view, update, or delete applet provider entities.

Figure 38 - Provider List Window

Creating a New Applet Provider To create a new provider: 1. On the Provider list window, click Create. The Provider creation window is displayed.

Figure 39 - Provider Creation Window

53

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

2. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

Name of the applet provider; for example, Gemplus (30 characters maximum).

RID

Registered application provider identifier (10 characters maximum). A provider may get a registered application provider identifier (RID) from ISO; for example, the Gemplus AID is A0 00 00 00 18.

Approval

Applet provider approval type, provided by the customer (50 characters maximum).

Approval Date

The date of approval. Click the down arrow and select from the list. Click the No approval date check box if no approval date is required.

Approval Limit Date

Last day of the approval validity period. Valid values: Later than or the same as the approval date. Click the No approval limit date check box if no approval limit date is required.

Custom characteristics

Free text (200 characters maximum).

To display information about a provider: 1. On the Provider list window, click the provider in the list. The Provider definition window for the selected provider is displayed. On this window, you can update or delete the card definition.

Figure 40 - Provider Definition Window

54

Managing Applets

Updating or Deleting a Provider To update the provider: 1. On the Applet Provider Characteristics window, click Update. The Update Provider window is displayed.

Figure 41 - Provider Update Window 2. In the window, enter values for parameters shown in the following table and click Validate. Parameter Name

Description

Name

Name of the applet provider; for example, Gemplus (30 characters maximum).

RID

Registered application provider identifier (10 characters maximum). A provider may get a registered application provider identifier (RID) from ISO; for example, the Gemplus AID is A0 00 00 00 18

Approved

Whether the applet is approved or not.

Approval date

The date of approval. Click the down arrow and select from the list. Click the No approval date check box if no approval date is required.

Approval limit date

Last day of the approval validity period. Valid values: Later than or the same as the approval date. Click the No approval limit date check box if no approval limit date is required.

Custom characteristics

Free text (maximum of 200 characters.

To delete the card definition: 1. Do one of the following: –

On the Provider list window, select the provider and click Delete.

–

On the Provider definition window, click Delete.

2. On the Delete Prompt window, click OK to confirm the delete.

55

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

STK Applets The following provides information on managing STK applets. An STK applet is an STK application with associated file structure and is linked to an applet provider and a card definition (card type, card definition, operating system, and virtual machine). An STK applet consists of the following:

56

•

applet characteristics

•

a list of STK applet files

•

a list of STK configuration files

•

a list of STK services, each one of which is composed of STK script files and STK configuration files

•

a list of incompatible applets

•

For additional information about STK applets, see “STK Applets” in “Appendix A Additional Information”

Managing Applets

Card Structure The following shows an example of the structure of a GemXplore98 card containing STK applets

Figure 42 - SIM Card File Structure Containing STK Applets

Using the STK Applet Search Facility To use the STK applet search facility: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Applet management

–

Click Applet on any GemXplore Suite management interface window.

57

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

2. On the left frame, select STK applet. The STK applet search and STK applet list windows are displayed.

Figure 43 - STK Applet Search Window 3. On the STK applet search window, enter any of the search criteria shown in the following table and click Find.:

58

Parameter Name

Description

Identifier

STK applet ID (conforms to ISO 7816-5).

Major Version

Major version number of the STK applet; for example 1 in V1.2.

Minor Version

Minor version number of the STK applet; for example 2 in V1.2

Card Definition Name

The definition name of the card. Click the down arrow and select from the drop-down list.

Provider Name

The name of the STK applet provider. Click the down arrow and select from the drop-down list.

Label

STK applet label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Managing Applets

4. The result of the search is displayed on the STK applet list window. If you do not enter any search criteria, all STK applets are displayed in the list when you click Find. On this window, you can upload, view, update, or delete STK applets.

Figure 44 - STK Applet List Window

Uploading an STK Applet to the Applet Database So that STK applets can be downloaded on to cards, they must be uploaded form the developers workstation to the applet database. To upload an STK applet:

59

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

1. On the STK applet list window, click Upload. The STK applet characteristics window is displayed:

Figure 45 - STK Applet Characteristics (Upload) Window 2. In the window, enter values for parameters shown in the following table:

60

Parameter Name

Description

Identifier

STK applet ID (conforms to ISO 7816-5).

Major Version

Major version number of the STK applet; for example 1 in V1.2.

Minor Version

Minor version number of the STK applet; for example 2 in V1.2

Card Definition Name

The definition name of the card. Click the down arrow and select from the drop-down list.

Provider Name

The name of the applet provider. Click the down arrow and select from the drop-down list.

Label

STK applet label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Description

Description of the STK applet.

Service type

Type of service (such as loyalty, E-purse, or charge account).

Issuance date

Date of issue of the STK applet.

Managing Applets

Parameter Name

Description

Code Size

Size of the code required on the card in bytes. For example, 1234 bytes.

Persistent data size

Size of the persistent data required on the card to run the STK applet (maximum of 10 digits).

Ram Data Size

Size of the ram data required on the card to run the STK applet (maximum of 10 digits).

3. Click More characteristics, the STK applet optional characteristics window is displayed:

Figure 46 - STL Applet Optional Characteristics (Upload) Window 4. In the window, enter values for parameters shown in the following table, and click Validate to return to the STK applet characteristics window. Parameter Name

Description

Limit On Use

Maximum of 100 characters

Owner

Owner or organization responsible for managing the STK applet.

Developer

Real name of the developer of the STK applet.

IDE

Integrated development environment use to develop the applet.

Custom Characteristics

Free text (maximum of 200 characters, truncated to fit the page).

5. On the STK applet characteristics window, click Upload.

Viewing, Updating, and Deleting STK Applets To view information about an STK applet:

61

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

1. On the STK applet list window, select the STK applet and click View. The STK applet characteristics window is displayed. On this window you can also update the STK applet characteristics.:

Figure 47 - ATK Applet Characteristics (View) Window 2. To display more characteristics, click More Characteristics.

Figure 48 - STK Applet Optional Characteristics (View) Window 3. Click Back on each window when you want to return to the STK applet list window. To update an STK applet:

62

Managing Applets

1. On the STK applet list window, select the STK applet and click Update. The STK applet characteristics window is displayed:

Figure 49 - STK Applet Update Window 2. In the window, enter values for parameters shown in the following table: Parameter Name

Description

Identifier

STK applet ID (conforms to ISO 7816-5).

Major Version

Major version number of the STK applet; for example 1 in V1.2.

Minor Version

Minor version number of the STK applet; for example 2 in V1.2

Card Definition Name

The definition name of the card. Click the down arrow and select from the drop-down list.

Provider Name

The name of the applet provider. Click the down arrow and select from the drop-down list.

Label

STK applet label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Description

Description of the STK applet.

Service type

Type of service (such as loyalty, E-purse, or charge account).

Issuance date

Date of issue of the STK applet.

63

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Parameter Name

Description

Code Size

Size of the code required on the card in bytes. For example, 1234 bytes.

Persistent data size

Size of the persistent data required on the card to run the applet (maximum of 10 digits).

Ram Data Size

Size of the ram data required on the card to run the STK applet (maximum of 10 digits).

3. Click More characteristics to update optional characteristics. The STK applet optional characteristics window is displayed:.

Figure 50 - STK Applet Optional Characteristics Window 4. In the STK applet optional characteristics window, enter values for parameters shown in the following table and click Validate to return to the STK applet characteristics window. Parameter Name

Description

Limit On Use

Maximum of 100 characters

Owner

Owner or organization responsible for managing the STK applet.

Developer

Real name of the developer of the STK applet.

IDE

Integrated development environment use to develop the STK applet.

Custom Characteristics

Free text (maximum of 200 characters, truncated to fit the page).

5. On the STK applet characteristics window, click Update. To delete an STK applet: 1. On the STK applet list window, select the STK applet to be deleted and click Delete. 2. On the Delete Prompt window, click OK to confirm the delete.

64

Managing Applets

Viewing, Adding, and Deleting STK Applet Files Each STK applet contains one or several STK applet files. These are script files that represent the electrical files (EFs) and their contents for STK applets and services. To view information about an STK applet file: 1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the File tab. The STK applet file list window is displayed:

Figure 51 - STK Applet File List Window To add STK applet files: 1. On the STK applet list window, select the STK applet and click Update. 2. On the STK applet update window, click the File tab. The STK applet file import window is displayed:

Figure 52 - STK Applet File Import Window 3. On the STK applet file import window either enter the path and file name in the STK applet file field, or click Browse and select the applet file to be imported. 4. Click Add to add the new applet file. Caution: The size of applet files is limited to 9999 bytes. If you attempt to add an applet file that is larger than this, you will get an error. To delete an STK applet file: 1. On the STK applet file list window, select the STK applet file to be deleted and click Delete. 2. On the Delete Prompt window, click OK to confirm the delete.

65

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Viewing, Updating, and Deleting STK Applet Configuration Files In addition to STK applet files, STK applets contain one or several configuration files (see “Figure 42 - SIM Card File Structure Containing STK Applets”). To view information about an STK applet configuration file: 1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the Configuration tab. The STK configuration file list window is displayed

Figure 53 - STK Configuration File List Window To update an STK applet configuration file: 1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the Configuration tab. 3. On the STK configuration file list window, select the STK configuration file and click Update. The STK configuration file import window is displayed:

Figure 54 - STK Configuration File Import Window 4. On the STK configuration file import window either enter the path and file name in the STK configuration file field, or click Browse and select the configuration file to be imported. 5. Click Add to add the new configuration file. To delete an STK applet configuration file: 6. On the STK applet configuration file list window, select the STK applet configuration file to be deleted and click Delete. 7. On the Delete Prompt window, click OK to confirm the delete.

66

Managing Applets

Viewing, Updating, Adding, and Deleting STK Applet Services To view information about an STK applet services: 1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the Services tab. The STK applet services list window is displayed. On this window you can add, update, or delete an STK applet file.

Figure 55 - STK Applet Services List Window To add an STK applet service: 1. On the STK applet list window, select the STK applet and click Update. 2. On the STK applet characteristics window, click the Services tab. 3. On the STK applet services list window, click Add. The STK service creation window is displayed:

67

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

4. In the window, enter values for parameters shown in the following table and click Validate. Parameter Name

Description

Identifier

Applet service ID (conforms to ISO 7816-5).

Version

Version number of the applet service; for example 1 in V1.2.

Provider Name

The name of the applet service provider. Click the down arrow and select form the drop-down list.

Label

Applet service label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Description

Description of the applet service.

Service type

Type of applet service (such as loyalty, E-purse, or charge account).

Issuance date

Date of issue of the applet service.

Code Size

Size of the code required on the card in bytes. For example, 1234 bytes.

Persistent data size

Size of the persistent data required on the card to run the applet service (maximum of 10 digits).

Ram Data Size

Size of the ram data required on the card to run the applet service (maximum of 10 digits).

Custom Characteristics

Free text (maximum of 200 characters, truncated to fit the page).

To update an STK applet service: 1. On the STK applet list window, select the STK applet and click Update. 2. On the STK applet characteristics window, click the Services tab.

68

Managing Applets

3. On the STK applet services list window, select the applet service and click Update. The STK service update window is displayed:

Figure 56 - STK Service Update Window 4. In the window, enter values for parameters shown in the following table and click Update. Parameter Name

Description

Identifier

Service ID (conforms to ISO 7816-5).

Version

Version number of the service; for example 1 in V1.2.

Provider Name

The name of the service provider. Click the down arrow and select from the drop-down list.

Label

Service label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Description

Description of the service.

Service type

Type of service (such as loyalty, E-purse, or charge account).

Issuance date

Date of issue of the service.

Code Size

Size of the code required on the card in bytes. For example, 1234 bytes.

69

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Parameter Name

Description

Persistent data size

Size of the persistent data required on the card to run the service (maximum of 10 digits).

Ram Data Size

Size of the ram data required on the card to run the service (maximum of 10 digits).

Custom Characteristics

Free text (maximum of 200 characters, truncated to fit the page).

1. On the STK applet services list window, select the STK service and click Delete. 2. On the Delete Prompt window, click OK to confirm the delete.

Viewing, Updating, Adding, and Deleting STK Applet Incompatibilities To view information about an STK applet incompatibility: 1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the Incompatibility tab. The STK applet incompatibilities list window is displayed. On this window, you can update or delete an STK applet incompatibility.

Figure 57 - STK Applet Incompatibilities List Window 3. On the STK applet incompatibilities list window, select the applet incompatibility and click View. The Applet incompatibility description window is displayed:

Figure 58 - Applet Incompatibility Description Window To update an STK applet incompatibility:

70

Managing Applets

1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the Incompatibility tab. 3. On the STK applet incompatibilities list window, select the applet incompatibility and click Update. The STK applet incompatibility update window is displayed:

Figure 59 - STK Applet Incompatibility Update Window 4. In the windows, enter values for parameters shown in the following table and click Update. Parameter Name

Description

Identifier

Applet ID (conforms to ISO 7816-5).

Major Version

Major version number of the applet; for example 1 in V1.2.

Minor Version

Minor version number of the applet; for example 2 in V1.2

Card Definition Name

The definition name of the card.

Description

Description of the incompatibility.

To delete an STK applet incompatibility: 1. On the STK applet list window, select the STK applet and click View. 2. On the STK applet characteristics window, click the Incompatibility tab. 3. On the STK applet incompatibilities list window, select the incompatible applet and click Delete. 4. On the Delete Prompt window, click OK to confirm the delete.

Java Packages The following provides information on Java packages. Java packages can contain one or several Java applets. Java package files contain the code, the loading and installation parameters for the package, and the instantiation parameters for the Java applets.

71

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

The following shows an example of the structure of a GemXplore ‘Xpresso V3 card containing Java applets:

Using the Java Package Search Facility To use the Java package search facility: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Applet management

–

Click Applet on any GemXplore Suite management interface window.

2. On the left frame, select Java package. The Java package search and Java package list windows are displayed.

Figure 60 - Java Package Search Window

72

Managing Applets

3. On the Java package search window, enter the search criteria shown in the following table and click Find.: Parameter Name

Description

Identifier

Java package ID (conforms to ISO 7816-5).

Major Version

Major version number of the Java package; for example 1 in V1.2.

Minor Version

Minor version number of the Java package; for example 2 in V1.2

Card Definition Name

The definition name of the card. Click the down arrow and select from the drop-down list.

Provider Name

The name of the Java package provider. Click the down arrow and select from the drop-down list.

Label

Java package label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

4. The result of the search is displayed on the Java package list window. If you do not enter any search criteria, all Java packages are displayed in the list when you click Find. On this window, you can upload, view, update, or delete Java packages.

Figure 61 - Java Package List Window

73

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Uploading, Viewing, Updating, and Deleting Java Packages So that Java packages can be downloaded on to cards, they must be uploaded from the workstation to the applet database. To upload a Java package: 1. On the Java package list window, click Upload. The Java package characteristics (upload) window is displayed:

74

Managing Applets

Figure 62 - Java Package Characteristics (Upload) Window 2. In the window, enter values for parameters shown in the following table: Parameter Name

Description

Identifier

Java package ID (conforms to ISO 7816-5).

Major Version

Major version number of the Java package; for example 1 in V1.2.

Minor Version

Minor version number of the Java package; for example 2 in V1.2

Card Definition Name

The definition name of the card. Click the down arrow and select from the drop-down list.

Provider Name

The name of the Java package provider. Click the down arrow and select from the drop-down list.

Label

Java package label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Description

Description of the Java package.

Service type

Type of service (such as loyalty, E-purse, or charge account).

Issuance date

Date of issue of the Java package.

Code Size

Size of the code required on the card in bytes. For example, 1234 bytes.

Persistent data size

Size of the persistent data required on the card to run the Java package (maximum of 10 digits).

Ram Data Size

Size of the ram data required on the card to run the Java package (maximum of 10 digits).

3. Click More characteristics. The Java package optional characteristics window is displayed:

Figure 63 - Java Package Optional Characteristics Window

75

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

4. On the Java package optional characteristics window, enter values for parameters shown in the following table and click Validate to return to the Java package characteristics window. Parameter Name

Description

Limit On Use

Maximum of 100 characters

Owner

Owner or organization responsible for managing the Java package

Developer

Real name of the developer of the Java package.

IDE

Integrated development environment use to develop the Java package.

Custom Characteristics

Free text (maximum of 200 characters, truncated to fit the page).

5. On the Java package characteristics window, click Upload. To view information about a Java package: 1. On the Java package search window, click Find. The Java packages are displayed in the Java package list window. On this window, you can view, update, upload, or delete a Java package.

Figure 64 - Java Package List Window

76

Managing Applets

2. On the Java package list window, select the Java package and click View. The Java package update window is displayed. On this window, you can also update the Java package.

Figure 65 - Java Package Characteristics Window

Viewing, Adding, and Deleting Java Package Files To view Java package files: 1. On the Java package list window, select the Java package and click View. 2. On the Java package characteristics window, click the File tab. The Java package files window is displayed:

Figure 66 - Java Package Files Window Note: For information on the two types of file that can be added, see “Java Package Files” in “Appendix A - Additional Information”. To add a Java package file:

77

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

1. On the Java package files window, select the Java package and click Update. The New Java package file window is displayed:

Figure 67 - New Java Package File Window 2. On the New Java package file window either enter the path and file name in the Java package file field, or click Browse and select the Java package file to be imported. 3. Click Add to add the new Java package file. Caution: The size of Java package files is limited to 9999 bytes. If you attempt to add a Java package file that is larger than this, you will get an error. To delete a Java package file: 1. On the Java package files window, click Update. 2. On the Java package files window, select the Java package file and click Delete. On the Delete Prompt window, click OK to confirm the delete.

Updating the Java Packages Required To view information about the Java package required: 1. On the Java package list window, select the Java package and click View. 2. On the Java package characteristics window, click the Pack Required tab. The List of Java package required window is displayed. From this window, you can update the Java package required list:

Figure 68 - List of Java Package Required Window To update the Java package required list:

78

Managing Applets

1. On the List of Java package required window, select the Java package and click Update. The Java package required window is displayed:

Figure 69 - Java Package Required Window 2. On the Java Package Required window, enter values for parameters shown in the following table: Parameter Name

Description

Identifier

Java package ID (conforms to ISO 7816-5).

Major Version

Major version number of the Java package; for example 1 in V1.2.

Card Definition Name

The definition name of the card. Click the down arrow and select from the drop-down list.

3. Click Add to add the new Java package to the Java package required list.

Viewing and Updating Java Package Incompatibilities To view information about a Java package incompatibility: 1. On the Java package list window, select the Java package and click View. 2. On the Java package characteristics window, click the Incompatibility tab. The List of Java package incompatibilities window is displayed. From this window, you can view or update Java package incompatibility:

Figure 70 - Java Package Incompatabilities List Window To view Java package incompatibility: 1. On the List of Java package incompatibilities window, select the Java package and click View. 2. On the Java package characteristics window, click the Incompatibility tab.

79

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

3. On the List of Java package incompatibilities window, select the Java package and click View. The Java package incompatibility view window is displayed:

Figure 71 - Java Package Incompatibility View Window To update a Java package incompatibility: 1. On the Java package list window, select the Java package and click View. 2. On the Java package characteristics window, click the Incompatibility tab. 3. On the List of Java package incompatibilities window, select the Java package and click Update. The Java Package Incompatibility Update window is displayed:

Figure 72 - Java Package Incompatibility Update Window 4. In the window, enter values for parameters shown in the following table and click Add. Parameter Name

Description

Identifier

Applet ID (conforms to ISO 7816-5).

Major Version

Major version number of the applet; for example 1 in V1.2.

Card Definition Name

The definition name of the card.

Incompatability info

Description of the incompatibility.

Viewing and Updating Java Package Java Applets To view information about the Java Applets in a Java package: 1. On the Java package list window, select the Java package and click View.

80

Managing Applets

2. On the Java package characteristics window, click the Java Applet tab. The List of Java Applets window is displayed. From this window, you can view or update a Java Applet:

Figure 73 - List of Java Applets Window To view a Java Applet: 1. On the Java package list window, select the Java package and click View. 2. On the Java package characteristics window, click the Java Applet tab. 3. On the List of Java Applets window, select the Java Applet and click View. The Java Applet view window is displayed:

Figure 74 - Java Applet Characteristics Window To update a Java package Java Applet: 1. On the Java package list window, select the Java package and click View. 2. On the Java package characteristics window, click the Java Applet tab. 3. On the List of Java Applets window, select the Java Applet and click Update. The Java package java applet update window is displayed:

Figure 75 - Java Package Java Applet Update Window

81

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

4. In the windows, enter values for parameters shown in the following table and click Add.

82

Parameter Name

Description

Identifier

Applet ID (conforms to ISO 7816-5).

Label

Java package label used by the user interface (maximum of 32 characters, conforming to ISO 7816-5).

Description

Description of the Java applet.

Custom Characteristics

Free text (maximum of 200 characters, truncated to fit the page).

6 Managing Card Entities in the Card Database

The following provides information on managing card entities in the Card Manager database. The functions are generally used to create, update, and delete individual card entities in the database. To populate the database with a large number of card entities simultaneously, a batch load facility is provided to load several definitions for each card entity. This facility uses XML files containing the card entity definitions. See “Using the Batch Load Facility” Note: Card entities can be managed only when the Platform facility Platform management has been set. See “Creating an Administrator Profile”.

Logging In If not already logged in, log in as described in “Step 1: Logging In” in “Getting Started”

Card Manager Interface Window The Card Manager interface window allows you to manage the following card entities in the Card Manager database: •

Card vendors

•

Card definitions

•

Card structures

•

Card profiles

•

Card applications

To display the Card Manager interface: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window

2. On the left frame of the Platform management window, click Product configuration. The Product list window is displayed. 3. Select the Card Manager card product in the list, and click Configure.

83

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

4. On the Product configuration window, click Product parameters. The Card Manager interface window is displayed:

Figure 76 - Card Manager Interface Window 5. Click Back to product management when you want to return to the Product configuration window.

84

Managing Card Entities in the Card Database

Managing Card Vendors The card vendor entity provides information about the card vendor, for example, Gemplus.

Card Vendor List Window The Card Vendor List window displays all card vendor entities in the Card Manager database. 1. To display the Card Vendor List window, do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window

2. On the left frame of the Platform management window, click Product configuration. The Product list window is displayed. 3. Select the Card Manager card product in the list, and click Configure. 4. On the Product configuration window, click Product parameters. 5. On the Card Manager interface window, click Card Vendor - Manage. The Card Vendor List window is displayed. On this window, you can create, consult, update, or delete card vendor entities. You can also use the batch load facility to load several card definition entities simultaneously into the database (see “Using the Batch Load Facility”).

Figure 77 - Card Vendor List Window 6. Click Back when you want to return to the Card Manager interface window.

Creating a Card Vendor To create a card vendor: 1. Do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window

2. On the left frame of the Platform management window, click Product configuration. The Product list window is displayed. 3. Select the Card Manager card product in the list, and click Configure.

85

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

4. On the Product configuration window, click Product parameters. 5. On the Card Manager interface window, click Card Vendor - Manage. The Card Vendor List window is displayed 6. On the Card Vendor List window, click Create. The Card Vendor Creation window is displayed:

Figure 78 - Card Vendor Creation Window 7. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

Name of the card vendor (maximum of 30 alphanumeric characters).

Description

Description of the card vendor (maximum of 80 characters)

Viewing, Updating, and Deleting Card Vendors To view information about a card vendor: 1. On the Card Vendor List window, select the card vendor and click Consult. The Card Vendor Information window is displayed:

Figure 79 - Card Vendor Information Window 2. Click OK when you want to return to the previous window.

86

Managing Card Entities in the Card Database

To update a card vendor: 1. On the Card Vendor List window, select the card vendor and click Update. The Card Vendor Update window is displayed:

Figure 80 - Card Vendor Update Window 2. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

Name of the card vendor. This cannot be updated.

Description

Description of the card vendor (maximum of 80 characters)

To delete a card vendor: 3. On the Card Vendor List window, select the card vendor and select Delete. 4. On the Vendor to Be Deleted window, click Delete.

Managing Card Definitions The card definition defines the electronic profile of the smart card.

Card Definition List Window The Card definition list window displays all card definition entities in the Card Manager database. 1. To display the Card definition list, do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window

2. On the left frame of the Platform management window, click Product configuration. The Product list window is displayed. 3. Select the Card Manager card product in the list, and click Configure. 4. On the Product configuration window, click Product parameters. The Card Manager interface window is displayed. 5. On the Card Manager interface window, click Card Definition - Manage. The Card Definition List window is displayed. On this window, you can create, consult, update, or delete card definition entities. You can also use the batch load facility to load several card definition entities simultaneously into the database (see “Using the Batch Load Facility”).

87

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Figure 81 - Card Definition List Window 6. Click Back when you want to return to the Card Manager interface window.

Creating a Card Definition To create a card definition: 1. On the Card Definition List window, click Create. The Card Definition Creation window is displayed:

Figure 82 - Card Definition Creation Window

88

Managing Card Entities in the Card Database

2. In the window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Internal Name

Internal name (maximum of 30 alphanumeric characters)

Commercial Name

Commercial name (maximum of 30 alphanumeric characters)

OS Name

Name of the embedded operating system (maximum of alphanumeric 30 characters)

OS Version

Version of the embedded operating system (maximum of 10 characters)

Chip Manufacturer

Name of the chip manufacturer (maximum of 30 characters)

Chip Model

Model reference of the chip (maximum of 30 characters)

EEPROM Size

Electrically Erasable Programmable ROM size (in bytes)

RAM Size

RAM size (in bytes)

ROM Size

ROM size (in bytes)

Free Size

Amount of free memory in the smart card after personalization (in bytes)

Viewing, Updating and Deleting Card Definitions To view a card definition: 1. On the Card Definition List window, select the card definition and click View. The Card Definition Information window for the selected card definition is displayed:

Figure 83 - Card Definition Information Window

89

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Click OK when you want to return to the previous window. To update a card definition: 1. On the Card Definition List window, click Update. The Card Definition Update window is displayed:

Figure 84 - Card Definition Update Window 2. In the window, enter values for parameters shown in the following table and click Update. Parameter Name

Description

Internal Name

Internal name. This cannot be updated.

Commercial Name

Commercial name (maximum of 30 alphanumeric characters)

OS Name

Name of the embedded operating system (maximum of alphanumeric 30 characters)

OS Version

Version of the embedded operating system (maximum of 10 characters)

Chip Manufacturer

Name of the chip manufacturer (maximum of 30 characters)

Chip Model

Model reference of the chip (maximum of 30 characters)

EEPROM Size

Electrically Erasable Programmable ROM size (in bytes)

RAM Size

RAM size (in bytes)

ROM Size

ROM size (in bytes)

Free Size

Amount of free memory in the smart card after personalization (in bytes)

To delete a card definition:

90

Managing Card Entities in the Card Database

3. On the Card Definition List window, select the card profile and select Delete. 4. On the Definition to Be Deleted window, click Delete.

Managing Card Structures The card structure contains a description of the internal file system of a smart card. The structure consists of a directory tree consisting of folders and elementary file types that relate to the different attributes of the file's structure; for example, record number, record size and so on. The following are the available file types in the directory: •

Master (MF): This is a unique, root directory, that contains all the elementary files required for the card structure.

•

Linear (LF): Binary/ASCII files with records of equal size.

•

Cyclic (CF): Binary/ASCII files with a series of records of equal size, and in cyclic order that do not specify a start or end line. When the file is full, the latest record in the file is overwritten in order for more records to be created.

•

Transparent (TF): Binary or ASCII files without a record structure.

•

Directory (DF): Used when you want to open a new folder in the directory.

For Java cards, GemXplore‘98, instances of applets an other applications, the available file types are: •

A: This specifies an STK applet.

•

S: This specifies an STK service.

•

P: This specifies a Java card package.

•

J: This specifies a Java card applet.

•

I: This specifies an instance of a Java card applet.

Card Structure List Window The Card Structure List window displays all card structure entities in the Card Manager database. To list card structures: 1. To display the Card Structure List window, do either of the following: –

On the GemXplore Suite Welcome window, click Platform management

–

Click Platform on any GemXplore Suite management interface window

2. On the left frame of the Platform management window, click Product configuration. The Product list window is displayed. 3. Select the Card Manager card product in the list, and click Configure. 4. On the Product configuration window, click Product parameters. The Card Manager interface window is displayed. 5. In the Card Management area, click Card Structure - Manage. The Card Structure List window is displayed. On this window, you can create, consult, update, or delete card structure entities. You can also use the batch load facility to load several card definition entities simultaneously into the database (see “Using the Batch Load Facility”).

91

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

Figure 85 - Card Structure List Window 6. Click Back when you want to return to the previous window.

Creating Card Structures Creating a card structure consists of creating Directory, Linear, Cyclic, and Transparent files, and STK applet, STK service and Java package files. 1. On the Card Structure List window, click Create. The Card Structure Creation window is displayed:

Figure 86 - Card Structure Creation Window 2. On the Create Card Structure window, enter the name of the new card structure, and click Create. The Card Structure window is displayed with the master file (3F00 MF).

92

Managing Card Entities in the Card Database

Creating Directory, Linear, Cyclic, and Transparent Files To create directory, linear, cyclic, and transparent files: 1. Select master file 3F00, and click Create. The File Information Create window is displayed.

Figure 87 - File Information Create Window 2. Select the type of file to be created, Directory, Linear, Cyclic, or Transparent and click Create. 3. Depending on the type of file selected, in the corresponding window, enter values for parameters shown in the following table and click Create. Parameter Name

Description

Name

Name of the directory file. For example, TELECOM (maximum of 30 alphanumeric characters)

Identifier

Identifier that defines the file in the smart card file system. For example, 7F10 (maximum of 20 alphanumeric characters)

Number of Records

Number of records in the file.

Size

Size of the file in bytes. For example, the amount of data stored in the file (can also include the header size). The file size is limited to 4 characters, so the maximum value is 9999 bytes.

Record Size

Size of a record.

4. Repeat the previous steps for all other files.

Creating a Card Structure with Minimum Security Levels (MSL) You can configure 03.48 security to assign different minimum security levels (MSLs) to different card applications (for example, GSM, USIM, and GOP). This means that the same OTA service can have different minimum security levels, depending on the card application. In the CardStructure.xml file, you can define an MSL for each card application, assigning a security parameter indicator (SPI) value to each MSL.

93

GemXplore Suite V1.3.1 Administrator’s Guide Service Pack 2 Edition

For each card application in the cardStructure.xml file, you specify a transparent file named “MSL” with the identifier “0001”, as follows:

The MSL must be stored under the DF or ADF the most representative of the corresponding card application. For example, the MSL for the GSM card application would be stored under DF GSM as follows: