# Installation and Upgrade Guide

# Licensing

This appendix describes how licensing is configured for SharePoint Console. It contains the following sections:

- Licensing Overview
- Installation Behavior
- Upgrade Behavior
- Upgrading an Existing License
- Merging License Keys
- Example - License File

## Licensing Overview

In order to function, SharePoint Console requires a valid license key on each SharePoint Console server in the environment. The license file containing this key must be located in the BEA_HOME directory. By default, BEA_HOME is C:\bea.

Depending on your use case, a different type of license is used. Each license type is defined by the license attributes that govern the behavior of the licensed installation. The following table lists the license types, the most important attributes for each type, and how the license should be obtained.

Table A-1 Use Cases and Corresponding License Types
License Type | Key Attribute | Obtainment Method
--- | --- | ---
Standard Evaluation | Expiration Days: Standard Evaluation licenses will expire 30 days from the date of installation. Units: Standard Evaluation licenses will allow a single execution of a crawler to import up to 50 SharePoint items. | Standard Evaluation licenses are automatically generated by the SharePoint Console installer.
Production | IP: Production licenses are only valid on a specific IP or within a specific IP range. | Existing customers can obtain Production licenses through elicense.bea.com or licensing@bea.com.

## Installation Behavior

By default, the installer attempts to install a Standard Evaluation license file containing a SharePoint Console key in the BEA_HOME directory.

If a license.bea file exists in the specified location, then the installer prompts you to merge a Standard Evaluation license with the existing license, overwrite the existing license with a Standard Evaluation license, or leave the existing license alone. If you elect to overwrite the existing license, then the installer places a backup of the existing license into the BEA_HOME directory.

If you are installing SharePoint Console on a machine with another BEA product on it (for example, BEA WebLogic Server, AquaLogic Interaction, AquaLogic Interaction Analytics, or AquaLogic Interaction Grid Search), choose to merge the license files when prompted by the installer.

## Upgrade Behavior

Subsequent installs of a SharePoint Console instance obey the same logic described in the Installation Behavior section. When upgrading to a new major or minor version of SharePoint Console, it is necessary to upgrade the license file. When prompted by the installer during upgrade, choose to merge the license files if there are other BEA products installed on the machine. Choose to overwrite the existing license file with a Standard Evaluation license if only SharePoint Console is installed on the machine. For details on merging license files, see Merging License Keys.

When installing the new Production license key, you do not need to run the installer again to change license keys; you only need to replace the existing license file with the new version's license file, then restart your SharePoint Console instance. For details, see Upgrading an Existing License.

## Upgrading an Existing License

If you are upgrading an existing license to a Production license, you can either combine the license keys or replace the existing license file with the new license file.

If you are upgrading a license on a machine with another BEA product on it (for example, BEA WebLogic Server, AquaLogic Interaction, AquaLogic Interaction Analytics, or AquaLogic Interaction Grid Search), you must merge the license keys for both products into a single file. For more information on merging license keys, see Merging License Keys.

## Merging License Keys

To manually combine two or more license keys into the license.bea file, either use a text editor or the tool provided in BEA_HOME.

By default:

- C:\bea\UpdateLicense.cmd

The path to java.exe must be in the PATH variable. Use the following command to execute the tool:

- `UpdateLicense.cmd <new_license_file>`

Replace `<new_license_file>` with the name of the file containing the license key you wish to add to license.bea.

## Example - License File

The following is an example of a license.bea file with a SharePoint Console Evaluation key:

    <?xml version="1.0" encoding="ISO-8859-1"?>

    <bea-licenses>

        <license-group format="1.0" product="AquaLogic Interaction SharePoint Console" release="1.1">

            <license

                component="Crawler"

                cpus="unvalued"

                expiration="never"

                expiration_days="30"

                ip="any"

                licensee="BEA Evaluation Customer"

                serial="616351266349-2404064437963"

                type="EVAL"

                units="50"

                users="unlimited"

    signature="MCwCFBa49QxGIwZOOUAeNE2tMu/HnbFgAhRnQ7XHShXQfQIFthYVMsYUV3a6nw=="

            />

    </license-group>

    </bea-licenses>