Table of Contents
The VCDS Installation Guide walks you through the steps necessary to install all three components of VCDS: the server, the client, and the agent.
VCDS may be installed in a mixed operating system environment. The server and client may be installed on Windows™, Solaris™, HP-UX, or Linux. However, the agents must be installed on the same machines as the NETeXPERT systems you wish to register with VCDS.
If installing the server on Solaris, it is recommended that you create a VCDS user and install the server in that user’s home directory. You may also wish to install the client in that user’s home directory for shared access among all users. Multiple users could launch the client from that single location.
When the VCDS server is started for the first time, a set of working/temp directories is created. On Solaris installations, these directories have read/write access only for the user that first started the server. This will cause problems starting the server if another user attempts to start the server.
Regardless of the agent installation location, the agent MUST be launched by the VSM user for the system which the agent represents, with the appropriate VSM environment sourced.
Note: DO NOT install the server, agent or client as the root user. After installing the server, it must be started by the user who installed it.
The Concurrent Versioning System (CVS) must be installed and a working directory defined prior to the installation of VCDS. The CVS PSERVER function must be available, as it is utilized by VCDS.
The CVS working directory is a directory located on the server host. It is where working copies of files are checked out. The VCDS server interacts with these files.
All VCDS users must have permissions to write to the CVS repository.
CVS is open source code freely available at several web sites. One such site is run by the GNU project at http://directory.fsf.org/devel/vc/. It is recommended you also download the CVS reference manual by Per Cederqvist et al.
This section walks you through the steps necessary to install the VCDS server. The server is the backbone of VCDS. The VCDS server:
provides the means for clients to communicate with NETeXPERT systems
manages the CVS repository
manages the NETeXPERT objects (events, methods, dialogs) in VCDS
Note: Before installing the VCDS server, an Oracle database user must be created. See Chapter 5, Appendix for more details.
Navigate to the location of your installation binary and launch it. (You may need to change permissions on the file.) The name of the binary is nxvcdsServer_X.X.X_win.exe for Windows platforms and nxvcdsServer_X.X.X_os.bin for *nix platforms, where X.X.X is the release version of the server and os is the operating system abbreviation (i.e. sol, hp, linux). After launching the installer, an InstallAnywhere progress meter is displayed, followed by a Longview Software splash screen, and finally ending with the Introduction screen as shown below. Click NEXT to proceed to the Choose Install Folder screen.
NOTE: The VCDS server MUST be installed on the host where your CVS working directory is located.
Choose your installation destination. The default location for Windows systems is C:\Program Files\Longview Software\NETeXPERT Version Control and Distribution System Server , and the default location for *nix systems is ~/vcdsServer . Click NEXT when you are ready to proceed to the Database Information screen.
Select a Complete or Custom installation. The default setting is Complete, which installs all server modules: event, method, dialog, and VCS.
Selecting Custom displays the window below. Select only the modules you wish to install for version control.
NOTE: As stated above, before proceeding with this step, a VCDS database user must be created. See Chapter 5, Appendix for more details.
On the Database Information screen, enter the information for your VCDS database instance. Following is the list of required values and what they represent:
Host - the host name or IP address of your VCDS database host.
Port - the port number for your VCDS database.
Oracle SID - the SID for your VCDS database instance.
User - the username for your VCDS database instance.
Password - the password for your VCDS database instance.
Click NEXT when you are ready to proceed to the Choose Workspace Directory screen.
On this screen, enter the information for the host where the CVS repository is located. The PSERVER function is used to establish a connection to a remote repository. CVSROOT is the directory where the CVS repository is located. Enter the full path to the repository. Click NEXT when you are ready to proceed to the Pre-Installation Summary screen.
Note: The password is encrypted prior to being written to the configuration files.
On the Pre-Installation Summary screen, please verify that all installation information is correct. If you notice any errors, please use the PREVIOUS button to navigate back to the screen where you can fix the error. Click the NEXT button to view the second Pre-Installation Summary screen. If all installation information looks correct, please click INSTALL to begin the installation. You will see a status screen while the installation is in progress.
This section walks you through the steps necessary to install the VCDS client.
Navigate to the location of your installation binary and launch it. The name of the binary is nxvcdsClient_X.X.X_win.exe for Windows platforms and nxvcdsClient_X.X.X_os.bin for *nix platforms, where X.X.X is the release version of the client and os is the operating system abbreviation (i.e. sol, hp, linux). After launching the installer, an InstallAnywhere progress meter is displayed, followed by a Longview Software splash screen, and finally ending with the Introduction screen as shown below. Click NEXT to proceed to the Choose Install Folder screen.
Choose your installation destination. The default location for Windows systems is C:\Program Files\Longview Software\VCDS Client , and the default location for Unix systems is ~/gcClient . Click NEXT when you are ready to proceed to the Choose Shortcut Folder screen.
The Choose Shortcut Folder screen provides you with a set of radio buttons to specify where client executable shortcuts should be installed. Please choose the option that satisfies your preferences and click NEXT when you are ready to proceed to the VCDS Server Location screen.
Select a Complete or Custom installation. The default setting is Complete, which installs all client modules: event, method, dialog, and VCS.
Selecting Custom displays the window below. Select only the modules you wish to install for version control.
On this screen, specify the network location of your VCDS server installation. Following is the list of required values and what they represent:
Host - the host name or IP address of your VCDS server.
Port - the port on which the VCDS server listens. The default setting 1099 should not need to be changed.
Click NEXT when you are ready to proceed to the Pre-Installation Summary screen.
On the Pre-Installation Summary screen, please verify that all installation information is correct. If you notice any errors, please use the PREVIOUS button to navigate back to the screen where you can fix the error. If all installation information looks correct, please click INSTALL to begin the installation. You will see a status screen while the installation is in progress.
This section walks you through the steps necessary to install the VCDS agent. For VCDS, the agent is responsible for communicating commands initiated by the server and client to the NETeXPERT system on which it is installed and running.
Navigate to the location of your installation binary and launch it. The name of the binary is nxvcdsAgent_X.X.X_os.bin, where X.X.X is the release version of the agent and os is the operating system abbreviation (i.e. sol or hp). After launching the installer, an InstallAnywhere progress meter is displayed, followed by a Longview Software splash screen, and finally ending with the Introduction screen as shown below. Click NEXT to proceed to the Choose Install Folder screen.
Choose your installation destination. The default location is ~/nxAgent . Click NEXT when you are ready to proceed to the Gateway Central Server Location screen.
On this screen, specify the network location of your VCDS server installation. Following is the list of required values and what they represent:
Host - the host name or IP address of your VCDS server.
Port - the port on which the VCDS server listens The default setting 1099 should not need to be changed.
Click NEXT when you are ready to proceed to the Agent Identity screen.
The agent allows you to supply a unique identification string. This is used as part of the name that the agent registers with ipmh and will help if you need to run multiple agents against a single VSM system.
If you are running multiple agents against the same VSM system, you can uniquely name this agent installation. On the Agent Identity screen, enter an identifier name for the agent. This can be any name you wish. For example, if this agent is sending data to VCDS, you may choose to name it vcds. This identifier is written to the startAgent script along with other start parameters. By creating additional startAgent scripts with unique identifiers, you can start multiple agents from a single agent installation. To learn more about this, please refer to the VCDS Administration Guide .
Click NEXT when you are ready to proceed to the Pre-Installation Summary screen.
On the Pre-Installation Summary screen, please verify that all installation information is correct. If you notice any errors, please use the PREVIOUS button to navigate back to the screen where you can fix the error. If all installation information looks correct, please click INSTALL to begin the installation. You will see a status screen while the installation is in progress.
VCDS NETeXPERT modules require the creation of a table, stored procedure, and several triggers in the VSM database. Check the Install Database Triggers checkbox and click the NEXT button to install these.
If you fail to install these triggers during the agent install, you can install them later using the installDbOps.sh script located in the <agent install dir>/script directory.
Note: Be sure to have the correct NETeXPERT environment sourced when running this script.
Before installing the VCDS server, an Oracle database user must be created. This is a new user separate and distinct from any of your VSM database users. All database tables are created automatically by the server the first time it is started.
During installation, you are asked about the name and location of this Longview Software Server database.
VCDS makes minimal use of the database, thus size requirements are modest.