Non-Vitrea Floating License

Server Installation Guide

VPMC-14053A
Copyright © 1997 - 2016 Vital Images, Inc. All rights reserved. Date of publication 5-2016.
Vitrea® protected by U.S. Patents 5,986,662; 6,130,671; 6,219,059; 7,031,504; 7,136,064; 7,362,329; 7,574,029; 7,590,272;
7,660,481;7,929,748;7,991,210; 8,214756; 8,249,687; 9,037,988 Other Patents Pending in the U.S. and other countries.
VitreaView® protected by U.S. Patents 6,130,671; 6,219,059; 7,136,064; and 7,362,329. Other Patents Pending in the U.S. and other
countries.

VPMC-14053A Non-Vitrea Floating License Server Install Guide

This publication is valid for Vitrea® 6.8 and later software versions.
No part of this work may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic or mechanical,
including photocopying and recording, or by any information storage or retrieval system without permission in writing from Vital Images.
Trademarks
Vital Images, Vitrea, VitreaView, ViTAL, and ViTAL U are registered trademarks of Vital Images, Inc. in several countries and may have other
protections in various countries.
All other marks are property of their respective owners.
Restricted Rights Legend
If this software or documentation is delivered to the Department of Defense (DOD) of the U.S. Government, it is delivered with Restricted
Rights as follows:
Use, duplication or disclosure of the software by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(l)(ii) of the
Rights in Technical Data and Computer Software clause at DFARS 252.227-7013.
If this software or documentation is delivered to any unit or agency of the U.S. Government other than DOD, it is delivered with Restricted
Rights and use, duplication or disclosure by the U.S. Government is subject to the restrictions as set forth in FAR 52.227-19 (b)(3). If the
software or documentation is delivered to NASA, it is delivered with Restricted Rights subject to the restrictions set forth in 18-52.227-86(d)
of the NASA FAR Supplement.
Limits of Liability and Disclaimer of Warranty
VITAL IMAGES SHALL HAVE NO LIABILITY OF ANY KIND FOR ANY DIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES BASED ON ANY DEFECT,
FAILURE OR MALFUNCTION OF THE SOFTWARE,OR USE OF ANY VITAL IMAGES DOCUMENTATION, WHETHER THE CLAIM IS BASED UPON
WARRANTY, CONTRACT, TORT OR OTHERWISE. VITAL IMAGES MAKES NO WARRANTY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO,
ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE WHETHER ARISING FROM STATUTE, COMMON LAW, CUSTOM
OR OTHERWISE.
Notice of Confidentiality
This software and the information in this software including, but not limited to, the ideas, concepts and know-how are proprietary,
confidential and trade secret to Vital Images, and the information contained therein shall be maintained as proprietary, confidential and
trade secret to Vital Images and shall not be copied or reproduced in any form whatsoever. This software and any information contained
therein shall not be disclosed to anyone other than authorized representatives of the user's employer, who is contractually obligated not to
disclose same without the express written consent of Vital Images. The user of this software and any information contained therein shall not
attempt to discern Vital Images' confidential and trade secret information and shall not reverse compile, disassemble, or otherwise reverse
engineer this software or any information contained therein.
Software License Notice
This software is a licensed product of and is distributed by Vital Images, and may only be used according to the terms of that license for the
system identified in the License Agreement. Installation and use of the software requires and is subject to the terms of a service and license
agreement with Vital Images, Inc. In the event of any conflict between these terms and the terms of any written agreement or agreement
assented to through electronic means with Vital Images, the terms of such written or assented agreement shall control.

Australian Sponsor: Vitrea: ARTG 241833

Toshiba Australia Pty Ltd VitreaView: ARTG 262479
PO Box 350
North Ryde, NSW 1670
Australia

MDSS GmbH
Schiffgraben 41
30175 Hannover, Germany

Toshiba Australia Pty Ltd is an authorized sponsor in Australia and act on behalf of Vital Images, Inc. in the communication of safety-related
incidents and regulatory matters with Therapeutic Goods Administration in Australia. Distributors are still the first line of communication
with their customers regarding service and complaints.

Manufactured by: Vital Images, Inc.; 5850 Opus Parkway, Suite 300; Minnetonka, MN, US; 55343; Phone 866.433.4624

VPMC-14053A
 Non-Vitrea Floating License Server Install Guide

Installing the Floating Licensing Server on a non-Vitrea Workstation. . . . . . 1

Floating License Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Hardware and Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Required Operating Systems for the Floating License Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Required Software for the Floating License Server: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
SQL Server Express:. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Memory Size: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Hard Disk Storage: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configure Operating System Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Install the Floating License Server on a non-Vitrea Workstation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Preparing for Licensing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

In This Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
License Option information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Access the Host Information Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Run the Host Information Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Send the Host Information XML File to Vital Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Acquire the License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Verify the license configuration was successful. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Set Up Email Notification for Expiring Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Log File Locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Determine if the Workstation License Server is working correctly . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Change the Workstation License Server from Local to access a Floating License Server . . . . . . . . . . 14
Modify the Session Timeout Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
To change the SessionTimeout Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Install Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

VPMC-14053A i
Non-Vitrea Floating License Server Install Guide

ii VPMC-14053A
 Non-Vitrea Floating License Server Install Guide

Installing the Floating Licensing Server

on a non-Vitrea Workstation

CAUTION: Federal law restricts this device to sale by or on the order of a physician, as directed by 21 CFR
801.109(b)(1).

Floating License Server Installation

NOTE: You only need to run the Host Information Tool to install the license file on the license server. It is not
®
required to run the Host Information Tool on a Vitrea Workstation when using the floating license server.

NOTE: The floating license server address must be configured on each Vitrea Workstation. You will complete this
procedure during the “Installing and Licensing the Vitrea Workstation” chapter in the Vitrea Workstation
Installation Guide.

Hardware and Software Requirements

Required Operating Systems for the Floating License Server

The Floating License Server requires the following operating systems:

• Microsoft Windows® 7 Professional 64-bit Edition with Service Pack 1

• Microsoft Windows® 8.1 Professional or Enterprise 64-bit Edition
• Microsoft Windows® 2008 Standard R2 64-bit Edition with Service Pack 1
• Microsoft® Windows Server 2012 R2 x64 Standard Edition

Required Software for the Floating License Server:

• Internet Explorer 11
• Windows Installer 4.5
• PowerShell

SQL Server Express:

• For supported Operating Systems, SQL Server 2014 SP1 Express requires an AMD Opteron, AMD Athlon 64,
Intel Xeon with Intel EM64T support, or Intel Pentium IV with EM64T support with 2GHz or faster processor.

Floating License Server Installation VPMC-14053A 1

Non-Vitrea Floating License Server Install Guide

Memory Size:
Vital recommends that the server have at least 2 GB of RAM.

Hard Disk Storage:

Vital recommends allocating 6 GB of storage.

Configure Operating System Prerequisites

Use the Vitrea Enterprise Suite Operating System Setup Guide to configure Windows 7, Windows 8.1, Windows
Server 2008 R2, or Windows Server 2012 R2.

Install the Floating License Server on a non-Vitrea Workstation

1. Run the InstallVitreaLicenseServer.exe file from your installation media.

2. Click Install.
Once the missing prerequisite applications are installed, the installer will be extracted and the following
screen displays.

2 VPMC-14053A Configure Operating System Prerequisites

 Non-Vitrea Floating License Server Install Guide

3. Click Next.

4. Use the default path in the Install Vitrea License Server to: section.
5. Use the default path in the Install License Database to: section.
6. Click Next.

Install the Floating License Server on a non-Vitrea WorkstationVPMC-14053A 3

Non-Vitrea Floating License Server Install Guide

7. Click the IP Address dropdown menu and select the address of the floating license server.
8. Click Next.

9. To modify the Domain or Computer Name, click Browse.

a On the Select a Domain or Computer screen, select the desired domain or computer name of where you
created the account.

NOTE: If the system is installed in a workgroup, enter the local computer name for the Domain/
Computer Name field.
b Click OK.

4 VPMC-14053A Install the Floating License Server on a non-Vitrea

 Non-Vitrea Floating License Server Install Guide

10. In the UserName field, enter a user name that has Read/Write access to the NAS. Use the vitrea-service
account which has access to the Share.
11. In the Password field, enter the password that corresponds to the user name entered in step 14.
12. Click Next.

13. Click Install.

14. This screen lists installation progress. No action is required.

Install the Floating License Server on a non-Vitrea WorkstationVPMC-14053A 5

Non-Vitrea Floating License Server Install Guide

15. Click Finish.

16. Complete the procedures within the “Preparing for Licensing” chapter.

6 VPMC-14053A Install the Floating License Server on a non-Vitrea

 Non-Vitrea Floating License Server Install Guide

Preparing for Licensing

NOTE: Before you can configure Vitrea Workstation licensing, you must complete the procedures in this chapter
to acquire the license file from Vital Customer Support. Note that it takes Vital Customer Support 24-48 hours to
send you the license file. Therefore, you should plan your license configuration process accordingly.

In This Chapter
You will learn to perform the following procedures:

• License Option information

• Access the Host Information Tool
• Run the Host Information Tool
• Send the Host Information XML file to Vital Customer Support
• Acquire the License File

License Option information

For a Vitrea Workstation deployment, you will configure licensing using the following scenario:

• Install Floating License on a non-Vitrea Workstation - You only need to run the Host Information Tool and
install the license file on the license server and not on any Vitrea Workstation in your deployment.

To set up a floating license server on a non-Vitrea Workstation, complete the procedures in the “Installing
the Floating License Server on a non-Vitrea Workstation” chapter and then complete the other procedures
in this chapter.

Access the Host Information Tool

The Host Information Tool is an executable file is essential to completing the license process. Vital services and
support teams use it to collect identifying information from the system which reduces the timeframe for the
creation and generation of a license for Vital’s products.
You can access the Host Information Tool by using one of the following two methods:

Use the Install Disk

1. Insert the Vitrea Workstation DVD into the DVD-ROM drive.
2. Navigate to the Licensing folder.
3. Copy and paste VitalHostInformationTool.exe file to the floating license server or Vitrea Workstation where
you want to create the license.

NOTE: For Node-Locked systems, you will need to copy and paste the exe file to each machine.

In This Chapter VPMC-14053A 7

Non-Vitrea Floating License Server Install Guide

Use the Customer Portal

1. Open an Internet browser.
2. Type www.vitalimages.com in the URL field.
3. Click the My Vital Images button.
4. Enter your Username and Password.
5. In the Helpful Links section, right-click the Host Information Tool link and select Save Target As.
6. Save the Host Information Tool.zip file to your desktop.

Run the Host Information Tool

CAUTION: You should configure network settings (including IP Address or DNS) prior to running the Host
Information Tool.

CAUTION: If you change the IP Address or DNS settings or reinstall your Operating System, you must run the
Host Information Tool again and acquire a new license from Vital Customer Support.
1. On your desktop, double-click the Host Information Tool.zip file and extract the VitalHostInformationTool.exe
file to your desktop.
2. Double-click the VitalHostInformationTool.exe file.

3. Click the Network interface dropdown menu and select Network Interface Card.
The Vital Host Information Tool screen displays with MAC Address, DNS Domain, and IP Address field
information.

8 VPMC-14053A Run the Host Information Tool

 Non-Vitrea Floating License Server Install Guide

4. Click the More ... link to display the remaining information that may be used to generate your license file.

5. Click Save As.

Run the Host Information Tool VPMC-14053A 9

Non-Vitrea Floating License Server Install Guide

6. Navigate to the desired location.

7. Click the Save as type: dropdown menu and select XML.
8. Click Save.

Send the Host Information XML File to Vital Customer Support

1. Create an email to Vital Customer Support at [email protected].
2. Include basic customer information such as the site name, Vital ID number, contact name, and phone
number.
3. Attach the .xml file to the email.
4. Send the email.

NOTE: Vital Customer Support typically sends you the license file within 24-48 hours.

Acquire the License File

1. 24-48 hours after you send the Host Information XML file to Vital Customer Support, you will receive the
license file in an email.
2. Open the email and save the license file to the following directory: E:\VitreaData\licenses\ or save to the
drive that contains the VitreaData folder.

10 VPMC-14053A Send the Host Information XML File to Vital Customer

 Non-Vitrea Floating License Server Install Guide

Verify the license configuration was successful

1. Using a Vitrea Workstation, verify that you completed the Vitrea Workstation software installation using the
“Other machine” option on the Select License Type screen.
2. Verify that you entered the correct license server IP Address on the Select License Type screen.
3. If the Vitrea Workstation launches successfully then the License configuration is correct.
4. Close the Vitrea Workstation session.

NOTE: If the Vitrea Workstation does not launch successfully, refer to the Troubleshooting chapter.

Set Up Email Notification for Expiring Licenses

If you are setting up a demonstration system or if you are turning on a single option for a customer to try a
particular software feature (e.g., cardiac, Vessel probe), complete the following steps.
1. Browse to C:\Documents and Settings\All Users\Vital Images\vitrea-license\conf.
2. Right-click and edit the vital-config.xml file.
3. Remove the <!-- -->.
4. Complete the email system information.

<smtp host="smtp.gmail.com" port="587" from="System Administrator &lt;[email protected]&gt;"

username="email.tester" password="emailpassword$" secure="true"/>

Verify the license configuration was successful VPMC-14053A 11

Non-Vitrea Floating License Server Install Guide

5. Scroll to the bottom of the config file, just before </vital-config>, and add the following text:
<settings>
<setting component=" Notification" key="licenseExpirationEmail " value="[email protected]"/>
</settings>
6. Save the vital-config.xml file.
Listed below is an example of the email notification you could receive:

Hello,

The license service had found issues with the following licenses to bring to
your attention:

- License with id "686c7bea-4e05-4b5b-85e2-ae987143f80c" will expire on

Sat Dec 31 00:00:00 CST 2011

Please contact the Vital Images Support center to address questions.

12 VPMC-14053A Set Up Email Notification for Expiring Licenses

 Non-Vitrea Floating License Server Install Guide

Troubleshooting

Introduction
This chapter describes several procedures you can complete when you encounter issues during the Vitrea
installation process.
This chapter contains the following troubleshooting topics:

• Log File Locations

• Determine if the Workstation License Server is working correctly
• Change the Workstation License Server from Local to access a Floating License Server
• Modify the Session Timeout Setting

Log File Locations

The most commonly-used log files can be located in the following locations:
For Windows 7/Windows Server 2008:

• C:\Program Data\Vital Images\Logs

• C:\Program Data\Vital Images\Vitrea-License\Logs
• E:\VitreaData\Temp
For Windows 8.1/Windows Server 2012 R2:

• C:\Program Data\Vital Images\Logs

• C:\Program Data\Vital Images\Vitrea-License\Logs
• E:\VitreaData\Temp

Introduction VPMC-14053A 13
Non-Vitrea Floating License Server Install Guide

Determine if the Workstation License Server is working correctly

Complete the following steps to access the Vitrea Licensing screen. It lists which licenses have been purchased.
1. Open an Internet browser.
2. In the URL field, enter http://licenseserverIPaddress:8760/vitrea-license/api/license/
usage?appVersion=999.

3. Under the License heading, click the desired link to access a subscreen that lists how many licenses have
been purchased, how many licenses are available, and which users are currently using the specific
licenses.

Change the Workstation License Server from Local to access a Floating

License Server
After you install and license the Vitrea Workstation, if you want to change the Workstation License settings. e.g.,
change from Local to Floating, perform the following steps:
1. Open regedit.
2. Navigate to the following path:
[HKEY_LOCAL_MACHINE\SOFTWARE\Vital Images\Vitrea].
3. Modify the value “LicenseServer” to use the new server location.
4. Modify the value “LicenseServerOverrideKey” to use the new server location.
5. Save your changes and close regedit.
6. From the Start menu, select All Programs | Vital Images | Vitrea Administration Tool.

14 VPMC-14053A Determine if the Workstation License Server is working

 Non-Vitrea Floating License Server Install Guide

7. Select the Configuration Manager button.

Change the Workstation License Server from Local to access a Floating License ServerVPMC-14053A 15
Non-Vitrea Floating License Server Install Guide

8. Select the License tab.

9. In the License section, clear the The license service URL refers to the same system as this VIMS node check
box.

16 VPMC-14053A Change the Workstation License Server from Local to

 Non-Vitrea Floating License Server Install Guide

10. Click Save.

11. Close the Vitrea Administration Tool.
12. Restart the Windows license service.

Modify the Session Timeout Setting

The Session Timeout has a setting (with a default value of 5 minutes) that will shut off the license if no heartbeat
is detected. Every ten seconds, the session timeout queries for any sessions that are active but have not been
confirmed.

Warning Messages
• If a session is not confirmed after 30 seconds, a message displays in the status bar.
• If a session is not confirmed after five minutes, a “Sorry” message displays in the status bar and the user
can click OK to close the session.

To change the SessionTimeout Setting

Modify the vital-config.xml file
1. Open Windows Explorer and navigate to the following directory: %ALLUSERSPROFILE%\ProgramData\Vital
Images\vitrea-license\conf.
2. Right-click the vital-config.xml file and select Open with | Notepad.
The vital-config.xml screen displays in Notepad.
3. In the <sessionTimeout>300</sessionTimeout> line, change the “300” to the desired value
(which is represented in seconds).
4. Select File | Save.
5. Close Notepad.

Restart the Vitrea License Server Service

1. Select Start | Control Panel | Administrative Tools.
2. Double-click Computer Management.
3. In the left pane, select Services and Applications.
4. In the main window, double-click Services.

Modify the Session Timeout Setting VPMC-14053A 17

Non-Vitrea Floating License Server Install Guide

5. Right-click Vitrea License Server and select Restart.

6. Select File | Save.

18 VPMC-14053A Modify the Session Timeout Setting

 Non-Vitrea Floating License Server Install Guide

Command Line Options

Install Options
NOTE: If you want to use a SQL installation that you have installed on your system instead of the SQL Express
installation that Vital installs for you, use the fully silent or the semi-silent install command line.
1. Install with full user interface:
InstallVitreaLicenseServer.exe
2. Fully silent installation (no user interface):

InstallVitreaLicenseServer.exe /s /v" /qn

DATABASEINSTANCE=<YourDatabaseInstance>
SQLPASSWORD=<SQLServiceAccountPassword> DOMAINNAME=<YourDomain>
USERNAME=<ServiceAccount> PASSWORD=<ServiceAccountPassword> /lv*
C:\Install\licenseInstall.log"
3. Semi-silent installation (unattended mode with progress bars):
InstallVitreaLicenseServer.exe /s /v" /qb DATABASEINSTANCE=<YourDatabaseIn-
stance> SQLPASSWORD=<SQLServiceAccountPassword> DOMAINNAME=<YourDomain>
USERNAME=<ServiceAccount> PASSWORD=<ServiceAccountPassword> /lv*
C:\Install\licenseInstall.log"

Install Options VPMC-14053A 19

Non-Vitrea Floating License Server Install Guide

20 VPMC-14053A Install Options