IBM Support

Using the IBM InfoSphere Information Server Default License Key File for 8.1

Product Documentation


Abstract

IBM InfoSphere Information Server installation no longer requires each customer to use a custom user license key file that restricts the product modules that the installation program can install. Instead, the IBM InfoSphere Information Server Default License Key File ("default license key file") is provided. The file enables the installation program to install any product module. When you use the default license key file, you must only install those product modules that are indicated on your Proof of Entitlement. You must also customize the license key information to activate only the features that are associated with the specific IBM InfoSphere DataStage and QualityStage related products and feature packs that are indicated on your Proof of Entitlement.
[<p>]
If you have questions about which products, components, or features you are entitled to, contact your IBM representative or IBM Business Partner for clarification.

Content

Introduction

The license key file controls:

  • The list of product modules and components that are presented by the installation program when you run it.
  • The specific features that are activated within InfoSphere DataStage (if you install IBM InfoSphere DataStage and QualityStage or IBM InfoSphere Information Analyzer). Different features are activated within InfoSphere DataStage depending on the specific InfoSphere QualityStage and InfoSphere DataStage products and feature packs that are activated.

Previously, IBM provided each customer with a customized license key file. This file caused only product modules that the customer was entitled to to appear in the installation program. When the customer installed InfoSphere DataStage and QualityStage or InfoSphere Information Analyzer, the InfoSphere DataStage features were activated based on the InfoSphere QualityStage and InfoSphere DataStage products and feature packs that were specified in the license key file.

IBM now instead provides a common default license key file to all customers. The default license key file is available from Passport Advantage as part of the IBM InfoSphere Information Server product download. It is included in the eAssembly for each platform supported by Information Server 8.1 and can be easily accessed via the InfoSphere Information Server 8.1 download document which references all files available through the eAssmebly. This file causes all product modules in the InfoSphere Information Server suite to appear in the installation program. It also causes all InfoSphere DataStage and QualityStage features to be activated. It is now your responsibility to:

  • Only install product modules that you are entitled to, and
  • Customize the license key information in your installation to activate only those InfoSphere DataStage and QualityStage features that you are entitled to (if any). To customize the license key information, use the LicensingServiceAdmin tool. You must perform the customization when you install the default license key file, and again whenever your entitlements to InfoSphere QualityStage or InfoSphere DataStage products or feature packs change.

Important: The LicensingServiceAdmin tool is included with InfoSphere Information Server, Version 8.1 Fix Pack 1. To use the tool, you must install Fix Pack 1.

The following table lists the InfoSphere QualityStage and InfoSphere DataStage products and feature packs and the features that are included with each product.

Table 1. InfoSphere DataStage related products

ProductFeatures
IBM InfoSphere DataStage
  • InfoSphere DataStage job features
  • Parallel canvas
  • Server canvas
IBM InfoSphere DataStage Server
  • InfoSphere DataStage job features
  • Server canvas
IBM InfoSphere DataStage MVS Edition
  • InfoSphere DataStage job features
  • MVS (mainframe) canvas
IBM InfoSphere DataStage Pack for SAS
  • SAS features
IBM InfoSphere QualityStage
  • InfoSphere QualityStage job features
  • Parallel canvas

Determining the default license key file to use

Two default license key files are available:

  • IBM InfoSphere Information Server Default License Key File for 8.1. Use this file if you are creating a new InfoSphere Information Server, Version 8.1 installation, or if you have an existing InfoSphere Information Server, Version 8.1 installation and need to install products that are not included in your current custom license key file.
  • IBM InfoSphere DataStage Server Default License Key File for 8.1. Use this file if you are upgrading to InfoSphere DataStage Server from IBM DataStage Server Version 7.5. This default license key file ensures that your system is properly configured for InfoSphere DataStage Server. You do not need to customize the license key information except in the following scenarios:
    • When you install this file, if you also have entitlement to IBM InfoSphere QualityStage or IBM InfoSphere DataStage MVS Edition. In this case, follow the steps defined in this document to customize the stored license key information to reflect the products that you are entitled to.
    • If you later upgrade to the full version of InfoSphere DataStage (with parallel processing). In this case, follow the steps defined in this document to customize the stored license key information to activate this product.

Installing the default license key file

For new InfoSphere Information Server, Version 8.1 installations:

  1. Place the default license key file in a temporary directory within the local file system of the computer on which you will install the services tier.
  2. Run the InfoSphere Information Server installation program to install InfoSphere Information Server.
  3. When you run the installation program to install the services tier, specify the location of the default license key file. The installation program uploads the license key information to the metadata repository.
  4. Install InfoSphere Information Server, Version 8.1 Fix Pack 1.
  5. Customize the license key information in the metadata repository as described in "Customizing the license key information" below.
    Note: If you are using the IBM InfoSphere DataStage Server Default License Key File for 8.1, you can skip step 5 because the file is preset to the correct DataStage entitlements for InfoSphere DataStage Server. However, if you also have entitlement to InfoSphere QualityStage or InfoSphere DataStage MVS Edition in addition to InfoSphere DataStage Server, you will need to customize the license key information to activate these products as well.

For existing InfoSphere Information Server, Version 8.1 installations:

  1. Leave your current custom license key file in place until one of the following is true:
    • You need to install a new product module that is not included in your custom license (the new product is not displayed as an installation option).
    • You acquire entitlement to a new InfoSphere DataStage product or feature pack (those listed in Table 1).
    • You lose entitlement to an InfoSphere DataStage product or feature pack.
    • You acquire or lose entitlement to InfoSphere QualityStage.
  2. Upload the default license key file to the metadata repository as described in "Uploading a default license key file to the metadata repository" below.
  3. If you are adding product modules to your installation, run the installation program to install the product modules.
  4. Install InfoSphere Information Server, Version 8.1 Fix Pack 1, if it is not already installed.
  5. Customize the license key information in the metadata repository as described in "Customizing the license key information" below.

Uploading a default license key file to the metadata repository

For an existing InfoSphere Information Server, Version 8.1 installation, use the InfoSphere Information Server Web Console to update the license key information in the metadata repository. The new information replaces the current license key information in effect.

To update the license key information:

  1. Ensure that your new default license key file is on a computer that can access the IBM InfoSphere Information Server Web console.
  2. Use one of the following methods to log in to the Web console as a suite administrator:
    • Click Start > IBM Information Server > IBM Information Server Web console.
    • Open a Web browser and navigate to the URL for the Web console. The URL has the syntax services_host:port, where services_host is the URL or IP address of the server where the services tier is installed and port is the port that is assigned to the Web console. The default port is 9080.
  3. On the Administration tab, click Domain Management > Licensing.
  4. Click Upload a Licensing File.
  5. Click Browse, navigate to and select your default license key file, and click Upload.
  6. Click Yes if prompted with the Serial Number mismatch warning.

Note: Once the default license file has been installed or uploaded, the list of licensed components no longer shows in the Licensing interface of the Information Server Web Console. Instead a "No data found." message is displayed since the default license cannot indicate the specific product components that are actually licensed.

Customizing the license key information

The license key information in your installation must activate only those InfoSphere QualityStage and InfoSphere DataStage features to which you are entitled. You use the LicensingServiceAdmin tool to customize this information for your installation. You must perform the customization when you install the license key file, and again whenever any of the following is true:

  • You add IBM InfoSphere DataStage and QualityStage or IBM InfoSphere Information Analyzer to your installation.
  • You acquire entitlement to a new InfoSphere DataStage product or feature pack.
  • You lose entitlement to an InfoSphere DataStage product or feature pack.
  • You acquire or lose entitlement to IBM InfoSphere QualityStage.

To customize the license key information, create a string of feature codes that identify the InfoSphere QualityStage and InfoSphere DataStage product and feature packs that you are entitled to. Pass this list of feature codes to the LicensingServiceAdmin tool to activate the appropriate InfoSphere DataStage and QualityStage features within your installation.

The following table lists the feature codes for each product and feature pack:

Table 2. Feature codes for products and feature packs

Feature codeProduct or Feature PackNotes
DSActivates features associated with the IBM InfoSphere DataStage product.
DSServerActivates features associated with the IBM InfoSphere DataStage Server product.The features activated for the DSServer feature code are a subset of the features that are activated for the DS feature code. When activating DS, it is not necessary to also activate DSServer. Activate only those products that you are entitled to.
DSMVSActivates features associated with the IBM InfoSphere DataStage MVS Edition product.
SASActivates features associated with the IBM InfoSphere DataStage Pack for SAS product.The SAS feature code can only be specified in combination with the DS feature code since the IBM InfoSphere DataStage Pack for SAS can only be licensed when IBM InfoSphere DataStage is also licensed. Do not include SAS in the feature code list without also including DS.
QSActivates features associated with the IBM InfoSphere QualityStage product.

When running the LicensingServiceAdmin tool to customize the license key information, you must specify all InfoSphere QualityStage and InfoSphere DataStage products and feature packs from the above table that you are entitled to. Feature codes that you do not include will cause features associated with those codes to be deactivated.

When IBM InfoSphere Information Analyzer is installed, InfoSphere DataStage is also installed as an entitlement to support the InfoSphere DataStage related operations of InfoSphere Information Analyzer. If you do not have entitlement to InfoSphere QualityStage or InfoSphere DataStage products or feature packs, then you must deactivate the features associated with those products. To do so, you must run the LicensingServiceAdmin tool and specify an empty feature code list. The empty list deactivates all InfoSphere QualityStage and InfoSphere DataStage features except those that are needed by InfoSphere Information Analyzer.

If IBM InfoSphere Information Analyzer is being installed or is activated along with either InfoSphere DataStage or InfoSphere QualityStage, then there are no special steps for activating the DataStage features required by InfoSphere Information Analyzer. Simply activate the InfoSphere DataStage and QualityStage features which you are entitled to.

Using LicensingServiceAdmin to customize the license key information

To activate or deactivate features of IBM InfoSphere QualityStage and IBM InfoSphere DataStage products and feature packs in the suite, run the LicensingServiceAdmin command. Each time you run the command, specify all items that you want to activate. Any products or feature packs that you do not specify are deactivated by the command.

You must have suite administrator authority to perform this task.

The LicensingServiceAdmin tool is included with InfoSphere Information Server, Version 8.1 Fix Pack 1. An earlier version of the LicensingServiceAdmin tool is installed prior to Version 8.1 Fix Pack 1 also but it does not support the new arguments for setting or listing licensed features. To use the tool, you must install Fix Pack 1.

To activate or deactivate features of InfoSphere QualityStage and InfoSphere DataStage products and feature packs:

  1. Log in to the computer on which the InfoSphere Information Server services tier is installed. Use an account that has execution permission for the tools in the ASBServer/bin directory.
  2. From a command prompt, change to the ASBServer/bin directory within the directory in which InfoSphere Information Server is installed. For example:
    •  cd /opt/IBM/InformationServer/ASBServer/bin
    •  cd C:\IBM\InformationServer\ASBServer\bin
  3. Run the LicensingServiceAdmin command with the -set_features option:
    •  ./LicensingServiceAdmin.sh -user isadmin -password ispswd -set_features featurecodes
    •  LicensingServiceAdmin -user isadmin -password ispswd -set_features featurecodes
In the command,
  • isadmin is the name of a user that has suite administrator authority.
  • ispswd is the user password.
  • featurecodes is a comma-separated list of codes that specify the InfoSphere QualityStage and InfoSphere DataStage products and feature packs to activate. See Table 2 above. The feature codes are separated by commas. If you include spaces in the list, you must enclose the full feature code list in quotes. Feature codes are not case sensitive. If only InfoSphere Information Analyzer is to be activated, leave the list blank.


Attention: The LicensingServiceAdmin tool supports other command-line options. Use only the options that are documented in this tech doc. Using other options might render your system non-operational.

Each time you run the command, specify the feature codes for all products and feature packs to activate. If there are products and feature packs that are already activated, include those feature codes as well so that they remain active. Any products and feature packs that you do not list in the command are deactivated.

For example, to activate only InfoSphere DataStage and the InfoSphere DataStage Pack for SAS, run the following command:

LicensingServiceAdmin -user isadmin -password ispswd -set_features DS,SAS -list_features

In this example, the Mainframe canvas and InfoSphere QualityStage features are not activated within the InfoSphere DataStage client applications.

The -list_features option causes the LicensingServiceAdmin tool to list the results. For example:

job-type = DataStage
licensed-feature = SAS_PACK
canvas = Parallel
canvas = Server
Info Operation successful

Note: The features that are displayed in the results are the InfoSphere DataStage and QualityStage features that are activated. They do not match the feature codes that you use on the command line. Use the codes in Table 2 above on the command line.

To activate InfoSphere Information Analyzer only, run the following command:

LicensingServiceAdmin -user isadmin -password ispswd -set_features -list_features

Execution of the above example returns the following:

No licensed features enabled.
Info Operation successful

Viewing a list of activated InfoSphere DataStage and QualityStage features

Run the LicensingServiceAdmin command-line tool to list the activated InfoSphere DataStage and QualityStage features within your suite.

You must have suite user authority to perform this task.

The LicensingServiceAdmin tool is included with InfoSphere Information Server, Version 8.1 Fix Pack 1. To use the tool, you must install Fix Pack 1.

To view the list:

  1. Log in to the computer on which the InfoSphere Information Server services tier is installed. Use an account that has execution permission for the tools in the ASBServer/bin directory.
  2. From a command prompt, change to the ASBServer/bin directory within the directory in which InfoSphere Information Server is installed. For example:
    •  cd /opt/IBM/InformationServer/ASBServer/bin
    •  cd C:\IBM\InformationServer\ASBServer\bin
  3. Run the LicensingServiceAdmin command with the -list_features option:
    •  ./LicensingServiceAdmin.sh -user isuser -password ispswd -list_features
    •  LicensingServiceAdmin -user isuser -password ispswd -list_features
In the command,
    • isuser is the name of a user that has suite user authority.
    • ispswd is the user password.
Attention: The LicensingServiceAdmin tool supports other command-line options. Use only the options that are documented in this tech doc. Using other options might render your system non-operational.

The command lists the features that are activated. Deactivated features are not listed. For example:

job-type = QualityStage
job-type = DataStage
licensed-feature = SAS_PACK
canvas = Parallel
canvas = MVS
canvas = Server
Info Operation successful

LicensingServiceAdmin tool command-line option shortcuts

You can use the following shortcuts in place of the options in the LicensingServiceAdmin command line:

Table 3. LicensingServiceAdmin tool option shortcuts

OptionShortcut
-user-u
-password-p
-list_features-lf
-set_features-sf

For example, to activate InfoSphere DataStage and the InfoSphere DataStage Pack for SAS, run the following command.

LicensingServiceAdmin -u isadmin -p ispswd -sf DS,SAS -lf

Original Publication Date

18 June 2010

[{"Product":{"code":"SSZJPZ","label":"IBM InfoSphere Information Server"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"Not Applicable","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF035","label":"z\/OS"}],"Version":"8.1","Edition":"All Editions","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
17 June 2018

UID

swg27018863