Ealth ARE: Service Documentation CR Licensing
Ealth ARE: Service Documentation CR Licensing
Ealth ARE: Service Documentation CR Licensing
CR Licensing
This document describes the Agfa HealthCare licensing workflow for the
Field Service Engineers (FSE).
► Document History
► Referenced Documents
Document Title
User Manual Licensing User Manual 0102
(Version B or higher)
Reference Manual Licensing Reference Manual 0101
(Version A or higher)
Edition 3, Revision 1
01-2009 printed in Germany Document Node ID: 24522499-24
sw_standard_e_template_v07
Agfa Company Confidential Copyright © 2009 Agfa HealthCare N.V.
DD+DIS012.06E CR Licensing
► Manufacturer
Agfa HealthCare N.V.
Publisher
Agfa-Gevaert HealthCare GmbH
Tegernseer Landstraße 161
D - 81539 München
Germany
Copyright © 2009 Agfa HealthCare N.V.
All rights reserved.
Technical modifications reserved.
AGFA and the Agfa-Rhombus are trademarks of Agfa HealthCare N.V.
WARNING:
Improper operation or service activities may cause damage or injuries.
INSTRUCTION:
(1) Read the “Generic Safety Directions” document
(see MEDNET GSO => General Info => Agfa HealthCare => Publications =>
Service Manual) prior to attempting any operation, repair or maintenance task
on the equipment.
(2) Strictly observe all safety directions within the “Generic Safety Directions” and
on the product.
LIST OF CONTENTS
2.2 License File is created by the FSE via Simplified ELMS ..........................................................6
3.1.1 How to obtain MAC address, Agfa Serial Number and Dongle ID .........................................11
3.2.1 Downloading a pre-created License File from the ELMS based on the Config ID .................12
8.7 Escalation................................................................................................................................32
9 SPARE PARTS.......................................................................................................................34
10 GLOSSARY ............................................................................................................................35
This document aims at those parts of the licensing workflow, in which the
Field Service Engineer is involved:
• Activating licenses on a new system
• Activating additional licenses on a system
• Upgrading a system and reactivating the existing licenses
• Troubleshooting:
o Replacing a broken or lost dongle
o Re-activating after having changed MAC address
o Resetting the Grace Period
There are two possibilities to create and receive the license file:
• The license file is generated and provided by the
National Sales Organisation (NSO).
• The license file is created by the FSE, using the Simplified ELMS.
2.1 License File is created and provided by the National Sales Organization
(NSO)
Using this option, the GSO Service dispatcher or the FSE initiates the request to
generate a new license file towards the NSO. This process is defined by local
procedures.
The license file is created in the ELMS by the ELMS coordinator in the NSO and
provided to the FSE via ELMS or e-mail.
For a detailed description refer to section 3.
Simplified ELMS is a process that can be used during an installation or upgrade activity
of Agfa HealthCare products. It provides the possibility to retrieve a license file file
regardless of the current location of the FSE, as long as an internet connection (fixed
or wireless) is available. The process requires information of the Sales Order.
It can be used by every authorized stakeholder (CCC, RSN, FSE, TPM, Dealer etc.).
Business rules, up-selling scenarios and upgrade strategies are implemented in the
Simplified ELMS.
2.2.2 Limitations
The Simplified ELMS process is driven by a web based tool that is designed as
a wizard based interface which guides the user trough workflow driven screens,
depending on the provided input data.
It can be accessed via internet browser (web based access).
URL: https://helicensing.agfa.net
• To use and access the (Simplified) ELMS, access to the internet is required.
• For using the (Simplified) ELMS on site, your service laptop has to be equipped
with a mobile GPRS internet connection since it might not be possible to access the
internet via the network of the site. This can be a GPRS card or a (wireless)
connection to a mobile phone providing GPRS networking.
For more information about GPRS, contact your local IT support call center or
hardware manufacturer.
• The required bandwidth for using the Simplified ELMS: approx. 115 Kb/s
• A removable medium (e.g. USB memory stick) is required to store the downloaded
license file on.
2.3.2.1 Defining the Simplified ELMS workflow type (by local organization manager)
Licenses that have been ordered are stored in the ELMS Sales Offices and linked to
the sales order number. When creating a license file, Simplified ELMS differentiates
between two workflow types for obtaining ordered licenses from the Sales Office:
• "Sales Order Flow": To create the license file using Simplified ELMS you will have
to enter the sales order number and only the ABC codes on the sales order will
be selectable.
• "Sales Office Flow": You can select all ABC codes that are available in your
Sales Office(s) to be included in the license file.
Which workflow is applied, is defined in the user account. All users of a single
Sales Office must use the same workflow type.
Therefore, the manager of the local Agfa organization or of the dealer organization
must decide which workflow type will be implemented in the organization, before user
accounts are created.
NOTE:
The Sales Order Flow is the default workflow and it is advised to use this flow
as it prevents licenses from different orders to be mixed up.
To be able to access the (simplified) ELMS you require a “user name” and
password protected ELMS user account:
First name:
Last name:
Sales office(s): *
* Sales office(s) you'll be working for. A Sales office corresponds to a local Agfa organization or to a
dealer organization.
** Ask your local organization (see also section 2.3.2.1).
Users of the Simplified ELMS must be trained. The training is available on the
Agfa Learning Platform (ALP):
NOTE:
A license file is linked to a product version and to product hardware. Any change of
the product version requires a new license file to be created and loaded, even if the
licenses contained by the license file don't change.
Scenario 1 Upgrade of a product that is already licensed and known on the ELMS.
Scenario 2 Upgrade of a product that is not yet licensed and not known on the ELMS.
NOTE:
The MAC address is also written on the manufacturer's label attached to the PC, but if
the network adapter has been replaced, this data is not accurate anymore and will not
deliver a working license file!
(1) On the respective PC go to Start Æ Run…
(4) Find the Mac address: The MAC address is the 'Physical Address' field of the
'Ethernet adapter Local Area Connection':
Figure 1
NOTE:
• For each NX System there is a customer specific license file.
• Whenever a new dongle is to be activated, a new license file should be provided
with the new dongle.
The license file can be obtained from the NSO in different ways:
• The NSO send an e-mail only providing a configuration ID to download the license
file from the ELMS via the Support Manager module (see section 3.2.1).
• The NSO sends an E-mail with the license file attached (see section 3.2.2).
3.2.1 Downloading a pre-created License File from the ELMS based on the Config ID
NOTE:
For more information about the ELMS screens, click on the <?> "question mark" in the
top right of the screens.
(1) Log on to the ELMS: https://helicensing.agfa.net
(2) In the navigation pane go to Support manager Æ Valid Config - Find .
(3) Fill in the known search criteria and click <Find Config>.
Figure 2
(4) You will see a list of configurations corresponding to your search criteria, or only
one if you selected a specific Config ID. In the column Config ID click the link of
the configuration you need.
Figure 3
(5) In the Configuration Ticket screen click the corresponding link to download
the license file.
Figure 4
Figure 5
(7) Browse for the location where you want to keep the license file and click <Save>
(additional dialogs to guide the download may pop up).
(8) Copy the license file to a portable medium (floppy disk, USB memory stick),
allowing you to copy it to the installed Agfa HealthCare product.
The e-mail explains clearly where to install (hospital address) the license, the customer
information, and other information required for this site.
Detach the license file from the e-mail message to a portable medium (floppy disk,
USB memory stick), allowing you to copy it to the installed Agfa HealthCare product.
The Simplified ELMS provides workflows for different scenarios. To be able to create
the license file on-site via simplified ELMS you will have to provide information to the
system.
Collect the required information depending on the given scenario:
4.1.2 Create license file for new installation Agfa hardware not known on ELMS
NOTE:
Scenarios can be combined. E.g. adding new license during upgrade.
NOTE:
Using the Simplified ELMS is self-explanatory if the correct input information
is available. For further assistance read the explanations given on the input pages
of the simplified ELMS.
Login
Yes
Yes
There is
Yes an old License File No
(upgrades or for the Device (new install)
additional licenses) on ELMS.
Select additional
Licenses Options.
Figure 6
Figure 7: Example
Figure 8: Example
(5) On the Product Selection screen select the Product you are installing and
click <Next>:
Figure 9: Example
(6) On the Agfa serial number entry screen enter the Agfa Serial Number and
click <Next>.
(7) On the Agfa serial number selection screen, select the serial number and
click <Next>.
(8) On the Find a customer screen enter the available customer reference(s) and
click <Next>:
NOTE:
This screen is only displayed it the serial number is not linked to a
customer yet.
(9) On the Customer Selection screen select the Customer ID in the first column:
NOTE:
This screen is only displayed if the customer could not be identified by
a unique search criteria in step (8).
(10) On the Select Software Version screen select the software version you will be
installing and click <Next>:
(11) Enter the Sales Order Number(s) for the device or software you're installing
and click <Add to list> to make them appear in the List of Order Numbers.
Click <Next> after adding all Sales Order Numbers.
NOTE:
Depending on your user account type, this screen may not be
displayed and you cannot enter Sales Order Number(s). You will have
access to all Sales Orders in the current Sales Office.
(12) In the Select base license screen select the base license (Starter Pack) for the
device or software you're installing and click <Next>:
NOTE:
• In the "Sales Order Flow", only the base licenses of the
Sales Order are listed here.
• In the "Sales Office Flow", all Base ABC codes that are available
in the current sales office are listed here.
• In case of product upgrade or adding additional licenses you only
have to confirm the existing base license.
(13) In the optional licenses screen check the optional licenses for the device or
software you're installing and click <Next>.
NOTE:
• In the "Sales Order Flow", only the optional licenses of the
Sales Order will be listed.
• In the "Sales Office Flow", all optional licenses that are available
in current sales office are listed.
(14) Select the version number of the Sub-product you're installing and
click <Next>.
NOTE:
The Select Sub-Product Software Version screen is only displayed if
Optional Licenses have been selected that enable sub-products
(e.g. XRDI as sub-product of NX).
(15) Check If all data are correct on the Confirm License File Request screen and
click <Confirm>:
(16) Click the hyperlink on the Download License File screen to download the
license file:
(17) Store the downloaded license file on a portable medium to be able to load it on
the Agfa Product.
CAUTION:
Licenses may become invalid.
Activating a license file on a system with wrong date, time or time-zone can cause the
licenses to become invalid!
Figure 21
Figure 22
NOTE:
If the license file was not created for this system, the License Manager will
pop up a dialog box (see section "8.6 Check if a License File matches an
Agfa HealthCare Product”). Click <No> and open the proper license file.
(7) If the license file is loaded successfully, the License Manager will pop up a dialog
box telling that the licenses have been updated.
You will be back in the License Manger Tool Start Screen.
(8) Exit the License Manager Tool.
(9) Additional configuration steps on the Agfa HealthCare product may be required to
enable the activated licenses. Refer to the Agfa HealthCare product Service
Documentation.
After performing the installation of the upgrade, the system configuration data on the
ELMS have to be updated. This data is contained in the Fingerprint File (FPF).
(1) Send the FPF created in section 6 to the ELMS coordinator in the
National Sales Organisation (NSO).
(2) The ELMS coordinator in the NSO uploads the FPF to the ELMS.
8 Troubleshooting
NOTE:
Always keep in mind the Grace Period of 30 days. If no new dongle was installed
when the period ends, the Agfa HealthCare product can not be operated further.
The procedure to solve a permanent dongle problem is similar for all situations:
(1) Order a new dongle (For order number refer to section 9 Spare Parts).
IMPORTANT:
In case of stolen dongle, the NSO orders the new dongle.
(2) Inform RSN/GSC about the new dongle ID.
(3) Receive the new license file generated by RSN or GSC helpdesk.
(4) Receive the new dongle from the Spare Part Centre (warehouse).
(5) Install the new dongle and load the received license file (see sections 5-7).
In any of these situations, the licenses will stay active for a period of 30 days, called
‘grace period’ and the user will receive warnings.
Once the system has been operated for 30 days in grace period, all licenses
are deactivated.
If the problem situation is made undone by reconnecting the right dongle or reinstalling
original hardware, after restarting the system, the Grace Period will end.
The period of 30 days is not restored, even after successfully ending the problem
situation. A new license file must be activated to reset the grace period:
(1) Request RSN or GSC to generate a new license file; this communication should at
least contain the Agfa Serial Number or Vendor Serial Number of the configuration.
(2) Receive new license file from RSN or GSC helpdesk.
(3) Load the new license file (see sections 5-7).
• You cannot activate a license file with a ‘Date Generated’ that is older than the
currently active license file’s ‘Date Generated’. In this case the system generates
a warning:
Figure 23
• When in Grace Period, you cannot activate a license file with a ‘Date Generated’
indicating a date before the Grace Period was last started. In this case the system
generates a warning:
Figure 24
• You cannot activate a license file with a ‘Date Generated’ indicating a date that
is younger than the current system time. In this case the system generates a
warning (no screenshot available).
NOTE:
• You can check the loaded license file’s ‘Date Generated’ by opening it in the
License Manager Tool and viewing the tab ‘License File Info’.
• You can also check the ‘Date Generated’ of any license file file by opening it in a
text editor or xml editor and looking into the element ‘LicenseKeyFile’:
Figure 25
IMPORTANT:
The license file is encrypted. This implies that any change to the contents of the file will
cause an error and it cannot be activated anymore.
NOTE:
Stop all Agfa applications that are running on the system, before changing date or time.
The license system strictly limits changing date / time to a correction of maximum
minus 3 hours (e.g. adjusting clock from 15 h to 12 h).
Extended time adjustments will result in deactivated licenses.
Figure 26
If you select <No>, the license file will not be activated. If you select <Yes>,
the license file will be activated.
IMPORTANT:
Activating a license file on a system for which it was not created, will cause the system
to run in Grace Period and may activate different licenses, not matching the expected
customer configuration.
8.7 Escalation
Problems that occur when connecting to the ELMS or using the Simplified ELMS can
be reported to the normal RSN or GSC helpdesk.
In exceptional situations, it may not be possible to retrieve the correct license file, e.g. if
the order information is not correct (wrong license) or incomplete (missing license).
In order to be able to continue the ongoing installation you can ask for a preliminary
license file (including one or more Service Licenses) that is valid for 40 days:
(1) Inform RSN about the problem on the site and requests ‘Service Licenses’ for the
affected Agfa product. This communication should at least contain the Agfa Serial
Number or Vendor Serial Number of the configuration and the ABC codes for the
missing licenses.
(2) RSN creates the Service License(s). One Service License is created for each
missing ABC code (base license or optional license).
(3) Create the preliminary license file using the Service Licenses, e.g. ES82S NX
LITE-EL (SERVICE LICENCE) of the Simplified ELMS (see section 4.3.1).
(4) Finish the installation (see sections 5-7).
IMPORTANT:
• The license file contains now one or more service licenses that are valid for 40
days after creating the license file. During this period,
o The ordering problem must be solved.
o The final license file must be created via Simplified ELMS
o The final license must be activated on the system (the service licenses must
be replaced with the sales licenses).
• Once a base Service License has been created, it is mandatory to make a
license file including this license.
• A Service License cannot be renewed nor extended.
In specific situations, the Simplified ELMS process cannot be continued to the end and
no license file file will be generated:
• If a license file file already exists for the system (e.g. in case of upgrade) and
it contains a Trial License (Base License or Optional License).
• If a Service Licenses was created for the system which has expired in the
meantime and no valid Sales License has been created yet to replace the
Service License.
Figure 27
Figure 28
The error will still be displayed, but now as a warning message, which only is
displayed once by default.
ELMS has no function to log out. Close the Internet Explorer completely, to disconnect
from the ELMS Server.
9 Spare Parts
10 Glossary
ABC code The base ABC code defines the Base License that is ordered
for the product.
The optional ABC codes define the Optional Licenses that are
ordered for the product.
The hardware ABC code defines the hardware that is ordered.
Agfa Serial Unique code that identifies a system.
Number
ALF An Application License File (ALF) is generated by the ELMS.
The license file should be loaded into the HealthCare application.
The base license and all the product options from the purchase
order are then activated.