Search
Clear search
Close search
Google apps
Main menu

Configuring the Connector for Livelink

Support end date : Sep 30, 2016

Connector Manager version 3.0


This document contains the information you need to install the Google Search Appliance Connector for Livelink and configure the Google Search Appliance and the connector to traverse, index, and search content in an OpenText Livelink ECM - Enterprise Server content repository.

This document is for Livelink administrators and administrators who install and configure the Google Search Appliance. If you are not familiar with the system that the connector will traverse and index, work closely with your system administrators to determine the correct values for installing and configuring the connector.


Introducing the Google Search Appliance Connector for Livelink

The Google Search Appliance Connector for Livelink is software that enables the Google Search Appliance to index and search content files and metadata that are stored in an OpenText Livelink ECM - Enterprise Server content repository. The connector formats content and metadata from the repository and feeds it to the Google Search Appliance as a content feed. This section discusses how the Google Search Appliance Connector for Livelink works and the different software components in an installation.

The connector provides query-time authentication and authorization using the available native security mechanisms.

After you install and configure a Livelink repository, the connector traverses the Livelink repository and feeds Livelink documents and their metadata to the search appliance for indexing. Traversal begins with the earliest document modification date and works forward. After the initial traversal, the connector works in an incremental mode to index documents that are added or modified.


Components in the Google Search Appliance Connector Installation

A typical connector installation consists of these components:

  • A content repository, which consists of the content management system server, the content files, and the supporting database in which metadata is stored, if any. A Google Search Appliance can index multiple repositories. You must configure one connector for each repository you index.
  • The content management system web client, installed on any platform supported by the content management system
  • The content management system's native API, which is typically installed on the connector manager host
  • Any other supporting software components of the content management system
  • An LDAP server or other external mechanism used for user authentication
  • Java Development Kit (JDK) or Java Runtime Environment version 1.5
  • A Google Search Appliance Connector installation, which consists of Apache Tomcat, the connector manager, and the connector for your content management system. These components are installed using a Google-provided installer
  • A Google Search Appliance

Supported Livelink Version

The connector supports OpenText Livelink ECM – Enterprise Server, versions 9.5 and later. The connector does not work with Livelink 9.2 SP1 or earlier.

Note: Information about Livelink, as used in this document, also applies to certain products labeled OpenText. Please refer to the OpenText website for further clarification.

Supported Operating Systems

The Google Search Appliance Connector for Livelink is supported on the following operating systems:

  • Windows Server 2008
  • Windows XP SP2 Professional
  • SUSE Linux Enterprise Server 10
  • SUSE Linux Enterprise Server 9

The connector manager and the Google Search Appliance Connector for Livelink are supported in virtualization environments. Google does not provide support for specific virtualization environments or for issues that are specific to virtualization.


Supported Java Version

The Google Search Appliance Connector for Livelink requires a minimum of Java Runtime Environment 5 and may support JRE 6.


Supported Apache Tomcat Version

The installer installs a connector manager, a connector type, and Apache Tomcat 6.0.18. Tomcat 5.5.23 is supported for this release of the connector and connector manager.


Before You Install the Connector

Port Settings

  • The default port for access to the Livelink server is 2099. Ensure that this port is open in your environment.
  • When HTTP Tunneling is enabled, ensure that ports 80 and 443 are open instead.

Configuring Crawl and Feeds for the Connector

Before you install the Google Search Appliance Connector for Livelink, you must make an addition to the Follow and Crawl URLs defined in the Admin Console. The Google Search Appliance rejects content in the repository without the addition.

To configure crawl and feeds for the connector:

  1. On the Admin Console, navigate to the Crawl and Index > Crawl URLs page.
  2. In the Follow and Only Crawl URLs with the Following Patterns box, add the following statement:

    ^googleconnector://

  3. Save the configuration.
  4. Click Crawl and index > Feeds.
  5. In the List of Trusted IP Addresses section, select Trust feeds from all IP addresses or Only trust feeds from these IP addresses.
  6. If you selected Only trust feeds from these IP addresses in step 5, type in the trusted IP addresses.
  7. Click Save Settings.

Configuring OpenText Livelink for the Connector

Before you install the connector, review the following information and perform any required tasks.


Ensuring Access to the Livelink Server Port

Some Livelink installations restrict access to the Livelink server port. Check with your network or Livelink administrator to see if the Google Search Appliance or the connector manager has access to the Livelink server port. If access is not allowed, then you need to use HTTP tunneling to access Livelink. For more details, see the Configuring Connector Instances section.


Setting Up the Database

In some circumstances, the Livelink connector depends on the DTreeAncestors database table. If you use one of the following three properties, you must enable the DTreeAncestors table:

  • Items to index on the connector configuration form
  • The excludedLocationNodes property in the connectorInstance.xml file. For more information on the excludedLocationNodes property, see the Advanced Configuration information for the property on the Livelink connector project hosting site.
  • The showHiddenItems property in the connectorInstance.xml file. For more information on the showHiddenItems property, see the Advanced Configuration information for the property on the Livelink connector project hosting site.

This table might be empty or incomplete if the Recommender agent is not enabled, or if your Livelink server is not at the correct monthly patch level, or in certain other circumstances which might have occurred before the appropriate monthly patch was applied. Contact OpenText for more information about DTreeAncestors or the monthly patches.


Improving Indexing Performance

To improve the indexing performance of the connector, add an index to the Livelink schema in your database.

The connector uses the following SQL ORDER BY clause:

ORDER BY DTree.ModifyDate, DTree.DataID

By default, this sort requires a full table scan. The addition of an index on the ModifyDate and DataID columns of DTree changes the execution plan to use an index scan instead. The following SQL CREATE INDEX statement shows the general idea:

CREATE INDEX DTree_Google ON DTree (ModifyDate, DataID)

You can use Oracle Enterprise Manager or SQL Server Enterprise Manager to create the index with a graphical user interface, or modify the CREATE INDEX statement to work in your environment and schema.


Preparing the Livelink Server for the Connector and Ensuring that Documents are Deleted from the Search Index

You can use the auditing feature of Livelink to ensure that documents are deleted from the Google Search Appliance index when they are deleted from the repository.

To enable document deletion:

  1. Log in to the repository as a Livelink Administrator.
  2. On the Livelink Server, navigate to the Livelink Administration page.
  3. On the Administer Event Auditing page, ensure that Delete events are audited.

Improving Document Removal Performance

During the document removal process, the connector queries the DAuditNew table. By default, this query performs a full table scan or an inefficient index scan. If auditing is enabled for a large number of events, ask your database administrator to add an index for the AuditID, AuditDate and EventID columns of the DAuditNew table in the Livelink database. Adding an index on the DAuditNew table changes the query execution plan to use an efficient index scan instead. The following SQL CREATE INDEX statement demonstrates the principle:

CREATE INDEX DAuditNew_Google ON DAuditNew (AuditID, AuditDate, EventID)


Setting Up Required Livelink User Accounts

You need two user accounts for the connector software. If you create specific user accounts for the connector software, you can more easily audit the user and monitor the actions of the connector in the repository.

The following table describes the user accounts and their functions.

Account Description
Traversal user A Livelink user account that the connector uses for indexing Livelink content. The permissions of this user determine the items that are indexed. If you are using a traversal user with Livelink 9.7 or later, this user must have at least See permission for the Workflow volume. The user does not need any permission for the subitems. You can view the Workflow volume from the Livelink Administration page within Livelink. This requirement does not apply to Livelink 9.6 and earlier versions.
System administrator A Livelink user account that the connector uses for access to the Livelink repository and for impersonating search users. The system administrator must have system administration privileges.

Refer to Changing Traversal Scope for details about the steps to take if you change permissions.


Authenticating Search Users with LDAP

If your Livelink server is using the Directory Services module with LDAP authentication, and you want to access the Livelink server port directly for search user authentication, you need to enable LDAP Synchronization and configure your LDAP server. This can be done from the Directory Services Administration section of the Livelink Administration page.

Note: You do not need to perform or schedule synchronization. You only need to configure your LDAP server on the LDAP Parameters page. The Configure LDAP Parameters link is only shown on the Livelink Administration page if LDAP Synchronization is enabled.

Livelink API Requirements

The connector requires the Livelink application programming interface (API), part of the Livelink ECM – Enterprise Server Software Development Kit (SDK) module. For secure connections, it also requires the Livelink ECM – Secure Connect module. The Livelink API and Livelink Secure Connect versions must be compatible, and they must support the Livelink version. Ensure that you use a copy of lapi.jar from a Livelink API installation, not a copy from the application\WEB-INF\lib directory of a Livelink Enterprise Server installation.

The following table contains information on which versions of the Livelink API, Livelink Secure Connect module for encrypted communications, and Livelink Server are supported together:

 
Livelink API Livelink Secure Content Livelink Server
9.7.1 9.7.1 9.7.1
9.6
9.5 SP1
9.7 8.7 9.7
9.6
9.5 SP1
9.6 9.6 9.7
9.6
9.5 SP1
9.5 SP1 9.1.2 9.5 SP1

Enabling ListNodes in Livelink Enterprise Server 9.7.1

The July 2008 and later monthly patches for Livelink 9.7.1 include a patch, LPO-586, PAT00027, that adds several constraints to the LAPI ListNodes function:

  • The function can be disabled, and is disabled by default.
  • The table name is compared to a white list of allowed table names.
  • The query string (SQL WHERE clause) is compared to a black list of disallowed strings.
  • A database transaction is started before the query is executed, and rolled back after the query returns.

The patched ListNodes function writes a new section to opentext.ini that looks like this:

[Lapi]
ListNodesTablesWhiteList={'DTree','WebNodes','WebNodesCatalog'}
ListNodesQueryBlackList={'commit',';','drop','alter','update','insert','delete','create'
EnableListNodes=FALSE
ListNodesSettingSaved=TRUE

For the Google Connector for Livelink to function correctly, you must enable the ListNodes function and add the following tables to the white list:

KDual
dual
DAuditNew
DTreeAncestors

For Oracle-based installations, you must also add the following derived views to the white list:

(select * from DTree order by ModifyDate, DataID)
(select * from DAuditNew order by AuditDate, EventID)

The black list and database transaction rollback do not interfere with the connector.

After you edit the EnableListNodes and ListNodesTablesWhiteList properties, the section looks like this, including the Oracle derived views:

[Lapi] ListNodesTablesWhiteList={'DTree','WebNodes','WebNodesCatalog','KDual','dual','DAuditNew',
'DTreeAncestors','(select * from DTree order by ModifyDate, DataID)','(select * from DAuditNew order by AuditDate, EventID)'}
ListNodesQueryBlackList={'commit',';','drop','alter','update','insert','delete','create'}
EnableListNodes=TRUE
ListNodesSettingSaved=TRUE

Important: Although it shown on two lines above due to formatting constraints, the ListNodesTablesWhiteList value must appear on one line.

If your opentext.ini file does not have a [Lapi] section, or the [Lapi] section does not have these properties, add them as needed.

Restart the Livelink server after making these changes. For more details about LPO-586, see Knowledge Base article 14785312 on the OpenText Knowledge Center.


Requirements on the Apache Tomcat Host

Perform the following tasks on the Apache Tomcat host before installing the connector:

  1. Install the correct version of the Livelink API. The version must contain lapi.jar.
  2. If you are using secure connections to Livelink, install the Secure Connect module, which contains llssl.jar.
  3. Install the Java Development Kit (JDK) or Java Runtime Environment (JRE) 1.5. This is required to run the connector and the installer.

Ensure that these files are available:

  • connector-otex.jar
  • lapi.jar
  • llssl.jar (optional)
Requirements when Apache Tomcat is on a Microsoft Windows Host

The following requirements must be met when you install the connector on a Microsoft Windows host and you want to use HTTP tunneling with Integrated Windows Authentication to connect to Livelink:

  • The Java library path for the servlet container must include the Livelink API binaries
  • The system PATH must include the LAPI bin directory

Add the LAPI bin directory when you install the Livelink API on the host.


Installing the Google Search Appliance Connector for Livelink

This section describes the installation process for the Google Search Appliance Connector for Livelink. You install the connector using an installer that installs Apache Tomcat, a connector manager, and the connector on a host computer.

The instructions that follow are in two parts. In the first part, you download and uncompress the installer package. In the second, you install the software on the connector host.

To download and uncompress the installation package:

  1. Log in to the host using an account with sufficient privileges to install the software.
  2. Start a web browser.
  3. Go to the connector download site on github.com.
  4. Download the correct software distribution package to the host where you are installing the software.
  5. Uncompress the package.
  6. If you are on Windows, skip step 7 and go to the instructions immediately below for installing Tomcat, a connector manager, and the connector.
  7. If you are on Linux, follow these instructions.
    1. Open a terminal window and go to the base directory of the GCI.bin file in the extracted folder.
    2. To run the installer in graphical mode, execute the following command:

      ./GCI.bin LAX_VM/java_location_to_java

      for example, ./GCI.bin LAX_VM /usr/java/j2sdk1.5.2_x/bin/java

    3. To run the installer in console mode, execute the command in Step 3 above with the -i console argument appended.
    4. Go to the following instructions and proceed from Step 2.

To install Apache Tomcat, a connector manager, and the Google Search Appliance Connector for Livelink:

  1. Double-click the distribution file to start the installer.

    You will see an introductory panel.

  2. Click Next.

    The Licence Agreement panel appears.

  3. Indicate whether you accept or decline the terms of the license and click Next:
    • To accept the license, click I accept the terms of the License Agreement.
    • To decline the terms, click I do NOT accept the terms of the License Agreement.
  4. On the Select Connector panel, select the correct connector and click Next.
  5. On the Install Connector panel, choose Install new Google Connector and click Next.
  6. To decline the terms, click I do NOT accept the terms of the License Agreement.
  7. On the Select Connector panel, select the correct connector and click Next.
  8. On the Connector Configuration panel, enter the name you want to assign the connector and a port number that is not already used by another application.

    If you are creating multiple installations of the connector, ensure that you do not use consecutive port numbers. Each connector installation requires two consecutive port numbers for use by Tomcat. For example, if ConnectorInstall1 is installed on port 8080, do not use port 8081 for ConnectorInstall2. In addition, do not use the AJP Connector port (port 8009) listed in the Tomcat server.xml file. In installations where SSL is supported, do not use the SSL port.manager.

  9. On the Livelink Connector Dependencies panel, navigate to the location of each of the required files.
    • lapi.jar
    • llssl.jar (if your configuration requires it)
  10. Enter the Google Search Appliance IP Address, which is the IP address to which the connector sends feeds.

    Entering the address ensures that only the search appliance can communicate with the connector manager.

    If you do not want the connector service to start automatically, uncheck the Start Livelink connector Service after Installation check box.

    If you do not want to register the connector manager on the search appliance during this installation process, uncheck the Register Connector Manager with GSA checkbox.

  11. Click Next.

    On the Connector Configuration panel, enter the name you want to assign the connector and a port number that is not already used by another application.

    If you are creating multiple installations of the connector, ensure that you do not use consecutive port numbers. Each connector installation requires two consecutive port numbers for use by Tomcat. For example, if ConnectorInstall1 is installed on port 8080, do not use port 8081 for ConnectorInstall2. In addition, do not use the AJP Connector port (port 8009) listed in the Tomcat server.xml file. In installations where SSL is supported, do not use the SSL port.

  12. Click Next.

    On the Choose Java Runtime Environment panel, choose the correct JRE for the connector to use and or click Search for Others if the correct JRE is not in the list.

  13. Click Next.
  14. On the Choose Install Folder panel, click Next to accept the default location or click Choose to navigate to a different folder, then click Next.

    The default location is the installation folder chosen in the previous step.

  15. On the Choose Shortcut Folder panel, indicate where you want icons created for the connector and click Next.
  16. Read the information on the Pre-Install\Update Summary panel and click Install.

    An informational panel indicates that the connector installation is in progress. The Register Connector Manager on the GSA panel is displayed.

  17. Type the search appliance administrator user name in the GSA UserID field.
  18. Type the password for the administrator in the GSA Password.
  19. Type the search appliance port number in the GSA Port field.
  20. Type in the Connector Manager Name and Description.
  21. Click Next.

    The installer indicates whether the installation process succeeded or failed and displays information about connector manager connectivity status, the connector manager URL, search appliance status, and the search appliance display URL.

  22. Click Done.
  23. To start the connector service, click Yes.

    Apache Tomcat starts and deploys the connector manager and connector.

  24. If the Start Livelink connector Service after Installation check box was left unchecked, start the connector service:
    • On Windows, click Start > Programs > Googleconnectors > connector_name > Start Livelink connector Service.
    • On Linux, to start the connector as a console, open a terminal windows and navigate to the installation location. Use the following command:

       

      ./Start_LiveLink_Connector_Console
  25. If you did not register the connector manager from the connector installer, continue with the instructions in this document for Registering a Connector Manager. If you registered the connector manager from the connector installer, continue with the instructions in this document for Configuring a Connector on the Admin Console.

Registering a Connector Manager on the Admin Console

This section describes how to register a connector manager on the Admin Console.

If you registered the connector manager from the connector installer during the installation process, skip this section. If you are using the Livelink connector and connector manager that are preinstalled on the search appliance, skip this section.

To register a connector manager on the Admin Console:

  1. Use a browser to log in as an administrator to the Admin Console on the target Google Search Appliance.
  2. Click Connector Administration > Connector Managers.

    If any connector managers are configured, a list of existing connector managers is displayed.

  3. In the Manager Name field, type a name to identify the new connector manager on the Admin Console.
  4. In the Description field, type a description of the new connector manager.
  5. In the Service URL field, type the URL to the Tomcat instance where the connector manager is running.

    This is the root access URL for the connector manager. Ensure that the location you enter is a fully-qualified host name or an IP address. For example, use http://example.com:8080/connector-manager, not http://example:8080/connector-manager.

    If you enter the Service URL and it contains a URL ending in .local or .domain, you see the error Invalid connector manager URL. Use the IP address of the host instead.

    For example, if the connector manager is located in the $CATALINA_HOME/webapps/connector-manager/ directory of a Tomcat server running on the myappserver host machine, its location is http://example.com:8080/connector-manager.

    The following values are used in this example:

    • http://example.com—The host name of the computer on which Tomcat runs. This must be a fully-qualified domain name.
    • 8080—The default http port on which Tomcat serves web applications. The value is configurable. See the Apache Tomcat documentation for further information on changing the value.
    • /connector-manager—The name or context of the web application.
    If access from the Google Search Appliance to Apache Tomcat is through a proxy server, the URL in the Service URL field must include the proxy redirect. For example:

    http://proxy.myexample.com:81/tomcat/connector-manager

  6. Click Save.

    The Admin Console displays a message saying New Connector Manager successfully added. The new connector manager appears in the list of connector managers. If the connector manager is running and Google Search Appliance can connect to it, a green dot appears in the Status column next to its name.

Configuring the Connector on the Admin Console

Use the Add Connector page in the Google Search Appliance Admin Console to create and configure a Livelink connector instance. The Add Connector page prompts you to enter values for all required configuration parameters.

There are five groups of Livelink-specific parameters on the Admin Console:

  • Connector Configuration
  • Livelink System Administrator
  • HTTP Tunneling
  • Separate Authentication
  • Indexing

The first two groups are shown by default. The additional groups can be shown by clicking the Show and enable additional parameters checkbox next to the group name.

Most of the configuration parameters correspond to the Livelink API parameters used to create a session. They are described briefly in the Livelink Configuration Reference section. For more information about these parameters, see “Session Creation Input Parameters” in the Livelink API Developer's Reference Guide from OpenText.

Advanced Configuration

You can configure additional parameters that are not displayed on the Admin Console by modifying the connectorInstance.xml file on the Apache Tomcat host. For complete information on using those parameters, see Advanced Configuration on the Connector for Livelink wiki at code.google.com.

General Guidelines
  • Restrict the feed file size to 100 MB or less to enhance performance, unless you have files larger than that that you wish to traverse.
  • Raise the batch sizes to 1000 by setting the traversal.batch.size in applicationContext.properties. If you do this, also set the Traversal Rate on the configuration page in the Admin Console to 1000. Larger batch files do not provide added benefit.
Adding a Livelink Connector Instance

To add a Livelink connector:

  1. Ensure that Apache Tomcat is running.
  2. On the Google Search Appliance Admin Console, click Connector Administration -> Connectors.

    The list of existing connectors is displayed.

  3. In the Add Connector section, choose the correct connect manager from the drop-down list.
  4. Click Add New Connector.

    New fields are displayed, including the name of the connector manager you selected.

  5. In the Connector Name field, type the name of the connector instance.

    Each connector instance added to a particular connector manager or Google Search Appliance must have a unique name. The connector name must consist of no more than 64 alphanumeric characters. All alphabetical characters must be lower-case. Connector names may include underscores (_) and hyphens (-), but they cannot begin with a hyphen.

  6. From the Type drop-down list, select Livelink_Enterprise_Server.
  7. Click Get Configuration Form.

    The connector manager name, connector name, and connector type are displayed.

  8. In the Host field, type the host name of the machine to connect to.
  9. In the Port field, type the port number to connect to.
  10. In the Livelink URL field, type the Livelink URL for search results.
  11. In the Username field, type the Livelink user name to use for indexing.

    Depending on the connector version you are configuring, the Username and Password fields have different definitions. For more information, see Livelink User Accounts.

  12. In the Password field, type the Livelink password for the configured user name.
  13. In the Livelink Domain field, optionally type name of the Livelink domain the configured user belongs to.
  14. Set up optional configuration parameters.
    • If your Livelink environment requires you to configure HTTP tunneling, check HTTP Tunneling and continue with Configuring HTTP Tunneling, then complete steps 16 to 20.
    • If your Livelink environment requires you to configure separate authentication, check Separate Authentication and continue with Configuring Separate Authentication, then complete steps 16 and following.
  15. Type the Username for indexing. For more information, see Livelink User Accounts.
  16. In the Items to Index field, optionally type a comma-separated list of object IDs specifying the items to index.

    This field is in different places on the configuration page, depending on which connector version you are configuring.

    If no items are specified, all of the items in the standard workspaces are indexed.

  17. In the Traversal Rate section, type the number of documents per minute that you want traversed. The default is 200.
  18. In the Retry Delay field, type the number of the minutes the connector waits between when a traversal is completed and when the next traversal starts.
  19. To suspend the traversal process without changing the existing connector schedule, check Disable Traversal.
  20. In the Connector Schedule section, indicate the hours between which you want the repository traversed.
  21. Click Save Configuration.
  22. To add lines to the connector schedule, click the Edit link next to the connector instance.
  23. Click Add Line to Schedule for each additional traversal period you want to schedule.

    Note that a connector scheduled to run from 12 a.m. to 12 a.m. always runs. Any other schedule with the same beginning and ending time never runs, either for a connector or for the Google Search Appliance's standard crawl function.

  24. Click Save Configuration.

Configuring HTTP Tunneling

This section provides instructions for configuring the Google Search Appliance and Google Search Appliance Connector for Livelink to use HTTP tunneling.

To configure HTTP tunneling and add the connector:

  1. Next to the HTTP Tunneling label, check the Show and enable additional parameters checkbox.
  2. Click Save Configuration.
  3. Complete the fields that are displayed.

    See HTTP Tunneling Parameters later in this document for more information.

  4. Click Save Configuration.
Note: If NTLM is required, then a full LAPI installation is needed.
Verifying That the Connector is Working

After you configure the connector, wait a few minutes and then verify on the Admin Console Feeds page that the Google Search Appliance is receiving feeds. Ensure that the following entry exists on the Crawl Diagnostics page:

connector_instance_name.localhost

Click the entry and navigate through successive links to verify that documents have been sent to the search appliance by the connector named connector_instance_name as content feeds.

After you verify that the search appliance is correctly receiving feeds, perform a search. Unless all content indexed by the connector is public content, perform a secure search.

To view the documents crawled by the connector and the data fed to the search appliance, enable feed logging, a feature that is disabled by default. This is available only for connectors installed on stand-alone hosts.

To enable feed logging:

  1. On the connector manager host, navigate to the directory where the connector is installed.
  2. Navigate to the Tomcat\webapps\connector-manager\WEB-INF directory or folder.
  3. Start a text editor and open the file applicationContext.properties.
  4. Locate the property feedLoggingLevel and change the value to ALL.
  5. Save the file.
  6. Restart the connector. The feed logs are available for all new documents sent by the connector to the search appliance.

Livelink Configuration Reference

The following sections describe the connector configuration parameters for the Livelink connector.


Connector Configuration Parameters

The following table describes the connector configuration parameters:

 
Name Description Values and Usage
Host The host name of the machine to connect to. This may be the host name or IP address of the Livelink server, the Web server, or the proxy server.

Livelink API: server parameter.

No default value.
Port The port number to connect to. This may be the port number of the Livelink server, the Web server, or the proxy server.

Livelink API: port parameter

For a standard Livelink connection, the port number is configured by the Port parameter in the general section of the opentext.ini file. For a tunneled or proxied connection, the port number should be the port number of the Web server or proxy server. The default value is 2099.
Livelink URL The Livelink URL for search results, for example, “http://host::port/Livelink/livelink.exe”. This is usually the standard URL through which users access Livelink. The Livelink URL must include a fully-qualified host name for the Cached and Text Version links in the search results to work. No default value.

Livelink System Administrator Parameters

The following table describes the system administration parameters for Software Version 1.0.1:

 
Name Description Values and Usage
Username The user name for a Livelink system administrator account that the connector uses for access to the Livelink repository and for impersonating search users. Set to the system administrator account that you configured in Livelink. No default value.
Password The password for the system administrator No default value.
Livelink Domain The name of the Livelink domain the configured user belongs to.

Livelink API: DomainName attribute in config parameter.

For a domains-enabled Livelink Server, the default value is the system domain.

HTTP Tunneling Parameters

In some environments, the connector manager does not have access to the Livelink server port, due to firewall restrictions. In cases where the Livelink server port is restricted, use HTTP tunneling through the Livelink web interface. To configure HTTP tunneling, click the Show and enable additional parameters check box next to the HTTP Tunneling label and then click the Save Configuration button. The configuration form expands to include the following parameters.

 
Name Description Values and Usage
Livelink CGI The Livelink URL path, for example, “/Livelink/livelink.exe”. The host and port values are taken from the Host and Port parameters. This parameter enables HTTP tunneling. If you are using a proxy server, the Host and Port parameters specify the proxy server, so you must include the Livelink host and port in fully-qualified URL, for example, “http://host::port/Livelink/livelink.exe”.

Livelink API: LivelinkCGI attribute in config parameter.

This is an optional parameter, with no default value.
HTTP Username The Web server user name.

Livelink API: HTTPUserName attribute in config parameter.

No default value.
HTTP Password The Web server password. Livelink API: HTTPPassword attribute in config parameter. No default value.
Enable NTLM Whether or not to use NTLM authentication. Livelink API: EnableNTLM attribute in config parameter. The default value is false. See “Session Creation Input Parameters” in the Livelink API Developer’s Reference Guide for more information about using NTLM when authenticating.
Use HTTPS Specifies whether to use HTTPS when tunneling, instead of HTTP. Livelink API: HTTPS attribute in config parameter. The default value is false.
Send Credentials to Web Server. Specifies whether the search user's credentials should be passed to the web server for authentication. Boolean value. This parameter is used only if HTTP tunneling is enabled (through the Livelink CGI parameter).

The default value is false.


Indexing Parameters

The following table describes the indexing parameters.

 
Name Description Values and Usage
Username A Livelink user account that the connector uses for indexing Livelink content. The permissions of this user determine the items that are indexed.

Livelink API: userName parameter.

Note: If the user permissions change, you must reset the Livelink Connector.
The default value is the Livelink system administrator account.
Items to Index A comma-separated list of object IDs specifying the items to index. For any listed items that are containers, such as workspaces, folders, projects, or discussions, all of the sub-items are also be indexed. If no items are specified, all of the items in the standard workspaces are indexed.

Specifying items to index requires the use of the DTreeAncestors table in Livelink, which in turn requires that the Livelink Recommender agent be enabled. The latest monthly Livelink patches are recommended.

This parameter is optional. No default value.

How Search is Supported

The connector indexes the same items that Livelink indexes, such as documents, folders, projects, and discussions. The exact types and locations to be indexed are configurable. For documents, only metadata and the original file of the current version are indexed. Renditions and earlier versions are not indexed. If the original file is larger than 30 MB, the file is skipped and only metadata will be indexed.

All attributes that have the same name are collected together as a single multi-valued property. For example, suppose that two categories are applied to an item, both have a Description attribute, and the item has values for both. Both values of Description are indexed. This collection of values takes place across metadata from different sources and with different data types. A category attribute named Comment is combined with the object info and version info attributes that are also named Comment.

If you follow the instructions in Ensuring that Documents are Deleted from the Google Search Appliance Index, items that are permanently deleted from Livelink are removed from the index on the Google Search Appliance.


Categories and Attributes

The connector indexes several types of Livelink metadata:

Categories

The categories that are attached to an item. By default, all category attributes that are marked as searchable within Livelink are indexed.

Category permissions are used only during the traversal and indexing processes, to determine which Categories are added to the index. Under version 1.0, the traversal user is a system administrator and all Categories are indexed. Under version 1.0.1, the traversal user is not required to be a system administrator, and the traversal user's permissions determined which Categories are indexed. All indexed attributes are available to any search user who has permission to view the item. Category permissions are not used at serve time.

System attributes

Additional node attributes defined in the database. By default, no system attributes are indexed.

Object info

This type includes metadata returned by GetObjectInfo, or essentially, the columns of the DTree table, including the ExtendedData assoc. By default, the following object info attributes are indexed:

  • Comment
  • CreatedBy
  • CreateDate
  • ModifyDate
  • Name
  • SubType
  • VolumeID
  • UserID

The object info attributes CreatedBy and UserID are indexed with the corresponding username string values, not the numeric user IDs.

Version Info

This type includes metadata returned by GetVersionInfo, or essentially, the columns of the DTreeVers table. By default, the following version info attribute is indexed:

MimeType

Only the atomic attributes are given names and indexed. Attribute sets and assoc values like ExtendedData are not indexed as a group. Only the constituent attributes are searchable.

Data Types

The Google Search Appliance supports the same data types as Livelink:

  • string
  • integer
  • boolean
  • date
  • float

You can search content and metadata in Livelink using the same search syntax that the Google Search Appliance supports with web content.


Traversal

The Google Search Appliance locates web and file system content for indexing through a process called crawl or crawling.

The Google Search Appliance locates content in a content repository using a process called traversal. Traversal is a process in which the connector issues queries to the repository to retrieve content files and the metadata associated with each content file. The content files and metadata are then fed to the Google Search Appliance as a content feed. For more information about content feeds, see the Feeds Protocol Developer’s Guide in GSA Product documentation.

In the initial traversal of a repository, the files are retrieved by last-modified date, starting with the oldest documents in the repository. After the initial traversal, files are retrieved when they are added to a repository or modified.

You can configure the Livelink installation so that documents deleted from the Livelink repository are also deleted from the index on the Google Search Appliance. For instructions, see Preparing the Livelink Server for the Connector and Ensuring that Documents are Deleted from the Search Index.

If the set of metadata that you select for index is changed you must retraverse the content using the instructions at Resetting Traversal.


Objects That Are Indexed

By default, the Livelink connector feeds all document versions to the search appliance.


Changing Traversal Scope

If you are using a permission-scoped traversal account (which only has access to what you want to index in Livelink) to limit what gets indexed by the Livelink Connector please read this section. For example, you may not want to index certain items, even though they are marked “Public” in Livelink.

The Livelink Connector traverses the entire repository chronologically by Last-Modified-Date. If you choose to restrict what you index with a restricted traversal account, you will have to do the following for the following cases when permissions on the traversal account change:

If Adding Collections or Objects:

  1. Set the permissions for the new object or collection to the traversal account.
  2. Reset the connector so that it can pick up the folder that was added (it will have an old last-modified-date.

If Removing Collections or Objects:

  1. Remove access for the object/collection for the account.
  2. Remove all content from the index.
  3. Reset the connector so that those particular objects/folders from the index will be removed.

How the Traversal Rate Affects Connector Behavior

When you configure a connector instance on the Google Search Appliance Admin Console, you set a traversal rate. The value indicates how many documents per minute the connector traverses in the repository. The default value is 200 documents per minute.

You can set the traversal rate to values higher or lower than 200 documents per minute. The connectors and connector manager are capable of faster traversal rates.

  • To reduce resource consumption in the repository, lower the traversal rate.
  • To increase indexing speed, raise the traversal rate.

If the traversal rate is set to 100 and the connector traverses 100 documents in less than one minute, the traversal process pauses. When the full minute elapses, the traversal process resumes.


Creating and Tuning Connector Schedules

When you schedule connector instances, the performance of the repository is a significant consideration. Depending on the number of traversals and the size of the documents retrieved for indexing, the use of connectors may degrade repository performance. Monitoring and performance-tuning the repository server is especially important when you deploy a new connector or document repository.

Note that a connector scheduled to run from 12 a.m. to 12 a.m. always runs. Any other schedule with the same beginning and ending time never runs, either for a connector or for the Google Search Appliance’s standard crawl function.

When you determine the connector schedule, take the following factors into account:

A connector instance cannot self-modify its traversal schedule. Therefore, you must monitor the performance of both the Google Search Appliance and the content management system regularly, and make manual adjustments to the traversal schedules of connectors to optimize performance. You can tune scheduling for optimal performance in these ways:

Additionally, the connector manager interrupts a connector that takes too long to process a batch of documents. The default duration after which the connector manager interrupts the connector is 1800 seconds, or 30 minutes. The duration is set by the value of the traversal.time.limit property in the applicationContext.properties file. If you want a shorter duration, you can change the value of traversal.time.limit.

To change the default value of the traversal.time.limit property:

  1. Stop Apache Tomcat.
  2. Open the applicationContext.properties file in a text editor. The top of the file contains comments with explanatory text. Do not uncomment any of the explanatory text, including the example for traversal.time.limit.
  3. Examine the file to see whether there is a traversal.time.limit entry.
  4. Save the file.
  5. Restart Tomcat.
Changing the Connector Retry Delay and Schedule

In connector manager 2.0 and later, and search appliance software version 6.2 and later, the search appliance Admin Console enables you to modify the connector retry delay, which is the time period that elapses between when one traversal is completed and the next starts. For example, you might want the connector to traverse the repository every hour between 8 a.m. and 8 p.m. or every two hours from midnight to 9 a.m.

The default retry delay is 5 minutes.

To change the traversal schedule, set the start and end times for traversal on the Connector Schedule drop down menus.

Resetting Traversal

If traversal has stopped or no new documents are being fed to the search appliance, you can reset the connector traversal process. When you reset the traversal, the content is traversed in full from the beginning point and the index is recreated.

Use the Reset link for the connector instance on the Admin Console > Connectors page.

Note: If you are using the default Connector Manager v2.x configuration, connector_manager_host_address must be localhost (or more specifically, 127.0.0.1), and the request must originate from the machine on which the Connector Manager is running. If direct access to the Connector Manager machine is inconvenient, Connector Administrators may wish to add administration machines to the list of IP addresses allowed by the RemoteAddrValve. For more details see RemoteAddrValve in the Google Search Appliance Connector Manager wiki.

When to Delete Feeds

This section applies only to content-feed-based connectors. Under the following circumstances, Google recommends that you delete connector feeds:

  • When you reindex content and the expected new document set leaves out documents or metadata that were previously indexed.
  • When you delete a connector instance

When you are reindexing the content, follow this general procedure:

  1. On the Admin Console > Connector Administration > Add Connector page, check Disable Traversal.

    Traversal is enabled by default.

  2. Make any required updates to the connector configuration.
  3. Delete the feed.
  4. Monitor the Crawl Diagnostics page in the Admin Console.
  5. When the indexed documents are removed from the index, navigate to the Connector Administration >Connectors page and click the Reset link for the connector.
  6. On the Admin Console >Connector Administration > Add Connector page, enable traversal by unchecking Disable Traversal.

If you are deleting a connector instance, we recommend that you separately delete the feed. Otherwise, content indexed by the connector is not removed from the index and public content indexed by the connector continues to appear in search results. However, secure content does not appear in search results because the authorization check fails.


When to Restart the Connector Service

Note: If you are using the Livelink connector and connector manager installed on the search appliance, this section does not apply.

Restarting the connector service means restarting Apache Tomcat.

Restart the connector service only under the following circumstances:

  • When you manually edit the connector’s properties file or one of the configuration files (applicationContext.xml, applicationContext.properties, logging.properties, or connectorInstance.xml).
  • When you install a connector or connector manager JAR file.
Tip: For edits to the connectorInstance.xml file only, you can apply the changes on the Admin Console, without restarting the connector service. Click the Edit link for the connector instance, then click Save Configuration.

Serving: Presenting Results to Users

The following sections describe how the connector serving process works and how serve-time security is maintained.


About Serving

Using the Google Search Appliance and Google Search Appliance Connector for Livelink to search a Livelink content repository is similar to using Google.com to search the web.

To locate particular information or documents in the repository, a user opens a browser window and navigates to a search page. The search page can be the default search page available on the Google Search Appliance or it can be a customized search page. The user types a search term in the search box and clicks Search.

The Google Search Appliance searches its index for documents and metadata containing the user’s search term.

When the Google Search Appliance finds all the documents that match the search request, it presents the user with a pop-up window and asks for the user’s user name and password. The connector manager passes the search results and the user credentials to the repository server. The repository server authenticates the user, evaluates the permissions for each document returned by the user’s search, determines which documents the user is authorized to view, and returns that information to the connector manager.

The Google Search Appliance displays a results page listing the documents the user is authorized to view. When the user clicks a link on the results page, a web client window opens in which the user can view the document or its metadata, depending on how the connector is configured. If the user does not have an open session to the repository, the web client asks for the user’s login credentials before displaying the document.


How Security is Supported

The connector supports authentication against the Livelink database and against an external directory service. For more details, see the Configuring Connector Instances section. The connector obtains authorization from the Livelink server when a user asks to view a particular item and the contents of the item. Since username for Livelink is case-sensitive, you may have issue with username on external directory service that is case-insensitive. The user must have at least See Contents, Read, or Guest permission, depending on the type of the item. For more information about permissions, see the Livelink Online Help.

To encrypt communications between the connector and the Livelink server, you must install and configure the Livelink ECM – Secure Connect module which contains the llssl.jar. Please contact OpenText to download the Secure Connect Module. For information about installing the Secure Connect module for the connector, see the next section, Installing the Google Search Appliance Connector for Livelink. For information about configuring secure connections to Livelink, see the Configuring Connector Instances section.

For More Security Information

For more information on authentication and authorization with connectors, see the chapters on Crawl, Index, and Serve, Use Cases with Public and Secure Serve for Multiple Authentication Mechanisms, and Cookie-Based Authentication Scenarios in Managing Search for Controlled-Access Content.

Upgrading the Connector

You can use the installer to upgrade from older versions of this connector to the current version.

To download and unzip the installation package:

  1. Log in to the host using an account with sufficient privileges to install the software.
  2. Start a web browser.
  3. Navigate to the connector download site on github.com.
  4. Download the software distribution package to the host where you are installing the software.
  5. Unzip the package.
  6. If you are on Windows, skip step 7 and go to the instructions immediately below for installing Tomcat, a connector manager, and the connector.
  7. If you are on Linux, follow these instructions:
    1. Open a terminal window and go to the base directory of the GCI.bin file in the extracted folder.
    2. Give the GCI.bin file execute permission.
    3. To run the installer in graphical mode, execute the following command:

      ./GCI.bin LAX_VM/java_location_to_java

      for example, ./GCI.bin LAX_VM /usr/java/j2sdk1.4.2_15/bin/java

    4. To run the installer in console mode, execute the command with the -i console argument appended.
    5. Go to the instructions below and proceed from Step 2.

To upgrade the connector:

  1. Double-click the installer executable to start the installer.
  2. Click Next.

    The License Agreement panel appears.

  3. Indicate whether you accept or decline the terms of the license and click Next:
    • To accept the license, click I accept the terms of the License Agreement.
    • To decline the terms, click I do NOT accept the terms of the License Agreement.
  4. If you accepted the terms, the installer offers you a choice of installing a new connector or updating the existing connector.
  5. Select the connector to upgrade and click Next.
  6. The installer displays the currently-installed connector version and the version to be installed. The installer also indicates that it must stop the running connector service.
  7. On the Dependencies panel, navigate to the location of the required files for your connector.
  8. To start the connector service automatically when the update is complete, check the checkbox.
  9. Click Next.
  10. Review the information panel and click Install.
  11. The connector is updated.
  12. Click Done.

Uninstalling Connectors and Connector Managers

Deleting a Connector Instance from the Admin Console

You delete a connector instance only on the Admin Console of the Google Search Appliance. When you delete the instance, you delete the configuration information for the instance. The connector manager no longer creates and runs the instance.

Each connector instance is listed on the Admin Console in the Connector Administration > Connectors section. The indicator light is either green or red. Green indicates the existence of the connector instance.

To delete a connector instance:

  1. Log in to the Admin Console as an administrator.
  2. Click Connector Administration > Connectors.
  3. Click the Edit link for the correct connector.
  4. Check the Disable Traversal checkbox for the connector you are deleting.
  5. Click Save Configuration.
  6. On the Connector Administration > Connectors page, locate the connector instance you want to delete.
  7. Click the Delete link on the line for the correct connector instance.
  8. Click OK.

Deleting a Connector Manager

To delete a connector manager, you must complete both of these steps:

  • Unregister the connector manager from the Admin Console.
  • Uninstall the connector manager on the Tomcat host.
Unregistering a Connector Manager from the Admin Console

Before you unregister a connector manager, you must first delete all connector instances associated with that connector manager.

Tip: If you have a large number of connector instances, you can stop the Tomcat instance on which the connector manager is running, then unregister the connector manager. To unregister a connector manager from the Admin Console:
  1. Log in to the Admin Console as an administrator.
  2. Click Connector Administration > Connector Managers.
  3. Locate the connector manager you want to delete.
  4. Click the Unregister link on the line for the correct connector manager.
  5. Click OK.
Uninstalling a Connector Manager

To uninstall a connector manager from the Tomcat host, do one of the following:

  • On Windows, click Start > All Programs > Google Search Appliance Connector version_number > Uninstall.
  • On Linux, click the appropriate shortcut.

To manually delete a connector manager on the Apache Tomcat host:

  1. Log in to the Apache Tomcat host as the installation owner (the user who installed Tomcat).
  2. Shut down Tomcat.
  3. Navigate to the $CATALINA_HOME/webapps directory.
  4. Delete the connector-manager.war file.
  5. Delete the $CATALINA_HOME/webapps/connector-manager directory.
  6. Restart Tomcat.

Troubleshooting the Google Search Appliance Connector for Livelink

This section provides information on the following topics:

  • Diagnosing Connector Problems
  • Logging
  • Error Messages

If you have a problem that requires you to file a ticket with Google Cloud Support, be prepared to provide Support with the following information:

  • Verbose connector logs. See Logging for information on changing the default logging level. If you are reporting a problem to Support, it is ideal if you can reproduce the problem with the logging level set to ALL. However, log files with entries made when the problem occurred are also helpful.
  • Connector configuration files.
  • Feed record and metadata log file.

Diagnosing Connector Problems

If you create a connector instance and no search results are returned, use the following checklist to help diagnose the problem.

 
Problem How to Diagnose
The connector has not traversed any documents. View the Admin Console Feeds page or Crawl Diagnostics page to confirm. View the connector logs to help determine the specific reason.
The search appliance has not accepted the feed. View the Admin Console Feeds page to determine whether the search appliance is accepting feeds.
The connector has not traversed the designated test documents. View the Admin Console Crawl Diagnostics page. Examine the connector logs and look for the end of a traversal or for errors associated with specific documents. Lastly, enable the teedFeedFile and reset the traversal.
The search appliance has not indexed the documents. This can be difficult to determine, but the Crawl Diagnostics page tells you which content files have not been indexed. Usually, you must wait until the content is indexed.

With content feed connectors, a document can appear on the Crawl Diagnostics pages almost immediately, sometimes before the feed appears on the Feeds page. However, the document does not appear in search results for another 5 to 15 minutes. If a document does not appear on Crawl diagnostics, it has not been indexed and probably has not been traversed.

Secure documents were not included in test searches. Ensure that a secure search was performed.
There were authentication failures. Depending on the search appliance version, examine the Security Manager log or the connector logs.
There were authorization failures. Examine the authorization log on the search appliance Access Control page or the connector logs. For connector authorization, the connector log has more details about failures than the search appliance authorization log.
Observes the following exception in the connector log:

SEVERE: Could not impersonate user (Invalid username/password specified.) (-2147482645)

com.google.enterprise.connector.otex.client.lapi.LapiException: Could not impersonate user (Invalid username/password specified.) (-2147482645)

Confirm if Livelink is configured to use Username in DOMAIN\username format. If yes:
  • Update your GSA to version 6.14 or higher
  • You will need to modify the livelink connector to use domain and username
  • Also, ensure that the domain info produced by the authentication mechanism is in the DOMAIN\user format and not DOMAIN.com\user format

Configure connector to attempt authentication for both upper and lower case user names if you see both cases being used in your environment.

Confirm if Livelink is configured to use Username in DOMAIN\username format. If yes:

  • Update your GSA to version 6.14+
  • You will need to modify the livelink connector to use domain and username
  • Also, ensure that the domain info produced by the authentication mechanism is in the DOMAIN\user format and not DOMAIN.com\user format

Configure connector to attempt authentication for both upper and lower case user names if you see both cases being used in your environment: Follow this open source project documentation.

When you examine the connector logs, error messages labeled SEVERE or Exception are good starting points. For authorization issues, search the logs for the user name of the users who experienced authorization failures.


Logging

Logging is a useful technique for recording information about how your installation is operating. You can use the information logged for troubleshooting the operations of the connector, the Google Search Appliance, and Livelink.

The connector manager and connectors use the java.util.logging package for logging. The installer installs a logging mechanism for the connector and starts the logging process automatically. The default logging configuration is defined in the logging.properties file.

To customize the configuration, navigate to connectors_root_dir/connector_name/Tomcat/webapps/connector-manager/WEB-INF/classes and edit the logging.properties file there.

The following line in the file sets the default logging level for the Livelink connector:

.level=INFO

The default logging level for most packages and output destinations (handlers) is INFO. To enable debugging at a finer level of granularity, you can change the default connector manager logging level to ALL or FINER. For example, you might change the logging level as follows:

.level = ALL

The possible values of the level property are OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL. The default level is INFO.

The logging level can be adjusted via the Administration Console—however this change affects only the currently running process and will be reverted back to default upon restarting the connector manager.

The output from the FileHandler appears in the connectors_root_dir/connector_name/Tomcat/logs directory. The output appears in the google-connectors.sequence.log file, where sequence is a series of numbers starting with 0 and incremented by 1 on each occurrence (0, 1, 2, 3...n). The first three log file names would be google-connectors.0.log, google-connectors.1.log, and google-connectors.2.log.

To log all http communications between the connector and the Livelink server, use the httpclient.wire log. Set this log in the logging.properties file only to debug problems, because a very large amount of data is logged, some of it in binary format.

The default level is SEVERE:

httpclient.wire.level=SEVERE

Change the level to ALL:

httpclient.wire.level=ALL

After editing the logging.properties file, restart Tomcat.

In addition, enable logging for the content management system’s native API on the Apache Tomcat host and, if relevant, on the repository server host.

Common Livelink Log Messages

The following table lists some entries that are found commonly in the Livelink connector log files.

 
Log Entry Description
INFO: START TRAVERSAL: 100 rows from ,0,2008-07-02 13:14:28,150075. Indicates the first batch of a traversal run from the beginning. Since the connector is starting a new traversal, only documents deleted after this point are removed from the index, as indicated by a relatively recent date here.
IINFO: START TRAVERSAL: 100 rows from 2007-05-30 11:04:58,32205,2008-07-02 13:14:28,150075. Indicates the first batch of a traversal run from the beginning, with specific items to index. The first date is the modified date of the earliest item to index. The second date, as before, is the deletion date of the most recently deleted document.
FINE: RESUME TRAVERSAL: 100 rows from 2007-02-03 11:55:05,30729,2008-07-02 13:14:28,150075. Indicates the next batch of an ongoing traversal. The first date is the modified date of the last document indexed. The second date is the deletion date of the last document removed from the index.
FINE: RESULTSET: 100 rows. DELETESET: 0 rows. The number of items considered for the latest batch. Some of the items may not have been processed, if the DELETESET contains more than zero rows.
FINE: AUTHENTICATE:username Indicates an authentication attempt for the given user.
FINE: RESULTSET: no rows. Indicates the end of the traversal. The connector pauses for five minutes and then looks for new content to index.
WARNING: Authentication failed for username. Indicates an authentication failure. Check case.
FINE: AUTHORIZE DOCIDS: object-ids FOR: username Indicates an authorization attempt for the given user, performed to filter search results.
The number of authorized documents, when the logging level is too high for more detailed results.
FINEST: AUTHORIZED: object-id: true FINEST: AUTHORIZED: object-id: false The authorization results for each document, in lieu of the count, if the logging level is low enough. True indicates that the user was authorized to see the document, while false indicates that the user was not authorized. Only authorized documents are shown in the search results.

Error Messages

This section describes some commonly encountered error messages and their likely solutions.

Error: Inability to Create an Authentication Object

You might see the following message in a log or on the Admin Console:

Could not create the authentication object for (-2147482645)

This happens when the security section of the opentext.ini file is edited to change Authentication=Livelink to Authentication=. This is an undocumented configuration change that forces Livelink to trust web server authentication. The change prevents LAPI from functioning correctly and in doing so keeps the connector from functioning correctly. LAPI requires an OScript object registered under the given name, which in this case is the empty string. There are four possible work-arounds for the error:

  1. Restore the Authentication=Livelink setting in the opentext.ini file.
  2. Install the OpenText Livelink ECM - Directory Services module, using either NTLM or LDAP.
  3. Install a separate Livelink front-end for the connector, using the setting Authentication=Livelink. No web server access is needed for this front-end. Note that multiple front-ends introduce complexity and require special handling.
  4. Install an OScript module that provides a no-op authentication object. If you do this, there is no way to handle authentication requests in the connector and you must enable authentication on the search appliance in place of connector-based authentication, using LDAP, Kerberos, or other means. Please contact Google Cloud Support for more details.
Search Appliance Unable to Connect to the Connector Manager

If the Apache Tomcat instance where the connector manager is installed is not started or if the location you type in is incorrect or invalid, a message is displayed on the Connector Manager Administration page of the Admin Console saying “The appliance could not connect to the connector manager as specified in the location. Make sure that the URL is correct, or try again later.”

Unable to connect to the connection manager error

HTTP 404 Error When Registering a Connector Manager

When you are registering a new connector manager, you might see the following error message:

The HTTP response failed with the following code: 404. No external connector managers registered.

This means that the CATALINA_HOME environment variable is not set correctly on the Tomcat host. Examine the Tomcat startup script or .bashrc and ensure that CATALINA_HOME points to the correct Tomcat installation.

Feed Exception During Traversal

You might see the following error message if you installed a connector manually or you are using a connector manager earlier than version 2.0:

SEVERE: Feed Exception during traversal.

com.google.enterprise.connector.pusher.FeedException: Connection refused: connect

This happens when the connector service is reinstalled, whether or not it is the same version, to a new location, but it is not reregistered on the Admin Console. The connector service points at localhost by default, rather than pointing to the search appliance. In this situation, the connectors are unable to feed documents to the search appliance.

To fix this issue:

  1. Log in to the Admin Console and navigate to the Connector Managers page.
  2. Click the Edit link for your connector manager.
  3. Click the Save button.

Alternatively, you can manually edit the applicationContext.properties file in the Tomcat/webapps/connector-manager/WEB-INF directory by changing localhost to the IP address of the GSA in the following line:

gsa.feed.host=localhost

If you manually edit the file, you must restart Tomcat after you save your changes.

Error Message When Trying to Add a Connector to an Unavailable Connector Manager

When a connector manager is unavailable, the Admin Console displays a circular red indicator next to the connector manager name. If you try to add a connector to an unavailable connector manager, you see the following error message:

The appliance encountered an error while trying to make the following servlet call: getConnectorList

The connector manager might be unavailable for one of the following reasons:

  • Tomcat is not running on the registered host and port.
  • The connector manager host is unreachable.
  • The Tomcat Remote Address Filter is rejecting access.

Check each condition and correct any problems.

Invalid response from the HTTP server

One cause for this error is that you enable HTTP tunneling and specify a Livelink CGI path value, but you set the Port parameter to the Livelink server port. If you use HTTP tunneling, the Port parameter must be the HTTP port of your web server. If you connect directly to the Livelink server port, disable HTTP tunneling.

A host name or IP address is required.

You must supply a value for The Host parameter. The Livelink API has a default value of localhost, but the connector does not use the default.

An HTTP username and HTTP password are required when NTLM authentication is enabled.

If you set the Enabled NTLM parameter to Yes, you must also supply a value for the HTTP Username and HTTP Password parameters. The Livelink API uses the process owner by default, but the connector does not allow this.

Livelink 9.5 or later is required.

The connector does not work with Livelink 9.2 SP1 or earlier. The connector is supported with Livelink 9.5 SP1 or later.

Error in configuration: …

A Livelink error message. For more information, see the Livelink API Developer's Reference Guide from OpenText.

Error in configuration: Invalid username/password specified.

Indicates an incorrect username, password, or Livelink domain.

get(name) not implemented for this datatype

There are three potential reasons that this error will appear:

  • If lapi.jar is from an Enterprise Server installation (OTHOME/application/WEB-INF/lib) from a Livelink version prior to 9.7.1, remote LAPI applications such as the Google connector will not operate. Instead, use a copy of lapi.jar from a Livelink API installation.
  • If a Livelink API call is interrupted by the connector manager or by an I/O error, LAPI may try to use an uninitialized object, which leads to this error. The interrupts are a normal part of the connector operation. The I/O errors typically indicate a loss of connectivity to the Livelink server, either due to a Livelink server outage, or a networking problem or timeout. A timeout can occur when a long-running operation, such as a database query, exceeds a timeout in a proxy server or load balancer used to access Livelink.
  • The traversal user does not have See permission for the workflow volume. The connector obtains authorization from the Livelink server when a user asks to view a particular item or its contents. See Setting Up Required Livelink User Accounts for more information.
Tip Since the username for Livelink is case-sensitive, you may have issues with the username on an external directory service if the external service is case-insensitive. For more information about permissions, see the Livelink Online Help.
SEVERE: toInteger() not implemented for this datatype

You must use LAPI version 9.7.1 to communicate with version 9.7.1 of the Livelink server. There is a LAPI patch for Livelink Server 9.7.1 that claims to fix this issue with earlier versions of LAPI, LPO-550, patch PAT08012. This patch does not correct the problem for the Google connector for Livelink. You must use LAPI 9.7.1.

SEVERE: Premature end-of-data on socket

Indicates a corrupt or missing version file. The corresponding document will be skipped and not indexed. This error appears only in the logs.


Related Documentation

For information visit the Google Search Appliance Help Center.

For the latest connector-specific documentation please see Connector documentation.

For information on developing connectors, see the Connector Developer's Guide. For release notes, see the connector open-source project site.

For more information about using secure connections to Livelink with HTTP over SSL (HTTPS), see the documentation for the Livelink ECM – Secure Connect module from OpenText.

For more information about permissions, see the Livelink Online Help from OpenText.

To learn about advanced configuration with Livelink, refer to the Google Search Appliance Connector for Livelink wiki.

Was this article helpful?
How can we improve it?