Beruflich Dokumente
Kultur Dokumente
grat
ionGui
de
Sur
veyWor
kbenchEnt
erpr
iseVer
sion4.
0to5.
3
Apr
il2010
April 2010 Survey Workbench Enterprise
For installation support, please contact our Survey Workbench installation experts at
installefmc@vovici.com. If phone support is requested an installation expert will call the
phone number requested.
Or visit www.Vovici.com
Please contact Vovici Technical Support if you believe any of the information shown here is
incorrect. Companies, names, and data used in examples herein are fictitious unless
otherwise noted. No part of this document may be reproduced or transmitted in any form
or by any means, electronic or mechanical, for any purpose, without the express written
permission of the Vovici Corporation.
Copyright © 2010 Vovici Corporation. All Rights Reserved. All other company and
product names are trademarks or registered trademarks of their respective holders.
Page 2 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Table of Contents
Page 3 of 37
April 2010 Survey Workbench Enterprise
1. Survey Workbench Enterprise Version 4.0 should already be installed and operational
on the application server. Survey Workbench Enterprise Version 5.3 can only
upgrade the database structure of Survey Workbench Enterprise Version 4.
Performing a migration from a previous version such as Version 3.0 may cause
problems.
2. Windows Server 2000 and Microsoft SQL Server 2000 are no longer supported by
Survey Workbench Enterprise. You must upgrade to Windows Server 2003 and
Microsoft SQL Server 2005, respectively, in order for Survey Workbench Enterprise
Version 5.3 to function. Version 5.3 has added support for Windows Server 2008
and Microsoft SQL Server 2008. Oracle requirements have not changed.
Microsoft .NET Framework (Version 2.0.50727. EFM Community Version 2.2 and
earlier used Version 1.1 of the .NET Framework)
o Available at:
http://www.microsoft.com/downloads/details.aspx?familyid=0856e
acb-4362-4b0d-8edd-aab15c5e04f5
Note: On Windows Server 2003 and Windows Server 2008, ASP.NET 2.0
must be set to “Allow under the Web Service Extensions in Microsoft IIS”
in order for Survey Workbench Enterprise to function properly. Follow
the steps below to achieve this:
5. The software requirements for Vovici V5 can be found at the URL below:
http://www.vovici.com/help/Community/5.0/Welcome/system_requirements.htm
6. The following backups must be performed before the migration process begins:
The physical directory where Survey Workbench Version 4.0 is installed.
Typically, this is located at C:\Inetpub\wwwroot\Vovici
The existing database used by the application.
Page 4 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Migration Tips:
1. The migration to Version 5.3 can only be done from Version 4. You must first update
or migrate from earlier versions to Version 4.0 before the migration can begin.
Please select from the applicable URLs below for documentation on how to do so:
Note: This was not the case between Version 1.45 and 2.x as a new survey
processor was introduced that changed the way URLs were built and
accessed.
3. Version 5.3 will continue to use the Survey Engine of 2.x, 3.x, and 4.x with some
updated code to support Version 5.3‟s new features.
4. Survey HTML will not be republished. Therefore, no custom edits of the HTML will be
lost.
5. There were no major fundamental changes to the data structure like there was in
Versions 2.x and Version 3.1. This greatly speeds the migration process from
previous migrations.
6. The ActiveX control for the Free Form Word Processor from Version 4.0 was changed.
Therefore, a new version will need to be installed for Version 5.3.
7. Similar to Version 3.1 and Version 4.0, Vovici Enterprise Version 5.3‟s installer does
not have “apply file permissions.” In some cases, permissions need to be applied
manually per Section 5 of this document.
8. The existing Version 4.0 installer should not be uninstalled. The Version 5.3 installer
will over install the application.
Page 5 of 37
April 2010 Survey Workbench Enterprise
9. The Version 5.3 installer will now explicitly add the default.aspx file as a default
document inside IIS. In the past, the installer did not address the issue of IIS
Virtual Directory default documents. Please see the Appendix section of this
document for more detailed information.
Page 6 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
2. Installation Process
Download New Survey Workbench Enterprise Version 5.3 file
1. In a Web browser, enter the following URL into the address field:
http://vovici.com/downloads/comm/5_3/Vovici_Ent_5_3.htm.
2. Click Save (Steps 3, 4, and 5 refer specifically to Microsoft Internet Explorer and
may be different on other browsers).
3. Choose a local directory in which to save the installer. Make a note of this directory.
Note: Our technicians will prove invaluable in assisting the server configuration
and Survey Workbench Enterprise installation. Please contact them at
installefmc@vovici.com for assistance downloading and installing Survey
Workbench Enterprise.
Page 7 of 37
April 2010 Survey Workbench Enterprise
Alert
Do not select “Never run software from „Vovici
Corporation,‟” otherwise installers produced by Vovici
will never work on the server.
Page 8 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
2. This will launch the Windows installer and the following start message will appear.
Startup message
Note: The version of the Survey Workbench Enterprise installer can be found
by following the steps below.
This is the version of the installer not the application itself and can help our Installation
Specialists and/or Technical Support staff discover which version of the software you are
installing. See next page for image.
Page 9 of 37
April 2010 Survey Workbench Enterprise
3. Click Next.
Page 10 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Please read the license agreement and if it is acceptable, select the “I accept the
terms in the License Agreement” check box option.
Page 11 of 37
April 2010 Survey Workbench Enterprise
5. Click Next.
In the “Select the web site the application should be installed on” drop-down menu,
select the web site where the application is currently installed.
7. Enter the name currently used for the virtual directory inside Microsoft IIS for Survey
Workbench Version 4.0 in the:
“Community”
http://servername/Community
Note: Clients who started with EFM Community Version 2.2 or earlier most
likely have a default value of Perseus instead of Community. The old value
of Perseus could be used for the virtual directory. This will keep existing
survey URLs the same. Otherwise, in order for old URLs to work a re-direct
on the Perseus virtual directory pointing to the new Community virtual
Page 12 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
directory will be needed. This re-direct will not work with Workgroup
Community and External E-mail List surveys.
If this redirect is not done a re-publish of the survey inside the main
application, once the migration is completed, will change the URL used to
access the survey. The survey will now use the new URL path (with
Community) to access the survey.
http://servername/Perseus
Note: Ensure that the virtual directory name selected is not already in use
by another application as a Web site name or virtual directory name on the
server.
8. Click Next.
Page 13 of 37
April 2010 Survey Workbench Enterprise
On the top part of the window there is an option named Complete with a + next to it.
Click the “+” sign to expose the following two components (Both of these options are
installed by default):
Survey Workbench – This determines the installation options for the main
application.
Vovici Service – Determines the installation options for the Vovici Service
that controls the scheduling feature within the main application.
Installing the service on multiple servers that are in a single web farm may result in
duplicate invitations being sent. Although, if the Vovici Service is disabled on all but
one server, this will prevent any duplicate invitations from being sent out. This
solution allows for a quick failover if the server running the Service goes down.
Simply enable the Vovici Service on one of the other servers and it will restore the
functionality without needing to locate the installer and re-run it to install the service
on another server.
Please contact our installation specialists for other information regarding the
migration of Survey Workbench on a Web farm.
Note: In order to use the same physical directory as before, Browse must be
clicked and the path specified; otherwise, the default value is:
C:/inetpub/wwwroot/vovici
If the default value is used for older clients who started with EFM Community Version
2.2 or earlier, the following subdirectories must be copied from the backup of the
Perseus Virtual Directory into the new Survey Workbench physical directory.
\AppData
\surveys
\reports
Note: This step must be completed if you want to proceed to the next step.
Selecting the text for either installation component will display available disk space.
10. Click the icon ( ) next to its name to install one component or the other. Select
the “X” icon to cancel installation of the component.
The following buttons (other than the three navigation buttons, Back, Next and
Cancel) are available on this page:
Page 14 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
11. Once all desired options have been configured click Next.
12. The Survey Workbench window will appear:
Click Upgrade in order for the installer to update the older Version 4.0 files to
Version 5.3.
Note: The following window will appear during the upgrade. The mention of
Survey Workbench Version 4.0 refers to the un-installation of the existing
Survey Workbench Version 4.0 program files.
Page 15 of 37
April 2010 Survey Workbench Enterprise
Page 16 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
If this option is selected the application will attempt to load the Administrative Portal
page based on the information it receives from IIS. Section 6 covers the steps
needed inside the Administrative Portal.
The steps outlined in Section 4 will still need to be done in order to fully register the
application with the new version. Otherwise, the application will be installed in a trial
state where it will expire after 30 days and certain advanced features will not be
enabled in the application.
Once a choice has been made on the check box, click Finish.
Page 17 of 37
April 2010 Survey Workbench Enterprise
16. If prompted, please restart before continuing this installation procedure or the
Vovici Service will not function correctly.
Note: A reboot of the server is required for the Vovici Service (this is a
Windows Service that handles the schedule functions inside the application)
to function properly. Until the server is rebooted, the schedule functionality
will not work in Survey Workbench.
Page 18 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
4. Options.lic file
This is the license file for the application and is needed in order to access the application. It
also controls which add-ons to the product that were purchased are accessible.
Existing version 4 options.lic files will work with Survey Workbench version 5.
Page 19 of 37
April 2010 Survey Workbench Enterprise
Using this authentication method, when the main application URL (for example,
http://servername/Community/login.aspx) is accessed the Survey Workbench
Enterprise login prompt will appear.
Login fields
Each of the two authentication modes has a different set of permissions that must be
allowed in order for Survey Workbench Enterprise to function correctly. Both authentication
modes still require the users to be added within Administrative Portal - Manage Users
or within the application itself under Administration Users. These two authentication
modes are displayed in more detail in the following sections.
Page 20 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Anonymous access must be enabled inside IIS in order for Survey Workbench
Authentication to function correctly.
The following permissions must be assigned after the Survey Workbench Enterprise Version
5.3 installer has been run in order for Survey Workbench Authentication to function.
Note: Most of the permissions listed below are requirements of the Windows
Operating System, the Microsoft IIS web server and Microsoft ASP.NET 2.0. They
are listed for your reference to speed the installation process and to aid
troubleshooting.
Vovici does not require any of the accounts listed below. The accounts listed in
most cases can be replaced with another account to align with the organization’s
security standards, but whatever account is used must have these minimum
permissions in order for the application to function properly. To change an
account being used, follow the instructions in the sections labeled “Determining
the account…” list at the bottom of the Windows NTFS permissions chart.
The Survey Workbench Enterprise installer does not attempt to assign permissions due to
security limitations encountered in most environments. Instead, they must be applied
manually in order for the application to function with Microsoft IIS and Microsoft ASP.NET
2.0 in a Windows environment.
Page 21 of 37
April 2010 Survey Workbench Enterprise
* - See the section regarding Determining the account running the default
Application Pool.
# - See the section regarding Determining the Account that the Web Server Runs as
in IIS.
** See the section regarding Determining the account that the Vovici Service runs as
(On some servers Modify permissions might be needed for the Vovici Service to function
properly)
## - This is a Microsoft .NET Framework created directory and whatever account runs the
Application Pool needs to have access to it. Otherwise, .NET applications will not function.
Page 22 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
This section is not meant to replace Windows documentation but is intended as a reference
for people that are not familiar with applying Windows NTFS permissions.
For example:
Permissions set up the /vovici directory are only applied to the:
/vovici/AppData directory
IIS Permissions
Permissions
Community Virtual Read
Directory
AppData Read
Write
Surveys Read
Write
Reports Read
Write
Page 23 of 37
April 2010 Survey Workbench Enterprise
By default, Survey Workbench Enterprise is run by the default Application Pool but this
varies. Please use the information listed above to determine the exact Application Pool.
In IIS 6.0, the Account that the default Application Pool runs as is typically Network Service.
The account actually used can be verified by doing the following:
This is the account that needs the permissions labeled for the Network Service account in
the Windows Permissions column.
In IIS, the Account that the Web Server runs as is typically IUSR_machinename or the
IWAM_machinename account. This can be checked by doing the following:
The Vovici Service used by Survey Workbench Enterprise performs all the scheduled
functions within the Schedule Events section of the main application. Please view our
Online Help for more information. The only exception is if the Now lightning bolt icon is
clicked under List view inside Schedule Events.
Page 24 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Note: Please record the username that is specified. This account needs the
permissions specified under the column Vovici Services in order to open and
close surveys.
The account listed here must have the ability to start services on the local
server otherwise, the Vovici Service cannot be started.
Windows Authentication
Integrated Windows authentication must be enabled inside Microsoft IIS in order to attempt
to log on to Survey Workbench Enterprise using Windows Authentication. The web.config
file also needs to be edited in order to support this authentication method.
Inside the Vovici root directory, the web.config file must be found (this path was specified
when the installer was run earlier in the process). The following line needs to be changed:
To:
1. Open IIS.
2. Right-click the Community Virtual Directory.
3. Select Properties.
4. Click the Directory Security tab.
5. Click Edit.
6. De-select (to disable) Anonymous access.
7. Select (to enable) Integrated Windows authentication.
8. Click OK twice.
Page 25 of 37
April 2010 Survey Workbench Enterprise
The following permissions must be assigned after the Survey Workbench Enterprise 5.3
installer has been run in order for Survey Workbench Authentication to function.
Note: Most of the permissions listed below are requirements of the Windows
Operating System, the Microsoft IIS web server and Microsoft ASP.NET 2.0. They
are listed for your reference to speed the installation process and to aid
troubleshooting.
Vovici does not require any of the accounts listed below. The accounts listed in
most cases can be replaced with another account to align with the organization’s
security standards, but whatever account is used must have these minimum
permissions in order for the application to function properly. To change an
account being used, follow the instructions in the sections labeled “Determining
the account…” list at the bottom of the Windows NTFS permissions chart.
The Survey Workbench Enterprise installer does not attempt to assign permissions due to
security limitations encountered in most environments. Instead, they must be applied
manually in order for the application to function with Microsoft IIS and Microsoft ASP.NET
2.0 in a Windows environment.
* - See the section regarding Determining the Account Running the Default
Application Pool.
Page 26 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
# - In certain IIS configurations (for example when Impersonation is enabled) all the
domain users that will access Survey Workbench Enterprise will need these permissions in
order to access the product correctly.
## - This is a Microsoft .NET Framework created directory and whatever account runs the
Application Pool needs to have access to it. Otherwise, .NET applications will not function.
Note: In some cases, Write and Modify permissions might need to be assigned to
these users over the AppData, Surveys, and Reports subdirectories.
It is recommended that a group be created containing all these users under Control Panels
– Administrative Tools – Computer Management – Local Users and Groups. This
will make assigning the permissions in Windows easier, but the group must be maintained
every time a new user is added.
** See the section regarding Determining the Account that the Vovici Service Runs as
(On some servers Modify permissions might be needed for the Vovici Service to function
properly)
This section is not meant to replace Windows documentation but is intended as reference to
people not familiar with applying Windows NTFS permissions.
Page 27 of 37
April 2010 Survey Workbench Enterprise
For example:
Permissions set up the /vovici directory are only applied to the:
/vovici/AppData directory
IIS Permissions
Permissions
Community Virtual Read
Directory
AppData Read
Write
Surveys Read
Write
Reports Read
Write
By default, Survey Workbench Enterprise is run by the default Application Pool but this
varies. Please use the information listed above to determine the exact Application Pool.
In IIS 6.0, the Account that the default Application Pool runs as is typically Network Service.
This can be verified by doing the following:
This is the account that needs the permissions labeled for the Network Service account in
the Windows Permissions column.
The Vovici Service used by Survey Workbench Enterprise performs all the scheduled
functions within the Schedule Events section of the main application. Please view the
Page 28 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Online Help for more information. The only exception is if the Now lightning bolt icon is
clicked under List view inside Schedule Events.
Note: Please record the username that is specified. This account needs the
permissions specified under the column Vovici Services in order to open and
close surveys.
Page 29 of 37
April 2010 Survey Workbench Enterprise
This section explains how to enter the URL in a web browser to access the Survey
Workbench Enterprise Administrative Portal.
Note: Internet Explorer 6.0 or 7.0 is required to access the Survey Workbench
Enterprise Administrative Portal.
The first time you run the Survey Workbench Enterprise installer, the Administrative Portal
needs to be accessed by a localhost URL on the server itself, not through a remote URL
(e.g., http://www.server.com/community/login.aspx).
Use the following URL if you plan to access a local server for installation:
http://localhost/community/admin/default.aspx
Note: If a virtual directory other than community was used in Section 3, Step 7 above,
replace community in the URL with the name of the virtual directory used. Attempting to
access this URL from a different computer by changing “localhost” to the server‟s name or
IP will fail on all initial installations performed until the administrator account is enabled
inside the Survey Workbench Enterprise Administrative Portal. This is by design and
is intended as an extra security feature.
In a web server hosting multiple web sites, in order to use localhost as a URL for a specific
Web site, a unique port needs to be assigned for localhost for that Web site. The steps
below explain how to do this. This example assumes the port will be 8080, but any viable
port that Microsoft IIS supports and is not currently in use will work.
Page 30 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
The administrator account, originally configured when the application was first installed,
should be used for the login credentials.
Please contact the Survey Workbench installation experts with any questions you may
have.
Windows Authentication
If Windows Authentication has been chosen, access can be from any machine but the log on
to the machine will need to be a local administrator (Not a Domain Administrator) account
on the Survey Workbench host application server.
Note: If a virtual directory other than community was used in Section B, Step 7
above, replace community in the URL with the name of the virtual directory used.
Attempting to access this URL from a different computer by changing “localhost”
to the server’s name or IP will fail on all initial installations performed after EFM
Community Version 2.1 Build 901 or later (earlier versions/builds did not have the
ability for remote access) until the administrator account is enabled inside the
Survey Workbench Enterprise Administrative Portal. This is by design and is
intended as an extra security feature.
Page 31 of 37
April 2010 Survey Workbench Enterprise
Follow the steps below to upgrade the existing Version 4.0 database structure to Version
5.3.
Note: This must be done before logging into the main part of application.
1. Click Configure.
2. Under Connections.
3. Click Run Table Setup.
Note: This will create the new tables and modify existing tables to accept
the Version 5.3 formatting.
Db Script Successful
Page 32 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
8. Click Mail and make sure the information under the tab is correct.
9. Click Test.
Page 33 of 37
April 2010 Survey Workbench Enterprise
8. Test Environment
The migration process is complete and testing can be performed. Below is a
recommendation of testing that can be done to ensure the migration was a success:
1. Test existing surveys (Under Surveys in the main application attempt to access
existing surveys from the list) .
2. Check published URLs and see if the surveys can be accessed via a Web browser.
Note: Some survey types require that this be tested in Preview from Write
Invitations.
Data – number of responses in the Data section on the survey‟s home pane.
Manage Responses – The number of records displayed inside Manage Responses:
please make sure that no filter is applied.
Export within Manage Responses – How many records are exported: please make
sure that either Manage Responses has no filter applied or the export is done
using the “No Filter” option, as this will often lower the number of exported
records.
4. Click Manage Reports.
Attempt to create some reports.
5. Attempt to create a new survey.
a. Create a test survey via Surveys – Create New Survey (Select External E-
mail List as the Respondent Source).
b. Test publishing by clicking Publish under the Actions Bar.
c. Click Select Participants and under the Actions Menu select Add Participant…
d. Enter an e-mail address in the e-mail field and click OK.
e. Inside Write Invitations enter a Subject and place the cursor inside the body of
the invite and under the Fields box click Survey URL.
f. Inside Schedule Events (formerly Deploy Survey) and under the New Menu select
Open Survey.
g. Set the Start time to the next half hour period (Either the top of the hour such as
1:00 or the bottom of the hour 1:30).
h. Set no Recurrence or Advanced options and click OK.
i. Under the New Menu select Send Initial Invitation.
j. Set the Start time to the next half hour period after the Open Survey event was
scheduled (Either the top of the hour such as 1:00 or the bottom of the hour
1:30).
k. Set no Recurrence or Advanced options and click OK.
l. Check the survey after both time periods entered to confirm that the survey was:
m. First “Opened.”
n. The initial invite was sent.
6. Confirm that any custom Survey Templates appear under Library – Survey
Templates.
7. Confirm that existing Community Members are still present in the UI and have profile
data.
Page 34 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
Page 35 of 37
April 2010 Survey Workbench Enterprise
9. Appendix
Determining the Web server root in Microsoft IIS:
The Web server root can be checked under Microsoft IIS by performing the following steps:
ASP.NET Framework
Survey Workbench Enterprise only works with Version 2.0.50727 of the Microsoft ASP.NET
Framework.
Microsoft ASP.NET Framework 1.1 will not function. If both are installed on the Application
Server inside Microsoft IIS, it is possible to enable the Version 2.0.50727 over the Version
1.1 by following the steps below:
Knowledge Base
Vovici has a Knowledge Base within our Vovici Customer Support Portal that contains
valuable recommendations on maintaining the server on which Survey Workbench
Enterprise is installed. It also contains troubleshooting assistance (This is in addition to our
installation experts). It also provides information about best practices for the application:
http://www.vovici.com/support/
In the past, the installer did not address the issue of IIS Virtual Directory default
documents. This meant that the virtual directory / web application created by the installer
would inherit the properties of the parent Web site. If the parent Web site did not have the
default.aspx file listed as one of the default documents, this would have to be manually
Page 36 of 37
Instructions for Upgrading from 4.0 to 5.3 April 2010
added by the user. In Version 5.3, the installer should explicitly add the default.aspx file as
a default document inside IIS as shown by the image below:
Documents tab
This should avoid permissions problems that sporadically occurred during installations and
upgrades of the application.
Page 37 of 37