Migrate From Version 2.2 to Version 3.1 Guide EFM Community Fall 2007(Version 3.10) July 2008 For support, contact Vovici Technical Support at (781) 261-4300, ext. 2 or use the web form located at: http://s3.parature.com/ics/support/default.asp?deptid=5474 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 Vovici Corporation. 2008 Vovici Corporation. All other company and product names are trademarks or registered trademarks of their respective holders.
Microsoft, MS and MS-DOS are registered trademarks, and Microsoft Access, FrontPage, Excel and Windows are trademarks of Microsoft Corporation in the USA and other countries. Printed in the United States of America. v. 3.10.16. Page 2 of 39
Table of Contents Title Migration from EFM Community 2.2 to EFM Community 3.1... 5 Requirements... 5 Things to Note:... 5 A. Uninstall the existing EFM Community 2.2... 9 B. Download new EFM Community 3.1 file... 10 C. Stop access to the main application and Survey Engine... 11 Ideas for stopping access:... 11 D. Running the installer... 12 Options.lic file... 15 E. Authentication and Permissions... 16 Windows 2003 Server permissions... 17 EFM Community Authentication... 17 Windows Authentication... 21 Windows 2000 Server Permissions... 25 EFM Community Authentication... 25 Windows Authentication... 28 F. Migrate Existing Data... 31 Access Administrative Portal... 31 Migrate Data... 32 G. Configure Workgroups... 33 H. Test Environment... 34 Appendix:... 36 1. Determining the web server root in IIS:... 36 2. ASP.NET Framework... 37 3. Troubleshooting and Best Practices... 38 4. Administrative Portal Guide... 39 Page 3 of 39
Page 4 of 39
Migration from EFM Community 2.2 to EFM Community 3.1 Requirements 1. EFM Community version 2.2 should already be installed on the application server and working. EFM Community 3.1 can only upgrade the database structure of EFM Community 2.2. Performing a migration from a previous version of EFM Community, such as version 2.1, will lead to problems. 2. Please see the sixth item in the Things to Note list. Free database space in the master database needs to be allotted to accommodate this change. 3. Both the survey submission and survey design sides of the application need to be disabled during the entire migration process. See Section C for more information. 4. ASP.NET 2.0 Framework needs to be installed. Microsoft.NET Framework (version 2.0.50727. EFM Community version 2.2 and earlier used version 1.1 of the.net Framework) Available at : http://www.microsoft.com/downloads/details.aspx?familyid=0856eacb-4362-4b0d-8edd-aab15c5e04f5 Note: On Windows 2003 ASP.NET 2.0 must be set to Allow under the Web Service Extensions in IIS in order for EFM Community to function properly. Follow the steps below to achieve this: 1. Open IIS 2. Click Web Service Extensions 3. Highlight ASP.NET 2.0 4. Click Allow 5. The following backups must be done before the migration process is started: the Perseus Virtual Directory the existing database(s) used by the application Things to Note: 1. The migration to version 3.1 can only be done from version 2.2. You must first update or migrate from earlier versions to version 2.2 before the migration can begin. Please see the URL below for documentation on how to do so: Update from version 2.0 or 2.1 to 2.2: http://vovici.com/downloads/commhelp/2_2/efm_comm_upgrade_2_x_to_2_2_guide.pdf Page 5 of 39
Migrate from version 1.45 to 2.2: http://vovici.com/downloads/commhelp/2_2/ss_efm_migration_to_efm_c_2_x.pdf 2. Existing version 2.2 survey URLs will not change. 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 3.1 will continue to use the Survey Engine of 2.x with some updated code to support version 3.1 s new features. 4. Survey HTML will not be republished. So no custom edits of the HTML will be lost. 5. The survey s SGC file (an XML file used to control much of the survey functionality) will be republished to support the database changes outlined below. 6. All data for multiple workgroup installations will now be contained in the master database. No longer does EFM Community require a separate database for each workgroup. This means the master database might need its disk allotment expanded prior to the migration. As noted below in section 8 a new groupid column will be added in several tables to track the content of different databases. This should be considered when planning the amount of disk allotment expansion. 7. Each workgroup s GRP_RESPONDENTS table will be replaced with one PDC_RESPONDENTS table in the master database. Note: For data integrity the GRP_RESPONDENTS table will remain in each database, just in case there needs to be a manual rollback to version 2.2. 8. The following tables are now combined as one table in the master connection and will use a new groupid column to identify records related to each workgroup. GRP_APPROVAL_GROUPS GRP_LISTLIBRARY GRP_MAILINGS GRP_PANEL GRP_PANEL_AUDIT GRP_PANEL_FILTERS GRP_PROJECT_ACCESS GRP_PROJECTS GRP_PROJECTS_USERS GRP_QUESTIONLIBRARY GRP_REPORT_USERS GRP_REPORTS GRP_RESPONDENTS GRP_SUBPANEL_MEMBERS GRP_SURVEY_VERSIONS GRP_SURVEYS GRP_TASKS GRP_TASKS_AUDIT GRP_TEMPLATELIBRARY Page 6 of 39
GRP_RESPONDENTS 9. Version 2.2 data tables were named in the format of T<projectid>. Version 3.1 survey data tables will be changed to G<groupid>_T<projected>. Both names will be padded in some cases with leading 0 s to reach ten digit values. For example: the groupid was: 18054968 This will be padded to: G0018054968 If the projectid was: 722876123 This will be padded to: T0722876123 So the combined new table name will be: G0018054968_ T0722876123 Note: All version 2.2 data tables will remain in their corresponding database, just in case there needs to be a manual rollback to version 2.2. 10. Currently in version 3.1 piping inside invitations will not work until the survey is opened. Testing of invitations should only be done once all other testing of a survey is complete. Once everything else in the survey is tested and in a final state, a test participant will need to be added and the survey will need to be opened. The invite should be sent to the test participant to ensure that piping inside the invitation is working. Only then should live survey participants be added and invitations sent. Note: This change was made because occasionally in version 2.2 some clients encountered problems when they preloaded data and changed questions after the data was preloaded. This broke the preloaded data in these scenarios. We are considering adding either an option of a test invitation or a staging mode where the survey is locked down for changes but allow invites to be sent out to test the prepopulation of data. 11. There is a new Active X control for the Free Form Word Processor that must be installed in order to use the Free Form Questionnaire Designer in version 3.1. Troubleshooting information for this installation is listed in the Help (link included below). http://www.vovici.com/help/community/3/troubleshooting/active_x.htm This must be installed even for users who previously used version 2.2 on the server. 12. The new EFM Community installer does not have authentication mode settings so often permissions need to be applied manually per Section E of this document. Page 7 of 39
13. Section C must before performed before running the installer in Section D of this document. Otherwise there is a chance data will be submitted during the migration process that will not be properly handled and could cause errors during the migration process. Page 8 of 39
A. Uninstall the existing EFM Community 2.2 The new installer for EFM Community 3.1 does not support over-installs: anytime an upgrade to version 3.1 is performed in the future the old installation needs to be removed first using Add/Remove Programs in Windows before installing the updated build. Note: The same applies for the existing software for version 2.2. Page 9 of 39
B. Download new EFM Community 3.1 file To being the installation process, please perform the following steps: 1. Downloading EFM Community requires a username and password that should be the same one provided in the past by our Installation experts. Please contact them at mailto:installefmc@vovici.com for assistance downloading and installing EFM Community. Our technicians will prove invaluable in assisting the server configuration and EFM Community installation. 2. In a web browser, navigate to the following URL: http://vovici.com/downloads/comm/3_1/community_3_1.htm 3. Click Save (Steps 3, 4, and 5 refer specifically to Microsoft Internet Explorer and may be different on other browsers.) 4. Choose a local directory to save the installer in. Make a note of this directory. 5. Click Save to begin downloading the installer. Once the download is complete, proceed to the next section. Page 10 of 39
C. Stop access to the main application and Survey Engine During the migration process access must be stopped to the following three files: Survey Engine (se.ashx) This is the se.ashx file located in the root of the EFM Community virtual Directory. Login.aspx This is the script that handles login attempts to the main application in most cases, although some are also handled by the next script in this list: Default.aspx This file automatically routes people to the login script and in some cases handles login attempts so it also must have access stopped to it as well. Note: The Default.aspx file inside the /admin directory must be preserved for Section F, but no changes should be made inside the Administrative Portal other than what is listed in Section F. Ideas for stopping access: Remove external accesses for the virtual directory used in EFM Community Change the port inside IIS so that port 80 is not used. For example 8080 could be used. This way the Administrative Portal would be accessed via, http://server.com:8080/community/admin/default.aspx Note: Renaming the files listed above will not work since the default.aspx file inside the /admin directory needs to verify if the default.aspx script in the main directory exists. This verification is done via a direct file path so other methods of denying web access to it should work as expected. Page 11 of 39
D. Running the installer Once the installer has been downloaded, locate the file and follow the steps below to unzip it and begin the installation. 1. Double click on the file. 2. This will launch the Windows installer and the following start message will appear: Note: The version of the EFM Community installer can be found by following the steps below. a. Right click on the file and click Properties b. Click Summary c. The version number is in the Comments field 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 is being installed. Note: Click Cancel at any time to stop the installation. 3. Click Next 4. This will display the License Agreement page. If it is acceptable, select the I accept the terms in the License Agreement option. 5. Click Next. 6. Select the web site from the dropdown where the application will be installed. 7. Enter the name for the virtual directory in IIS that will be used to access the application via a URL. The default value is: Community So the URL to access the main application will be: http://servername/community Page 12 of 39
Note: 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 directory will be needed. This re-direct will not work with Workgroup Community and External Email 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 within the UI and allow the new URL path (with Community) to work with the survey. It is recommended that the old value of perseus be kept. So the URL to access the main application will be: http://servername/perseus Note: Ensure that the virtual directory name is not already in use as a web site name or virtual directory name on the server. 8. Click Next. 9. The Custom Setup page will appear. Multiple options can be selected on this page. 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): Page 13 of 39
EFM Community 3.1 This determines the installation options for the main application (Includes the Administrative Portal used in Section F to migrate the existing EFM Community data). Vovici Service Determines the installation options for the Vovici Service that controls the scheduling feature within the main application. Note: The Vovici Service will be installed by default. It provides time-based services to users such as deployment of invitations, opening and closing of surveys, etc. It is highly recommended that the Vovici Service is installed because certain functions require this service to work properly. o 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. 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 the need of locating the installer and re-running it to install the service on another server. o Please contact our Installation Specialists for other information regarding the installation of EFM Community 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/vovici If the default value is used the following subdirectories must be copied from the backup of the Perseus Virtual Directory into the new vovici physical directory. \AppData \surveys \reports This needs to be done moving to Section E. Selecting the text for either installation component will display how much disk space is taken up by it. 10. To toggle whether to install one component or the other click the icon ( ) next to its name. Select the X icon to choose not to install the component. The following buttons (other than the three navigation buttons, Back, Next and Cancel) are available on this page: Reset Used to return all options to the original default states. Disk Usage Click to open a page that displays the following information about every drive partition either physically connected to the computer and/or mapped over a network: Disk Size The total available disk space Available The amount of free space available Required How much disk space will be taken by the application 11. Once all desired options have been configured click Next Page 14 of 39
12. Click Install to start the installation of selected components. 13. Click Finish after installation is complete. 14. If prompted, please Restart before continuing this installation procedure or EFM Community will not function correctly. Note: The EFM Community installer file will check to see how many subfolders are underneath the AppData directory (Located within the Community Virtual Directory) and if it only finds the _default (which is included in the installation) directory listed it will automatically access the setupconfig.aspx script in a web browser. Otherwise the section at the beginning of Section E must be followed. Options.lic file Along with the username and password provided by the Vovici installation experts a file should also be provided called options.lic. This file needs to be copied into the following directory before proceeding: Drive Letter:\pathto\Vovici\AppData The path for Drive Letter:\pathto\ should be the path to the root of the web site specified in Step 9 above. Page 15 of 39
E. Authentication and Permissions Once the machine has been restarted (assuming it was needed) the authentication mode to use to allow access to the application must be decided and configured inside IIS. The rest of this chapter is divided into two sections based on the Operating system used on the application server: Windows 2003 Server Windows 2000 Server Page 16 of 39
Windows 2003 Server permissions EFM Community has two authentication modes: 1. EFM Community authentication The authentication process is handled by EFM Community via users added under Manage Users in the Administrative Portal. When the main application URL is accessed the EFM Community login prompt will appear. 2. Windows authentication IIS handles the authentication of the user. EFM Community only verifies that the Windows account used to log into the computer itself was added to the list of authorized users under Manage Users in the Administrative Portal. No login screen to the application is displayed to the user. Each of the two authentication modes has a different set of permissions which must be allowed in order for EFM Community to function correctly. Both authentication modes still require the users to be added within Administrative Portal - Manage Users or within the application itself under Group Administration Manage Users. These two authentication modes are displayed in more detail below: EFM Community Authentication Anonymous access must be enabled inside IIS in order for EFM Community Authentication to function correctly. Note: Integrated Windows authentication must be disabled inside IIS in order to attempt to login into EFM Community using EFM Community Authentication. To Enable "Anonymous access" and disable "Integrated Windows authentication" in IIS follow the steps below: 1. Open IIS 2. Right click the Community Virtual Directory 3. Select Properties 4. Click the Directory Security tab 5. Click Edit 6. Select (to enable) Anonymous access 7. Deselect (to disable) Integrated Windows authentication 8. Click OK twice Page 17 of 39
EFM Community Authentication Permissions The following permissions must be assigned after the EFM Community 3.1 installer has been run in order for EFM Community Authentication to function. Note: The accounts used in most cases can be replaced with another account, 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. While the installer does try to define most of these permissions by default, in some environments it is possible that the installer does not have enough privileges to set the permissions as intended or something on the server has prevented the permissions from being applied properly. I. Windows NTFS Permissions Network IIS_WPG# Service* Community Virtual Directory and Execute AppData Full Control Surveys Full Control Vovici Service** (Modify) Reports Full Control Temporary Full Control N/A N/A ASP.NET Files## C:\Program Files\Vovici\Service Windows Temp Dir### and Execute * - 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 18 of 39
### - This directory is a Windows environment setting. (This permission is a.net requirement) The default value is: C:/Windows/Temp, but this can be verified under, Control Panel System Advanced inside the Environment Variables tab under System Variables : it will be the TEMP variable. Note: It is advisable to verify that permissions have propagated down to files inside each of these directories for each account. In some cases child objects (files inside directories) are not allowed to receive permissions from the parent objects (directories). II. IIS Permissions Community Virtual Directory AppData Surveys Reports Permissions III. Determining the Application Pool used by EFM Community By default EFM Community is run by the default Application Pool but this varies. Please use the information listed above to determine the exact Application Pool. 1. Open IIS 2. Select the web site that is being used to host EFM Community 3. Right click the Community Virtual Directory folder (specified during the original installation, typically called Perseus) 4. Select Properties 5. Select the Virtual Directory tab 6. Record the Application Pool setting at the bottom of the page. IV. Determining the account that runs the 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: 1. Open IIS 2. Click the + next to Application Pools 3. Right click Default Application Pool 4. Select Properties 5. Select the Identify Tab 6. Record the username that is specified. This is the account that needs the permissions labeled for the Network Solutions account in the Windows Permissions column. V. Determining the account that the web server runs as in IIS 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: 1. Open IIS 2. Right click the web site that is being used to host EFM Community 3. Select Properties Page 19 of 39
4. Select the Directory Security Tab 5. Under Anonymous access and authentication control click Edit Note: Please verify the username that is specified. If IUSR_machinename is listed sometimes this is not used when EFM Community is used, instead the IWAM_machinename account will be used by IIS. On Windows 2003 Server the IIS_WPG account is used in most scenarios instead of the IUSR_machinename account: both the IUSR and IWAM local machine accounts are included in the IIS_WPG account by Windows. VI. Determining the account that the Vovici Service runs as The Vovici Service used by EFM Community performs all the scheduled functions within the Schedule Events section of the main application. The only exception is if the Now lightning bolt icon is clicked under view inside Schedule Events. This can be checked by doing the following: 1. Inside the Control Panel open Administrative Tools 2. Double-click (open) Services 3. Look for the Vovici Service, it is typically named Vovici Service and right click it 4. Select Properties 5. Select the Login Tab Note: the username that is specified. This account needs the permissions specified under the column Vovici Services in order to open and close surveys. Page 20 of 39
Windows Authentication Integrated Windows authentication must be enabled inside IIS in order to attempt to login into EFM Community using Windows Authentication. Note: Anonymous access must be disabled in order for Windows Authentication to function correctly. Edit the Web.Config File for Windows Authentication Inside the perseus 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: <authentication mode="" /> To: <authentication mode="windows" /> To Enable "Integrated Windows authentication" and disable "Anonymous access" in IIS follow the steps below: 1. Open IIS 2. Right click the Community Virtual Directory 1. Select Properties 2. Click the Directory Security tab 3. Click Edit 4. De-select (to disable) Anonymous access 5. Select (to enable) Integrated Windows authentication 6. Click OK twice Note: Some networks require that Digest Authentication for Windows domain servers be checked in order for users to have access to all features within EFM Community. Windows Authentication Permissions The following permissions must be assigned after the EFM Community 3.1 installer has been run in order for EFM Community Authentication to function. Note: The accounts used in most cases can be replaced with another account, 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. While the installer does try to define most of these permissions by default, in some environments it is possible that the installer does not have enough privileges to set the permissions as intended or something on the server has prevented the permissions from being applied properly. Page 21 of 39
I. Windows (NTFS) Permissions Network Service* Windows User Accounts# Community Virtual Directory and Execute AppData Full Control Surveys Full Control Vovici Service** (Modify) Reports Full Control Temporary Full Control N/A N/A ASP.NET Files## C:\Program Files\Vovici\Service Windows Temp Dir### and Execute * - See the section regarding Determining the account running the default Application Pool. # - In certain IIS configurations (for example when Impersonation is enabled) all the domain users that will access EFM Community 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. ### - This directory is a Windows environment setting. (This permission is a.net requirement) The default value is: C:/Windows/Temp, but this can be verified under, Control Panel System Advanced inside the Environment Variables tab under System Variables : it will be the TEMP variable. Note: In some cases 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) Page 22 of 39
Note: It is advisable to verify that permissions have propagated down to files inside each of these directories for each account. In some cases child objects (files inside directories) are not allowed to receive permissions from the parent objects (directories). II. IIS Permissions Community Virtual Directory AppData Surveys Reports Permissions III. Determining the Application Pool used by EFM Community By default EFM Community is run by the default Application Pool but this varies. Please use the information listed above to determine the exact Application Pool. 1. Open IIS 2. Select the web site that is being used to host EFM Community 3. Right click the Community Virtual Directory folder (specified during the original installation, typically called Perseus) 4. Select Properties 5. Select the Virtual Directory tab 6. Record the Application Pool setting at the bottom of the page. IV. Determining the account that runs the 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: 1. Open IIS 2. Click the + next to Application Pools 3. Right click Default Application Pool 4. Select Properties 5. Select the Identify Tab 6. Record the username that is specified. This is the account that needs the permissions labeled for the Network Solutions account in the Windows Permissions column. Page 23 of 39
V. Determining the account that the Vovici Service runs as The Vovici Service used by EFM Community performs all the scheduled functions within the Schedule Events section of the main application. The only exception is if the Now lightning bolt icon is clicked under view inside Schedule Events. This can be checked by doing the following: 1. Inside the Control Panel open Administrative Tools 2. Double-click (open) Services 3. Look for the Vovici Service, it is typically named Vovici Service and right click it 4. Select Properties 5. Select the Login Tab Note: the username that is specified. This account needs the permissions specified under the column Vovici Services in order to open and close surveys. Page 24 of 39
Windows 2000 Server Permissions EFM Community has two authentication modes: 1. EFM Community authentication The authentication process is handled by EFM Community via users added under Manage Users in the Administrative Portal. When the main application URL is accessed the EFM Community login prompt will appear. 2. Windows authentication IIS handles the authentication of the user. EFM Community only verifies that the Windows account used to log into the computer itself was added to the list of authorized users under Manage Users in the Administrative Portal. No login screen to the application is displayed to the user. Each of the two authentication modes has a different set of permissions which must be allowed in order for EFM Community to function correctly. Both authentication modes still require the users to be added within Administrative Portal - Manage Users or within the application itself under Group Administration Manage Users. These two authentication modes are displayed in more detail below: EFM Community Authentication Anonymous access must be enabled inside IIS in order for EFM Community Authentication to function correctly. Note: Integrated Windows authentication must be disabled inside IIS in order to attempt to login into EFM Community using EFM Community Authentication. To Enable "Anonymous access" and disable "Integrated Windows authentication" in IIS follow the steps below: 1. Open IIS 2. Right click the Community Virtual Directory 3. Select Properties 4. Click the Directory Security tab 5. Click Edit 6. Select (to enable) Anonymous access 7. Deselect (to disable) Integrated Windows authentication 8. Click OK twice Page 25 of 39
EFM Community Authentication Permissions The following permissions must be assigned after the EFM Community 3.1 installer has been run in order for EFM Community Authentication to function. Note: The accounts used in most cases can be replaced with another account, 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. While the installer does try to define most of these permissions by default, in some environments it is possible that the installer does not have enough privileges to set the permissions as intended or something on the server has prevented the permissions from being applied properly. I. Windows NTFS Permissions Community Virtual Directory ASP.NET and Execute Windows User Accounts* AppData Full Control Surveys Full Control Vovici Service** (Modify) Reports Full Control Temporary Full Control N/A N/A ASP.NET Files## C:\Program Files\Vovici\Service Windows Temp Dir### and Execute * - 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. ### - This directory is a Windows environment setting. The default value is: C:/Windows/Temp, but this can be verified under, Control Panel System Advanced inside the Environment Page 26 of 39
Variables tab under System Variables : it will be the TEMP variable. This permission requirement is out of our control and is an ASP.NET requirement not an EFM Community requirement. Note: It is advisable to verify that permissions have propagated down to files inside each of these directories for each account. In some cases child objects (files inside directories) are not allowed to receive permissions from the parent objects (directories). II. IIS Permissions Community Virtual Directory AppData Surveys Reports Permissions III. Determining the account that the web server runs as in IIS 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: 1. Open IIS 2. Right click the web site that is being used to host EFM Community 3. Select Properties 4. Select the Directory Security Tab 5. Under Anonymous access and authentication control click Edit Note: Please verify the username that is specified. If IUSR_machinename is listed sometimes this is not used when EFM Community is used, instead the IWAM_machinename account will be used by IIS. IV. Determining the account that the Vovici Service runs as The Vovici Service used by EFM Community performs all the scheduled functions within the Schedule Events section of the main application. The only exception is if the Now lightning bolt icon is clicked under view inside Schedule Events. This can be checked by doing the following: 1. Inside the Control Panel open Administrative Tools 2. Double-click (open) Services 3. Look for the Vovici Service, it is typically named Vovici Service and right click it 4. Select Properties 5. Select the Login Tab Note: the username that is specified. This account needs the permissions specified under the column Vovici Services in order to open and close surveys. Page 27 of 39
Windows Authentication Integrated Windows authentication must be enabled inside IIS in order to attempt to login into EFM Community using Windows Authentication. Note: Anonymous access must be disabled in order for Windows Authentication to function correctly. Edit the Web.Config File for Windows Authentication Inside the perseus 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: <authentication mode="" /> To: <authentication mode="windows" /> To Enable "Integrated Windows authentication" and disable "Anonymous access" in IIS follow the steps below: 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 Note: Some networks require that Digest Authentication for Windows domain servers be checked in order for users to have access to all features within EFM Community. Windows Authentication Permissions The following permissions must be assigned after the EFM Community 3.1 installer has been run in order for EFM Community Authentication to function. Note: The accounts used in most cases can be replaced with another account, 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. While the installer does try to define most of these permissions by default, in some environments it is possible that the installer does not have enough privileges to set the permissions as intended or something on the server has prevented the permissions from being applied properly. Page 28 of 39
I. Windows (NTFS) Permissions Community Virtual Directory ASP.NET and Execute Windows User Accounts* AppData Full Control Surveys Full Control Vovici Service** (Modify) Reports Full Control Temporary Full Control N/A N/A ASP.NET Files## C:\Program Files\Vovici\Service Windows Temp Dir### and Execute * - In certain IIS configurations (for example when Impersonation is enabled) all the domain users that will access EFM Community 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. ### - This directory is a Windows environment setting. The default value is: C:/Windows/Temp, but this can be verified under, Control Panel System Advanced inside the Environment Variables tab under System Variables : it will be the TEMP variable. This permission requirement is out of our control and is an ASP.NET requirement not an EFM Community requirement. Note: In some cases 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) Page 29 of 39
Note: It is advisable to verify that permissions have propagated down to files inside each of these directories for each account. In some cases child objects (files inside directories) are not allowed to receive permissions from the parent objects (directories). II. IIS Permissions Community Virtual Directory AppData Surveys Reports Permissions III. Determining the account that the Vovici Service runs as The Vovici Service used by EFM Community performs all the scheduled functions within the Schedule Events section of the main application. The only exception is if the Now lightning bolt icon is clicked under view inside Schedule Events. This can be checked by doing the following: 1. Inside the Control Panel open Administrative Tools 2. Double-click (open) Services 3. Look for the Vovici Service, it is typically named Vovici Service and right click it 4. Select Properties 5. Select the Login Tab Note: the username that is specified. This account needs the permissions specified under the column Vovici Services in order to open and close surveys. Page 30 of 39
F. Migrate Existing Data The migration of the data from the version 2.2 database format to version 3.1 will be handled via the Administrative Portal inside Edit Connections. No external utility will be needed outside the basic installer for EFM Community 3.1 which should already be installed. Access Administrative Portal Enter the URL below in a web browser to access the EFM Community Administrative Portal. Note: Internet Explorer 5.5 or 6.0 is required to access the EFM Community Administrative Portal. Depending on the authentication method designated in Section E access to the EFM Community Administration Portal will be different: EFM Community Authentication The first time the EFM Community 3.1 installer is run it is required that access be made on the server that EFM Community is installed on or by remotely connecting to it. The Administrative Portal will be accessed through the following URL: http://localhost/community/admin/default.aspx Note: If a virtual directory other than community was used in Section D, 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 EFM Community Administrative Portal. This is by design and is intended as an extra security feature. Using Localhost on a Web Server Hosting Multiple Web Site 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 IIS supports and is not currently in use will work. 1. Open IIS 2. Right click the web site that is being used to host EFM Community 3. Select Properties 4. Select the Web Site Tab 5. Click Advanced 6. Click Add 7. Leave the IP Address (All Unassigned) 8. Enter 8080 for the TCP Port 9. In the Host Header Name enter localhost 10. Click OK Page 31 of 39
After the initial setup is configured usage of the administrator account to access the EFM Community Administrative Portal remotely will be enabled. Windows Authentication If Windows Authentication was chosen access can be from any machine but the login to the machine will need to be a local system administrator (Not a Domain Administrator) on the EFM host application server. The Administrative Portal will be accessed through the following URL: http://server/community/admin/default.aspx Or via the server either locally or by remotely connecting to it: http://localhost/community/admin/default.aspx Note: If a virtual directory other than community was used in Section D, 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 SurveySolutions/EFM 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 EFM Community Administrative Portal. This is by design and is intended as an extra security feature. Migrate Data Follow the steps below to migrate the existing version 2.2 data to version 3.1. 1. Click Edit Connections 2. Click Run Table Setup Note: This will create the new tables and modify existing tables to accept the version 3.1 formatting. 3. Click the Update button ( ) for the first Workgroup 4. Repeat step 3 for each Workgroup Note: This must be done before logging into the application. Page 32 of 39
G. Configure Workgroups External access to the files listed in Section C should be restored for this step. 1. Login into the main application 2. Go to Administration - Setup - Publishing 3. Make sure the publishing information is valid, otherwise update the information. 4. Click Save Setup 5. Click Test Setup Page 33 of 39
H. Test Environment The migration process is complete and testing can be performed. Below is a recommendation of testing that can be done to insure the migration was a success: Test existing surveys (Under Surveys in the main application attempt to access existing surveys from the list) 1. Check published URLs and see if the surveys can be accessed via a web browser. Note: Some survey types require this be tested in Preview from Invitations. 2. Click Manage Responses o Make sure all responses are visible o Test an export and see if the correct number of responses are displayed Note: All three of the following response counts should match: 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. 3. Click Manage Reports o Attempt to create some reports Attempt to create a new survey 1. Create a test survey via Surveys Create New Survey (Select External Email as the Respondent Source.) 2. Test publishing by clicking Publish under the Actions Bar. 3. Click Select Participants and under the Actions Menu select Add Participant 4. Enter an e-mail address in the e-mail field and click OK. 5. Inside Invitations enter a Subject place the cursor inside the body of the invite and under the Fields box click Survey URL. 6. Inside Schedule Events (formerly Deploy Survey) and under the New Menu select Open Survey. 7. Set the Start time to the next half hour time period (Either the top of the hour such as 1:00 or the bottom of the hour 1:30). 8. Set no Recurrence or Advanced options and click OK. 9. Under the New Menu select Send Initial Invitation 10. Set the Start time to the next half hour time 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). 11. Set no Recurrence or Advanced options and click OK. 12. Check the survey after both time periods entered to confirm that the survey was: a. First Opened b. The initial invite was sent. Confirm that any custom Survey Templates appear under Library Survey Templates. Confirm that existing Community Members are still present in the UI and have profile data o Click Community Members Existing community members will be listed here Page 34 of 39
o Click Profiles (accessed under the Community tab) Confirm that existing profiles are present Confirm that data exists for the profile members, under Manage Profiles Page 35 of 39
Appendix: 1. Determining the web server root in IIS: The web server root can be checked under IIS by performing the following steps: 1. Open IIS 2. Right click the web site that is being used to host EFM Community 3. Select Properties 4. Click the Home Directory tab Note: the path specified in the Local Path field Page 36 of 39
2. ASP.NET Framework EFM Community 3.1 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 IIS it is possible to enable the version 2.0.50727 over the version 1.1 by following the steps below: 1. Open IIS 2. Right click the Community Virtual Directory 3. Select Properties 4. Click the ASP.NET tab 5. Select 2.0.50727 in the ASP.NET version dropdown box. 6. Click OK Page 37 of 39
3. Troubleshooting and Best Practices The following link is to the Best Practices and Troubleshooting Guide for EFM Community version 3.1: http://vovici.com/downloads/commhelp/3_1/bp_tr/efmc_troublesh_bp.htm This contains valuable recommendations on maintaining the server EFM Community is installed on as well as troubleshooting advice that should prove helpful. Page 38 of 39
4. Administrative Portal Guide The link below explains how to access the Administrative Portal and what the functions are of each section of the Administrative Portal. It can be very helpful in administering the application: http://vovici.com/downloads/commhelp/3_1/admin_port/efm_comm_admin_gde.htm Page 39 of 39