Solutions

How to preserve Path Map settings and the VM I-Net applet configuration when upgrading Version Manager or moving to a different server



ID:    S138232
Published:    29 June 2011
Updated:    07 June 2021

Operating System(s)

  • All Unix
  • All Windows

Product(s)

  • PVCS Version Manager
 

Description

Use the following steps to retain your Path Maps and VM I-Net Web Client servlet definitions when upgrading from PVCS VM 8.5.3 and older, or when moving to another machine.
 
As of VM 8.6.1, Version Manager supports in-place upgrades from VM 8.6.0 and newer, but the instructions in this document can still be used to transfer data to another machine.

Resolution

Back Up Configuration Files

It is a good idea to save a backup copy of the following files:
 
Install_Dir\vm\common\bin\pvcsstart.bat (pvcsstart.sh on UNIX)
Install_Dir\vm\common\tomcat\conf\jk\uriworkermap.properties (Windows only; no longer necessary as of VM 8.6.1)
Install_Dir\vm\inet\props\* (VM I-Net servers only)
Install_Dir\vm\common\tomcat\webapps\vminet\WEB-INF\web.xml (VM I-Net servers only)
Install_Dir\vm\common\tomcat\webapps\serenafs\WEB-INF\server-config.wsdd (VM File Servers only)
Install_Dir\vm\common\tomcat\webapps\*.dav (WebDAV servers only)
 

Preserving File Server Settings

To preserve all user-configurable settings of the File Server, including the Path Maps, you can copy the relevant information from your old server-config.wsdd. The file is located at:

Install_Dir\vm\common\tomcat\webapps\serenafs\WEB-INF\server-config.wsdd
 
Copy only the section marked by the following tags:
 
<globalConfiguration>
...
</globalConfiguration>

Paste the copied section into the similar section in the new file.
 
CAUTION! Do NOT replace an entire server-config.wsdd file with one from a different version of Version Manager. Doing so can cause problems, for example compromising new features added to support RIDE performance improvements.

Preserving Servlet Definitions: Windows

  • To preserve the Servlets definitions and the end-user preferences in the Web Client (Edit | Options and Filter), backup and copy the entire VM_Install_Dir\vm\inet\props folder.
  • To just preserve the Servlet definitions, only copy the file VM_Install_Dir\vm\inet\props\PVCSServlets.properties to the newly installed Version Manager release.
 
IMPORTANT! If the servlets were configured to use a Version Manager File Server, you must reconfigure or restore the File Server path map definitions BEFORE proceeding to the next step.
 
Next, launch the Version Manager Application Server Admin utility (vpadmin) and make sure the "Location of Netscape Configuration Files" and/or "Location of Microsoft IIS Scripts Directory" matches the desired location for the new server installation (as they too will be inherited from PVCSServlets.properties). If the servlets were configured to use a Version Manager File Server, start the File Server. Finally, go to the Servlets tab, select the first servlet from the list, click Modify and then click Apply.

Preserving Servlet Definitions: Linux, if configured with vpadmin

  • To preserve the Servlets definitions and the end-user preferences in the Web Client (Edit | Options and Filter), backup and copy the entire VM_Install_Dir/vm/inet/props folder.
  • To just preserve the Servlet definitions, only copy the file VM_Install_Dir/vm/inet/props/PVCSServlets.properties to the newly installed Version Manager release.
 
IMPORTANT! If the servlets were configured to use a Version Manager File Server, you must reconfigure or restore the File Server path map definitions BEFORE proceeding to the next step.
 
Next, launch the Version Manager Application Server Admin utility (vpadmin). If the servlets were configured to use a Version Manager File Server, start the File Server. Finally, go to the Servlets tab, select the first servlet from the list, click Modify and then click Apply.
 

Preserving Servlet Definitions: UNIX & Linux without vpadmin

To preserve the end-user preferences in the Web Client (Edit | Options and Filter), backup and copy the entire VM_Install_Dir\vm\inet\props folder.
 
To preserve your Servlet definitions, backup the web.xml file and copy relevant information into the new file. The location of this file depends on the Version Manager release:
 
  • In VM 6.8.1 and newer the file is located at:
    VM_Install_Dir/vm/common/tomcat/webapps/vminet/WEB-INF/web.xml

  • In VM 6.8.0 the file is located at:
    VM_Install_Dir/vminet/tomcat/webapps/vminet/WEB-INF/web.xml

  • Servlets defined in UNIX Version Manager Server releases prior to 6.8.00 (using the servlets.properties file) cannot be preserved.
 
 
CAUTION! In the following procedure, do NOT copy the <servlet> ... </servlet> section that contains <servlet-name> "vminet". Also, do NOT modify any <servlet-mapping> values that refer to the "vminet" servlet.
 
After installing the new version, copy the sections from <servlet> up to and including </servlet> for every servlet referring to a project database that was added to the old web.xml file, and paste them into the new web.xml file (which can be found at VM_Install_Dir/vm/common/tomcat/webapps/vminet/WEB-INF/web.xml).

When upgrading to VM 8.6.1 or newer, add the directive <async-supported> true </async-supported> to every copied <servlet> ... </servlet> section.
 
The two <servlet-mapping> ... </servlet-mapping> sections that exist for every one of these servlets should also be copied into the new web.xml file.
 
Example of the sections that should be copied for a servlet, with the async-supported directive that is required for VM 8.6.1+ added in bold:

In the servlet section of web.xml:

<servlet>
    <servlet-name> SampleDB </servlet-name> <description> Sample Serena PVCS Version Manager project </description> <servlet-class> pvcs.vm.
servlet.VmServlet </servlet-class>
    <init-param> <param-name> rootPath </param-name> <param-value> /usr/serena/vm/common/sampledb </param-value> </init-param>
    <init-param> <param-name> serverName </param-name> <param-value> or-rgering-el7 </param-value> </init-param>
    <init-param> <param-name> logtimeout </param-name> <param-value> 15 </param-value> </init-param>
    <init-param> <param-name> DateTimeFormat </param-name> <param-value>  </param-value> </init-param>
    <init-param> <param-name> defaultPassword </param-name> <param-value> ! </param-value> </init-param>
    <load-on-startup> 0 </load-on-startup>
    <async-supported> true </async-supported>
</servlet>


In the servlet-mapping section of web.xml:

<servlet-mapping>
    <servlet-name> SampleDB </servlet-name> <url-pattern> /SampleDB/* </url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name> SampleDB </servlet-name> <url-pattern> /SampleDB </url-pattern>
</servlet-mapping>

 
Finally, if you are upgrading to VM 8.6.1+, add the following in-between the servlets section and the servlet-mapping section, if it is not already there:
 
<!-- users's section start -->
<filter>
    <filter-name>ExpiresFilter</filter-name>
    <filter-class>org.apache.catalina.filters.ExpiresFilter</filter-class>
    <async-supported>true</async-supported>
    <init-param>
        <param-name>ExpiresByType image</param-name>
        <param-value>A86400</param-value>
    </init-param>
    <init-param>
        <param-name>ExpiresByType text/css</param-name>
        <param-value>A86400</param-value>
    </init-param>
    <init-param>
        <param-name>ExpiresByType application/javascript</param-name>
        <param-value>A86400</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>ExpiresFilter</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
</filter-mapping>
<!-- users's section end -->
 

Preserving WebDAV Settings

To preserve the WebDAV servlets, copy all directories matching the following pattern the target machine:

Install_Dir\vm\common\tomcat\webapps\*.dav

Although WebDAV servlet directories usually have a *.dav extension, it is possible for them to have different names as that is was entirely up to the VM administrator who installed it. If you are not sure whether there are WebDAV servlets using non-standard names, look for directories containing WEB-INF\lib\webdav.jar.  Example:

Install_Dir\vm\common\tomcat\webapps\MyWebDAV\WEB-INF\lib\webdav.jar

If found, copy that directory as well (in this example Install_Dir\vm\common\tomcat\webapps\MyWebDAV).
 

Remove the NT Service Before Upgrading (Version Manager File Server, Web Server, or WebDAV Server) [REQUIRED]

If the Version Manager Application Server is installed as an NT Service, you must remove the service before upgrading.

To remove the service, perform the following steps:
1.    Launch the Version Manager Application Server Configuration utility from the Serena submenu of the Start menu.
2.    Click the Remove NT Service button.
3.    Restart the computer
 

Uninstall Before Upgrading from Earlier Versions

If you plan to install Version Manager in the same location as a previous version, you must uninstall it before upgrading. The Sample Database may remain, but all other files should be removed. Failure to perform these uninstall tasks may cause conflicts when you upgrade.
 
  • This applies to full releases prior to VM 8.6.1 only, not to patches.
  • Before uninstalling, ensure that the Version Manager Web Server and your web server (IIS or Apache) are NOT running.

NOTES:
  • Prior to changing any file in your new VM install, please back up the new versions with a ".org" extension.
  • If circumstances prevent you from completing both the server and client upgrades before work must resume, complete the server upgrades before resuming work. You are less likely to encounter problems when running old clients against new servers than when running new clients against old servers. Neither is recommended practice, but running old clients against new servers is less likely to present problems.

 


Rate this Solution

Find Answers

Type a question or describe what you are looking for below

My Recent Searches

Welcome kb sso

Additional Assistance

  • Submit a Case Online
  • FAQs