Home

Sparx Systems Keystore Services User Guide

1. ENTERPRISE ARCHITECT Sparx Systems Keystore Service SSKS User Guide This booklet describes the Sparx Systems Keystore Service facilities for Enterprise Architect The Sparx Systems Keystore Service is used to manage the registration keys issued with the Floating Licenses purchased for Enterprise Architect Corporate Business amp Software Engineering Systems Engineering and Ultimate editions and for related MDG products Sf SYSTEMS Copyright 2005 2010 Sparx Systems Pty Ltd Sparx Systems Keystore Service User Guide 2005 2010 Sparx Systems Pty Lid All rights reserved No parts of this work may be reproduced in any form or by any means graphic electronic or mechanical including photocopying recording taping or information storage and retrieval systems without the written permission of the publisher Products that are referred to in this document may be either trademarks and or registered trademarks of the respective owners The publisher and the author make no claim to these trademarks While every precaution has been taken in the preparation of this document the publisher and the author assume no responsibility for errors or omissions or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or
2. Feature Description Feature will be installed when required on the local hard XxX Entire feature will be unavailable on your hard drive Wise Installation Wizard Fi Disk Cost Reset lt Back option Description S Sparx Systems A TCP IP service that exposes shared key management functions to remote Keystore Service Enterprise Architect clients 2005 2010 Sparx Systems Pty Ltd 9 Install the Keystore Service option escrptiom Po Install this feature if you would like the host machine to act as the Keystore server Keystore Manager An application that facilitates administration 13 of a remote or local keystore e g adding removing releasing keys Install this feature if you would like to administer local or remote Sparx Systems Keystore Service keystores or legacy file based keystores from the host machine Continue through the installation prompts and screens to finalize the installation If you installed the Sparx Systems Keystore Service feature the installer attempts to start the service at the end of the installation process using the default configuration For further information on configuring the service please see the Configure the Keystore Service 11 topic Sparx Systems Keystore Service User Guide Start Stop the Keystore Service 10 3 Start Stop the Keystore Service You can start and stop the Sparx Systems Keystore Service through Mi
3. Windows Windows 98 Windows NT Windows ME Windows XP Windows Vista Windows 2000 and Windows 2003 Server are trademarks of Microsoft GOVERNING LAW This agreement shall be construed in accordance with the laws of the Commonwealth of AUSTRALIA Sparx Systems Keystore Service User Guide Introduction Support 6 1 3 Support Technical support for Sparx Systems Keystore Service is available to registered users Responses to support queries are sent by email Sparx Systems endeavors to provide a rapid response to all product related questions or concerns Registered users can lodge a support request by visiting http www sparxsystems com registered reg_ support html An online user forum is also available for your questions and perusal at http www sparxsystems com cgi bin yabb YaBB cqgi 2005 2010 Sparx Systems Pty Ltd 7 Introduction Your Feedback 1 4 Your Feedback Sparx Systems likes to stay in touch with what the Sparx Systems Keystore Service users require in order to accomplish their tasks efficiently and effectively We value any suggestions feedback and comments you might have regarding this product documentation or install process You can access our online feedback pages at e www sparxsystems com bug_report htm and e www sparxsystems com feature_request htm Alternatively you can contact Sparx Systems by email at support sparxsystems com Sparx Systems Keyst
4. found User User Name is not a configuration property AUTHMETHOD_ OPTIONS was left blank Enter a valid Active Directory group in the AUTHMETHOD_OPTIONS property in the service configuration file or use the AM_GLOBALPASSWORD authentication module if you do not want keystore access to be restricted to a particular Active Directory group The Active Directory authentication module failed to initialize as the Active Directory group specified in the configuration property AUTHMETHOD_ OPTIONS could not be resolved Ensure that the group name specified in the configuration property AUTHMETHOD_OPTIONS exists and is spelt correctly The user failed to authenticate with the keystore as they are not a member 2005 2010 Sparx Systems Pty Ltd 25 Troubleshooting Reported Error member of any permitted of the Active Directory group specified in the configuration property groups AUTHMETHOD_OPTIONS Add the user to the group specified in the configuration property AUTHMETHOD OPTIONS Account name User Name The user name requesting to authenticate with the keystore could not be not found found on the domain Add the user to domain Sparx Systems Keystore Service User Guide Index 26 Index A Activity Logs 22 Add Keys Dialog 15 Add Shared Keys 15 Assign Key To Workstation 21 Authentication Failures Active Directory 23 Authentication Failures Global Password 23 Auto Checkin Opti
5. 08 1i Err 1 ee LEI ma e w j iire hri i ihr bijil FI l kij jani CELER m eE 0 8 2 2 T thig edis ieei f ar Biy O PS pak w_et Laer l pee vr Alternatively to display this dialog click on the Add Key s icon in the toolbar or right click in the Keys contained in this store panel and select the Add context menu option In the text field type the keys provided by Sparx Systems one key per line Click on the OK button to register them with the keystore Sparx Systems Keystore Service User Guide Keystore Service Administration Set Issue Periods for the Keys 16 5 3 Set Issue Periods for the Keys The Sparx Systems Keystore Service helps you to e Ensure that the number of people using Enterprise Architect is limited to the number of floating licenses that have been purchased e Enable people to operate Enterprise Architect using a floating license while disconnected e g using a laptop computer To achieve this select the key store from the Key Stores section of the Sparx Systems Keystore Service dialog and then select the Tools Options menu option The Options dialog displays Keystore Options Keystore ssks mfraser03 Key leases expire after 1 Days Z Auto checkin Vv Alternatively to display this dialog right click on the keystore name in the Key Stores panel and select the Options context menu option When most people close Enterprise Architect they no longer requir
6. or right click on the key and select the Release context menu option Sparx Systems Keystore Service User Guide Keystore Service Administration Delete Shared Keys 20 5 6 Delete Shared Keys To delete a key from the keystore open the Sparx Systems Key Siore dialog click on the key in the Keys contained in this store panel and then select the Key Delete menu option Alternatively click on the Delete Key icon in the toolbar or right click on the key and select the Delete context menu option 2005 2010 Sparx Systems Pty Ltd 21 Configure Enterprise Architect to Acquire Keys From Keystore 6 Configure Enterprise Architect to Acquire Keys From Keystore Shared keys are available through the purchase of floating licenses for the Corporate edition of Enterprise Architect version 4 51 or later and also the Business amp Software Engineering Systems Engineering and Ultimate editions of Enterprise Architect version 7 5 or later 1 From the workstation start Enterprise Architect and select the Help Register and Manage License Key s menu option The License Management dialog displays 2 Click on the Add Key button the Add Registration Key dialog displays p Enter Private Key Get Shared Key Name Michael Fraser Company Sparx Systems Shared Keystore ssks mfraser03 ass Selecta Product ENTS x canei _ Hep 3 Select the Get Shared Key tab
7. 4 Inthe Name and Company fields type your user name and company name 5 Click on the button to the left of the Shared Keystore field and browse to the network location of the shared key store 6 Inthe Select a Product field select the licensed product and then click on the OK button If keys are available one is allocated to you and you are able to continue working in Enterprise Architect If keys are not available you cannot work in Enterprise Architect and must wait until another user closes Enterprise Architect and releases their key Sparx Systems Keystore Service User Guide Activity Logs 22 7 Activity Logs The activity of the Sparx Systems Keystore Service is logged to file according to the options specified in the keystore configuration 1 The log content resembles the following 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 11 2010 03 12 2010 03 12 2010 03 11 2010 03 12 2010 03 11 2010 03 12 2010 03 11 2010 03 12 2010 03 11 2010 03 11 2010 03 12 2010 03 12 2010 03 11 2010 03 11 2010 03 12 2010 03 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 11 15 29 16 15 29 16 15 29 16 15 29 16 15 29 16 15 29 16 15 29 16 INFO HHsFe
8. 7 User Forum 6 Online User Guide 2 W Options Dialog 16 Properties 11 Workstation Restart 10 Assign Key To 21 Select Feature 8 Set Auto Checkin 16 Set Issue Period 16 Software Product License Agreement 4 Start 10 Stop 10 Support 6 User Feedback 7 Using Shared Keys 21 Sparx Systems Keystore Services Activity Logs 22 Add Shared Keys To Keystore 15 Administration 13 Authentication Failures Active Directory 23 Authentication Failures Global Password 23 Checkin Failures 23 Checkout Failures 23 Connect To Local Keystore 17 Connect To Remote Keystore 14 Delete Shared Keys 20 Initialization Failures 23 Migrate Keys Between Keystores 17 Release Shared Keys 19 Troubleshooting 23 SSKS Introduction 2 Online User Guide 2 Support For Registered Users 6 ee Troubleshooting Authentication Failures Active Directory 23 Authentication Failures Global Password 23 Checkin Failures 23 Checkout Failures 23 Initialization Failures 23 Sparx Systems Keystore Service User Guide Sparx Systems Keystore Service User Guide www sparxsystems com
9. HTTERHTT TEETER HTH TATE HTT EH T TET TEKH TEETH TTT EK TTT eT Tee TT INFO Sparx Systems Keystore Service 4 INFO S SSSHSSSSERSSSE ASSES HSSSER SSL LASSE RHSSELHISSELHSSELHSSELH SELL HTSELETSELE RS INPO Protocol Version 1 0 4 INFO Start Time 2010 03 11 15 29 11 4 INFO Operating System Windows 6 01 4 INFO INFO Service Path C EA Addins SparxServices Current Debug INFO Logging Dir C EA Addins SparxServices Current Debug Logs INFO PAEERRGIRPPRAHERHPIEERRRAHEEUAAEPRREEEPHAHEERRHEREPAHEPRRAHEERAAHERHAHEEHAHHEEHA INFO Starting up SYSTEM SUCCESS Sterted GlobelPassword Authentication Module SYSTEN SUCCESS Sterted AuthenticeationMenager SYSTEM SUCCESS Started keystore manager SYSTEM SUCCESS Management thread started SYSTEM SUCCESS Bound and listening on port 7771 SYSTEM SUCCESS Socket acceptor thread started INFO Now listening for connections SYSTEM Client connected from 172 16 17 96 SYSTEM SUCCESS Client from 172 16 17 96 authenticated User Name mfreser Product Sparx Systems Enterprise Architect build 854 SYSTEM Client disconnected from 172 16 17 96 SYSTEM Client connected from 172 16 17 96 SYSTEM SUCCESS Client from 172 16 17 96 authenticated User Name mfraser Product Sparx Systems Enterprise Architect build 854 INFO CHECKOUT SUCCESS mfraser Sparx Systems Enterprise Architect build 854 aa aa 7 BA Ultimate Edition M
10. PRASERO3 m SYSTEM SUCCESS Checked out EA Ultimate Edition key for MFRASEROS mfraser S STEM Client disconnected from 172 16 17 96 SYSTEM Client connected from 172 16 17 96 SYSTEM SUCCESS Client from 172 16 17 96 authenticated User Name mfraser Product Sparx Systems Enterprise Architect build 654 INPO CHECKIN SUCCESS mfraser Sparx Systems Enterprise Architect build 854 WAPI SETI SEGPGmMP BA Ultimate Edition SYSTEM SUCCESS Client at 172 16 17 96 checked in key SIr PS SYSTEM Client disconnected from 172 16 17 96 2005 2010 Sparx Systems Pty Ltd 23 Troubleshooting 8 Troubleshooting The best source of troubleshooting information can be found in the Sparx Systems keystore Service log files 11 2 The log file location and level of detail are configured through the configuration file It is recommended that for trouble shooting the LOG_LEVEL property be set to the highest level SYSTEM so that the greatest amount of information is available to the administrator Initialization Failures Reported Error Could not open keysiore at FilePath The file does not exist and could not be created Could not open keystore no keystore file specified Invalid or missing keystore file Keystore file cannot be opened by this version of the service or the file has been corrupted Key file has been moved Checkout Failures Reported Error There are no more available
11. Sparx Systems Licensed users are granted the right to print a single hardcopy of the user manual per licensed copy of the software but may not sell distribute or otherwise dispose of the hardcopy without written consent of Sparx Systems Sparx Systems Pty Lid 7 Curtis St Creswick Victoria 3363 AUSTRALIA Phone 61 3 5345 1140 Fax 61 3 5345 1104 Support Email support sparxsystems com Sales Email sales sparxsystems com Website www sparxsystems com Sparx Systems Keystore Service User Guide Introduction End User License Agreement 4 1 2 End User License Agreement Sparx Systems Keystore Service SSKS Copyright C 1998 2010 Sparx Systems Pty Lid All Rights Reserved IMPORTANT READ CAREFULLY This End User License Agreement EULA is a legal agreement between YOU as Licensee and SPARX for the SOFTWARE PRODUCT identified above By installing copying or otherwise using the SOFTWARE PRODUCT YOU agree to be bound by the terms of this EULA If YOU do not agree to the terms of this EULA promptly return the unused SOFTWARE PRODUCT to the place of purchase for a full refund The copyright in the SOFTWARE PRODUCT and its documentation is owned by Sparx Systems Pty Ltd A C N 085 034 546 Subject to the terms of this EULA YOU are granted a non exclusive right for the duration of the EULA to use the SOFTWARE PRODUCT YOU do not acquire ownership of copyright or other intellectual property rights in any p
12. alleged to have been caused directly or indirectly by this document Printed March 2010 Special thanks to Publisher All the people who have contributed suggestions examples bug Sparx Systems reports and assistance in the development of the Sparx Systems i Keystore Service The task of developing and maintaining this tool Managing Editor has been greatly enhanced by their contribution Geoffrey Sparks Technical Editor Michael Fraser Contents l Table of Contents Foreword 1 Introduction 2 Copyright NotiCe ieniicensccciececsccdesss ce cente ddd oaeeo aaner aaea ead aaea stes ecasesdeces lt tapdbencteseunysduvesnescveute 3 End User License Agreement ccssseececeseeeeeeenseeeeeeenseeeeeenseeeeeeenseeeeesenseeneesnseneeeeeaseeneeenseeenenes 4 SUPPOMt AE T E OT 6 Vour Feedback OaE E E A hate ein E RR A 7 Install the Keystore Service 8 Start Stop the Keystore Service 10 Configure the Keystore Service 11 Keystore Service Administration 13 Connect To a Remote Keystore ssssssunssnnnsennnnnnnnnnneunnnunnnunnnnunnnunnnunnnnunnunnnnnnnnnnnnnnnnnnnnn nunen nnna 14 Add Shared E E 15 Set Issue Periods for the KeyS sssnssunsenunnuunruunrununnnnnnuunnununnnnnnnnnnnnnnnnnnnnnnnnnnn nnne nnnn annen nanenane 16 Migrate Shared Keys From File Based Keystore ccs cccssscsseeeeesseesseeeeseeeeeeeesesneeeneeeeeneas 17 Release Shared Keys 1ccssccccseccceseeesesseeseeeeenseeeseeseesneeeneeeesaaaesasneeee
13. anual Local Service amp TPM Base Services Enables acc Manual Local Service eid UPnP Device Host Allows UPn Manual Local Service Oi User Profile Service This service Started Automatic Local System Virtual Disk Provides m Manual Local System Extended A Standard Fi Locate the Sparx Systems Keystore Service entry in the Services console and start stop or restart it through the console toolbar buttons or context menu options 2005 2010 Sparx Systems Pty Ltd 11 Configure the Keystore Service 4 Configure the Keystore Service When starting up the Sparx Systems Keystore Service scans its installation directory for the file keystoreService config which contains a list of properties and values used to configure the server The properties and their descriptions are provided below SERVER_PORT The TCP IP port on which the service is configured to listen for incoming connections By default the Sparx Systems Keystore Service is configured to run on port 7770 AUTHMETHOD The method used to authenticate Keystore Service users connecting to the service The value of this method affects how the property AUTHMETHOD_ OPTIONS is interpreted below Valid AUTHMETHOD values are e AM_GLOBALPASSWORD Users authenticate with a single global password the password is specified in the AUTHMETHOD_OPTIONS property and can be left blank e AM_ACTIVEDIRECTORY Users authenticate according to Active Directory
14. art of the SOFTWARE PRODUCT by virtue of this EULA Your use of this software indicates your acceptance of this EULA and warranty DEFINITIONS In this End User License Agreement unless the contrary intention appears e EULA means this End User License Agreement e SPARX means Sparx Systems Pty Ltd A C N 085 034 546 e Licensee means YOU or the organization if any on whose behalf YOU are taking the EULA e SOFTWARE PRODUCT or SOFTWARE means Sparx Systems Keystore Service which includes computer software and associated media and printed materials and may include online or electronic documentation e Support Services means email based support provided by SPARX including advice on usage of Sparx Systems Keystore Service investigation of bugs fixes repairs of models if and when appropriate and general product support e SPARX support engineers means employees of SPARX who provide on line support services GRANT OF LICENSE In accordance with the terms of this EULA YOU are granted the following rights a To install and use one copy of the SOFTWARE PRODUCT or in its place any prior version for the same operating system on a single computer As the primary user of the computer on which the SOFTWARE PRODUCT is installed YOU may make a second copy for your exclusive use on either a home or portable computer b To store or install a copy of the SOFTWARE PRODUCT on a storage device such as a network server used on
15. bility correctness accuracy reliability correspondence with any description or sample meeting your or any other requirements uninterrupted use compliance with any relevant legislation and being error or virus free are excluded Where any legislation implies in this EULA any term and that legislation avoids or prohibits provisions in a contract excluding or modifying such a term such term shall be deemed to be included in this EULA However the liability of SPARX for any breach of such term shall if permitted by legislation be limited at SPARX s option to any one or more of the following upon return of the SOFTWARE PRODUCT and a copy of the receipt e If the breach relates to the SOFTWARE PRODUCT e the replacement of the SOFTWARE PRODUCT or the supply of an equivalent SOFTWARE PRODUCT e the repair of such SOFTWARE PRODUCT e the payment of the cost of replacing the SOFTWARE PRODUCT or of acquiring an equivalent SOFTWARE PRODUCT or e the payment of the cost of having the SOFTWARE PRODUCT repaired e If the breach relates to services in relation to the SOFTWARE PRODUCT e the supplying of the services again or e the payment of the cost of having the services supplied again TRADEMARKS All names of products and companies used in this EULA the SOFTWARE PRODUCT or the enclosed documentation may be trademarks of their corresponding owners Their use in this EULA is intended to be in compliance with the respective guidelines and licenses
16. ble Keys for this product exist however they are all checked out to other users If this error is frequently reported consider limiting the use of the product across your enterprise or purchasing more keys to meet the demand for the product This keystore does not contain keys for the requested product Keys for the product might have been provided by the keystore in the past but have since been removed Uninstall the product and return any shared keys on the client machine Sparx Systems Keystore Service User Guide Troubleshooting 24 Checkin Failures Reported Error Key not found in keystore The key being checked in has either been deleted since it was checked out or was checked out from another keystore Ensure that users return any shared keys to the keystore they were leased from before swapping keystores Authentication Failures Global Password Reported Error GlobalPasswordAM Authent The user failed to authenticate with the keystore as they provided a icate failed due to an invalid password password that did not match the server password specified in the configuration property AUTHMETHOD_OPTIONS Ensure that the password is entered correctly passwords are case sensitive otherwise contact your Sparx Systems Keystore Service administrator for the correct password Authentication Failures Active Directory Reported Error Could not get DefaultNamingConte
17. ce User Guide Keystore Service Administration Migrate Shared Keys From File Based Keystore 18 Alternatively to display this dialog click on the Migrate key store icon in the toolbar or right click in the Key Stores panel and select the Migrate to context menu option Click on the button to the right of the Destination field and browse for the name of the network based keystore into which the shared keys are to be transferred Click on the OK button to migrate the shared keys from the source file based keystore to the target service based keystore 2005 2010 Sparx Systems Pty Ltd 19 Keystore Service Administration Release Shared Keys 5 5 Release Shared Keys It is usually not necessary to manually release a shared key from a workstation as this happens automatically if e The keystore s AutoCheckin 16 option has been enabled and you close all running instances of Enterprise Architect on your workstation e The lease on the key expires However if further users want to access Enterprise Architect and there is some technical anomaly that has prevented the return of a key you can manually release the key using the Sparx Systems Key Store dialog To release a key from active association with a particular workstation click on the key in the Keys contained in this store panel and then select the Key Release menu option Alternatively click on the Release Key icon in the toolbar
18. ce console 2005 2010 Sparx Systems Pty Ltd 13 Keystore Service Administration 5 Keystore Service Administration The management of shared keys within a keystore is performed through the Keystore Manager application which operates through the Sparx Systems Key Store dialog File Key Tools Help ty b ali Key Stores File Path Key Count Key Count Keys contained in this store Key Product Assigned To To manage a remote keystore you must first connect 14 the application to it and to any number of other remote keystores as required The Keystore Manager then enables you the administrator to e Add Shared Keys 15 e Set Issue Periods for Shared Keys 16 e Migrate Shared Keys from a Legacy File Based Keystore 174 e Release Shared Keys 195 e Delete Shared Keys 20 Sparx Systems Keystore Service User Guide Keystore Service Administration Connect To a Remote Keystore 14 5 1 Connect To a Remote Keystore To connect to a remote keystore select the File Link To menu option on the Sparx Systems Key Store dialog The Shared Keystore Selection dialog displays Select a Keystore _ File Based Keystore Keystore Location Sparx Keystore Server Server Address ssks mfraser03 Password ecccece Alternatively to display this dialog click on the Link to existing store icon in the toolbar or right cli
19. ck in the Key Stores panel and select the Link to context menu option Select the Sparx Keystore Server radio button to indicate that you want to connect to a remote service The File Based Keystore option is there to provide backwards compatibility with legacy file based keystores see Migrate Shared Keys from a Legacy File Based Keystore below In the Server Address field type the URI to the Sparx Systems Keystore Service server If the authentication module you choose requires a password type that into the Password field To test connectivity to the server with the credentials you have entered click on the Test button If the connection fails review the address password and permissions Once the connection succeeds click on the OK button to finalize the connection to the server The Sparx Systems Key Store dialog redisplays with the path of the remote keystore in the Keystores panel 2005 2010 Sparx Systems Pty Ltd 15 Keystore Service Administration Add Shared Keys 5 2 Add Shared Keys Add Shared Keys To add shared keys to the keystore on the Sparx Systems Key Store dialog select the Key Add menu option The Add Keys dialog displays Add Keys to Keystore Keystore ssks mfraser03 Please enter one or more keys to be added to the shared key store One key per line Pir i n Dar Eri bii iii i r i mi i S E N Sam 8 0 2 ETFS P A 0 9 er s hi tak Bete ted ol OES l FPR TPrI TIN 22 8
20. crosoft Windows Services console You access the Services console either through the Control Panel under Administrative Tools or by running the command services msc from the command line File Action View Help 9 H 5 os B m Ni E Services Local Sparx Systems Keystore Service Name z Description Status Startup Type Log On As e Software Protection Enables the Automatic D Network Service 93 Spa ns Service Automatic Local System SE RE SPP Notification Service Provides So Manual Local Service TE SQL Server SQLEXPRESS Provides sto Started Automatic Network Service Ch SQL Server Active Directory Helper Enables inte Disabled Network Service ced SQL Server Browser Provides SQ Disabled Network Service CA SQL Server VSS Writer Provides th Started Automatic Local System Z SSDP Discovery Discovers n Started Manual Local Service ke a Storage Service Enforces gr Manual Local System e3 Superfetch Maintains a Started Automatic Local System ce System Event Notification Service Monitors sy Started Automatic Local System Tablet PC Input Service Enables Tab Manual Local System Ok Task Scheduler Enables aus Started Automatic Local System Gh TCP IP NetBIOS Helper Provides su Started Automatic Local Service ced Telephony Provides Tel Manual Network Service Li Themes Provides us Started Automatic Local System Oy Thread Ordering Server Provides or M
21. e their computers at work Selected If a user has a key with no automatic check in they then have use of the key for a theoretically unlimited time However the Sparx Systems Keystore Service also enables an administrator to limit use by setting an issue period for the keys in the key store The period is counted as continuous time spent away from the network connection to the key store The issue period can be set in either weeks or days For example if a user has a license with an issue period of one week and is away from an active connection to the key store for more than one week they cannot use Enterprise Architect until they obtain another key To set the issue period for the keys in the key store e Inthe first Keys leases expire after field type the required number of units in the second field click on the drop down arrow and select the unit Days or Weeks Click on the OK button to confirm your selection 2005 2010 Sparx Systems Pty Ltd 17 Keystore Service Administration Migrate Shared Keys From File Based Keystore 5 4 Migrate Shared Keys From File Based Keystore You might want to upgrade from a legacy file based keystore and migrate your keys to a new network based keystore This process effectively removes all keys from the file based keystore leaving it empty and places the keys into the network based keystore To migrate the shared keys select the File Link To menu option on the Sparx Sys
22. e their license Therefore there is little point in continuing to allocate the license to a user who is not actually using Enterprise Architect e On the Options dialog you select the Auto checkin checkbox so that any license in the key store is automatically returned to the key store when the user closes Enterprise Architect Click on the OK button to confirm your selection When the user closes Enterprise Architect the key is then available to the next user who wants to do some work in Enterprise Architect However a laptop user having closed Enterprise Architect might still want to use the license off site with no access to the key store and therefore no way to request another key While the laptop user can put their machine into standby or hibernate mode while leaving Enterprise Architect running there is the risk that the laptop might have to be rebooted Once Enterprise Architect restarts it will report the lack of a license the license having been automatically checked in e To enable such users to have access to Enterprise Architect you could deselect the Auto checkin checkbox for the keys in the key store Click on the OK button to confirm your selection This acts against the purpose of having the checkbox It is therefore advisable to create two key stores each with a different setting for Auto checkin Mobile users who want to use Enterprise Architect from home or other Not selected disconnected locations Fixed users who leav
23. group membership the permitted group is specified by a common name in the AUTHMETHOD_OPTIONS property for example AUTHMETHOD_OPTIONS SSKS_USERGROUP AUTHMETHOD_ OPT The value of this property depends on the value specified in the AUTHMETHOD IONS property above please see the description for AUTHMETHOD for more details KEYSTORE_PATH The path to the keystore file By default the service is configured to check keys in and out from the sskeys dat file located in the installer directory Note The user the service is set to run as must be granted read write permissions to the keystore file specified by KEYSTORE_PATH If a service is set to run as the user LOCALSYSTEM it generally has read write access to its installation directory MINIMUM_EA_BUIL The minimum build of Enterprise Architect that can be serviced by the keystore You D can use this keystore server setting to deny older builds of Enterprise Architect the shared keys from this keystore AUDIT_TIME_PERIO The time period in seconds to wait between logging audit reports Audit reports are D logged at the INFO level To turn auditing off set this property to 0 zero LOG_LEVEL The level of messages that are written to the log file Higher log levels include messages from the lower levels that precede them Valid log levels from lowest to highest are 1 FATAL Events that result in termination of the service s execution 2 WARNING Events that fall outside of the n
24. ht Notice 34 e End User Licensing Agreement 44 e Support 64 e Your Feedback 7 e Install the Keystore Service 84 e Start Stop the Keystore Service 105 e Configure the Keystore Service 11 e Sparx Systems Keystore Service Administration 135 e Configure Enterprise Architect to Acquire Keys from Keystore 21 e Activity Logs 224 e Troubleshooting 23 2005 2010 Sparx Systems Pty Ltd 3 Introduction Copyright Notice 1 1 Copyright Notice Copyright 1998 2010 Sparx Systems Pty Ltd All rights reserved The software contains proprietary information of Sparx Systems Pty Ltd It is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright law Reverse engineering of the software is prohibited Please read the license agreement 4 for full details Due to continued product development this information can change without notice The information and intellectual property contained herein is confidential between Sparx Systems and the client and remains the exclusive property of Sparx Systems If you find any problems in the documentation please report them to us in writing Sparx Systems does not warrant that this document is error free No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means electronic mechanical photocopying recording or otherwise without the prior written permission of
25. keys for this product in the key store The key store does not contain any keys for this product The service was unable to open the keystore file specified by the KEYSTORE_PATH property in the configuration file Ensure that this path exists and that the user account the Sparx Systems Keystore Service runs under has the necessary permissions to read and write to the file No file path was specified in the property in the configuration file Type a file path into the KEYSTORE_PATH configuration property that the user account the Sparx Systems Keystore Service runs under can read and write to The keystore file specified by the configuration property KEYSTORE_PATH is either incompatible with the current version of the keystore service or has somehow been corrupted on the file system Restore the keystore file specified in the configuration property KEYSTORE_PATH from a recent backup or contact Sparx Systems Support for assistance The keystore file specified by the configuration property KEYSTORE_PATH is locked to the serial number of the hard drive it is created on If the keystore file is moved from this hard drive the service is unable to open it If the keystore file has been moved restore the file to its initial location Certain RAID configurations can affect how the hard drive s serial number is presented to the keystore service Thus it is recommended that you house the keystore file on a non RAID drive wherever possi
26. ly to install or run the SOFTWARE PRODUCT over an internal network If YOU want to increase the number of users entitled to concurrently access the SOFTWARE PRODUCT YOU must notify SPARX and agree to pay an additional fee c To make copies of the SOFTWARE PRODUCT for backup and archival purposes ADDITIONAL RIGHTS AND LIMITATIONS YOU hereby undertake not to sell rent lease translate adapt vary modify decompile disassemble reverse engineer create derivative works of modify sub license loan or distribute the SOFTWARE PRODUCT other than as expressly authorized by this EULA YOU further undertake not to reproduce or distribute license key codes except under the express and written permission of SPARX ASSIGNMENT YOU may only assign all your rights and obligations under this EULA to another party if YOU supply to the transferee a copy of this EULA and all other documentation including proof of ownership Your license is then terminated TERMINATION Without prejudice to any other rights SPARX may terminate this EULA if YOU fail to comply with the terms 2005 2010 Sparx Systems Pty Ltd 5 Introduction End User License Agreement and conditions Upon termination YOU or YOUR representative shall destroy all copies of the SOFTWARE PRODUCT and all of its component parts or otherwise return or dispose of such material in the manner directed by SPARX WARRANTIES AND LIABILITY WARRANTIES SPARX warrants tha
27. on 16 C Checkin Failures 23 Checkout Failures 23 Compiled 19 March 2010 2 Configure Keystore Service Properties 11 Copyright Notice 3 D Delete Shared Keys 20 oy es End User License Agreement 4 a ae Floating License Editions of Enterprise Architect 2 MDG Products 2 Initialization Failures 23 Install Sparx Systems Keystore Service 8 Introduction License Agreement 4 Support 6 To Sparx Systems Keystore Service 2 Issue Period 16 K Keys Assign To Workstation 21 Expire After 16 For Floating Licenses 21 Lease Expiry 16 Register Product Key In Enterprise Architect 21 Set Auto Checkin 16 Set Issue Period 16 Shared Using 21 Keystore Manager 13 Select Feature 8 Keystore Server Option 14 a License Agreement 4 Migrate Keys To Remote Keystore 17 Migrate Keystore File Dialog 17 er Options Dialog 16 R Register Product Key 21 Product Key In Enterprise Architect 21 Release Shared Keys 19 ae Services Console Windows 10 Shared Key Store Selection Dialog 14 Shared Keys Assign To Workstation 21 Using 21 Software Product License Agreement 4 Sparx Systems Key Store Dialog 13 Sparx Systems Keystore Service Assign Key To Workstation 21 2005 2010 Sparx Systems Pty Ltd 27 Index Sparx Systems Keystore Service Configure 11 E U Copyright Notice 3 End User License Agreement 4 Install 8 Introduction 2 License Agreement 4 User Feedback
28. ore Service User Guide Install the Keystore Service 8 2 Install the Keystore Service When you purchase a floating license product that uses the Sparx Systems Keystore Service you receive an email from Sparx Systems Sales that provides e The installation instructions for the Keystore Service e The location of the installer executable file soarxkeystoreservice exe to download e The password that enables you to run the executable If you do not received the password or have lost a previous password please contact Sparx Systems Sales at sales sparxsystems com To install the Keystore Service download and run the executable file and enter the password This installation is password protected Enter the installation password into the field below Password Cancel Note Vista Windows 7 users Please ensure that the installer is run with administrator permissions by right clicking on the SparxKeystoreService exe installer file and selecting the Run as Administrator context menu option Review the license agreement and readme information clicking on the Next button as you finish reading each document The Select Features page displays from which you select the features to install Select Features Please select which features you would like to install Spars Systems Keystore Service Keystore Manager Will be installed on local hard drive 8 Entire feature will be installed on local hard drive
29. ormal scope of the service s operation but are not fatal such as the incorrect password supplied by a client 3 REPORT Events generated by the keystore s internal auditing mechanism 4 INFO Events generated within the normal scope of the service s operation Such as key checkin and checkout SYSTEM Detailed system level events such as client connection disconnection and service module startup LOG_DIRECTORY The path to which the log files are written Sparx Systems Keystore Service User Guide Configure the Keystore Service 12 Notes e This directory must already exist at service start time e The user the service is set to run as must be granted read write permissions to the directory specified by LOG_DIRECTORY If a service is set to run as the user LOCALSYSTEM it generally has read write access to its installation directory LOG_FILECOUNT The number of rolling log files that the service keeps Log files are kept in First In First Out FIFO order with the oldest log file being deleted once the LOG_FILECOUNT threshold is reached LOG_FILESIZE The size in bytes a log file can reach before the logging framework rolls the log files over Other system level properties such as the service startup condition and service user account can be configured through the Microsoft Windows Service console See the Start Stop the Keystore Service 10 topic for details on how to access the Servi
30. saeseseaeseseaeeseeeseseaeeneeeeeeeas 19 Delete Shared Keys n a r See aged hen Jc aaa aaae te ae Eere t ee E nE decd daea aeaaea 20 Configure Enterprise Architect to Acquire Keys From Keystore 21 Activity Logs 22 Troubleshooting 23 Index 26 2005 2010 Sparx Systems Pty Ltd 1 Foreword Foreword The Sparx Systems Keystore Service is used to manage the registration keys issued with the Floating Licenses purchased for Enterprise Architect Corporate Business and Software Engineering Systems Engineering and Ultimate editions and for related MDG products Sparx Systems Keystore Service User Guide Introduction 2 1 Introduction The Sparx Systems Keystore Service SSKS is used to manage the use of registration keys issued with the Floating Licenses purchased for Enterprise Architect Corporate Business and Software Engineering Systems Engineering and Ultimate editions and for related MDG products Using the Sparx Systems Keystore Service application an administrator can create a key store in a network file location that enables licenses with a finite administrator defined issue period to be assigned to specific workstations The key store also enables the administrator to quickly determine which user has a particular key and to see the date on which the key expires Note Each Enterprise Architect workstation can be associated with only one key store at a time See Also e Copyrig
31. t the SOFTWARE PRODUCT will perform substantially in accordance with the accompanying written materials for a period of ninety 90 days from the date of receipt and any Support Services provided by SPARX shall be substantially as described in applicable written materials provided to YOU by SPARX and SPARX support engineers will make commercially reasonable efforts to solve any problems associated with the SOFTWARE PRODUCT EXCLUSIONS To the maximum extent permitted by law SPARX excludes for itself and for any supplier of software incorporated in the SOFTWARE PRODUCT all liability for all claims expenses losses damages and costs made against or incurred or suffered by YOU directly or indirectly including without limitation lost costs profits and data arising out of e YOUR use or misuse of the SOFTWARE PRODUCT e YOUR inability to use or obtain access to the SOFTWARE PRODUCT e Negligence of SPARX or its employees contractors or agents or of any supplier of software incorporated in the SOFTWARE PRODUCT in connection with the performance of SPARX obligations under this EULA or e Termination of this EULA by either party for any reason LIMITATION The SOFTWARE PRODUCT and any documentation are provided AS IS and all warranties whether express implied statutory or otherwise relating in any way to the subject matter of this EULA or to this EULA generally including without limitation warranties as to quality fitness merchanta
32. tems Key Store dialog or use the toolbar icon or context menu option 14 and select the File Based Keystore option then browse for the local keystore and click on the OK button to connect to it The Sparx Systems Key Store dialog now resembles the following File Key Tools Help ty bg a Key Stores File Path Key Count EA Ultimate Edition j C temp sskeys dat 7 Type Key Count ssks mfraser03 0 Available 10 Expired but Available 0 Checked Out 0 Total Available 10 Keys contained in this store Key Product Assigned To Lease Expires S BL P ai EA Ultimate Edition irr a oes EA Ultimate Edition 7 TA ba b i lia EA Ultimate Edition Pe ri ra EA Ultimate Edition Bids doba EA Ultimate Edition 5 i a es ae EA Ultimate Edition E a BELIAN LA A EA Ultimate Edition 5 maf We Md oll EA Ultimate Edition a ee EA iicn Colitinn iS In the Key Stores panel click on the file based keystore path and then on the File Migrate To menu option The Migrate Keystore File dialog displays with the local keystore file path in the Source field Migrate Keystore File The keystore migration process allows you to transfer keys from a file based keystore to a service based keystore NOTE All keys will be removed from the source keystore once the transfer is complete Source C temp sskeys dat Destination ssks mfraser03 Sparx Systems Keysiore Servi
33. xt Could not open root DSE Could not initialize the Active Directory COM interface The Active Directory authentication module failed to initialize as it could not resolve the Default Naming Context for the current domain Ensure that the machine the Sparx Systems Keystore Service is installed on is able to contact the Active Directory domain controller and has the necessary permissions to query the domain s Active Directory The Active Directory authentication module failed to initialize as it could not open the domain s root DSA Directory Server Agent Specific Entry DSE at Idap rootDSE The root DSE entry provides information about the contents and capabilities of the Active Directory domain controller Ensure that the machine the Sparx Systems Keystore Service is installed on is able to contact the Active Directory domain controller and has the necessary permissions to query the domain s Active Directory The Active Directory authentication module failed to initialize as it could not open or access the Active Directory COM interface Ensure that the machine hosting the user account that the Sparx Systems Keystore Service runs under has the necessary permissions to create and communicate with the Active Directory COM interface No permitted ActiveDirectory The Active Directory authentication module failed to initialize as the group name provided in the AUTHMETHOD_OPTIONS configuration property Group Group Name not

Sparx Systems Keystore Services User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents