Installing and Uninstalling Adabas Directory Server on Linux, UNIX and Windows

The Adabas Directory Server is installed using the Software AG Installer. It does not require a license key.

You can download the Software AG Installer from the Software AG Empower website at https://empower.softwareag.com/.

This document provides product-specific instructions for installing the Adabas Directory Server. It is intended for use with Using the Software AG Installer, which explains how to prepare your machine to use the Software AG Installer and how to use the Software AG Installer and Software AG Uninstaller to install and uninstall your products. The most up-to-date version of Using the Software AG Installer is always available in the webMethods product documentation area of the Software AG documentation web site on Empower.

This document covers the following topics:


Installation Overview

This product is installed using the Software AG Installer, which you can download from the Software AG Empower website at https://empower.softwareag.com/.

The Adabas Directory Server can be installed without installing any other Software AG products; it is not grouped with any other product. However, a Directory Server must already be installed before you attempt any other Adabas family product installations that require the Directory Server; the Directory Server installation location is requested during the installation of many Adabas family products.

If you have a Directory Server already installed at your site from an earlier release of Software AG products, you do not need to install it again; your new products can use the existing installation instead.

The Directory Server must be installed on a machine in your network that can be accessed by all machines where Entire Net-Work will be installed (both Entire Net-Work Server and Entire Net-Work Client). It should be installed on a dedicated system that is operational 24 hours a day, with a UPS.

We recommend that you install one Directory Server for use with all the Software AG products that require it.

System Requirements

This section describes the system requirements of Directory Server.

Supported Operating System Platforms

Software AG generally provides support for the operating system platform versions supported by their respective manufacturers; when an operating system platform provider stops supporting a version of an operating system, Software AG will stop supporting that version.

For information regarding Software AG product compatibility with IBM platforms and any IBM requirements for Software AG products, please review the Product Compatibility for IBM Platforms web page.

Before attempting to install this product, ensure that your host operating system is at the minimum required level. For information on the operating system platform versions supported by Software AG products, complete the following steps.

  1. Access Software AG's Empower web site at https://empower.softwareag.com.

  2. Log into Empower. Once you have logged in, you can expand Products & Documentation in the left menu of the web page and select Product Version Availability to access the Product Version Availability screen.

  3. Use the fields on the top of this screen to filter its results for your Software AG product. When you click the Search button, the supported Software AG products that meet the filter criteria are listed in the table below the filter criteria.

    This list provides, by supported operating system platform:

    • the Software AG general availability (GA) date of the Software AG product;

    • the date the operating system platform is scheduled for retirement (OS Retirement);

    • the Software AG end-of-maintenance (EOM) date for the product; and

    • the Software AG end-of-sustained-support (EOSS) date for the product.

Note:
Although it may be technically possible to run a new version of your Software AG product on an older operating system, Software AG cannot continue to support operating system versions that are no longer supported by the system’s provider. If you have questions about support, or if you plan to install this product on a release, version, or type of operating system other than one listed on the Product Version Availability screen described above, consult Software AG technical support to determine whether support is possible, and under what circumstances.

Supported Hardware

For general information regarding Software AG product compatibility with other platforms and their requirements for Software AG products, visit Software AG's Hardware Supported web page.

Space Requirements

The following table displays the minimum disk space requirements on Windows and Linux systems for various Adabas LUW and Entire Net-Work LUW products, including the Adabas Directory Server:

Product Space Requirement
Entire Net-Work Client 25 MB
Entire Net-Work Server 30 MB
Adabas Directory Server 20 MB

Windows Requirements

In Windows environments, be sure to install Microsoft Visual Studio 2008 Redistributable Package.

Firewall Requirements

If you attempt to install and use this software in a system with a firewall in place, be sure that your system administrator has set up the firewall so that the component applications can access the ports they need (including the Adabas Directory Server port and any ports Entire Net-Work dynamically assigns during its own processing). For more information about port usage, read the Port Number Reference found elsewhere in this documentation.

Configuration Considerations

This section describes configuration issues you should consider before you install the Adabas Directory Server.

How Many Directory Servers Should You Install?

If a Directory Server is not installed in your enterprise, you must install one when you install any Software AG product that requires it, such as Entire Net-Work. If a Directory Server is already installed in your enterprise, you do not need to install another, although you may if you wish.

Note:
We recommend that you use only one Directory Server for all Software AG products that require it.

Where Should You Install the Directory Server?

Although you can install the Directory Server on the same machines as your other Software AG products, Software AG does not recommend it. There are two reasons for this recommendation:

  1. Your system performance could be impacted.

  2. In Windows environments, problems will arise if the services for Software AG products that require the Directory Server are started before the Directory Server service. The Directory Server service must be started first. We recommend, therefore, that the Directory Server be installed on a stable machine that is not frequently rebooted, and separate from your other Software AG products.

Before You Begin

Before you begin installing this product, ensure that the following prerequisites have been met:

  1. Software AG strongly recommends that you create an installation image of your existing Software products and store the image on your internal network. You should create an image for each operating system on which you plan to run the installation (for example, 32-bit, 64-bit, or both). This will help you reduce WAN traffic and speed up installation and will ensure consistency across installations over time, since the Software AG Installer provides only the latest release of each product.

  2. Close (stop) all open applications, especially those applications interacting with or depending on your Adabas databases. This includes Natural, Adabas Manager, the Adabas DBA Workbench, and prior releases of any other Adabas products. To be on the safe side, also shut down all Software AG services.

    Important:
    For some Software AG products, the Software AG Uninstaller will not be able to remove key files that are locked by the operating system if the associated Software AG products are not shut down.

  3. Disable any antivirus software.

  4. Ensure the target computer is connected to the network.

  5. If this product requires a license key file, verify the license key file is copied somewhere in your environment . Products requiring license key files will not run without valid license keys. For more information, read The License Key, elsewhere in this section.

  6. Verify your environment supports the system requirements for this product, as described in System Requirements, elsewhere in this section.

Installation Steps

The Adabas Directory Server is installed using the Software AG Installer. This installation documentation provides a brief description on how to install the Directory Server directly on the target machine using the installer wizard. For detailed information on the installer wizard, read Using the Software AG Installer.

Note:
Read Using the Software AG Installer also if you want to use console mode, or if you want to install using an installation script or installation image.

Start of instruction setTo install the Adabas Directory Server, complete the following steps:

  1. Start the Software AG Installer as described in Using the Software AG Installer.

  2. When the first page of the Software AG Installer wizard (the Welcome panel) appears, choose the Next button repeatedly, specifying all required information on the displayed panels, until the panel containing the product selection tree appears.

    All Adabas-related products (including Adabas Directory Server) can be selected for installation within the Adabas Family product selection tree.

    Note:
    The Infrastructure tree and required components therein is automatically selected for all Software AG product installations.

  3. To install the Directory Server, select (check) the Adabas Directory Server entry from the Adabas Family product selection tree.

    Note:
    You can opt to install other Software AG products from this list at the same time. This section just describes the installation of the Directory Server.

  4. On the License panel, read the license agreement and select the check box to agree to the terms of the license agreement and then click Next to continue. If you do not accept the license agreement, the installation will stop.

  5. When the Configure panel appears, specify the port number for the Directory Server that should be used for this installation. For complete information on the port used by the Directory Server, read Port Number Reference.

    On UNIX and Linux systems, the user is given the choice of installing Adabas Directory Server as an Application or as a Daemon. Software AG strongly recommends installing as a Daemon, so that the service startup and shutdown will be controlled by the system. If installed as an Application, the user must manually start and stop the Directory Server.

    Click Next to continue.

  6. On the last panel, review the items you have selected for installation. If the list is correct, choose the Next button to start the installation process.

After the Directory Server has been installed, it will start automatically on Windows, and on UNIX only if it has been installed as a Daemon.

Configuring Product Components for Windows Personal Firewall

If you have the default Microsoft Windows personal firewall enabled on a PC and you would like to install and run Adabas and Entire Net-Work components on that PC, you will need to allow communications through the firewall on certain ports. You can do this in one of two ways: you can allow ports for a specific executable program or you can open specific ports. This section covers the following topics:

Note:
If you attempt to install Adabas or Entire Net-Work in a system with a firewall in place, be sure that your system administrator has opened the firewall for the Adabas Directory Server port or the installation may not complete successfully.

Allow Ports for a Specific Executable Program

You can allow a specific executable program to open a port. To do so, issue the following command:

C:\>netsh firewall add allowedprogram program="<path and file name>" 
name="<component-name>" profile=ALL

where <path and file name> is the path and file name of the file you want to allow and <component-name> is a user-specified name to identify the file you are allowing. The following table lists the common Adabas and Entire Net-Work component files that might need to be allowed if Windows personal firewall is enabled:

Component Name Path and File Name
Entire Net-Work Client Service <your-installation-location>\EntireNetWorkClient\bin\wclservice.exe
Entire Net-Work Kernel program <your-installation-location>\EntireNetWorkServer\bin\wcpkernel.exe
Entire Net-Work Server Service <your-installation-location>\EntireNetWorkServer\bin\wcpservice.exe
Adabas Directory Server Service <your-installation-location>\SoftwareAG\SoftwareAgDirectoryServer\bin\xtsdssvcadi.exe

To remove the Adabas or Entire Net-Work component as an allowed program, issue the following command:

C:\>netsh firewall delete allowedprogram program="<path and file name>" 
profile=ALL

where <path and file name> is the path and file name of the file you want to disallow.

Open a Specific Port

To open a specific port for use by an Adabas or Entire Net-Work component in the firewall, issue the following command:

C:\>netsh firewall add portopening protocol=TCP port=nnnn 
name="<component-name>" profile=ALL

where nnnn is the port number you want to open and <component-name> is a user-specified name to identify the port you are allowing.

To avoid port number conflicts, read Port Number Reference for a general list of the ports used by Software AG products.

To close a specific port in the firewall, issue the following command:

C:\>netsh firewall delete portopening protocol=TCP port=nnnn profile=ALL

where nnnn is the port number you want to close.

Uninstallation Steps

You uninstall this product using the Software AG Uninstaller. For information on how to use the uninstaller, read the Using the Software AG Installer guide.

Installing Fixes Using Software AG Update Manager

Adabas Directory Server is updated using the Software AG Update Manager (SUM).

You can download the Software AG Update Manager from the Software AG Empower website at https://empower.softwareag.com/.

This SUM installation documentation on Empower provides a brief description on how to update Software AG products directly on the target machine using the Update Manager wizard. The SUM documentation also includes instructions on how to apply updates in console mode or using scripts.

Start of instruction setTo update Adabas Directory Server, complete the following steps:

  1. Download and install Software AG Update Manager for your platform from Empower.

  2. Shut down any running instances of the product. Updates cannot successfully apply if the application is active.

  3. From a console prompt in the SUM /bin directory, enter UpdateManagerGUI.bat (UpdateManagerGUI.sh on UNIX/Linux).

  4. On the opening page of the SUM tool, select Install Fixes from Empower, enter your SAG product directory root location and provide your Empower User ID and password. Click Next.

  5. Expand through the Adabas Family product selection tree to find the entry for this product.

    Tip:
    If the product is not shown in the tree, there is either no update available or the product is not installed in the location you specified.

  6. Select (check) the Adabas Directory Server entry in the product selection tree. Click Next.

    Tip:
    You can select more than one product to update before proceeding.

  7. The next screen presents a summary of products that are about to be updated. If any of them require manual pre-installation steps, they will be highlighted in red and you will be directed to read the update readme file for that product before proceeding.

    Complete any pre-installation steps outlined in the readme file and check the box next to Pre-installation steps have been completed. Click Next.

    Note:
    If any pre-installation steps are required, the Next button will be unavailable until you confirm these steps have been completed.

  8. The tool will apply updates to all selected products and present you with a final screen confirming updates have been applied. Click Close to exit SUM or Home to return to the tool's starting panel.

Uninstalling Fixes Using Software AG Update Manager

Start of instruction setTo remove an installed update, complete the following steps:

  1. Shut down any running instances of the product.

  2. Start Software AG Update Manager.

  3. On the opening page, select Uninstall Fixes from the selection panel. Click Next.

  4. If any product selected for uninstall requires manual steps, you will be directed to review the update readme and confirm you have performed any pre-uninstallation steps. Click Next.

  5. The fix(es) you selected for uninstall will be removed and the product(s) returned to their previous state. Click Close to exit SUM or Home to return to the tool's starting panel.