IDOL License Server
Version: 10.8
Administration Guide
Document Release Date: November 2014
Software Release Date: November 2014 Administration Guide
Notice
This documentation is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in this documentation is subject to change without notice and does not represent a commitment on the part of Autonomy. While reasonable efforts have been made to ensure the accuracy of the information contained herein, Autonomy assumes no liability for errors or omissions. No liability is assumed for direct, incidental, or consequential damages resulting from the use of the information contained in this documentation.
The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict accordance with the End User License Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner.
This documentation may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations are strictly coincidental. Trademarks and Copyrights
Copyright © 2014 Hewlett-Packard Development Company, L.P. ACI API, Alfresco Connector, Arcpliance, Autonomy Process Automation, Autonomy Fetch for Siebel eBusiness Applications, Autonomy, Business Objects Connector, Cognos Connector, Confluence Connector, ControlPoint, DAH, Digital Safe Connector, DIH, DiSH, DLH, Documentum Connector, DOH, EAS Connector, Ektron Connector, Enterprise AWE, eRoom Connector, Exchange Connector, FatWire Connector, File System Connector for Netware, File System Connector, FileNet Connector, FileNet P8 Connector, FTP Fetch, HTTP Connector, Hummingbird DM Connector, IAS, IBM Content Manager Connector, IBM Seedlist Connector, IBM Workplace Fetch, IDOL Server, IDOL, IDOLme, iManage Fetch, IMAP Connector, Import Module, iPlanet Connector, KeyView, KVS Connector, Legato Connector, LiquidOffice, LiquidPDF, LiveLink Web Content Management Connector, MCMS Connector, MediClaim, Meridio Connector, Meridio, Moreover Fetch, NNTP Connector, Notes Connector, Objective Connector, OCS Connector, ODBC Connector, Omni Fetch SDK, Open Text Connector, Oracle Connector, PCDocs Fetch, PLC Connector, POP3 Fetch, Portal-in-a-Box, RecoFlex, Retina, SAP Fetch, Schlumberger Fetch, SharePoint 2003 Connector, SharePoint 2007 Connector, SharePoint 2010 Connector, SharePoint Fetch, SpeechPlugin, Stellent Fetch, TeleForm, Tri- CR, Ultraseek, Verity Profiler, Verity, VersiForm, WebDAV Connector, WorkSite Connector, and all related titles and logos are trademarks of Hewlett-Packard Development Company, L.P., which may be registered in certain jurisdictions.
Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint, and other Microsoft products referenced herein are trademarks of Microsoft Corporation.
UNIX is a registered trademark of The Open Group.
AvantGo is a trademark of AvantGo, Inc.
Epicentric Foundation Server is a trademark of Epicentric, Inc.
Documentum and eRoom are trademarks of Documentum, a division of EMC Corp.
FileNet is a trademark of FileNet Corporation.
Lotus Notes is a trademark of Lotus Development Corporation.
mySAP Enterprise Portal is a trademark of SAP AG.
Oracle is a trademark of Oracle Corporation.
Adobe is a trademark of Adobe Systems Incorporated.
Novell is a trademark of Novell, Inc.
Stellent is a trademark of Stellent, Inc. All other trademarks are the property of their respective owners. Notice to Government End Users
If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 252.227-7013. Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished-rights reserved under the copyright laws of the United States. Autonomy, Inc., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA. 94105, US.
Autonomy License Server (10.8) Page 2 of 34 Contents
Contents 3 About This Document 5
Documentation Updates 5
Related Documentation 7
Conventions 7
Notational Conventions 7
Command-Line Syntax Conventions 8
Notices 8
Autonomy Product References 9
Autonomy Customer Support 9
Contact Autonomy 10 Chapter 1: Introduction 11
License Server 11
Autonomy’s IDOL Platform 11
License Server Architecture 11 Chapter 2: Install License Server 13
Use the IDOL Server Installer 13
Download License Server 16 Chapter 3: Configure License Server 17
Modify Configuration Parameter Values 17
Configuration File Sections 18
Logging Section 18
Server Section 19
Service Section 19
Customize Logging 19 Chapter 4: Operate License Server 21
Start and Stop License Server 21
Start License Server 21
Stop License Server 21
Autonomy License Server (10.8) Page 3 of 34 Administration Guide Contents
Send Actions to License Server 22 Chapter 5: License Services 23
Display License Information 23
Notes on Licensing 23
Revoke a Client License 24
Revoke Stale Licenses 25
Forcibly Revoke Licenses from Inaccessible Clients 25
Troubleshoot License Errors 26
Find the Number of Licensed Documents 27 Glossary 29 Index 33
Autonomy License Server (10.8) Page 4 of 34 About This Document
This document is for administrators who want to install and configure a License Server as part of an IDOL installation. It is intended for readers who have installed IDOL Server, and who are familiar with concepts related to administering a multipart distributed application.
l Documentation Updates
l Related Documentation
l Conventions
l Autonomy Product References
l Support
l Contact Autonomy Documentation Updates
The information in this document is current as of License Server version 10.8. The content was last modified November 2014.
You can retrieve the most current product documentation from the HP Autonomy Knowledge Base on the Customer Support Site.
A document in the Knowledge Base displays a version number in its name, such as IDOL Server 7.5 Administration Guide. The version number applies to the product that the document describes. The document may also have a revision number in its name, such as IDOL Server 7.5 Administration Guide Revision 6. The revision number applies to the document and indicates that there were revisions to the document since its original release.
Autonomy recommends that you periodically check the Knowledge Base for revisions to documents for the products your enterprise is using.
To access Autonomy documentation
1. Go to the Autonomy Customer Support site:
https://customers.autonomy.com
2. Click Login.
3. Type the login credentials that you were given, and then click Login.
The Customer Support Site opens.
4. Click Knowledge Base.
Autonomy License Server (10.8) Page 5 of 34 Administration Guide About This Document
The Knowledge Base Search page opens.
5. Search or browse the Knowledge Base.
To search the knowledge base:
n In the Search box, type a search term or phrase and click Search.
Documents that match the query display in a results list.
To browse the knowledge base:
n Select one or more of the categories in the Browse list. You can browse by:
o Repository. Filters the list by Documentation produced by technical publications, or Solutions to Technical Support cases.
o Product Family. Filters the list by product suite or division. For example, you could retrieve documents related to the iManage, IDOL, Virage or KeyView product suites.
o Product. Filters the list by product. For example, you could retrieve documents related to IDOL Server, Virage Videologger, or KeyView Filter.
o Version. Filters the list by product or component version number.
o Type. Filters the list by document type. For example, you could retrieve Guides, Help, Packages (ZIP files), or Release Notes.
o Format. Filters the list by document format. For example, you could retrieve documents in PDF or HTML format. Guides are typically provided in both PDF and HTML format.
6. To open a document, click its title in the results list.
To download a PDF version of a guide, open the PDF version, click the Download icon in the PDF reader, and save the PDF to another location.
To download a documentation ZIP package, click Get Documentation Package under the document title in the results list. Alternatively, browse to the desired ZIP package by selecting either the Packages document Type or the ZIP document Format from the Browse list.
Autonomy License Server (10.8) Page 6 of 34 Administration Guide About This Document
Autonomy welcomes your comments.
To send feedback on Autonomy documentation
l send email to [email protected]
l provide:
n full document title with version and revision number
n location: heading, a snippet of text or screen capture
n your comments
n your contact information in the event we need clarification Related Documentation
The following documents provide more details on License Server. Conventions
The following conventions are used in this document. Notational Conventions
This document uses the following conventions.
Convention Usage
Bold User-interface elements such as a menu item or button. For example:
Click Cancel to halt the operation.
Italics Document titles and new terms. For example:
l For more information, see the IDOL Server Administration Guide.
l An action command is a request, such as a query or indexing instruction, sent to IDOL Server.
monospace File names, paths, and code. For example: font The FileSystemConnector.cfg file is installed in C:\Program Files\FileSystemConnector\.
Autonomy License Server (10.8) Page 7 of 34 Administration Guide About This Document
Convention Usage
monospace Data typed by the user. For example: bold l Type run at the command prompt.
l In the User Name field, type Admin.
monospace Replaceable strings in file paths and code. For example: italics user UserName
Command-Line Syntax Conventions
This document uses the following command-line syntax conventions.
Convention Usage
[ optional ] Brackets describe optional syntax. For example:
[ -create ]
| Bars indicate “either | or” choices. For example:
[ option1 ] | [ option2 ]
In this example, you must choose between option1 and option2.
{ required } Braces describe required syntax in which you have a choice and that at least one choice is required. For example:
{ [ option1 ] [ option2 ] }
In this example, you must choose option1, option2, or both options.
required Absence of braces or brackets indicates required syntax in which there is no choice; you must type the required syntax element.
variable Italics specify items to be replaced by actual values. For example:
. . . Ellipses indicate repetition of the same pattern. For example:
-merge filename1, filename2 [, filename3 ... ]
where the ellipses specify, filename4, and so on.
Notices
The use of punctuation—such as single and double quotes, commas, periods—indicates actual syntax; it is not part of the syntax definition.
Autonomy License Server (10.8) Page 8 of 34 Administration Guide About This Document
This document uses the following notices:
Caution: A caution indicates an action can result in the loss of data.
Note: A note provides information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases—for example, memory limitations, equipment configurations, or details that apply to specific versions of the software
Tip: A tip provides additional information that makes a task easier or more productive.
Autonomy Product References
This document references the following Autonomy products. Autonomy Customer Support
Autonomy Customer Support provides prompt and accurate support to help you quickly and effectively resolve any issue you may encounter while using Autonomy products. Support services include access to the Customer Support Site (CSS) for online answers, expertise-based service by Autonomy support engineers, and software maintenance to ensure you have the most up-to-date technology.
To access the Customer Support Site
l go to https://customers.autonomy.com
The Customer Support Site includes:
l Knowledge Base. The CSS contains an extensive library of end user documentation, FAQs, and technical articles that is easy to navigate and search.
l Case Center. The Case Center is a central location to create, monitor, and manage all your cases that are open with technical support.
l Download Center. Products and product updates can be downloaded and requested from the Download Center.
l Resource Center. Other helpful resources appropriate for your product.
To contact Autonomy Customer Support by e-mail or phone
l go to http://www.autonomy.com/work/services/customer-support
Autonomy License Server (10.8) Page 9 of 34 Administration Guide About This Document
Contact Autonomy
For general information about Autonomy, contact one of the following locations:
Europe and Worldwide North and South America
E-mail: [email protected] E-mail: [email protected]
Telephone: +44 (0) 1223 448 000 Telephone: +1.415.243.9955 Fax: +44 (0) 1223 448 001 Fax: +1.415.243.9984
Autonomy Corporation plc Autonomy, Inc. Cambridge Business Park One Market Plaza Cowley Rd. Spear Tower, Suite 1900 Cambridge CB4 0WZ San Francisco CA 94105 United Kingdom USA
Autonomy License Server (10.8) Page 10 of 34 Chapter 1: Introduction
This section describes the License Server, and the IDOL product suite and system architecture.
l "License Server"
l "Autonomy’s IDOL Platform"
l "License Server Architecture" License Server
The Autonomy License Server allows you to license all your Autonomy products.
When you set up your Autonomy system, you install a License Server on a machine that all other services can contact over the network. This License Server must have access to the license key file that contains your licensing information.
You then configure each Autonomy service with a [License] configuration section. In this section, you configure the host and port of the License Server. These components then contact the License Server for license details when they start up. The License Server manages the licenses for all your services.
You can operate the License Server using ACI actions, HTTP requests that provide a quick way to operate the License Server from your Web browser. Autonomy’s IDOL Platform
License Server integrates with Autonomy’s Intelligent Data Operating Layer (IDOL). IDOL gathers and processes unstructured, semi-structured, and structured information in any format from multiple repositories using IDOL connectors and a global relational index. It can automatically form a contextual understanding of the information in real time, linking disparate data sources together based on the concepts contained within them. For example, IDOL can automatically link concepts contained in an e-mail message to a recorded phone conversation, which can be associated with a stock trade. This information is then imported into a format that is easily searchable, adding advanced retrieval, collaboration, and personalization to an application that integrates the technology.
For more information on IDOL, refer to the IDOL Getting Started Guide. License Server Architecture
You can send ACI actions or service actions to the License Server using your Web browser. You send ACI actions using the ACI port of the machine that License Server is installed on. You can also send service actions to the License Server using your Web browser (for example, to pause or stop the License Server). You send service actions using the service port of the machine that the License Server is situated on.
Autonomy License Server (10.8) Page 11 of 34 Administration Guide Chapter 1: Introduction
Autonomy License Server (10.8) Page 12 of 34 Chapter 2: Install License Server
This section describes how to install Autonomy License Server. The License Server is required for licensing Autonomy products.
l "Use the IDOL Server Installer"
l "Download License Server" Use the IDOL Server Installer
This section describes how to use the IDOL Server stand-alone installer to install License Server on Windows.
To run the stand-alone installer program
1. Double-click the appropriate installer package:
IDOLServer_VersionNumber_Platform.exe The Welcome dialog box opens.
2. Read the text, and click Next.
The Windows Admin Privilege dialog box opens.
3. Ensure you have administrative privileges, then click Next.
The License Agreement dialog box opens.
4. Read the license agreement. Select I accept the terms of the License Agreement, then click Next.
The Select Install Folder dialog box opens.
5. Specify the folder to install License Server in. By default, it installs the system in C:\Program Files\Autonomy\IDOLServer on Windows. You can click Choose to navigate to another location. Click Next.
The Choose Install Type dialog box opens.
Autonomy License Server (10.8) Page 13 of 34 Administration Guide Chapter 2: Install License Server
6. Select Advanced Install. You must select this option if you want to install only License Server and not IDOL Server. Click Next.
The License Server LicenseKey File dialog box opens.
7. Type the path or click Choose and navigate to the location of your Autonomy license key file (licensekey.dat), which you obtained when you purchased IDOL.
The Select Install Set dialog box opens.
8. Select Custom from the Install Set list.
Select the check box for the License Server component, and clear the check boxes for the other components. Click Next.
Autonomy License Server (10.8) Page 14 of 34 Administration Guide Chapter 2: Install License Server
The Choose Shortcut Folder dialog box opens.
9. Select a location for shortcut icons, and click Next.
The License Server Port Settings dialog box opens.
10. Change the following information or accept the defaults, then click Next.
ACI Port that client machines use to send ACI actions to the License Server. Port
Service Port by which you send service actions to the License Server. This port must not Port be used by any other service.
The Executable (and Service) Prefix dialog box opens.
11. Enter a prefix for your installation services and executables to uniquely identify them. The prefix must contain only letters and numbers, and must not start with a number. By default, this option is set to Autonomy. Click Next.
The Pre-Installation Summary dialog box opens.
12. Check the settings you have made, and click Install.
The Installing IDOL Server dialog box opens.
The dialog box indicates the progress of the installation process. If you want to end the installation process, click Cancel.
13. The Install Complete dialog box opens. Click Done to exit the installation.
Autonomy License Server (10.8) Page 15 of 34 Administration Guide Chapter 2: Install License Server
Download License Server
You can download the License Server executable file (licenseserver.exe) and a default configuration file (licenseserver.cfg) from the Autonomy customer support site download center. After you download the files, copy them to the machine where you want to install License Server, and place them both in the same folder.
Note: In this case, if you want to install License Server as a service, you must use the - install command line option.
Autonomy License Server (10.8) Page 16 of 34 Chapter 3: Configure License Server
The settings that determine how the License Server operates are contained in the InstallationName.cfg configuration file, which is located in your installation folder. You can modify these settings to customize the License Server according to your requirements.
l "Modify Configuration Parameter Values "
l "Configuration File Sections"
l "Customize Logging" Modify Configuration Parameter Values
This section describes how to enter parameter values in the configuration file. Enter Boolean Values
The following settings for Boolean parameters are interchangeable:
TRUE = true = ON = on = Y = y = 1
FALSE = false = OFF = off = N = n = 0 Enter String Values
Some parameters require string values that contain quotation marks. Escape each quotation mark by inserting a backslash before it.
For example:
FIELDSTART0="" Here, quotation marks indicate the beginning and end of the string. All quotation marks that are contained in the string are escaped.
If you want to enter a comma-separated list of strings for a parameter, and one of the strings contains a comma, you must indicate the start and the end of this string with quotation marks.
For example:
ParameterName=cat,dog,bird,"wing,beak",turtle If any string in a comma-separated list contains quotation marks, you must put this string into quotation marks and escape each quotation mark in the string by inserting a backslash before it.
For example:
ParameterName="",dog,bird,"wing,beak",turtle
Autonomy License Server (10.8) Page 17 of 34 Administration Guide Chapter 3: Configure License Server
Configuration File Sections
The License Server configuration file contains several sections, which represent different areas that you can configure. You can configure each area by setting configuration parameters for it. For details of the available parameters, refer to the License Server Reference.
The configuration file sections that you can use each configuration parameter in are listed under Allowed in Sections.
The configuration file can contain the following sections:
l "Logging Section" below
l "Server Section" on the next page
l "Service Section" on the next page Logging Section
The [Logging] section lists the logging streams that you want to set up to create separate log files for different log message types. It contains a section for each of the listed logging streams, in which you configure the settings that determine how to log each stream.
For example:
[Logging] LogDirectory=MyLogs 0=APPLICATION_LOG_STREAM 1=ACTION_LOG_STREAM
[APPLICATION_LOG_STREAM] LogFile=application.log LogTime=true LogEcho=true MaxLogSizeKbs=1024 LogTypeCSVs=application LogLevel=normal LogExpireACtion=datestamp
[ACTION_LOG_STREAM] LogFile=action.log LogTime=true LogEcho=true MaxLogSizeKbs=1024 LogTypeCSVs=action LogLevel=normal LogExpireAction=datestamp
Autonomy License Server (10.8) Page 18 of 34 Administration Guide Chapter 3: Configure License Server
Server Section
The [Server] section contains settings that determine the ports to use to send ACI actions to the License Server, and which machines can send these actions. It also contains settings that control the management of stale licenses (that is, licenses that have not been issued or updated within a specified number of seconds).
For example:
[Server] AdminClients=*.*.*.* Port=17500 Threads=8 ReplaceStaleLicenses=true UseLicenseWithinSeconds=18000 Related Topics
l "Revoke Stale Licenses" on page 25 Service Section
The [Service] section contains settings that determine which machines have permission to use and control the License Server service.
For example:
[Service] ServicePort=40010 ServiceControlClients=127.0.0.1 ServiceStatusClients=127.0.0.1 Customize Logging
You can customize logging by setting up your own log streams. Each log stream creates a separate log file in which specific log message types (for example, action, index, application, or import) are logged.
To set up log streams
1. Open the License Server configuration file in a text editor.
2. Find the [Logging] section. (If the configuration file does not contain a [Logging] section, create one.)
3. In the [Logging] section, create a list of the log streams you want to set up using the format N=LogStreamName. List the log streams in consecutive order, starting from 0 (zero). For
Autonomy License Server (10.8) Page 19 of 34 Administration Guide Chapter 3: Configure License Server
example:
[Logging] LogLevel=FULL LogDirectory=logs 0=ApplicationLogStream 1=ActionLogStream
4. Create a new section for each of the log streams. Each section must have the same name as the log stream. For example:
[ApplicationLogStream] [ActionLogStream]
5. Specify the settings for each log stream in the appropriate section. You can specify the type of logging to perform (for example, full logging), whether to display log messages on the console, the maximum size of log files, and so on. For example:
[ApplicationLogStream] LogTypeCSVs=application LogFile=application.log LogHistorySize=50 LogTime=true LogEcho=false LogMaxSizeKBs=1024
[ActionLogStream] LogTypeCSVs=action LogFile=logs/action.log LogHistorySize=50 LogTime=true LogEcho=false LogMaxSizeKBs=1024
6. Save and close the configuration file.
7. Restart the service for your changes to take effect.
Autonomy License Server (10.8) Page 20 of 34 Chapter 4: Operate License Server
This section describes how to operate License Server.
l "Start and Stop License Server"
l "Send Actions to License Server" Start and Stop License Server
This section describes how to start and stop your License Server service.
Note: For License Server to run, you must have a valid licensekey.dat file in the same folder as the LicenseServer.exe.
Start License Server
You can start the License Server using one of the following methods:
l Double-click the InstallationLicenseServer.exe file in your installation folder (Windows).
l Start the License Server Service from a system dialog box (Windows).
Note: You must install License Server as a service to use this method.
To start the License Server Service from a system dialog box:
a. Display the Windows Services dialog box.
b. Select the InstallationLicenseServer service, and click Start to start License Server.
c. Click Close to close the Services dialog box. Stop License Server
You can stop License Server from running using:
l services (for Windows):
a. Display the Windows Services dialog box.
b. Select the InstallationIDOL service, and click Stop to stop License Server.
c. Click Close to close the Services dialog box.
Autonomy License Server (10.8) Page 21 of 34 Administration Guide Chapter 4: Operate License Server
l the service port:
Send the following action to the License Server service port (you must have specified a service port in the License Server configuration file):
http://LicenseServerhost:servicePort/action=stop where LicenseServerhost is the name or IP address of the host on which License Server is running, and servicePort is the License Server service port (which is specified in the [Service] section of the License Server configuration file). Send Actions to License Server
You operate License Server by sending actions from your Web browser. The general syntax of these actions is:
http://LicenseServerHost:port/action=action&requiredParams&optionalParams where,
LicenseServerHost is the IP address or name of the machine on which License Server is installed.
port is the ACI port by which actions are sent to License Server (set by the Port parameter in the License Server configuration file's [Server] section).
action is the name of the action you want License Server to run.
requiredParams are the parameters that you must supply for the action you are requesting. (Not all actions have required parameters.)
optionalParams are parameters that you can supply for the action you are requesting. (Not all actions have optional parameters.)
Note: Separate individual parameters with an ampersand (&).
Autonomy License Server (10.8) Page 22 of 34 Chapter 5: License Services
License Server provides licenses for Autonomy products. When you install the Autonomy product, it requests a license from the License Server that you specify during the installation.
Note: For License Server to license a product, the encrypted license file (licensekey.dat) for the product must be located in the License Server installation folder. Refer to the Autonomy product administration guide for details of how to install and license the product.
l "Display License Information"
l "Notes on Licensing"
l "Revoke a Client License"
l "Revoke Stale Licenses"
l "Forcibly Revoke Licenses from Inaccessible Clients" Display License Information
You can display information on the licenses that the License Server can grant, as well as details of licenses that the License Server has already granted.
You can display information on licenses that the License Server grants using an ACI action.
To display license information
l Send the following action from your Web browser:
http://host:port/action=LicenseInfo where,
host is the IP address or host name of the machine on which License Server is installed.
port is the port number that client machines use to communication with License Server. This port is specified in the Port configuration parameter in the License Server configuration file [Server] section.
Notes on Licensing
You must install License Server on a machine with a known static IP address.
After you set up your licensing, you can revoke licenses at any time, for example, to reallocate them to different clients or to change a client IP address.
Autonomy License Server (10.8) Page 23 of 34 Administration Guide Chapter 5: License Services
For modules that License Server licenses, you must not:
l Remove the contents of the license and uid directories.
l Change the IP address of the machine on which a licensed module is running.
l Change the service port of a module.
l Replace the ethernet card.
Any of the above cause the module to become inoperable. If you do need to make changes to a module, you must first revoke the license, and then reissue the license after you have made the change. Revoke a Client License
After you set up licensing, you can revoke licenses at any time, for example, to reallocate them to different clients or to change a client IP address.
To revoke a license
1. Stop the Autonomy solution that uses the license.
2. Run the following action from a command prompt.
InstallDir/ExecutableName[.exe] –revokelicense –configfile cfgFilename
This action returns the license to the License Server.
You can send the LicenseInfo action from a Web browser to the running License Server server to check for free licenses. In this sample output from the action, one IDOL server license is available for allocation to a client.
l "Display License Information" on the previous page
Autonomy License Server (10.8) Page 24 of 34 Administration Guide Chapter 5: License Services
Revoke Stale Licenses
If a license is stale, you can revoke it by sending the RevokeStaleLicenses action. A stale license is one that has not been issued or updated within a specified number of seconds. You can specify the number of seconds after which a license is regarded as stale as the value of the UseBy action parameter.
For example:
http://LicenseServerHost:port/action=RevokeStaleLicenses &UseBy=18000 You can also use the ReplaceStaleLicenses and UseLicenseWithinSeconds configuration parameters in the [Server] section of the configuration file to automatically revoke stale licenses. For more information, refer to the License Server Reference. Forcibly Revoke Licenses from Inaccessible Clients
If a client machine becomes inaccessible, you can revoke a license on it by sending the next ACI action to the License Server. The AdminRevokeLicense action frees the license from the inaccessible machine.
Note: Call the AdminRevokeLicense function only for inaccessible client machines. Otherwise, the module shuts down and becomes inaccessible.
http://LicenseServerHost:port/action=AdminRevokeLicense &ClientProductType=produ ctType&ClientIP=clientHost&ClientServicePort=clientPort where,
productType is the product type of the Autonomy solution whose license you want to revoke from the inaccessible client.
clientHost is the IP address of the inaccessible client machine.
clientPort is the port by which service actions are sent to the Autonomy module on the inaccessible client (specified by the ServicePort parameter in the module configuration file's [Service] section).
Autonomy License Server (10.8) Page 25 of 34 Administration Guide Chapter 5: License Services
Troubleshoot License Errors
The table below contains explanations for typical licensing-related error messages.
License-related error messages
Error message Explanation
Error: Failed to update license from the The configuration of the service has been license server. Your license cache details do altered. Verify that the service port and IP not match the current service configuration. address have not changed since the service Shutting the service down. started.
Error: License for ProductName is invalid. The license returned from the License Server Exiting. is not valid. Ensure that the license has not expired.
Error: Failed to connect to license server Cannot communicate with the License using cached licensed details. Server. The product still runs for a limited period, however you should verify whether your License Server is still available.
Error: Failed to connect to license server. Failed to retrieve a license from the License Error code is SERVICE: ErrorCode Server or from the backup cache. Ensure that your License Server can be contacted.
Error: Failed to decrypt license keys. Please Provide Autonomy Support with the exact contact Autonomy support. Error code is error message and your license file. SERVICE:ErrorCode
Error: Failed to update the license from the Failed to retrieve a license from the License license server. Shutting down Server or from the backup cache. Ensure that your License Server can be contacted.
Error: Your license keys are invalid. Please Your license keys appear to be out of sync. contact Autonomy support. Error code is Provide Autonomy Support with the exact SERVICE:ErrorCode error message and your license file.
Failed to revoke license: No license to The License Server cannot find a license to revoke from server. revoke.
Failed to revoke license from server Failed to revoke a license from the License LicenseServer Host:LicenseServerPort. Server. Provide Autonomy Support with the Error code is ErrorCode exact error message.
Failed to revoke license from server. An You cannot revoke a license from a running instance of this application is already service. Stop the service and try again. running. Please stop the other instance first.
Autonomy License Server (10.8) Page 26 of 34 Administration Guide Chapter 5: License Services
License-related error messages, continued
Error message Explanation
Failed to revoke license. Error code is Failed to revoke a license from the License SERVICE:ErrorCode Server. Provide Autonomy Support with the exact error message.
Your license keys are invalid. Please contact Failed to retrieve a license from the License Autonomy Support. Error code is Server. Provide Autonomy Support with the ACISERVER:ErrorCode exact error message and your license file.
Your product ID does not match the Your installation appears to be out of sync. generated ID. Forcibly revoke the license from the License Server and rename the license and uid directories.
Your product ID does not match this The service port for the module or the IP configuration. address for the machine appears to have changed. Check your configuration file.
Find the Number of Licensed Documents
You can send the LicenseInfo action to your License Server to find out how many documents your License Server installation is licensed for.
The LicenseInfo response includes a list of the components that you have a license for. For the Content component license information, the following tags show your licensed number of documents:
Tag Description
In addition, the
For example:
Autonomy License Server (10.8) Page 27 of 34 Administration Guide Chapter 5: License Services
Autonomy License Server (10.8) Page 28 of 34 Glossary C
Category component
A The IDOL server component that manages categorization and clustering. ACI (Autonomy Content Infrastructure) Community component A technology layer that automates operations on unstructured information for The IDOL server component that cross enterprise applications, which manages users and communities. enables an automated and compatible business-to-business, peer-to-peer connector infrastructure. The ACI allows enterprise An Autonomy fetching solution (for applications to understand and process example HTTP Connector, Oracle content that exists in unstructured Connector, File System Connector and formats, such as e-mail, Web pages, so on) that allows you to retrieve office documents, and Lotus Notes. information from any type of local or ACI Server remote repository (for example, a database or a Web site). A server component that runs on the Autonomy Content Infrastructure (ACI). Connector Framework Server (CFS)
ACL (access control list) Connector Framework Server processes the information that is retrieved by An ACL is a set of data associated with a connectors. Connector Framework document that defines which users, Server uses KeyView to extract groups, and roles are permitted to access document content and metadata from a document or data source (for example, over 1000 different file types. When the an Oracle database or Windows file information has been processed, it is sent system). to an IDOL server or Distributed Index Handler (DIH). action Content component A request sent to an ACI server. The IDOL server component that active directory manages the data index and performs A domain controller for the Microsoft most of the search and retrieval Windows operating system, which uses operations from the index. LDAP to authenticate users and computers in a network. D
Autonomy Business Console (ABC) DAH (Distributed Action Handler)
An IDOL application that allows you to DAH distributes actions to multiple manage IDOL server content. versions of IDOL server or a component. It allows you to use failover, load balancing, or distributed content.
Autonomy License Server (10.8) Page 29 of 34 Administration Guide Glossary: database - OmniGroup Server (OGS)
database operations that add information.
An IDOL Server data pool that stores Intellectual Asset Protection System indexed information. The administrator (IAS) can set up one or more databases, and An integrated security solution to protect specifies how data is fed to the your data. At the front end, authentication databases. checks that users are allowed to access DIH (Distributed Index Handler) the system that contains the result data. At the back end, entitlement checking The Distributed Index Handler allows you and authentication combine to ensure to efficiently split and index extremely that query results only include documents large quantities of data into multiple IDOL that the user is allowed to see, from servers to create a completely scalable repositories that the user is allowed to solution that delivers high performance access. and high availability. It provides a flexible way of transparently batching, routing, and categorizing the indexing of internal K and external content into the IDOL KeyView server. The IDOL component that extracts data, including text, metadata, and subfiles I from over 1,000 different file types. IDOL
The Autonomy Intelligent Data Operating L Layer (IDOL) server, which integrates LDAP unstructured, semi-structured and structured information from multiple Lightweight Directory Access Protocol. A repositories through an understanding of protocol that applications can use to the content, delivering a real time retrieve information from a server. LDAP environment in which operations across is used for directory services (such as applications and content are automated, corporate e-mail and telephone removing all the manual processes directories) and user authentication. See involved in getting the right information to also: active directory, primary domain the right people at the right time. controller.
IDOL Proxy component License Server
An IDOL server component that accepts License Server enables you to license incoming actions and distributes them to and run multiple Autonomy solutions. You the appropriate subcomponent. IDOL must have an Autonomy License Server Proxy also performs some maintenance on a machine with a known, static, IP operations to make sure the address. subcomponents running, and start and stop them when necessary. O IndexTasks component OmniGroup Server (OGS) A component that processes documents A server that communicates with your before indexing to perform additional security repositories to retrieve access
Autonomy License Server (10.8) Page 30 of 34 Administration Guide Glossary: primary domain controller - XML
permissions for your users and applies them to documents in IDOL server.
P
primary domain controller
A server computer in a Microsoft Windows domain that controls various computer resources. See also: active directory, LDAP.
V
View
An IDOL component that converts files in a repository to HTML formats for viewing in a Web browser.
W
wildcard
A character that stands in for any character or group of characters in a query.
X
XML
Extensible Markup Language. XML is a language that defines the different attributes of document content in a format that can be read by humans and machines. In IDOL server, you can index documents in XML format. IDOL server also returns action responses in XML format.
Autonomy License Server (10.8) Page 31 of 34 Administration Guide Glossary: primary domain controller - XML
Autonomy License Server (10.8) Page 32 of 34 Index install IDOL server 13 L
A License information
ACI Displaying
actions 22 Child services 23
actions license key. see licensing. 14
ACI actions 22 License Server
AdminRevokeLicense 25 configure
RevokeStaleLicenses 25 configuration file sections 18
syntax 22 modify values 17
AdminRevokeLicense action 25 configuring
C configuration file examples 18
Child services licenses
Displaying license information 23 errors 26
configuration parameters forcibly revoke licenses from inaccessible clients 25 Port 22 licensekey.dat 14 ServicePort 25 revoke a client license 24 configure revoke stale licenses 25 License Server M configuration file examples 18 manage stale licenses 19 configuration file sections 18 P modify values 17 Port configuration parameter 22 D R Displaying revoke client licenses 25 Child service license information 23 RevokeStaleLicenses action 25 E S example ServicePort configuration parameter 25 License Server configuration file 18 syntax I actions 22 IDOL 11
IDOL server
installation 13
Autonomy License Server (10.8) Page 33 of 34 Administration Guide Index: ACI – IDOL server
Autonomy License Server (10.8) Page 34 of 34