The readme contains information, not included in the manuals or online help, on installing and using the current release of Version Manager. Additional information is available in KnowledgeBase articles available via your browser.
The Version Manager readme consists of the following files:
This readme file is organized into distinct parts. Please read the parts that correspond to the Version Manager components that you are using.
Part 1: Supported Platforms / System Requirements
Part 2: Version Manager CLI, Desktop Client, File Server, and PCLI
Part 3: Version Manager IDE Client
Part 4: Version Manager Web Client
Part 5: Version Manager WebDAV Server
Part 6: Copyright/Disclaimers/Support
Part 1: Supported Platforms / System Requirements |
O/S | 32-Bit CPU's | 64-Bit CPU's | Notes | ||||
---|---|---|---|---|---|---|---|
Pentium Class | AMD64 (x86_64) |
Itanium 2 (McKinley) |
PA-RISC | PowerPC | SPARC | ||
Windows XP Pro SP3 | C | - | - | - | - | - | 6 |
Windows 7 Ultimate/Enterprise/Professional SP1 | C | C | - | - | - | - | 2, 4 |
Windows 8 & 8.1 Enterprise/Professional | C | C | - | - | - | - | 2, 4 |
Windows 2003 Server R2 | S | S | - | - | - | - | 2, 4 |
Windows 2008 Server SP2 | S | - | - | - | - | - | |
Windows 2008 Server R2 SP1 | - | S | - | - | - | - | 2, 4 |
Red Hat Enterprise Linux 5.0 & 6.x | C S | C S | - | - | - | - | 1, 2, 4, 5 |
SuSE Linux 10, 10.1, 11, & 11.1 | C S | C S | - | - | - | - | 1, 2, 4, 5 |
HP-UX 11.23 & 11.31 | - | - | C | C S | - | - | 2, 3, 4, 5 |
AIX 6.1 & 7.x | - | - | - | - | C S | - | 2, 4, 5 |
Solaris 10 & 11 | - | - | - | - | - | C S | 2, 4, 5 |
Notes:
Legend: C = Client; S = Server; - = Not supported |
Optionally, you may use a supported third-party web server to access the servlets hosted on the Version Manager Web Server. This may be convenient if you have already configured a third-party web server and wish to use the existing front-end and HTTPS certificates with Version Manager.
NOTE
Version Manager does not require a third-party web server. By default, the Tomcat-based Version Manager Web Server will stand on its own.
A third-party web server does NOT take the place of Version Manager’s Tomcat implementation, but rather runs in addition to it.
Web Server | Notes | |||||
---|---|---|---|---|---|---|
Microsoft Internet Information Services 6.0 | 1, 5 | |||||
Microsoft Internet Information Services 7 | 4 | |||||
Microsoft Internet Information Services 8 | ||||||
Oracle iPlanet Web Server 7.0 | ||||||
Sun ONE Web Server 7.0 | ||||||
Sun Java System Web Server 6.1 & 7.0 | ||||||
Apache 2.0.54 - 2.2.x | 2, 6 | |||||
Tomcat 7.0.34 | 3 | |||||
Notes:
|
Browser | O/S | Notes |
---|---|---|
Chrome | Windows & UNIX\Linux | |
Firefox 10 and above (unless noted otherwise on the Serena Support Site) |
Windows & UNIX\Linux | 1, 2, 4, 5 |
Internet Explorer 8, 9 & 10 |
Windows | 2, 3 |
Notes:
|
JRE | Notes |
---|---|
Sun 1.7.0 | 1 |
Sun 1.6.0 | 1 |
Sun 1.5.0 | 1 |
Notes:
|
Large projects can exceed the memory allocated for Java in a variety of situations and with a variety of Version Manager interfaces. See "Out of Memory Error" or General Failure Operating on Large Projects in the Usage Cautions readme (usage_cautions.html) for information on setting the Java Heap Size for Version Manager clients.
In addition to Operating System requirements, the minimum system requirements are:
Client Systems – Minimum | |||
---|---|---|---|
Platform | Memory | CPU | Disk Space |
Win XP Pro | 128 MB | P400 | 140 MB |
Win Vista Biz | 128 MB | P400 | 140 MB |
Win Vista Ult | 128 MB | P400 | 140 MB |
Win Vista Ent | 128 MB | P400 | 140 MB |
Win 2003 Server | 128 MB | P400 | 140 MB |
Win 2008 | 128 MB | P400 | 140 MB |
In addition to Operating System requirements, the recommended system requirements are:
Client Systems – Recommended | |||
---|---|---|---|
Platform | Memory | CPU | Disk Space |
Win XP Pro | 256 MB | P550 | 140 MB |
Win Vista Biz | 128 MB | P550 | 140 MB |
Win Vista Ult | 128 MB | P550 | 140 MB |
Win Vista Ent | 128 MB | P550 | 140 MB |
Win 2003 Server | 256 MB | P550 | 140 MB |
Win 2008 | 256 MB | P550 | 140 MB |
Memory requirements for the server depend on how many users access the server at the same time and how many daemon processes are running (by default, 5 to 20 daemons are running). Use the formula in the table below to calculate your memory needs.
Server Systems | ||||
---|---|---|---|---|
Base | Concurrent Users | Daemons | Total | |
Formula | 256 MB | + 6 MB per user | + 8 MB per daemon | = ? |
Example | 256 MB | 6 x 100 = 600 MB | 8 x 20 = 160 MB | = 1016 MB |
NOTE: The example is for the case of 100 concurrent users and 20 daemon processes. It is included only to illustrate the use of the formula and is not intended as a recommendation.
You must enable Compatibility View in Internet Explorer 8 in order to use it with the Version Manager Web client. To do this:
In order to use IIS 7 as your Web server with Version Manager, you MUST select the Role Service ASP.NET and its dependent Role Services while setting up IIS 7. This is a mandatory step to use IIS 7.
If you are using IIS 6 on Windows 2003 Server, there is a little extra work you need to do to set up isapi-redirect.dll as a Web Service Extension File.
To run the Version Manager web server or Version Manager WebDAV Server, your Apache web server must include Dynamic Shared Object (DSO) support. To see if your web server includes DSO support, run the following command from Apache's bin directory:
./httpd -l
If mod_so.c is listed in the command's output, your Apache install includes DSO.
If your installation of Apache does not include DSO support, you must obtain one that does, compile your own Apache server to include DSO support (as detailed in the Apache 1.3 README.configure file or the Apache 2.0 INSTALL file, as found in Apache's source distribution), or use a different web server.
Installation of Version Manager on Linux, Solaris, HP-UX, and AIX uses a significant amount of space in the directory specified by $TMP (this data sticks around until you delete it), and temporarily places a significant amount of data in the VM_Install_Dir/VMverNum_inst directory (where verNum is the version number of the Version Manager release).
NOTE: About 170 MB of additional space is required to expand vm###unixpatch.tar so that it can be used; however, this data can be written anywhere on the network—or even to a CD-ROM.
The Version Manager Difference/Merge tool requires openmotif22 libraries. If they are not installed, you will get an error similar to: mgdiff: error while loading shared libraries: libMrm.so.3: cannot open shared object file.
Ensure that you have the libMrm.so.3 library installed to your system along with any dependent libraries. As an example, the required libraries for RedHat 5 can be obtained by installing the RPMs openmotif22-2.2.3-18.i386.rpm and libXp-1.0.0-8.1.el5.i386.rpm.
The 32-bit version of ActivClient 6.1, or newer, works with Version Manager CAC authentication on Windows. However, version 6.2, or newer, requires some extra setup steps on each client system. See the Serena PVCS Version Manager Installation Guide for more information.
NOTE The 64-bit version of ActivClient is not supported.
On Linux, ActiveClient 3.0 is supported.
Version Manager requires Serena License Manager 2.1.4.1 or newer.
Version Manager integrates with Serena TeamTrack 6.6.1; SBM 2009 R1.04, R2.01, R3, and R4.03; and SBM 10.1.
NOTE - SBM 2009 R4 or newer: As of SBM 2009 R4, there is no longer a link to the SourceBridge installer in the SBM web client. Contact your SBM administrator to obtain the correct SourceBridge installer for your SBM version.
Version Manager integrates with Serena Tracker 8.0.3. Note, the rich integrations to Eclipse and VisualStudio require TeamTrack or SBM.
Version Manager installs a private copy of Apache Tomcat 7.0.25 in support of the Version Manager File Server, Web Server, Meritage (WebDAV), and SSO authentication. This installation of Tomcat is designed to work with Version Manager. Version Manager will not work with a generic Tomcat installation. If you have other Tomcat installations, you should ensure that they are not using the same ports (8005, 8009, 8080, 8090, 8443, and 8444).
Version Manager installs Apache Axis2 version 1.5.5.
Part 2: Version Manager CLI, Desktop Client, File Server, and PCLI |
Before attempting to install Version Manager, review the Serena PVCS Version Manager Installation Guide for general information as well as specific scenarios that may apply to you. The following topics have been moved out of this readme file and into the Installation guide:
Disable Anti Virus Software Before Installing
Windows Requires Administrative Rights
Stop the Server before Upgrading
Remove the NT Service Before Upgrading
Upgrade Both Servers and Clients
Uninstall before Upgrading from Earlier Releases
Backup Configuration Files
Cleanup References to Obsolete File Servers
Do Not Use a Pre 8.4.4 Server.xml File
Preserve File Server Settings
Preserve Servlet Definitions
Location of ISLV.INI Differs Between Upgrade from 8.1 (or Older) and 8.2 (or Newer)
End-User Licensing on UNIX
See the Serena PVCS Version Manager Installation Guide for details.
This section briefly describes the differences between the release types. Each release type has a different number of digits in its release number:
X.X = Full Release: This is intended to be installed to a clean system (any previous Version Manager install should be uninstalled). In addition to newly developed features, enhancements, and fixes, it contains the enhancements and fixes of all the Patches and Hotfixes released since the previous full release.
TIP You can backup and restore certain configuration settings to ease setup of a full release. See the Serena PVCS Version Manager Installation Guide.
X.X.X = Patch: This must be installed to a system that already has a Full Release installed to it. In addition to newly developed enhancements and fixes, it contains the fixes of all the Hotfixes released since the previous patch.
X.X.X.X = Hotfix: This must be installed to a system that already has a Full Release installed to it. It contains a fix for a specific issue, or small group of closely related issues.
IMPORTANT! Download and review the latest edition of the Readme and the Serena PVCS Version Manager Installation Guide before installing.
If your LDAP server is configured to use Secure Sockets Layer (SSL) but there is not a certificate database in the VM_Install_Dir/vm/common/bin/OS directory or the database is missing the required SSL certificates, you will receive errors, such as:
"Failed to connect to LDAP server."
"You cannot access this project because your login account, UserName, is invalid ..."
See LDAP Connection/Authentication Fails in the Usage_Cautions.html readme file.
This error message may appear during installation if you chose to install the sample database. The error may also occur when you attempt to run a PCLI command; the desktop client and the PCLI may hang. This occurs if the local time zone is set to "Australia/Melbourne". It may also occur with other time zones.
You can work around this issue by specifying an equivalent time zone (different name, same time). Here are two methods of changing your time zone:
Use /usr/sbin/timeconfig (as root) to set a different time zone. Try one of the GMT time zones with the same offset as that of your time zone. This affects the entire system.
Define the TZ environment variable just in the shell that is used to launch the Version Manager desktop client or the PCLI. For example:
export TZ=GMT-9
To prevent an accidental hang by users who forget to set this variable, you could add the following as the second line in the file VM_Install_Dir/vm/linux/bin/pvcsvmdmn:
TZ=GMT-9; export TZ
If you want to install to a server using a path name that contains any directory names longer than eight characters, you may first need to map a network drive to that location and use the drive mapping to install Version Manager. If you do not use a drive mapping, an error message may appear stating that the path to the setup executable is invalid.
To prevent errors when installing or working from a network installation of Version Manager, make sure network path names do not contain directory names longer than eight characters.
Workstation installations of Version Manager may behave unpredictably if you are using Microsoft Novell Client drivers to access a Netware server. We recommend using Novell Netware Client drivers.
This is not a supported configuration.
When you install to the root of a UNC share, the installer indicates that zero space is required. The installer shows the required space correctly if you select a directory on the share. In either case, Version Manager will be correctly installed--provided you actually have enough disk space on the share.
To successfully install Version Manager, you need 450 MB of hard disk space on the drive containing Windows (150 MB for the CD-ROM installation) and 600 MB on your destination drive. If you delete temporary files created during installation, you will not need this amount of space once Version Manager is installed.
Set the following kernel parameters to allow the Version Manager web and file servers to work properly on HP-UX:
max_thread_proc 1000
maxfiles 2000
IMPORTANT: After setting the kernel parameters, you must rebuild the kernel.
Some UNIX platforms require patches before they will run the JRE as used by Version Manager. See http://knowledgebase.serena.com/InfoCenter/index?page=content&id=S137614. Else, see Serena support at http://support.serena.com and use the Advanced Search page to search for S137614.
Part 3: Version Manager IDE Client |
The Version Manager IDE client supports the following development environments:
IDE | IFC_SCC | SCC | RIDE | Notes |
---|---|---|---|---|
Adobe ColdFusion Studio 9.0 | X | |||
Eclipse 3.7 & 4.2 | X | X | ||
IBM Rational Application Developer 8.0 & 8.5 | X | X | 1 | |
IBM Rational Rose Enterprise 2002 | X | |||
IBM Rational Software Architect 7.5 | X | |||
Microsoft Visual Studio 2005 | X | X | X | |
Microsoft Visual Studio 2008 (SP1), 2010 (SP1), 2012 (SP4) | X | X | ||
Sybase PowerBuilder 11.5 & 12.5 (Classic) | X | 2 | ||
NOTES
|
IMPORTANT!
Eclipse/RAD: Before enhancing your installation of Eclipse/RAD with additional Eclipse framework applications, first install Eclipse/RAD and the Version Manager Rich IDE Plug-in and ensure that it works correctly. If you experience a problem after installing additional Eclipse framework applications, you will know it is an issue with the additional software rather than with Eclipse itself or the integration between Version Manager and Eclipse.
Eclipse RIDE on SuSE Linux: There is a dependency upon the library libexpat.0.so. Your SuSE installation probably has a newer version of this file, for example libexpat.1.so. Unfortunately there are several third-party libraries that depend upon the older version of the file. To avoid sporadic crashes, you must download and install a compact pack specific to your operating system in order to acquire the needed version of libexpat0. See http://rpm.pbone.net/index.php3/stat/3/srodzaj/1/search/libexpat.so.0
IFC_SCC/COM/Web Integrations: See the Supported Web Servers table for the versions of Microsoft Internet Information Services supported by the IDE COM/Web integration.
The Version Manager IDE client is certified for use with Serena TrackerLink 6.5 and above. However, Tracker 6.6 or later is required for the "Clean up associations on undo checkout" feature.
If you are using an old version of the Java Runtime Environment (JRE), the Eclipse Issue view may not display reports and issues due to a TeamTrack authentication problem exhibited with versions of the JRE prior to 1.4.2_06
The Linux version of the rich integration to Eclipse does not work correctly if the TeamTrack server is using NTLM authentication. One can still submit issues, but no issues are visible via the Active Issues or IDE Folder view.
To avoid this issue, do not to use NTLM authentication when the integration clients are on a non-windows platform. If you must use NTLM, set up an external virtual directory on the TeamTrack/IIS server.
Using Single Sign On with versions of Eclipse prior to 3.5 may still require that you login to TeamTrack when opening an issue from inside Eclipse RIDE.
The Serena Issues view will incorrectly display Japanese characters unless it is used with TeamTrack 6.3 or newer.
Visual Studio may crash when you open a solution that is under source control and contains an XDE model. This appears to be related to XDE loading an older version of the JRE.
Before attempting to install Version Manager, review the Serena PVCS Version Manager Installation Guide for general information as well as specific scenarios that may apply to you. The following topics have been moved out of this readme file and into the Installation guide:
Run Visual Studio at Least Once Before Installing the Integration
See the Serena PVCS Version Manager Installation Guide for details.
The Version Manager plug-in does not work with Rational Application Developer 7.0.0.0. During the RAD install, you can choose to update the install. Please ensure that you install Rational Application Developer 7.0.0.2 or newer.
To use a new version of the Version Manager IDE client, you must uninstall any previous version of the IDE client on your system before installing the new version. If you wish to use an older version of the IDE client once the new version is installed, you must uninstall it before installing the older software.
If Serena TrackerLink is installed to your system, it remains the active source control provider after you install the IDE client.
To use the IDE client with TrackerLink:
Exit any open IDEs.
Select TrackerLink from the Serena Tracker program group in your Start menu. The Serena TrackerLink dialog box appears.
Select Serena PVCS Version Manager from the SCC Provider drop-down list.
Click the Activate button. The change will take effect the next time you start your IDE.
To use the IDE client without TrackerLink:
Exit any open IDEs.
Select Serena | Serena PVCS Version Manager | Version Manager IDE Client | Select Serena Provider from the Windows Start menu. The Select Serena Provider dialog box appears.
Select Serena PVCS Version Manager.
Click OK. The change will take effect the next time you start your IDE.
If you currently use TrackerLink with SCC IDEs and wish to use SourceBridge (TeamTrack) instead, change your SCC provider from TrackerLink to Version Manager before installing SourceBridge. SourceBridge will then set itself as the SCC provider and pass SCC information on to Version Manager.
To set the SCC provider, launch the Version Manager SCC Admin. For details, see the Serena PVCS Version Manager IDE Client Implementation Guide.
If you install SourceBridge while TrackerLink is still set as the SCC provider, SourceBridge will try to use TrackerLink as the SCC provider. Source control will not work.
To correct this, set the SCC provider in the System Settings tab of the SourceBridge dialog box. For details, see the "About Setting Up SourceBridge" section of the Serena PVCS Version Manager Administrator's Guide.
Workaround: Reboot to update your system's path information.
Part 4: Version Manager Web Client |
Before attempting to install Version Manager, review the Serena PVCS Version Manager Installation Guide for general information as well as specific scenarios that may apply to you. The following topics have been moved out of this readme file and into the Installation guide:
Disable Anti Virus Software Before Installing
Windows Requires Administrative Rights
Stop the Server before Upgrading
Remove the NT Service Before Upgrading
Uninstall before Upgrading from Earlier Releases
Backup Configuration Files
Do Not Use a Pre 8.4.4 Server.xml File
Preserve Servlet Definitions
UNIX: Browser Location Must Be Added to Path
Configuring a Different Web Server Post Install
Using TrackerLink with SSL
See the Serena PVCS Version Manager Installation Guide for details.
If the applet is not completely removed, there may be unusual behavior after you install a different version. Follow these steps to remove the applet:
In <Windows Dir>\Downloaded Program Files, right-click the VM I-Net applet, and remove it.
Remove <Windows System Dir>\vmi660.dll.
Remove <Windows Dir>\Java\lib\vmi660.zip.
In the registry editor, remove the following entry:
HKEY_CLASSES_ROOT\CLSID\{CCF028C4-4631-11D3-90BD-00A0C9B727E1}
In <Windows Dir>\Downloaded Program Files, right-click the VM I-Net applet, and remove it.
Remove <Windows System Dir>\vmi660.dll.
Remove <Windows Dir>\Java\lib\vmi660.jar.
In the registry editor, remove the following entry:
HKEY_CLASSES_ROOT\CLSID\{CCF028C4-4631-11D3-90BD-00A0C9B727E1}
Newer versions of the Web client can co-exist with multiple versions on the same system (which is convenient if you must access servers running different versions of Version Manager).
You can remove newer applet versions via the Version Manager Web Client Configuration page of the Web client (http://YourServer:Port/vminet_install.html). For information on its use, see its help page or the Serena PVCS Version Manager Web Client User's Guide.
To access the web client, you must disable the Protected Mode option in Internet Explorer on newer versions of Windows. To do so, you can either double click on the Protected Mode On status message from the Internet Explorer status bar or select Tools | Internet Options | Security and clear the Enable Protected Mode checkbox.
This is not a supported configuration.
To start iPlanet Web Server on Pentium IV servers, you must disable internal servlet support. From the iPlanet Web Server Administration page, select a server to manage. Select the Servlets tab, and then select the No option under Activate the Servlet Engine.
Internet Explorer 8 and 9 support is provided in single process mode. To enable single process mode, create the following registry entry:
HKCU\Software\Microsoft\Internet Explorer\Main - TabProcGrowth
And set the value of the dword to: 1
Once installation of the Version Manager Web Client is complete, you can delete the Serena PVCS Version Manager MSI file if disk space is a consideration. The file is typically located in a folder named "C:\Windows\Downloaded Installations" and is around 110 MB.
After you delete the file, you can still use Add/Remove Programs to modify or remove Version Manager.
NOTE: If you are using IIS 6 on Windows 2003 Server, there is a little extra work you need to do to set up isapi-redirect.dll as a Web Service Extension File. See IIS 6 on Windows 2003 Server Requires Extra Setup.
To run Version Manager web or Version Manager WebDAV Server, your Apache web server must include Dynamic Shared Object (DSO) support. To see if your web server includes DSO support, see the topic in the Supported Platforms / System Requirements section.
Part 5: Version Manager WebDAV Server |
Version Manager works with the following WebDAV clients:
NOTE:
Before attempting to install Version Manager, review the Serena PVCS Version Manager Installation Guide for general information as well as specific scenarios that may apply to you. The following topics have been moved out of this readme file and into the Installation guide:
Disable Anti Virus Software Before Installing
Windows Requires Administrative Rights
Stop the Server before Upgrading
Remove the NT Service Before Upgrading
See the Serena PVCS Version Manager Installation Guide for details.
To run Version Manager web or Version Manager WebDAV Server, your Apache web server must include Dynamic Shared Object (DSO) support. To see if your web server includes DSO support, see the topic in the Supported Platforms / System Requirements section.
Part 6: Copyright/Disclaimers/Support |
To contact Serena support, please log in at support.serena.com.
Serena recognizes that virtualization technology provides significant utility and value to our customers. As such, Serena conducts functional testing and certifies our products using virtualization technology in addition to native environments. While Serena expects that our products will function properly when running on supported platforms in a virtualized environment as well as a native environment, there may be functional and performance limitations. Serena will not require that customers recreate and troubleshoot every issue in a non-virtualized environment, however there may be circumstances in which such action may be required. Serena will only make this request when there is reason to believe that the virtualized environment is a contributing factor to the issue. If the issue cannot be reproduced in a supported non-virtualized environment, customers will need to refer their issues to their virtualization vendor.
The following disclaimers are provided on behalf of third party components used by and distributed with the Version Manager web server, Version Manager File Server, and WebDAV Server. Please see the Serena PVCS Version Manager documentation for acknowledgements, and individual LICENSE files for additional information, regarding any third party components.
THE JAVA RUNTIME ENGINE, TOMCAT AND XERCES JAVA PARSER (THIS SOFTWARE) IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN MICROSYSTEMS, OR THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DocuComp® comparison technology licensed from ASI Software.
Portions of the software, DocuComp® comparison © 2004 ASI Software, Inc. All rights reserved.
This product includes software developed by
The Apache Software Foundation (http://www.apache.org/).
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)
Portions © Copyright 2006 Microsoft Corporation. Al Rights Reserved.
Portions © Copyright 1996, 1999 International Business Machines Corporation and others. All Rights Reserved.
Portions © Copyright Intalio Inc. and others. All Rights Reserved.
Portions © Copyright eHelp Corporation. All Rights Reserved.
Portions © Copyright Digia Plc. All Rights Reserved.
End Readme
Copyright © 2003–2013 Serena Software, Inc. All rights reserved.