Microsoft App-V 4.6 deployment

NVivo 10 Windows

This topic describes how to deploy NVivo 10 Windows to client machines running Windows 7 using Microsoft Application Virtualization 4.6 (SP1).

You can use App-V 4.6 (SP1) to deploy NVivo 10 except for one prerequisite component—Adobe FlashPlayer 11.  The FlashPlayer plug-in is required to play YouTube videos in NVivo 10 Windows (Service Pack 2 or later), so if users want to work with YouTube videos, you will need to deploy NVivo using App-V 5.0—for more information, refer to Microsoft App-V deployment.

In this topic


 


Overview

Microsoft Application Virtualization (App-V) is an on-demand application delivery solution that allows NVivo 10 Windows to be virtualized, centralized, and instantly delivered as a service to users anywhere on any device.

This deployment method is only suitable for sites using NVivo Server, where all NVivo projects will be hosted on the server and there is no requirement to create projects on the client machines. This is because SQL Server Express (needed to create local projects) cannot be packaged in App-V.

We recommend that you purchase an enterprise license for NVivo—this means you only need to use one license key to activate NVivo for all the users in your site. For more information on licensing, refer to Understand licensing for NVivo.

If you also want to deploy NCapture—this is a browser extension that allows users to gather material from the web—we recommend that you install NCapture directly on the client machines.

Top of Page

Understand the process of deploying NVivo using App-V

The overall process for deploying NVivo using App-V 4.6 (SP1) consists of the following activities:

  1. Download and extract the installation files

  2. Create the NVivo 10 package

  3. Add the package and application

  4. Enter and activate the license key. Each instance of NVivo needs to be activated. This includes entering the license key and providing activation details. The end user can activate the software or you can set up automated activation—for more information refer to:

Top of Page

Download and extract the installation files

Windows Installer 4.5 must be installed on the App-V server before you create the NVivo 10 package. You can download it (if not already installed) using this link:

 Windows Installer 4.5

The NVivo 10 (32-bit and 64-bit) installer packages are available for download from the QSR website:

https://www.qsrinternational.com/support_downloads.aspx

The MSI file and application files can be extracted from the NVivo 10 installer using one of the commands below. This creates a number of folders containing application files along with the QSR NVivo 10.msi file.

  • For 32-bit installations, use: NVivo10.x86.exe /a

  • For 64-bit installations, use: NVivo10.x64.exe /a

If you are installing the 32-bit version of NVivo 10, you should also install QuickTime 7 (this is not required, if your users are not working with audio or video files). You can download QuickTime 7 using this link:

QuickTime Player 7.7  (37.1 MB)

Top of Page

Create the NVivo 10 package

The procedure below explains how to create a new NVivo 10 package with the Application Virtualization Sequencer.

IMPORTANT  You should sequence on a machine that matches the operating system and configuration of the target clients. Because these instructions are for creating a package for Windows 7 client machines, you should also sequence on a Windows 7 machine.

First, create the NVivo 10 package:

  1. Open Microsoft Application Virtualization Sequencer.

  2. You create the package using the Create New Package wizard, which you can access in the following ways:

  • If you have a template you want to use, click File>New from Template, then choose your template, and then click Open.

  • If you do not have a template, click Create a New Virtual Application Package.

  1. In the Create New Package wizard, on the Packaging Method page, click Create Package, and then click Next.

  2. On the Prepare Computer page, address any potential problems (with the current operating environment) that are identified by the Sequencer, and then click Next.

  3. On the Type of Application page, click Standard Application, and then click Next.

  4. On the Select Installer page, click Perform a custom installation, and then click Next.

  5. On the Package Name page, enter a Virtual Application Package Name that does not contain spaces—for example, NVivo10—and click Next.

  6. On the Installation Page, install the software as follows:

  1. Open an elevated Command Prompt window (you will install the software via the command line).

  2. (For 32-bit NVivo only) Prepare to install QuickTime Player 7.7 by using this command line to extract its component packages:

QuickTimeInstaller.exe /extract

Then, install two of its component packages using the following command lines:

AppleApplicationSupport.msi /qb

QuickTime.msi /qb DESKTOP_SHORTCUTS=0

IMPORTANT Do not install the AppleSoftwareUpdate.msi package.

  1. Install NVivo using the following command line:

msiexec /Option <Required Parameter> [Optional Parameter]

For example, you could install NVivo using the following:

msiexec /i "QSR NVivo 10.msi" /qb

Refer to Installation options and parameters for a list of command line options and public properties.

  1. In the Sequencer, select the I am finished installing check box, and then click Next.

  2. In the Configure Software page, click Run All and then close each application that opens (for 64-bit NVivo, only a single application opens), and then click Next.

IMPORTANT  Do not enter a license key (or start a trial) when NVivo 10 launches. The license will be entered later (either manually or via a script) when the user activates NVivo on their client machine. Information about the different activation methods you can use is provided later in this topic.

  1. On the Installation Report page, check for error, warning and information messages (address issues, if necessary), and when you are ready to proceed, click Next.

  2. On the Customize page, click Stop now  (unless you want to customize shortcuts, streaming or target operating systems), and then click Next.

  3. On the Create Package page, click Save the package now, and click the Browse button to choose the folder location for the package, and then click Create.

NOTE  Do not save the package in the same folder as the application installer files.

  1. When the package has been successfully created, click Close to exit the Create New Package wizard.

Next, edit the application OSD file to allow interaction between the virtualized application and the local operating system (this allows NVivo to play audio and video files):

  1. Using Windows Explorer, locate the application OSD file—for example, NVivo 10 10.0.138.0.osd—and open it using Notepad. This file was generated when you created the package.

  2. Locate the LOCAL_INTERACTION_ALLOWED tag and set the value to "TRUE".

  3. Save and close the OSD file.

Finally, if you are not using a template (which provides deployment information), you need to provide package deployment information, as follows:

  1. In the Sequencer, click Modify an Existing Virtual Application Package.

  2. Click Edit Package, and then click Next.

  3. On the Select Package screen, click the Browse button and select the package created in the previous section, and then click Edit.

  4. On the Deployment tab, make sure the Protocol, Hostname, Port and Path (for your content share folder) are correctly configured.

  5. On the File menu, click Save.

Top of Page

Add the package and application

Now that you have created the package, you are ready to create the application group in the Application Virtualization Management Console.

IMPORTANT  If you use different machines to sequence and stream the packages, then you will need to copy all the package files (you can copy the entire project directory) from the sequencing machine to the content share directory on your streaming machine, before you can create the application group in the Application Virtualization Management Console.

First, add the application group:

  1. Open the Application Virtualization Management Console, right-click Applications and select New Application Group.

  2. Enter a Group Name—for example, NVivo10—and click Finish.

  3. Right-click the new application group and click Import Applications, then browse to the NVivo 10 project file (.sprj) and click Open.

  4. On the General Information screen, click Next.

  5. Select the Publishing Shortcuts you want—for example Desktop and Start Menu—and then click Next.

  6. (For 64-bit NVivo only) On the File Associations screen, click Next.

  7. On the Access Permissions screen, click Add to grant access to Active Directory Groups, and then click Next.

  8. On the Summary screen, check whether the .osd and .ico file paths are pointing to the correct location (you can fix this later), and then click Finish.

  9. In the Application Virtualization Management Console, right-click Packages, and then click Refresh. The NVivo 10 package should appear in the list.

Next, make sure that the paths are correct, as follows:

  1. In the Application Virtualization Management Console, navigate to Applications and click on the NVivo 10 group. Right-click on each application, click Properties and then check the file paths for the OSD and Icon files are correct.

  2. Make sure that NVivo starts on a machine that has access to the package. First, launch Application Virtualization Client on the client machine, select the publishing servers, and then click  Get Updated Publishing Information. Next start NVivo—the Welcome to NVivo 10 dialog box should be displayed (click Cancel, if you do not want to activate the software now). If you cannot start NVivo, refer to Troubleshooting the App-V deployment.

Top of Page

Activation method 1 - Manual (by user)

If the license has not been activated silently (via method 2 - automated activation), the user is prompted to enter and activate their license key the first time they launch NVivo.

To enter and activate a license, the user can follow these steps:

  1. Start NVivo.
  2. On the Welcome to NVivo 10 dialog box, enter the license key, and then click OK.

  3. On the License Activation dialog box, enter your details. Fields marked with an asterisk (*) must be completed.

  4. Click Activate.

Top of Page

Activation method 2 - Automated activation

You can set up automated silent activation using the process below. Each time the user launches NVivo, an activation script is run silently before the software is launched. The script runs every time NVivo is launched, but the license is only activated the first time the user launches NVivo.

IMPORTANT You must use an enterprise license when you activate by this method—refer to Understand licensing for NVivo for more information.

Create the activation.xml file

First, create an XML file with that contains details needed to activate NVivo.

Copy the text below into Notepad, set the values within the tags, and then save as an .xml file in a shared location—for example as activation.xml in the App-V Content Directory. Ensure that you save it with UTF-8 encoding.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<Activation>

  <Request>

    <FirstName>John</FirstName>

    <LastName>Sysadmin</LastName>

    <Email>[email protected]</Email>

    <Phone>+1-555-555-5555</Phone>

    <Fax>+1-555-555-5555</Fax>

    <JobTitle>Your Job Title</JobTitle>

    <Industry>Your Industry</Industry>

    <Department>Your Department</Department>

    <Organization>Your Organization</Organization>

    <City>Boston</City>

    <Country>USA</Country>

    <State>Massachusetts</State>

  </Request>

</Activation>

You can also download a zip file containing the sample activation file. Extract the file and then open it in your text editor.

NOTE  You must observe the following rules, or the activation will fail:

  • Fields in bold are mandatory.

  • You must use a valid email address.

  • You must use abbreviations for the following countries:

  • For United States of America, use USA

  • For United Kingdom, use UK

  • For all other countries, capitalize the first letter of each word—for example, 'Mexico' or 'New Zealand'. Refer to the list of accepted country names for the specific format and spelling for your country name.

Create the activation.bat file

Next, you will create a batch file that submits your license key and activation XML file you created in the previous section.

To create an activation batch file:

  1. Click in the field below and press CTRL + C to copy the code to your clipboard.

  1. Paste into a new Notepad file.

  2. Replace <Virtual File Tree> (removing the brackets) with the location of the package.

NOTE  You can find this location by double-clicking the .sft project file to open it in the Application Virtualization Sequencer, and then checking the virtualized file structure via the Files tab.

  1. Replace  <license key> (removing the brackets) with your license key in the following format: xxxx-xxxxx-xxxxx-xxxxx-xxxxx (including hyphens).

NOTE  If you want to use NVivo as a 30 day trial, you can use the  '-i' parameter without a license key.

  1. Replace <\\Fileserver\SourceDirectory> (removing the brackets) with the location of the activation.xml file you created.

  2. Save as a .bat file in a shared location—for example, App-V Content Directory.

Example:

Update the application .osd file

  1. Browse to the location of the application OSD file—for example, NVivo 10 10.0.138.0.osd—on the App-V server and open using Notepad.

  2. To set up the scripted activation, add some statements to the <DEPENDENCY> tag:

  1. Click in the field below and press CTRL+C to copy the code to your clipboard.

  1. Paste the text within the <DEPENDENCY> tag (do not delete any existing statements in the tag). Then, update the HREF tag to point to the activation batch file you created in the previous section.

Example:

  1. Save and close the OSD file.

NOTE The activation script will run each time a user launches NVivo, but the license is only activated the first time they launch the software. You can test that it is working on a client machine, by getting publishing updates (to get the latest version of the OSD file) and then launching NVivo.

Top of Page

Troubleshooting the App-V deployment

If the end user cannot launch NVivo, activation fails, or the user has problems running NVivo, you can try to understand the problem by troubleshooting on the client machine.

If you have trouble streaming the package to the client machine, check that the OSD file paths are correct:

  1. Using Windows Explorer, locate and open each .osd file in Notepad and check that the location of the .sft package file is correctly recorded in the HREF attribute in the CODEBASE tag.

If NVivo will not launch, check that all the application files have been streamed to the client:

  1. On the desktop of the client machine, right-click the NVivo 10 application icon.

  2. On the Shortcut tab, in Target, add '/exe cmd.exe' just after 'sfttray.exe'—for example,

IMPORTANT  When you have finished your checks, you will need to remove the  '/exe cmd.exe' statement from the Target.

  1. Click OK.

  2. Double-click the NVivo 10 application icon. This will launch a Command Prompt window.

  3. In the Command Prompt window, use the dir command to view the contents of  the streamed hidden drive (usually Q:\). Make sure all the application files have been streamed to the client machine.

  4. If the user has license or activation problems, you can do a command line activation and direct the output to a text file, so that you can see any error messages.

  1. In the Command Prompt window, activate NVivo using the following command line:

NVivo.exe -i <license key> -a "\\FileServer\SourceDirectory\activation.xml" > C:\temp\out.log

  1. Check the output log file.

NOTE  

  • Make sure that you remove the  '/exe cmd.exe' statement from the shortcut after you have completed the troubleshooting steps above.

  • Angle brackets <  > indicate that the enclosed element is mandatory. You need to replace the text within the angle brackets with relevant information. Do not type the angle brackets themselves in the command line.

If users are experiencing problems with playing audio and video files, make sure that NVivo can interact with the operating system on the local machine:

  1. On the Streaming server, open the <packagename>.osd file in Notepad and make sure that the value of LOCAL_INTERACTION_ALLOWED is set to "TRUE".

Top of Page