INSTALLATION AND SET UP GUIDE

Transcription

1 INSTALLATION AND SET UP GUIDE This guide will help IT administrators to install and set up NVivo Server. It provides step by step instructions for installing the software, configuring user permissions and allocating licenses. 1 Installation and Setup Guide

2 Copyright 2010 QSR International Pty Ltd. ABN All rights reserved. NVivo and QSR words and logos are trademarks or registered trademarks of QSR International Pty Ltd. Microsoft,.NET, Silverlight, SQL Server, Internet Explorer, Windows and Windows Server are trademarks or registered trademarks of the Microsoft Corporation in the United States and/or other countries. Google Chrome is a trademark or registered trademark of Google Inc. Quest vworkspace is a registered trademark or trademark of Quest Software, Inc. in the United States and other countries. Citrix and XenApp are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. This information is subject to change without notice. 2 Contents

3 INSTALLATION AND SETUP GUIDE Contents Introducing NVivo Server Access Help and other resources... 4 Understanding NVivo and NVivo Server Store projects on NVivo Server Understand how your organization can benefit from NVivo Server... 5 NVivo and NVivo Server licensing... 6 Working on a Local Area Network (LAN)... 6 Preparing to install NVivo Server... 7 Minimum system requirements... 7 Recommended system requirements... 7 Understand what is installed... 8 File locations... 9 Installing NVivo Server... 9 Add server roles and services... 9 Consider administrator accounts Install the NVivo Server software Enable server services Configure the server firewall Start NVivo Server Manager and activate your license Activate the server license Manage users and permissions Assign users to server user groups Manage Client Access Licenses (CALs) How do I allocate Client Access Licenses (CALs)? Allocate CALs to named users or groups Help users to manage their NVivo Server projects Set up server connections in the NVivo client Make sure users can access server projects - a checklist Help users to manage audio and video files What to expect when multiple users are working on a server project Add a Project Owner (when an existing owner is no longer available) Maintaining and monitoring NVivo Server See who is connected Check project files and logs Perform maintenance tasks Contents 3

4 Introducing NVivo Server Welcome to NVivo Server. This guide is designed to get IT administrators up and running with the software. It includes information about installing NVivo Server and configuring it for NVivo users. Access Help and other resources Once you install NVivo Server, you can access Help from NVivo Server Manager click the Help link in the top right of any page. The Help provides comprehensive instructions for working with NVivo Server. The Help Welcome page contains links to resources such as the QSR Forum and the QSR support team. You can also find useful information on the IT Administration page on our website: Refer to the NVivo Help in the client application for detailed information about how NVivo works. Understanding NVivo and NVivo Server NVivo is a desktop application that lets users organize, analyze and visualize information anything from Word documents to videos, podcasts and database tables. Users can code to organize their material by topic and run queries to uncover trends and emerging themes. The visualization tools let them create diagrams, charts or models to present and clarify their discoveries. On its own, NVivo supports basic teamwork, allowing users to track and analyze changes to a project based on user profiles. Team members can also work on individual projects and then import them into a master project but they cannot work on the same project at the same time. This is where NVivo Server can assist. 4 Introducing NVivo Server

5 INSTALLATION AND SETUP GUIDE Store projects on NVivo Server NVivo Server is a server-side application that manages NVivo projects in a centralized database repository, allowing users to work on the same project at the same time: From the NVivo client, users can work on standalone projects or connect to NVivo Server to access server projects You can manage licenses and user access to the server using the browser-based NVivo Server Manager. You can also use other tools, such as SQL Server Management Studio, to manage backups, restores and other server housekeeping tasks. Understand how your organization can benefit from NVivo Server NVivo Server can help your organization to: Deliver true collaboration by allowing teams to analyze the same materials at the same time and immediately see each other s changes. Different approaches means deeper discovery and the ability to leverage the whole team s expertise on-the-spot. Streamline project administration by monitoring, maintaining, backing up and keeping track of all projects in one secure location. Share information, knowledge and outcomes across your organization effectively, as NVivo Server projects are stored in a central location that can be made accessible to all. Enhance security by providing access to projects using authenticated Windows credentials, and role based permissions. Analyze more data and embed larger audio and video resources in your projects. So even on large scale projects you can work with more data easily. Perform administrative tasks simply and quickly with our browser-based NVivo Server Manager. Introducing NVivo Server 5

6 NVivo and NVivo Server licensing NVivo 9 and NVivo Server 9 are separate software products. To work with NVivo projects stored on a server, your organization needs licenses for both NVivo 9 and NVivo Server 9. Each client machine needs an NVivo 9 license, and a license is also required to install NVivo Server 9 onto the server. NVivo Server 9 licensing arrangements are tailored to meet your organization s needs. The licensing is based on the number of users and the hardware that NVivo Server 9 will be installed on. When users connect to a server project, they consume Client Access Licenses (CALs). You can choose to allocate licenses to specific users, or to concurrent (floating) users, or a combination of both. Find out more about allocating CALs later in this guide. Working on a Local Area Network (LAN) As NVivo Server 9 enables multiple users to access and work on each centrally stored NVivo 9 project it needs to be installed on a server that is connected to a network. Specifically, NVivo Server 9 is designed to provide access to NVivo 9 projects on a Local Area Network (LAN) or via a virtualized desktop. Note: If you want users to access server projects via an internet connection, you could use a thin client software product such as: Microsoft Remote Desktop Connection Microsoft Remote Desktop Services Citrix XenApp Quest vworkspace 6 Introducing NVivo Server

7 INSTALLATION AND SETUP GUIDE Preparing to install NVivo Server This section outlines the hardware and software requirements for NVivo Server and describes the components that are installed. Refer to the NVivo 9 Getting Started Guide for information about the requirements for installing NVivo 9 ( NVivo client ). Minimum system requirements 1.2 GHz Pentium III-compatible processor (32-bit) or 1.4 GHz Pentium 4-compatible processor (64-bit) 2 GB RAM Microsoft Windows Server 2003 SP2. (Web editions of Windows Server are not supported) Approximately 5 GB of available hard-disk space or more depending on data storage needs Intel x86-compatible (32-bit) processors and Intel x64-compatible (64-bit) processors are supported (Itanium (64-bit) processors are NOT supported) Internet Explorer 7 (or later) or Google Chrome is required to access NVivo Server Manager Internet access is required to activate your license key Recommended system requirements 2.0 GHz Pentium 4-compatible processor or faster 4 GB RAM or more Microsoft Windows Server 2003 SP2 or later, Microsoft Windows Server 2008 or Microsoft Windows Server 2008 R2. Both 32-bit and 64-bit editions of these operating systems are supported. (Web editions of Windows Server are not supported) Approximately 20 GB of available hard-disk space or more depending on data storage needs Intel x86-compatible (32-bit) processors or Intel x64-compatible (64-bit) processors are supported (Itanium (64-bit) processors are NOT supported) Internet Explorer 7 (or later) or Google Chrome is required to access NVivo Server Manager Internet access is required to activate your license key Preparing to install NVivo Server 7

8 Understand what is installed When you install NVivo Server, the following components are installed (if they are not already present): Windows Installer 4.5 Microsoft.NET Framework 3.5 Service Pack 1 SQL Server 2008 R2 Standard Edition The following diagram shows the installed components: The NVivo Service runs as a Windows Service under the server s local system account (NT AUTHORITY\ System). This account is granted the necessary database permissions at install time The metabase is installed in the QSRNVIVO9 SQL Server instance. The NVivo Server metabase contains data used by NVivo Server to manage all NVivo Server projects NVivo Server is installed with its own SQL Server 2008 R2 Standard Edition database instance (QSRNVIVO9). The SQL Server database instance is created during installation A browser-based application which runs in Internet Information Services (IIS). Under IIS, the application is installed in the default web applications pool Note: The following are not supported on the server hosting NVivo Server: Any other installation of SQL Server, or any other SQL Server database instance Installation of any other software that uses SQL Server SQL Server database mirroring SQL Server failover clustering Deployment of the service and database components of NVivo Server to separate machines Customization of the SQL Server instance, the NVivo Server metabase, NVivo Service or NVivo Server Manager settings 8 Preparing to install NVivo Server

9 INSTALLATION AND SETUP GUIDE File locations The NVivo Server application and database files are installed to: C:\Program Files\QSR\NVivo Server 9 C:\Documents and Settings\All Users\Application Data\QSR\NVivo Server 9 (Windows Server 2003) C:\ProgramData\QSR\NVivo Server 9 (Windows Server 2008 and 2008 R2) NVivo Server projects are stored in the following location (you can modify this location after install using SQL Server Management Studio): C:\Program Files\Microsoft SQL Server\MSSQL10_50.QSRNVIVO9\MSSQL\DATA Note: These file locations may differ slightly on 64-bit machines or where C: is not the system drive. Installing NVivo Server The process for installing NVivo Server is: 1 Add server roles and services before you install NVivo Server. 2 Consider administrator accounts what accounts will you use to install and administer NVivo Server? 3 Install the NVivo Server software. 4 Enable server services after you install NVivo Server. 5 Configure the server firewall. Add server roles and services Before installing NVivo Server, you need to add server roles and services. The actions you need to take depend on your operating system: CPU Windows Server 2003 or 2003 R2 Windows Server 2008 R2 or 2008 R2 x86 Add Application Server role Enable ASP.NET Add Application Server role Add Web Server role Enable.NET Framework 3.5 Enable Web Server Support x64 Add Application Server role Add Application Server role Add Web Server role Enable.NET Framework 3.5 Enable Web Server Support Installing NVivo Server 9

10 Consider administrator accounts Before installing NVivo Server, you should consider the administrator accounts you will use to install the software and the account you will nominate as the default NVivo Server administrator account. The account you use to run the NVivo Server installer must have administrator privileges on the server. During installation, you need to specify a default NVivo Server administrator account. This is the account you use to monitor the server in NVivo Server Manager and it may or may not be the same as the account used to run the installer. The following considerations apply when choosing which accounts to use: Account used to install NVivo Server this may be a local account on the server, or a domain account on a domain to which the server belongs. If you intend to use a domain account as the default NVivo Server administrator account, you must use a domain account to run the NVivo Server installer. Default NVivo Server administrator account This may be a local account on the server, or a domain account on a domain to which the server belongs. You may want to create a dedicated Windows group (for example, NVivo Administrators ) and add user accounts to this group, as required. This account becomes the default Project Owner of the NVivo sample project. Install the NVivo Server software 1 Log on to the server using an account with administrator privileges. You should log on with a domain account if that is what you intend to use as the default NVivo Server administrator account. 2 Insert the NVivo Server 9 DVD into the DVD drive. If the DVD menu does not automatically display, locate and double-click the file NS9Menu.exe on the DVD. 3 Click Install now and follow the prompts to: Install any prerequisite components. You may be asked to restart your machine on restart the installation will continue automatically. Accept the license agreement and enter your license key. Choose the Complete set up option, and then select other options as required. Note: When choosing the Windows account or group to be given server administrator permissions, enter the server location (machine or domain name) and Windows user name or group. This defaults to the local administrators group on the server. 4 When the installation is complete, you may need to enable server services or configure the server firewall. 10 Installing NVivo Server

11 INSTALLATION AND SETUP GUIDE Enable server services After installing NVivo Server on Windows Server 2003 SP2 (64-bit) or Windows Server 2003 R2 (64-bit), you need to enable ASP.NET for.net 2.0. Configure the server firewall Firewalls can block communication channels. There are some ports and applications that must not be blocked by a firewall for NVivo Server to function correctly. Port exceptions include: TCP Port 8731 for the NVivo Service TCP Port 8732 for the NVivo Service TCP Port 8733 for the NVivo Service TCP Port 1433 for the SQL Service UDP Port 1434 for the SQL Service TCP Port 80 for HTTP (only required when activating NVivo Server or adding license keys) Application exceptions include: C:\Program Files\Microsoft SQL Server\MSSQL10_50.QSRNVIVO9\MSSQL\Binn\ sqlservr.exe Start NVivo Server Manager and activate your license NVivo Server Manager is a browser-based application that lets you: Activate product licenses for NVivo Server Define role-based permissions Allocate Client Access Licenses (CALs) Manage NVivo Server projects. To access NVivo Server Manager: 1 Enter the web address: Note: You access NVivo Server Manager using a local or domain account that has been configured as an NVivo Server administrator account. You can specify this account as the default when you install NVivo Server or by adding this account to the Administrators group in NVivo Server Manager. On Windows Server 2008 or later, if the account is a member of the server s administrators group and is not the local administrator account BUILTIN\ Administrator, then you need to disable the following security policy User Account Control: Run all administrators in Admin Approval Mode. 2 If prompted, install the Microsoft Silverlight plug-in when you first launch NVivo Server Manager. Start NVivo Server Manager and activate your license 11

12 The NVivo Server Manager home page is displayed: Move through tabs to manage, licenses, users and projects Login details Access Help Activate the server license When you purchase NVivo Server you are provided with a license key. You must activate the license key before users can connect to the NVivo Server to work with NVivo Server projects. NVivo Server supports multiple active license keys. You must purchase a license key with a processor license for each CPU (a multi-core processor counts as one CPU). For virtual servers, a processor license is required for each CPU allocated to the server instance. If you upgrade your hardware, you may need to purchase additional processor licenses. 12 Start NVivo Server Manager and activate your license

13 To activate a server license key: 1 In NVivo Server Manager, click the Licensing tab. You need to activate the server license before users can connect to NVivo Server See the number of Client Access Licenses (CALs) available based on active license keys Add new license keys 2 On the left, click the Licenses tab. 3 For the license you want to activate, click Activate. 4 In the Activate License dialog box, enter the contact details. 5 Click Activate. Depending on the conditions of your license, the key will entitle you to run NVivo Server on a server with a specific number of processors and entitle you to a specific number of Client Access Licenses (CALs) you can see the details at the bottom of the Licenses tab. Refer to Manage Client Access Licenses later in this guide. To deactivate a license key (for example, if you want to use it on another server), click Deactivate. You may need to reallocate CALs as a result of deactivation. When you have installed and activated NVivo Server, you can configure permissions and allocate Client Access Licenses (CALs). Start NVivo Server Manager and activate your license 13

14 Manage users and permissions Before users can access projects on NVivo Server, you need to add them to the appropriate server user groups. Users can access the server using either: Their current Windows domain account (using integrated Windows authentication). A nominated Windows account on the server or a domain to which the server belongs. Assign users to server user groups The server administrator can control access to the server by assigning users to server user groups these groups control what the group members can do on the server. The following roles can be assigned: Users can connect to the server and access server projects. Project Creators can connect to the server and are allowed to create new server projects. Administrators have access to license allocation, user groups and other server management tools via NVivo Server Manager this guide supports the administrator role. Only members of this group can access NVivo Server Manager. While server groups control access to the server, they do not control access to specific projects. In the NVivo client, Project Owners add users to project user groups refer to the NVivo client Help for more information. To assign users to server user groups: 1 In NVivo Server Manager, click the Users tab. 2 On the left, click the Groups tab. 14 Manage users and permissions

15 INSTALLATION AND SETUP GUIDE 3 In the Groups box, select the group you want to add users to. 4 Click the Add button. The Select Users dialog box opens. 5 In the From this location box, enter the server or domain name of the user account or group. 6 Enter the user accounts or groups you want to add separate multiple names with a semi colon. 7 Click the Check Names button to verify user account or group names. 8 Click OK. When assigning users to server groups, consider the following: You must add at least one user account or group to the Project Creators group. The server administrator defined during install is automatically added to the Administrators group. This group must contain at least one user account or group. To remove users from an NVivo Server user group, select the names in the Members list and click the Remove button. If you remove a named user, you should also remove their CAL allocation refer to Allocate CALs to named users or groups in the next section. Manage Client Access Licenses (CALs) Depending on the terms of purchase, your NVivo Server license entitles you to a number of Client Access Licences (CALs) that allow users to access server projects. This section describes CALs and provides instructions for allocating them to named users. How do I allocate Client Access Licenses (CALs)? CALs can be allocated to: Named users specified user accounts (not groups) that have 1 CAL reserved for their specific use. These user accounts have a guaranteed server connection at all times. Concurrent users user accounts or groups that do not have any CALs reserved for their use. These user accounts require 3 CALs each. Concurrent or floating users connect to NVivo Server on a first-come, first-served basis. A concurrent user can only connect if there are available CALs. For example, if your product license includes 12 CALs, you could allocate 3 CALs to named users and allow 3 concurrent users to connect to the server: Manage Client Access Licenses (CALs) 15

16 Or you could leave all CALs unallocated and allow 4 concurrent users to connect at the same time: When allocating CALs you may want to consider the following: CALs are consumed when users open projects and are released when projects are closed. Users cannot conserve CALs by logging on to multiple machines using the same named user account a named user consumes 1 CAL on the first machine and 3 CALs on any subsequent machine. To maximize the use of your CALs, the number of licenses available for concurrent users should be a multiple of three (3, 6, 9, 12 and so on). Allocate CALs to named users or groups 1 In NVivo Server Manager, click the Licensing tab. 2 On the left, click the Allocation tab. See the number of CALs allocated to named users and the number available for concurrent users 16 Manage Client Access Licenses (CALs)

17 INSTALLATION AND SETUP GUIDE 3 Click the Add button. The Select Users dialog box is displayed: 4 In the From this location box, enter the server or domain name of the user account. 5 Enter the user accounts you want to add separate multiple user account names with a semi-colon. If you allocate a license to a user account that has not been added to the Users project group it is automatically added. 6 Click the Check Names button to automatically verify the correct user account names. 7 Click OK. To remove a named user, select it from the list and click the Remove button. Removing a named user merely removes the CAL allocation it does not remove the user from server user groups. Help users to manage their NVivo Server projects This section will help you to get users up and running with projects on NVivo Server. Set up server connections in the NVivo client Before users can access a server project, they must set up a server connection in the Application Options of the NVivo client. On the Connections tab, click Add to set up a new connection. They need to enter the following: In the Name box, enter a friendly name for the connection for example Staff Projects Server In the Host box, enter the server name, this can be: - A server name, for example myserver - A fully qualified domain name, for example myserver.abccompany.com - An IP address, for example If you are responsible for installing the NVivo client, you can automatically set up the server connection using the command line. Refer to the NVivo 9 Network Administrator s Guide for information about performing a silent install of NVivo this guide is available on the IT Administration page on our website ( For detailed instructions on setting up a server connection in the NVivo client, refer to the NVivo client Help. Help users to manage their NVivo Server projects 17

18 Make sure users can access server projects a checklist If a user is having trouble opening a server project, check that: The user account exists on the server machine or domain. An NVivo Server license has been activated in NVivo Server Manager. The user has been added to either the Users or Project Creators server user group in NVivo Server Manager. Sufficient Client Access Licenses (CALs) have been made available in NVivo Server Manager to support named or concurrent user access. The user has a valid server connection this is defined in the Application Options dialog in their NVivo client application. The user is logging on using the correct user account. A Project Owner for the project has added the user to a project user group (Project Owners, Contributors or Readers), or Guest access to the project is enabled. Ask the Project Owner to confirm this. If a Project Owner becomes unavailable you may need to add a Project Owner refer to Add a Project Owner later in this guide. Help users to manage audio and video files NVivo users can choose to embed media files in a project or store them outside the project on their computer or on a network location. They may also choose to do both storing small media files in the project, and storing large media files outside the project. Any files that exceed 100 MB must be stored outside the project. If media files are stored on a user s local machine then other users cannot access them. You should encourage users to store these files in a location accessible to all users for example, on a shared network drive. Users can change the location of external media files in the project refer to the NVivo client Help for more information. What to expect when multiple users are working on a server project When more than one user is working in a project, NVivo Server automatically saves updates and manages any potential conflicts between the users. Users may ask the following: Why can t I save the project? When users update a project, the changes are saved immediately to the server and are visible to other users users do not have to manually save their projects. Why can t I edit this project item? If a user wants to edit the content of a source or model, they must switch to edit mode. If another user tries to edit the item at the same time, they will see a message indicating that the item is not available for edit. NVivo will prompt with another message when the item becomes available. 18 Help users to manage their NVivo Server projects

19 INSTALLATION AND SETUP GUIDE How do I see everyone s updates? NVivo refreshes the workspace whenever a user performs common actions such as navigating to a different folder or opening an item. To manually refresh the NVivo workspace users can click Refresh, in the Workspace group, on the Home tab. Conflict with another user, what now? NVivo informs users if they try to make a change that conflicts with another colleague s work. For example, if a user attempts to change an item that is out of date (due to another user s changes), NVivo will display a message and retrieve the latest data so that they can try again. Can I have my own application settings? Each user can have their own application preferences for example, they can hide the audio waveform or use a larger font in datasets. Add a Project Owner (when an existing owner is no longer available) Project Owners are the only users who can give other users access to a project, change project properties and perform other project management tasks. If existing Project Owners are unavailable for a particular project (for example, because people have left your organization), you may need to add another Project Owner to the project. To add Project Owners: 1 Open the NVivo Server Manager. 2 Click the Projects tab. 3 In the Projects list, select the project to which you want to add Project Owners. 4 Click Add Owners. 5 In the From this location box, enter the server or domain name of the user account. 6 Enter the user accounts you want to add separate multiple user account names with a semi colon. Note: If you add a user account that has not been added to the Users project group it is automatically added. 7 Click the Check Names button to automatically verify the correct user account names. 8 Click OK. Help users to manage their NVivo Server projects 19

20 Maintaining and monitoring NVivo Server You can use NVivo Server Manager to monitor the status of NVivo projects, check who is connected and keep track of file sizes and logs. To perform other maintenance tasks you can use SQL Server Management Studio links to the relevant Microsoft Developer Network (MSDN) articles are provided in the NVivo Server Help. See who is connected For information about users, including the projects they are connected to: 1 In NVivo Server Manager, click the Users tab. 2 On the left, click the Users tab: Select a user to see the server user groups they belong to and the projects they are connected to Check the number of CALs being consumed by the users who are currently connected 20 Maintaining and monitoring NVivo Server

21 Check project files and logs To see information about NVivo project data files and logs, in NVivo Server Manager, click the Projects tab: Select a project and see who is connected Repair a project Add a new project owner if an existing owner is no longer available Refresh the list of projects. This is useful if you used SQL Server Management Studio to restore or remove projects Perform maintenance tasks The NVivo Server Help provides more detailed information about maintaining and monitoring NVivo Server including links to relevant Microsoft Developer Network (MSDN) articles. Refer to the Help for information about how to: Monitor the event log Repair a project Back-up a server project Restore a server project Migrate NVivo Server Migrate server projects Maintaining and monitoring NVivo Server 21

22