BES and Op-Center 6.5 Licensing

This document contains the following topics:

  1. What's new in 6.5
  2. License types and combinations explained
    1. Node-locked and network licenses explained
    2. License combinations explained
    3. ORB Licensing explained
  3. Applying licenses to product installations
    1. Applying Node-locked licenses
    2. Applying network licenses
    3. Applying multiple licenses
  4. Configuring VisiBroker licenses
    1. Configuring VisiBroker C++ server, VisiTransact, or VisiNotify
    2. Configuring VisiBroker for Java servers using the Borland Java Launcher (vbj)
    3. Configuring VisiBroker for Java servers that do NOT use the Borland launcher (vbj)
    4. Licensing and running VisiBroker 6.x using a shared installation with a Node-lockeded license
  5. Migrating and removing licenses
    1. Migrating from a 6.0 or 6.0RP1 license to a 6.5 installation
    2. Removing licenses

What's new in 6.5

In BES version 6.5, licensing is quite similar to version 6.0. The same license types are available, and configuration of licenses has not changed.

The following are new in version 6.5:

License types and combinations explained

You must apply and register a separate license for each host on which you want to run a BES or Op-Center licensed component. The licensed components are:

Licensing of BES and Op-Center is based on the Sanctuary licensing architecture used by most other Borland products. Sanctuary provides for more secure licensing, offers the option of network licensing (see Node-locked and network licenses explained) and will permit BES and Op-Center to participate in Suite licensing with other Borland products using a single license for all products in a Suite.

Important: There is no grace period. You MUST activate your license before the product will run. For Node-locked licenses this means registration, and is achieved most easily when your host machine has Internet connectivity. See Applying licenses to product installations for more details.

Node-locked and network licenses explained

In BES and Op-Center, licenses come in two different types:

License combinations explained

In BES and Op-Center 6.5, the SKUs have been defined such that optional features can be purchased and licensed separately. This avoids creating a complex set of SKUs for every combination of product features offered. The following combinations are typical:

Licenses that cannot be combined

In general, you cannot apply two BES licenses together. These include:

Production:

Development/Trial:

Attempting to apply licenses that are incompatible with each other will result in a run-time error indicating the problem.

Warning: If you apply a Trial or Development license together with a Production license, all licensed features of that installation will have Trial or Development behaviors. For example, you cannot have BES Deployment license and Op-Center Trial license together in the same installation. This means that service will be interrupted every 72 hours, and in the case of trials, the product will expire after 60 days. If you wish to remove a Trial or Development license, see Removing licenses.

VisiServices licenses explained

In version 6.0, it was required that separate licenses be applied for each of the VisiServices. In the most extreme case where VisiBroker Edition, VisiSecure, VisiTransact, and VisiNotify were installed, this required that four licenses be applied to the same installation to permit the use of all these components.

In version 6.5, this has been changed; you no longer need to apply the extra VisiServices licenses. It is required that a BES license be applied (AppServer Edition or VisiBroker Edition). A migrated 6.0 or 6.0RP1 BES license also suffices.

This new behavior also applies to the new VisiServices: VisiTime and VisiTelcoLog.

ORB Licensing explained

Only VisiBroker ORBs running as servers require licensing. An ORB is considered to be a server if it

Client ORBs, even if they enable security (VisiSecure), do not require licensing. Therefore, for client ORBs (even secure ones), you do NOT need to:

See Configuring VisiBroker licenses for the complete VisiBroker license configuration instructions.

Applying licenses to product installations

This section explains how to apply network and Node-locked licenses to your product installation.

Applying Node-locked licenses

Before you begin

Things you will need:

Using the lmadm tool

Node-locked licenses are applied using the lmadm tool found in your installation's bin directory (<install_dir>/bin/lmadm). The lmadm tool, depending upon the command arguments that are used, can run:

If you use the Borland product installer wizard, you will be offered an option to run the Borland product registration Wizard automatically at the end of your installation. You can always register licenses at any time using lmadm directly. The lmadm License Manager GUI is also available as a tool in the Borland Management Console (menu command Tools>License Manager), and this can be used to manage licenses on remote hosts (see Remote registration and activation).

Registration requires that you be a Borland Developer Network (BDN) member. If you are not a member, you can create membership while you are in the process of registering your license, as described in the instructions below.

GUI-based registration and activation of Node-locked licenses

  1. Either select the option at the end of the GUI install to Register your license, or run the command:
       <install_dir>/bin/lmadm
    The default install directory is C:\Borland\BDP on Windows, and /opt/borland/bdp on Unix and Linux.

    This will display the Registration Wizard. To register your license, select 'Have Serial Number' and click Next.

  2. Enter your Serial Number and Key and click Next.

  3. Select your Registration method and click Next.

    The Wizard will guide you through the steps required to register and activate your license.

    You can select:
  4. If you did not choose Direct in step 3, you will receive an activation file. To complete the activation process simply copy this file into the <install_dir>/license directory and it will be applied automatically when you start your product.

Command line registration and activation of Node-locked licenses

If you do not have a GUI environment, or if you want to register your license remotely using Telnet, run the command:

   <install_dir>/bin/lmadm -i console

This will display a selection of commands that will allow you to manage your licenses. These commands are:

  [0] Direct register (requires internet connection)
  [1] Register using Web, and receive activation file via email
  [2] List all licenses
  [3] Disable a license
  [4] Enable a license
  [5] Get network account name
  [6] Migrate a node locked license
  [7] Release large distribution license
  [8] Save
  [9] Quit

Direct registration and activation

  1. If the system on which your product is installed has an Internet connection, enter 0 (zero) and press Enter to use [0] Direct register.

  2. This will prompt you to:
    1. Enter your serial number
    2. Enter your key
    3. And either:
      • Enter your Borland Developer Community (BDN) username and password, or
      • Enter information enabling you to create a BDN account.

When you've completed these steps, the license will be activated and you can begin using your product.

Indirect registration and activation

  1. If your system does not have an Internet connection, enter 1 and press Enter to use [1] Register using Web.

  2. The tool will:
    1. Display the URL of the Borland registration web site that you must visit to register (http://reg.borland.com).
    2. Display a KEY number that you will need when you visit the Borland registration web site.

  3. To complete your registration, visit the Borland registration web site (http://reg.borland.com), enter your BDN account info (or create one), and enter your serial number and the KEY the lmadm tool displayed.

    An activation file that contains instructions on how to activate your license will arrive by email.

  4. Copy the activation file to the system on which your product is installed, into the <install_dir>/license directory. Starting your product will activate the license automatically.

Remote registration and activation

You can register and apply licenses for remote installations using a central Management Console, or you can run the lmadm tool over telnet.

Using the Management Console

Some points of interest regarding this feature:

To register and activate licenses on a remote host:

  1. After installing BES or Op-Center on the desired hosts, start the SCU process of each installation. (by default c:\borland\bdp\bin\scu.exe).

  2. From a Management Console installed on any host, log in and discover each of the remote SCU processes. These will appear as agents under the Agents folder in the Console.

  3. In the Agents folder, select an agent you want to license.

  4. Select the License tab on the right-side view. This will display the current license status.

  5. Right-click on the agent node in the tree, and select the Register command. This will open the Registration Wizard.

  6. Enter your licensing information into the Registration Wizard as it is requested.

Important: The License Manager tool available in the Management Console's Tools>License Manager command can only license the installation local to the running Console. It cannot be used for remote licensing.

Using lmadm over Telnet

To register and activate a license on a remote system without running an SCU on the system, you must Telnet into a system and run lmadm in the command line mode.

Applying network licenses

Network licenses are licenses controlled by a license server — either FlexLM or Borland License Server (Belise). Network licenses are much more simple to install and administer. Registration of each individual license is not required. Instead, a single registration will cover all the licenses in a single purchase.

Things you will need:

Installing the License Server

Both FlexLM and Borland License Server are supported. For instructions on how to install them, see http://license.borland.com/lservers. This web site will guide you through the installation of your preferred license server.

Registering your certificates

  1. Click on the License Hosting link from the web page for your preferred license server (accessed in the previous step at http://license.borland.com/lservers).
  2. Enter the username and password from the License Certificate you want to register.
  3. Enter the IP address of your license server.

If you are using the Borland License Server, you will receive Client SLIPs and a Server SLIP by email. FlexLM users will receive DAT files.

Installing SLIPs (or DATs)

Installing network license SLIPs (or DATs) involves simply copying them to the appropriate locations.

Network license SLIPs (or DATs) come in two types:

The SLIP (or DAT) files contain instructions on how to install them. The Server SLIP (or DAT) will be copied to the License Server machine in a location appropriate to the type of server you are using.

The Client SLIPs (or DATs) will be copied to each system on which you installed a BES/Op-Center product. By default, they are installed to:

   <install_dir>/license

Note: It is possible in some cases to install a network client SLIP (or DAT) in a shared location on your network, and configure all of your products to access the same SLIP (or DAT). This is not encouraged if you are using the Op-Center managed object mechanisms (which you will use if you are running the J2EE Development or Op-Center Trial products). However, for VisiBroker standalone installations, this can be an efficient technique. Refer to the Borland License Server or FlexLM documentation for information about configuring a shared network client SLIP (or DAT).

Applying multiple licenses

In some cases, you will need to apply multiple licenses to one installation. This will be required if you purchase optional products that can be added onto a base product. For a description of which licenses can be stacked in this way, see License combinations explained.

Node-locked licenses

Applying more licenses to the same product installation is similar to the first license application.

GUI Environment

If you are able (and want) to run a GUI, run the License Manager tool. This is accessible using the Management Console menu command Tools>License Manager. Or run it directly, using the command:

   <install_dir>/bin/lmadm -r info

This will display the License Manager.

Do the following:

  1. Select the menu command Serial>Add, and you will be prompted for your Serial Number and Key.

  2. The new serial number should now appear in red letters in the License Manager. Right-click on the red serial number and select the Register command.

  3. Follow the procedure for Node-locked licenses using a GUI environment described in GUI-based registration and activation of Node-locked licenses.

Command line environment

The procedure for adding licenses in a command line environment is identical to the original license application. See Command line registration and activation of Node-locked licenses.

Network licenses

When multiple SKUs are ordered with network licensing, you will receive a license certificate and a SLIP (or DAT) file for each SKU. Apply all license certificates to your license server. For each installation, copy the SLIP (or DAT) files for the desired SKUs to the license directory. More than one SLIP (or DAT) per installation causes the features to be added together for that installation.

Configuring VisiBroker licenses

In most cases when using Op-Center, or BES, the license will be preconfigured. However, in some cases (distributing VisiBroker components with an application or customizing the standard VisiBroker installation footprint), you will need to set license properties so that the component will be able to locate the license.

Each licensed component must have environment variables set to declare the location of the license file.

Note: In examples below <install_dir> resolves to the directory containing your BES installation: C:\Borland\BDP for Windows, /opt/borland/bdp for Unix and Linux.

Configuring VisiBroker C++ server, VisiTransact, or VisiNotify

To configure VisiBroker C++ server, VisiTransact, or VisiNotify you must set two license environment variables:

   export BES_LIC_DIR=<install_dir>/var

   export BES_LIC_DEFAULT_DIR=<install_dir>/license

Note: The file <install_dir>/bin/vbroker.csh contains scripts that will set these variables correctly.

Configuring VisiBroker for Java servers using the Borland Java Launcher (vbj)

In this case, vbj handles setting the license variables automatically, so no configuration is necessary.

However, if you wish to override these settings, you can edit the vbj configuration file at:

   <install_dir>/bin/vbj.config

and change the following settings:

   vmprop borland.enterprise.licenseDir=$var(installRoot)/var

   vmprop borland.enterprise.licenseDefaultDir=$var(installRoot)/license

Although not recommended, on Windows platforms only you can override the vbj settings using the system environment variables. For example:

   export BES_LIC_DIR=<BES installation directory>/var

   export BES_LIC_DEFAULT_DIR=<BES installation directory>/license

The vbj launcher will convert the system environment variables (Windows only) and the vmprop settings in the config file to the Java System properties:

   borland.enterprise.licenseDir

   borland.enterprise.licenseDefaultDir

Configuring VisiBroker for Java servers that do NOT use the Borland launcher (vbj)

If you run your VisiBroker for Java server directly, using java, you must set the license directory values using Java System properties:

   java -Dborland.enterprise.licenseDir=<install_dir>/var
     -Dborland.enterprise.licenseDefaultDir=<install_dir>/license ... 

Debugging license settings

When using components that are built with the BES Launcher (such as partition.exe, scu.exe), you can check the license variable settings by passing the debug flag to them when they are executed:

   scu -debug ...

When using components that are built with the Borland Java launcher (vbj), you can check the license variable settings by passing the debug flag to them when they are executed:

   vbj -VBJdebug ...

JARs required on your Java classpath for VBJ ORBs running as servers

The following JARs must be on the classpath of VBJ ORBs running as servers. They can be found in your installation's lib directory.

Licensing and running VisiBroker 6.x using a shared installation with a Node-lockeded license

If you have a single VisiBroker installation on a network shared drive and you would like VisiBroker components in that installation to be run from multiple remote hosts follow this procedure so that the components can locate the appropriate license.

The Node-lockeded licensing mechanism used by VisiBroker requires:

Therefore, if you install VisiBroker on a network share, each host that executes VisiBroker from that network share must have its own local license that has been activated. In addition, some VisiBroker configuration files must be modified to accommodate this case.

At a high level, the procedure involves:

  1. Modifying config files for lmadm and vbj to accept environment variables to set the license locations.

  2. Modifying the Vbroker.bat, VBroker.sh, or VBroker.csh file to set the two license file locations so that BES_LIC_DEFAULT_DIR points to the VisiBroker installation, and BES_LIC_DIR points to a location on each remote host.

  3. Running the modified file on each remote host to set the environment properly.

  4. Running lmadm to register and activate the license on each remote host.

The following are detailed instructions to license and run a shared VisiBroker installation.

  1. Install VisiBroker onto a network share. Below, we will refer to the path to this installation as <install_dir>.

  2. On Windows, for each remote host, mount a network drive that permits access to share the VisiBroker installation. Map the share to the same drive letter on every remote host.

  3. Create a directory on each remote host to contain license files. Be sure the local path to this directory is identical on all remote hosts. for example:
    C:\Borland\licenseDir
  4. Copy the <install_dir>/var/license.ini file to the license file directory you created in the previous step.

  5. Edit the <install_dir>/bin/lmadm.config and the <install_dir>/bin/vbj.config files as follows:

    Change the lines:
    vmprop borland.enterprise.licenseDefaultDir=$var(installRoot)/license
      vmprop borland.enterprise.licenseDir=$var(installRoot)/var
    to:
    vmprop borland.enterprise.licenseDefaultDir=$env(BES_LIC_DEFAULT_DIR)
      vmprop borland.enterprise.licenseDir=$env(BES_LIC_DIR)
  6. If you are on Windows, edit the <install_dir>/bin/vbroker.bat to the following, where <path to VB> is interpreted as the path, from the local host, to the network shared VisiBroker installation:
    set VBROKER_ADM=<path to VB>/var/standalone/adm
    
    set BES_LIC_DIR=<license file directory>
    
    set BES_LIC_DEFAULT_DIR=<path to VB>/license
    
    set OSAGENT_PORT=<your desired port number>
    
    set VBROKERDIR=<path to VB>
    
    set PATH=<path to VB>\bin;<path to VB>\jdk\jdk1.4.2\bin;<path 
      to VB>\bin\apache2;%PATH%
    
    start
  7. If you will be using VBroker.csh, edit it as follows:
    #!/bin/csh
    
    setenv VBROKER_ADM <path to VB>/var/vbroker/adm
    
    setenv BES_LIC_DIR <license file directory>
    
    setenv BES_LIC_DEFAULT_DIR <path to VB>/license
    
    setenv OSAGENT_PORT <your desired port number>
    
    setenv VBROKERDIR <path to VB>
    
    # the apache2 paths are used only by the Borland Enterprise Server
    # complete install
    if ("$?PATH") then
    setenv PATH <path to VB>/bin:/opt/java1.4/bin:<path to VB>/bin/apache2:${PATH}
    else
    setenv PATH <path to VB>/bin:/opt/java1.4/bin:<path to VB>/bin/apache2
    endif
    
    if ("$?SHLIB_PATH") then
    setenv SHLIB_PATH <path to VB>/lib:<path to VB>/lib/apache2:${SHLIB_PATH}
    else
    setenv SHLIB_PATH <path to VB>/lib:<path to VB>/lib/apache2
    endif
  8. If you will be using VBroker.sh, edit it as follows:
    #!/bin/sh
    
    VBROKER_ADM=<path to VB>/var/vbroker/adm
    export VBROKER_ADM
    
    BES_LIC_DIR=<license file directory>
    export BES_LIC_DIR
    
    BES_LIC_DEFAULT_DIR=<path to VB>/license
    export BES_LIC_DEFAULT_DIR
    
    OSAGENT_PORT=<your desired port number>
    export OSAGENT_PORT
    
    VBROKERDIR=<path to VB>
    export VBROKERDIR
    
    # the apache2 paths are used only by the Borland Enterprise Server
    # complete install
    PATH=<path to VB>/bin:/opt/java1.4/bin:<path to VB>/bin/apache2:${PATH}
    export PATH
  9. Run the VBroker script on the remote host.

  10. You should be able to run lmadm to register and activate your license. Afterwards you should be able to run any VisiBroker component on the remote host. For instructions on using lmadm, see Using the lmadm tool.

Migrating and removing licenses

Migrating a 6.0 or 6.0RP1 license to a 6.5 installation

Migrating Node-locked licenses

Warning: You must migrate your 6.0 or 6.0RP1 licenses before applying any new licenses to your 6.5 installation. The migration process overwrites the borland.lic file as explained in the following procedure.

The following procedure applies only to:

To migrate your 6.0 or 6.0RP1 license to your 6.5 installation:

  1. Run a command window (for example, on Windows, a DOS command window).

  2. Navigate to your 6.5 the bin directory in your 6.5 installation directory (default C:\Borland\BDP\bin).

  3. Execute the command:
       lmadm -i console
    This will display a series of command options.

  4. Enter 6 for Migrate a node locked license.

  5. As prompted, enter the full path of your 6.0 or 6.0RP1 installation (default C:\Borland\BDP or /opt/borland/bdp).

  6. As prompted, press enter to migrate the license to this 6.5 installation.

  7. You will be notified that a borland.lic file already exists in your 6.5 installation.

    Warning: If you have not applied any licenses to your 6.5 installation, this file will be empty. However, if you have applied licenses to this 6.5 installation, continuing will overwrite those licenses with those from the 6.0/6.0RP1 installation.

    To continue, enter 0 (zero).

    This should complete the migration.

  8. Enter 9 to exit.

    You can now run your 6.5 product.

Migrating network licenses

To migrate 6.0 and 6.0RP1 network licenses to 6.5 installations, simply copy the SLIP (or DAT) files to your license sever and clients as instructed in Applying network licenses.

copy

Removing licenses

Note: A bug in the License Manager GUI exists that complicates deletion of network licenses. Do not use the License Manager to delete network licenses. Instead, use the lmadm command line tool to disable them, as described in Removing network licenses.

Removing Node-locked licences

  1. Either run the Management Console and select the menu command Tools>License Manager, or run:
       <install_dir>/bin/lmadm -r info

    Note: The License Manager GUI must be run on the same system on which the license is installed.

    This will display the License Manager.

  2. Right click on the license you wish to delete, and select Delete.

  3. When exiting the License Manager, be sure to answer Yes to the request to Save Changes.

Removing network licenses

  1. Run the lmadm command line tool:
       <install_dir>/bin/lmadm -i console
  2. Enter 2 and press Enter to list all licenses. Note the item number in brackets in the left column next to the license you wish to disable.

  3. Press Enter to continue.

  4. Enter 3 and press Enter to disable a license.

  5. Enter the item number (in brackets) to disable, and press Enter.

  6. Enter 8 to save your changes, then enter 9 to exit.