ConferenceXP 5 Installation Notes
From UW Center for Collaborative Technologies Wiki
This documents provides installation instructions and notes for the various ConferenceXP 5.x software components. In general, each software component has a separate MSI installer for 32-bit and 64-bit architectures. The exceptions (currently, the CXP Client) are described below.
Before installing any other components, be sure that you have installed .Net framework 2.0.
Client
For all architectures, download and run the the x86 client MSI.
For Vista-based systems, the client pops up a security warning each time the program is launched. The only way to avoid this currently is to disable Vista's User Account Control (UAC).
Prior to ConferenceXP 5.1, running Reflector or Archive Service and Client on the same system was not supported.
Vista Audio Issues: CXP 5.0
(Note: this issue was resolved in ConferenceXP 5.1 by adding the codec to the client setup.)
The audio codec used by ConferenceXP "Windows Media Audio V2" is not included in Vista. If the codec is not installed, the only audio options available will be uncompressed. One symptom if the missing codec is very choppy audio. Another symptom is that setting the audio compression check box in the advanced audio dialog doesn't stick on.
The audio codec can be found in this download: kb324290, however the installation was found not to work on Vista using the included setup executable.
To install the audio codec:
- Download the update to c:\wmpcdcs8.exe
- Make an admin command prompt and execute the following:
- cd \
- mkdir wmpcdcs8
- wmpcdcs8.exe /T:c:\wmpcdcs8 /C
- Now a set of files should be extracted to the directory c:\wmpcdcs8
- Open explorer to that directory, and for each of the following files, right click and select install: msaudio.inf, wmadmo.inf, msaud.inf
- Now the codec should be installed.
Installing side-by-side with previous version
It is fine to install the 5.x client on the same system with a 4.1 client, or different 5.x client versions on the same system, however it is not recommended to actually run them both at the same time. Also note that if you uninstall one of them, you will probably need to re-install the other.
Installing on Windows Server 2008
One of the ConferenceXP prerequisites is Windows Media Player. In order to use Windows Media Player on Windows Server 2008, you have to go to the Server Manager and Add Features, then install the Desktop Experience Feature, and reboot. After Windows Media Player is working, you may also need to manually install the audio codec (see above).
Venue Service
The steps are: 1) Install and activate IIS; 2) Install and activate Microsoft .NET and ASP.NET; 3) Install the Venue Service MSI; 4) Miscellaneous post-processing steps. The precise set of steps differs for XP versus Vista versus Windows 7 and Windows Servers and for the various IIS versions.
Step 1: Install and Activate IIS
To install IIS on Windows XP, follow these steps:
- Selecting Start => Control Panel => Add Or Remove Programs.
- Click Add/Remove Windows Components.
- In the Components list, select the Internet Information Services (IIS) check box, and then click Next.
- Click Finish.
To install on Vista and Windows 7:
On these platforms, the process is streamlined such that IIS and ASP.NET are installed at once. Refer to the instructions under the heading "To install IIS and ASP.NET on Windows Vista" on this page. Briefly, the procedure is as follows:
- Control Panel -> Programs -> Turn Windows Features on or off
- Select the following features under "Internet Information Services":
- "World Wide Web Services -> Application Development Features -> ASP.Net" Note that this causes a set of dependencies to be automatically selected. Don't unselect any of them.
- "Web Management Tools -> IIS 6 Management Compatibility -> IIS Metabase and IIS 6 Configuration compatibility" This feature is needed to enable the Venue Service setup MSI to run properly.
- Optional but recommended: "Web Management Tools->IIS Management Console"
To install on Windows Server 2008 and 2003 R2:
Install IIS and ASP.Net by installing the Web Server role using "Manage My Server" (or "Manage Your Server"). The role is called "Application Server (IIS, Asp.Net)" on Server 2003 R2. While adding the role, on 2008 be sure to check the ASP.Net role service and the IIS 6 metabase compatibility role service, and to confirm to add the other role services upon which these depend. On 2003 R2, check the box to install/configure Asp.Net.
For all but Windows XP and Server 2003 (non-R2), proceed to Step 3.
Step 2: Install and activate .NET and ASP.NET
This step applies to WindowsXP and Server 2003 only. The above step should suffice for ASP.NET installation on Vista, Windows 7 and Server 2008 and Server 2003 R2.
Installing .NET Framework 2.0
First, you must ensure that .NET 2.0 is installed. You can verify this by checking under the list of installed programs:
- Selecting Start => Control Panel => Add Or Remove Programs.
- Click Change or Remove Components. Actually, this is the default, so you shouldn't have to click anything.
- Check for the program Microsoft.NET framework 2.0 in the listing. If it exists, close the menu and skip to the registration step below.
If .NET 2.0 is not installed, follow these steps:
- Go to the Windows Update Web site.
- Click Custom Install.
- In the left navigation bar, click Select optional software updates.
- Select the check box to the left of Microsoft .NET Framework version 2.0. (or possibly later versions; See below)
- Click Go to install updates.
- Click Install.
Notice that version 3.5 SP1 and presumably later releases do include .Net Framework 2.0.
Registering ASP.NET with IIS
Next, you must register ASP.NET with IIS. Follow these steps:
- In Windows, on the Start menu, point to Programs, point to Accessories, and then click Command Prompt.
- At the command prompt, type (Note that the details of the path may vary slightly on different systems):
%WINDIR%\Microsoft.NET\Framework\v2.0.4322\aspnet_regiis.exe -i
Where v2.0.4322 is the version number of the .NET Framework that you installed on your server.
- Press Enter
Step 3: Run the setup utility
Run the MSI to install the venue service. Of course you have to install .Net Framework first. The latest version is fine.
Note that on Vista, Windows 7 or Server 2008 with UAC you should first start an admin command prompt (e.g. Right-click on the command prompt icon and select 'Run as Admin'), then run the MSI from that command prompt.
For many installations this is the final step. Add a firewall expeption for TCP port 80, and configure a Conference XP client to point at your venue service to test.
Step 4: Add Permission to Temp Directory
This step my only be necessary on some web server installations.
You may need to add a permission to your system temp directory to allow the Venue Service to work properly. If you run a web browser on your venue service system, and navigate to http://localhost/venueservice, then click on GetParticipants then Invoke, if you see a message beginning with:
System.InvalidOperationException: Unable to generate a temporary class (result=1).
Then you need to add a permission for the account under which the web service runs (typically MachineName\ASPNET) to %windir%\temp (typically C:\windows\temp). Add Read&Execute, Read and List Folder Contents, then restart the web server.
Step 5: Add Permission for Application Directory (IIS 7 or later)
When running on Windows 7 or Server 2008 with "Application Pool Identities" (the default) you may need to add permissions to allow the application to access the data file C:\Inetpub\wwwroot\VenueService\VenueService.dat. If you run a web browser on your venue service system, and navigate to http://localhost/venueservice, then click on GetParticipants then Invoke, if you see a message indicating that the applicaton could not access C:\Inetpub\wwwroot\VenueService\VenueService.dat, then you will know that a permission needs to be added.
To add the permission:
- In Windows Explorer, right-click, c:\inetpub\wwwroot\VenueService, select Properties and select the "Security" tab.
- Click the "Edit" and then "Add" button
- Enter "IIS AppPool\DefaultAppPool" in the "Enter the object names to select:" text box.
- Click the "Check Names" button and click "OK".
- Make sure the DefaultAppPool user has the following permissions: Modify, Read & Execute, List, Read, Write. Click OK.
An alternative way to give the application the necessary permissions is to run the IIS management console from "Computer Management", and set the application pool used by the application to run under the NetworkService account, or other account of your choice. You can change the application pool used by the application by selecting VenueService under "Default Web Site", then click "Advanced settings" on the right panel. You can change the account used by the application pool by selecting Application Pools in the left panel, then select the application pool to change, and select "Advanced Settings" in the right panel. The Identity property sets the account that will be used. Be sure to restart the web server after making these changes.
Step 5: Miscellaneous Post-Processing
You may need to explicitly modify your firewall settings to allow through HTTP traffic on port 80. On Windows 7 and Server 2008 this is done by clicking Advanced Settings in Windows firewall, then "Inbound Rules" and enabling the "World Wide Web Services" rule.
For IIS 6.0, make sure the ASP.NET v2 "Web Service Extensions" are enabled. This option is set under the IIS configuration tool, which is part of "Administrative Tools" (which is available from the control panel).
Note that on Vista with UAC, you may need to explicitly run the administrative tool as administrator.
Side-by-side installations
Side-by-Side installations of different Venue Service versions on one system should work fine. Simply assign different virtual directory names during setup for the different versions, for example 'venueservice4', 'venueservice5', etc..
Diagnostic Service
The setup for the Diagnostic Service is nearly identical to the Venue Service. Substitute the Diagnostic Service install file for the Venue Service install file in the above instructions.
Additional Firewall Exception
The Diagnostic service listens on UDP port 1776 by default for inbound reception reports. A firewall exception may need to be added for this port. If the client running locally on the diagnostic service system appears in diagnostic statistics, but remote clients do not, then the firewall exception likely needs to be added.
Additional Permissions for Diagnostic logging
If the diagnostic logging feature is enabled in the web.config file for the DiagnosticService, additional permissions will be needed.
Registry Permission:
To allow logging configuration to be persisted across diagnostic service restarts, create a registry key and give the application pool identity permission to write there. Permission problems for this case will appear in the system's Application event log. To resolve, be sure that the the identity used by the DiagnosticService application pool has permission to read and write registry values at the specified location.
- Run regedit as administrator
- Create HKEY_LOCALMACHINE\Software\CCT\DiagnosticService if it doesn't exist
- Add Full Control permission for "this key and subkeys" for the identity in use by the application, most likely "<local machine>\Network Service" or "IIS AppPool\DefaultAppPool".
File Permission:
By default the diagnostic service will write the log files to the web application directory in c:\inetpub\wwwroot\DiagnosticService. To allow the files to be created and written, add modify permission to the directory for the identity used by the Diagnostic Service application, most likely "<local machine>\Network Service" or "IIS AppPool\DefaultAppPool". If there is a file permission problem preventing the log files from being created, this will be logged as a warning in the system's application event log.
Archive Service
The Archive Service requires that Microsoft SQL Server be installed first. This can be SQL Server 2008, 2005 or 2000, or one of the free SQL Server Express editions.
To simplify deployment, you should configure the database to use a default (unnamed) instance. For ordinary SQL Server, this happens by default. Ironically, this is not the default for SQL Server Express, so be sure to select 'default' in the Instance Configuration screen of the Express Edition 2008 setup, or for 2005 Express Edition, follow these SQL Server Express installation instructions. Notice that there appears to be a bug in the SQL Server 2008 Express edition setup, prior to SP1 that causes it to create a named instance "SQLEXPRESS" even when Default Instance is selected.
Next, run the MSI installer that is appropriate for your architecture. The installer will offer to initialize the database. You should select Yes unless you have pre-existing archive data that you wish to preserve. Be aware that if SQL Server is installed at a non-standard location, you will see an error, and will need to manually build the database as described next.
Manually Building or Rebuilding the Database
First verify that setup found your database installation:
If the ConferenceXP Archive Service setup does not successfully find the SQL Server database directory, you will see an exception during setup. If you have problems building the database, check AddDatabase.sql in the Archive Service application directory (Default application directory location: "C:\Program Files\Center for Collaborative Technologies\ConferenceXP\ConferenceXP Archive Service 5.x"). You may need to edit the file, replacing two instances of the place holder string "MSSQLServerLocation" with the actual data directory path. For example, the default location for the default instance with SQL Server 2008 is:
C:\Program Files\Microsoft SQL Server\MSSQL10.MSSQLSERVER\MSSQL\DATA
For SQL Server Express edition 2008 prior to SP1:
C:\Program Files\Microsoft SQL Server\MSSQL10.SQLEXPRESS\MSSQL\DATA
When new versions of SQL Server are released, it is expected that they will use slightly different paths. After correcting/verifying, and saving your changes, proceed to manually build the database as described below.
To Manually Build the Database:
If you chose not to let the setup create the ArchiveService database, or if the database creation failed, you can manually create the database and the stored procedures. First be sure to log in to an account that has the required SQL Server permissions. Navigate to the ArchiveService application directory and run from the command prompt:
osql -E -i AddDatabase.sql -r -n osql -E -i AddSps.sql -r -n
Note that in some installation scenarios you may need to also specify the server in the osql command:
osql -S <local host name>\<sql server instance name> -E -i AddDatabase.sql
Caution: The AddDatabase script will delete any existing ArchiveService Database. If you have existing data you want to preserve, you should back it up before rebuilding the database.
Enable Archive Service to recognize a named instance of SQL Server 2005/2008
Open the Archive Service Application Directory and edit the AddDatabase.sql file as follows:
In the CREATE DATABASE ArchiveService section, for both Filename paths, change MSSQLServerLocation to the SQL Server Data folder, which is typically C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\DATA\. For example, change the following two lines:
FILENAME = N'MSSQLServerLocation\ArchiveService.mdf', FILENAME = N'MSSQLServerLocation\ArchiveService_log.ldf',
To:
FILENAME = N'C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\DATA\ArchiveService.mdf', FILENAME = N'C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\DATA\ArchiveService_log.ldf',
Where C:/Program%20Files/Microsoft%20SQL%20Server/MSSQL.1/MSSQL/DATA/ is the actual installation location.
Save the AddDatabase.sql file.
Edit the ArchiveAdmin.exe.config file and in the following key, specify the instance name for the datasource: For example, change:
<add key="MSR.LST.ConferenceXP.ArchiveService.SQLConnectionString" value="Data Source = .; Initial Catalog = ArchiveService; Integrated Security = SSPI; Pooling = false"/>
To:
<add key="MSR.LST.ConferenceXP.ArchiveService.SQLConnectionString" value="Data Source = .\InstanceName; Initial Catalog = ArchiveService; Integrated Security = SSPI; Pooling = false"/>
Where InstanceName is the instance name of your database.
Save the ArchiveAdmin.exe.config file.
Edit the ArchiveWindowsService.exe.config file, and uncomment the SQLConnectionString line under the <appSetting> key, and then specify the instance name for the datasource.
For example, change:
<add key="MSR.LST.ConferenceXP.ArchiveService.SQLConnectionString" value="data source=.;initial catalog=ArchiveService;integrated security=SSPI"/>
To:
<add key="MSR.LST.ConferenceXP.ArchiveService.SQLConnectionString" value="data source=.\InstanceName>;initial catalog=ArchiveService;integrated security=SSPI"/>
Where InstanceName is the instance name of your database.
Save the ArchiveWindowsService.exe.config file.
Use Osql.exe, a SQL Server tool, to create the ArchiveService database by doing the following: Open the Command Prompt window. At the command prompt, change the current directory to the C:\Program Files\Center for Collaborative Technologies\ConferenceXP\Archive Service directory. At the command prompt, type:
osql.exe –E –S .\InstanceName –i AddDatabase.sql osql.exe –E –S .\InstanceName –i AddSPs.sql
Where InstanceName is the instance name of your database. For SQL Server Express, the default instance name is SQLExpress.
Stop and then start the Archive Service.
Archive Service Database Settings
You can change the ArchiveService database initialization settings by editing the SQL script file, AddDatabase.sql, located in the Archive Service application directory, then using the scripts to rebuild the database. The default settings install the database on the C drive with a growth rate of 50 MB and a default size of 100 MB. We recommended that you restrict the growth rate to a small number of bytes, because the Archive Service must cache incoming data while SQL Server is growing the database. Setting the growth rate too high may result in losing data during recording.
Open the Archive Service application directory, which is located by default in C:\Program Files\Center for Collaborative Technologies\ConferenceXP\. Open AddDatabase.sql and make the changes you want for the location, growth rate, or size of the ArchiveService database, and then save the file. Then proceed to rebuild the database as described above.
Changing Archive Service configuration settings
You can change Archive Service settings, such as the TCP Listening port it listens on or the timeout setting, by editing the Archive Service configuration files, located in the <install location>\Center for Collaborative Technologies\ConferenceXP\Archive Service folder. After making changes to a configuration file, restart the Archive Service to make sure the new settings take effect.
Change the TCP Listening port
Open the ArchiveWindowsService.exe.config file and edit the value for the following key:
<add key="MSR.LST.ConferenceXP.ArchiveService.TCPListeningPort" value="8082"/>
Where 8082 is the default TCP listening port.
Save the file and restart the Archive Service.
Change the timeout value
Open the ArchiveAdmin.exe.config file, located in the Archive Service application directory and edit the value for the following key:
<add key="MSR.LST.ConferenceXP.ArchiveService.CommandTimeout" value="600"/>
Where 600 is the number of seconds that Archive Service waits for a response before timing out.
Save the file and restart the Archive Service.
Installing on Windows 7
The supported SQL Server editions for Windows 7 are 2008 SP1 and later. The earlier editions are not tested, and not likely to work.
Archive Service Known Issues
- There are possible message dialog boxes that may appear near the end of setup that may be hidden behind the main setup dialog making it appear as if setup has hung.
- Under some circumstances there are Windows Firewall exceptions needed which are not created automatically by the installer. The symptom is that conferences appear to archive correctly, but when playing back a conference, no streams appear in the lower "streams" panel. The workaround is to manually add a firewall exception: Open the Firewall Exceptions dialog, click "Add Program", and browse to: "C:\Program Files\Center for Collaborative Technologies\ConferenceXP\ConferenceXP Archive Service 5.0\ArchiveWindowsService.exe"
- If you placed your SQL data files in a location other than the default location, the database creation phase of the setup will fail. To create the database find the SQL script addDatabase.sql in the Archive Service application directory and edit the two lines as noted by the comment in the file to point to the actual location of your SQL data, then manually rebuild the database as described above.
Legacy Archive Service Setup Document
These instructions describe ConferenceXP 4.0 setup. [1].
Reflector
For all platforms, it suffices to open and run the reflector MSI file.
Reflector Service Known Issues
- Prior to ConferenceXP 5.1, Running ConferenceXP client and Reflector Service on the same system was not supported.
