Search
Clear search
Close search
Google apps
Main menu
true

Configuring the Connector for FileNet

Support end date : Sep 30, 2016

Connector software version 3.0
Connector Manager version 3.0
Installer version 3.0


This document contains the information you need to install the Google Search Appliance Connector for FileNet and configure the Google Search Appliance and the connector to traverse, index, and search content in an IBM FileNet content repository.

This document is for FileNet 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.

Use this document in conjunction with the following related documents:



Introducing Google Search Appliance Connector for FileNet

The Google Search Appliance Connector for FileNet is software that enables the Google Search Appliance to index and search content files and metadata that are stored in an IBM FileNet 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 FileNet works and the different software components in an installation.

For a general overview of how the connector manager and connectors work, see Introducing Connectors.

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

 

After you install and configure a FileNet repository, the connector traverses the FileNet repository and feeds FileNet 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
  • 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 FileNet Version

This connector is compatible with FileNet Content Manager P8 Version 4.0, 4.5 4.5.1, 5.0, and 5.1.


Supported Operating Systems

The connector manager and Google Search Appliance Connector for FileNet are supported on the following 32-bit operating systems:

  • Microsoft Windows Server 2008 SP2 Standard Edition
  • Microsoft Windows Server 2003 Enterprise Edition
  • Red Hat Linux 5

The connector manager and Google Search Appliance Connector for FileNet are supported on the following 64-bit operation systems:

  • Microsoft Windows Server 2008 SP2 Standard Edition
  • Microsoft Windows Server 2008 R2 Enterprise x64 Edition
  • Microsoft Windows Server 2003 Enterprise x64 Edition

The connector manager and the Google Search Appliance Connector for FileNet 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 FileNet requires a minimum of Java Runtime Environment 5 and may support JRE 6.


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

These are the prerequisites for setting up the connector:

  • Java Runtime Environment (JRE) 5 or 6 installed on the connector manager host
  • Ensure that the file Jace.jar is available.
  • Ensure that the following files, which are available in your FileNet Workplace installation, are in the lib2 directory or folder:
    • javaapi.jar
    • activation.jar
    • mailapi.jar
    • p8cjares.jar
    • WcmApiConfig.properties
  • Ensure that the following files are available in the FileNet Workplace installation in the WSI/lib directory or folder:
    • builtin_serialization.jar
    • wasp.jar
    • activation.jar
    • wsdl_api.jar
    • jaxrpc.jar
    • jetty.jar
    • saaj.jar
    • log4j.1.2.x.jar
    • javaapi.jar
  • Ensure that the following files are available in the FileNet Workplace installation in the WSI/conf directory or folder:
    • Clientconf.xml
    • Policy.xml
    • Policy10.xsd
    • package12.xsd
    • package13.xsd

Connector Quick Start

This section provides instructions that enable you to quickly deploy and run a Google Connector for FileNet instance. After you deploy the connector, it crawls and indexes the repository content and the documents become searchable using the Google Search Appliance.

To deploy a connector and create a connector instance with the default settings:

  1. Prepare the FileNet server for the connector.
  2. On the Google Search Appliance Admin Console, Configure Crawl Patterns and Feeds for the connector.
  3. Install the connector.
  4. Register the Connector Manager on the search appliance.
  5. Create a Connector Instance.
  6. Verify that the connector is discovering content from the repository and verify that the search appliance is indexing the content.

Preparing the FileNet Server for the Connector and Ensuring that Documents Are Deleted from the Search Index

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

The FileNet connector uses content feeds to send documents and metadata to the search appliance. The connector is responsible for deleting documents and metadata from the search appliance index when documents are deleted from the content repository. The FileNet connector does this by sending a delete feed to the search appliance when a document is removed from the repository.

To enable document deletion:

  1. Log in to the repository to be indexed by the Google Search Appliance as a user with sufficient privileges to enable audiing.
  2. Open the FileNet Enterprise Manager console.
  3. Select the object store crawled by the connector.
  4. Right-click the object store.
  5. Click Properties.
  6. Click the General tab.
  7. Check the option Auditing Enabled? to enable auditing for the correct FileNet object type.
  8. Click Ok. Auditing is now enabled at the object store level. The panel closes.
  9. To have greater control of auditing for each object type in the FileNet object store:
    1. Create a rule for the audit definition and ensure that the values Success and Apply to Subclasses are incorporated into the rule
    2. Save and validate the rule.

Configuring Crawl and Feeds for the Connector

Before you install the Google Search Appliance Connector for FileNet, 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://

    For metadata-and-URL feeds, the following format is also supported:

    http://hostname:port/foo/bar.html

  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.

Installing the Google Search Appliance Connector for FileNet

This section describes the installation process for the Google Search Appliance Connector for FileNet. 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. Navigate to the connector download site.
  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 FileNet:

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

    You see an introductory panel.

  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. 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. On the FileNet Connector Dependencies panel, navigate to the location of each of the required files.
    • javaapi.jar
    • activation.jar
    • mailapi.jar
    • p8cjares.jar
    Ensure that all of the required .jar files are in the same folder.
  7. If you choose the wrong location and want to use the default location, click Restore Default for the particular location.
  8. Click Next.
  9. 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.

  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.

  11. If you do not want the connector service to start automatically, uncheck the Start FileNet connector Service after Installation check box.
  12. 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.
  13. Click Next.
  14. 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.
  15. Click Next.
  16. 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.

  17. On the Choose Shortcut Folder panel, indicate where you want icons created for the connector and click Next.
  18. 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.

  19. Type the search appliance administrator user name in the GSA UserID field.
  20. Type the password for the administrator in the GSA Password field.
  21. Type the search appliance port number in the GSA Port field.
  22. Type in the Connector Manager Name and Description.
  23. 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.

  24. Click Done.
  25. To start the connector service, click Yes.

    Apache Tomcat starts and deploys the connector manager and connector.

  26. If the Start FileNet connector Service after Installation check box was left unchecked, start the connector service:
    • On Windows, click Start > Programs > Googleconnectors > connector_name > Start FileNet 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_FileNet_Connector_Console

  27. 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.

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.


Creating a Connector Instance

Use the Add Connector page in the search appliance Admin Console to create and configure a FileNet connector instance. The Add Connector page prompts you to enter values for all required configuration parameters, including common parameters for all connectors. During configuration, you provide values for the parameters listed in the following table.

Name Description Values and Usage
Login Login of a Filenet super user The user name of a FileNet super user who can access all documents in the repository
Password Password of the super user The super user's password
Object store Object store name The name of the object store where the documents you want to index are stored
Content Engine URL The URL of the FileNet Content Engine The location of the FileNet Content Engine
Workplace URL URL for results display There are two options, direct access and object access. Direct access links directly to the document containing the search terms, and object access links to a FileNet page containing information about the document as well as a link to it.

For direct access to the documents, enter a URL based on this pattern:

http://server address:port of the application/Workplace/getContent

For access to the FileNet object information, which contains a direct link to the content, enter a URL based on this pattern:

http://server address:port of the application/Workplace/properties/ObjectInfo.jsp
 
Make Public Public/Secure results option Select this option to make public all documents fed to appliance by this connector. When all documents are public, the user can see all possible results from the repository. However, if the user clicks on an access-controlled document, the repository prompts for credentials to authorize access.

When this option is unchecked, all documents fed to appliance by this connector are marked as secure. Only authenticated users can see secure results.
Additional Where Clause Additional clause in FileNet query language. Optional restrictions to be added to the connector Where clause.

To add a FileNet connector on the Admin Console:

  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. On the Type drop-down list, select FileNet_P8.
  7. Click Get Configuration Form.

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

  8. In the Username field, type the user name of a FileNet super user.
  9. In the Password field, type the password for the Super user.
  10. Type the name of the object store where the documents you want to index are stored.
  11. Type the Workspace display URL.
  12. Set isPublic as desired for public or secure results.
  13. In the Traversal Rate section, type the number of documents per minute that you want traversed.

    The default is 200.

  14. 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.
  15. To suspend the traversal process without changing the existing connector schedule, check Disable Traversal.
  16. In the Connector Schedule section, indicate the hours between which you want the repository traversed.

    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.

  17. Click Add Line to Schedule for each additional traversal period you want to schedule.
  18. Click Save Configuration.

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.

Connector Reference

This section contains advanced configuration information for the Google Search Appliance Connector for FileNet.


Connector Instance Parameters

This section contains additional information about the information you provide when you configure a connector.

Name Description Values and Usage
Login Login of a Filenet super user The user name of a FileNet super user who can access all documents in the repository. The connector uses these credentials for traversing the FileNet object store and discovering documents in the object store. The connector can discover only those objects to which the user has access. Therefore, we strongly recommend that you use super user credentials for maximum coverage during traversal. At serve time, the user can have a lower level of user privileges.
Password Password of the super user The super user's password
Object store Object store name The name of the object store where the documents you want to index are stored
Content Engine URL The URL of the FileNet Content Engine The location of the FileNet Content Engine; the URL to Filenet P8. The format is http://ApplicationServerName:port/wsi/FNCEWS40DIME, where FNCEWS40DIME is auto-generated when the Filenet server is installed.
Workplace URL URL for results display There are two options, direct access and object access. Direct access links directly to the document containing the search terms, and object access links to a FileNet page containing information about the document as well as a link to it.

For direct access to the documents, enter a URL based on this pattern:

http://server address:port of the application/Workplace/getContent

For access to the FileNet object information, which contains a direct link to the content, enter a URL based on this pattern:

http://server address:port of the application/Workplace/properties/ObjectInfo.jsp
 
Make Public Public/Secure results option Select this option to make public all documents fed to appliance by this connector. When all documents are public, the user can see all possible results from the repository. However, if the user clicks on an access-controlled document, the repository prompts for credentials to authorize access.

When this option is unchecked, all documents fed to appliance by this connector are marked as secure. Only authenticated users can see secure results.
Additional Where Clause Additional clause in FileNet query language. An Additional Where Clause allows you to specify additional filter conditions to be used by the FileNet connector while traversing documents on given FileNet object store. This clause is a part of a query that starts with AND. Contact your FileNet administrator for more information on constructing Where clauses. The following example restricts traversal to a single subfoler:

AND Document.This INSUBFOLDER '/path_to_add'

In the above example, the connector traverses documents under the subfolder specified by path_to_add.

Advanced Configuration

Advanced configuration is performed by modifying the connectorInstance.xml file, which is located in the Installation_Location\Tomcat\webapps\connector-manager\WEB-INF\connectors\Filenet_P8\instance_of_connector\ directory. You must restart the connector after you edit the connectorInstance.xml file.

For more on setting advanced attribute values, see the advanced configuration section of the Google FileNet Connector Release Notes. The following section describes the advanced configuration attributes and how they affect connector traversal.

Controlling Metadata Sent with Feeds

The connector provides support for both including and excluding metadata. The included and excluded metadata are used to filter the metadata attributes sent with the feeds to the search appliance. The metadata discovered by the connector for each document is first checked against the included/excluded metadata list.

  • SuperSet: The list of all the metadata attributes discovered by the connector for the particular document.
  • included_metadata: The list of attribute names which will be included in the feeds.
  • excluded_metadata: The list of all attribute names which will be excluded from the feeds.

The following rules are applied when you filter metadata:

  • If included_metadata is empty, the attribute list that results from (SuperSet - excluded_metadata) is sent with the feeds.
  • If included_metadata has one or more attributes, the attribute list that results from (included_metadata - excluded_metadata) is sent with the feeds.
Handling Time Zone Issues

A FileNet installation may be set up so that the underlying database is in a time zone different from that of the connector host. The difference between the two time zones results in a time interval. If a document's last-modified date falls in the interval, the document is not indexed.

FileNet connector version 2.6 and later contain improvements to avoid this. The connector now discovers the current machine's time zone and includes it in the query. In addition, if you find errors in indexing because of a time discrepancy, you can manually configure the connector time zone.

Before you do this, determine the time-zone delta for the installation. The time-zone delta is based on the time zone that is maintained by your database server. There are three cases in which database server stores the time-stamp for any particular document.

  1. (Current Time + Current Machine's TimeZone). For example, the Current Time is 1:00 p.m. and the Current Machine's TimeZone is GMT+05:30.If the document is stored at 1:00p.m., the time-stamp stored in the database is (01:00p.m. + 05:30), or 06:30 p.m. In this case, the time zone delta value is GMT-, or GMT-05:30.
  2. (Current Time - Current Machine's TimeZone) For example, the Current Time is 1:00 p.m. and the Current Machine's TimeZone is GMT+05:30. If the document is stored at 1:00 p.m., the time-stamp stored in the database is (01:00p.m. - 05:30), or 07:30 a.m. In this case, the TimeZone Delta value should be GMT+00:00.
  3. (Current Time). For example, the Current Time is 1:00 p.m. and Current Machine's TimeZone is GMT+05:30. If the document is stored at 1:00 p.m. the time-stamp stored in database is (01:00p.m.). In this case, the TimeZone Delta value should be GMT+ , or GMT+05:30.

To manually configure the connector time zone:

  1. On the connector manager host, open the CONNECTOR_HOME\Tomcat\webapps\connector-manager\WEB-INF\connectors\Filenet_P8\connector-instance\connectorInstance.xml file.
  2. Uncomment the property tag <?property name="db_timezone" value=""/> and give the Time-Zone Delta value in the format GMT(+|-)hh:ss
  3. Save the file.
About the Jaas.conf File

This file is required to crawl content on the FileNet 4.0 Server. The JAAS configuration specifies which authentication technologies, or Login Modules, are used to verify client credentials.

A JAAS configuration file contains one entry for each configured application. Each entry consists of a list of Login Modules for that application. Based on the contents of the configuration file, the JAAS framework dynamically determines which set of authentication technologies to invoke when a client application attempts to authenticate itself.

Each entry in a JAAS configuration is marked Required, Requisite, Sufficient, or Optional. The authentication process for the client succeeds only if all Login Modules marked either Required or Requisite succeed. If no Required or Requisite Login Modules succeed, at least one Sufficient or Optional Login Module must succeed.


How Search is Supported

This sections describes how the Google Search Appliance Connector for FileNet supports search.


Supported Document Formats

The FileNet connector supports search for all document formats supported by FileNet. If your repository contains multiple versions of the same document, the FileNet connector traverses only the Major (released) version of the document.


Supported Metadata

The connector supports searching the following FileNet metadata:

  • ClassificationStatus
  • ContentRetentionDate
  • ContentSize
  • CurrentState
  • CurrentVersion
  • DateContentLastAccessed
  • DateCreated
  • DateLastModified
  • DocumentTitle
  • Id
  • IsCurrentVersion
  • IsFrozenVersion
  • IsReserved
  • LastModifier
  • LockTimeout
  • LockToken
  • MajorVersionNumber
  • MimeType
  • MinorVersionNumber
  • Name
  • ObjectStore
  • Owner
  • StorageLocation
  • VersionStatus

You can modify which object types are indexed by manually editing the connectorInstance.xml file. For instructions, see the Advanced Configuration page on Release Notes page for the FileNet connector.

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

Version 2.6 and later of this connector support multivalued metadata of Integer, String, Float, Boolean, Binary, Date, and Object types.


Traversal

The following sections describe how the connector traversal process works.


About the Traversal Process

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 or a metadata-and-URL 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 FileNet installation so that documents deleted from the FileNet repository are also deleted from the index on the Google Search Appliance. For instructions, see Deleting Documents from the Google Search Appliance Index.

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


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, taking the following factors into account :

  • When to run the traversal process

    You might add a connector instance to run in off-peak hours to spread out the initial index creation during times of low demand on the repository.

  • How long to run the traversal process

    You might add a connector instance with a very brief schedule to perform predeployment testing, and experiment to see the effects of lengthening the schedule.

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:

  • Create a schedule that minimizes the number of concurrent traversal processes that are running.
  • Restrict the times at which those processes run. For example, if the content management system is executing a resource-intensive job, the connector might run slowly. Schedule the connector to run at times when demand on the content management system is light.

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.
    • If there is an entry, modify the duration.
    • If there is no entry, add one to the end of the file:

      traversal.time.limit=duration_in_seconds

  4. Save the file.
  5. Restart Tomcat.

Changing the Connector Retry Delay and Schedule

In connector manager 2.0 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.

In search appliance software version 6.0 and later, use Reset link for the connector instance on the Admin Console > Connectors page. On search appliances running software versions earlier than 6.0, use the following instructions from a browser.

To reset the traversal, open a browser and enter a URL in the following format, where connector_manager_host_address is the location of the connector manager and connector_name is the name of the connector whose traversal you are restarting:

http://connector_manager_host_address:8080/connector-manager/restartConnectorTraversal?ConnectorName=connector_name

For example, if the host address is http://www.myhost.com/ and the connector manager is named our_connector:

http://www.example.com:8080/connector-manager/restartConnectorTraversal?ConnectorName=our_connector

The URLs are case-sensitive. After you submit the command, you see a response in the browser window. Some browsers display only a zero (0). Other browsers display a full XML document. A 0 response indicates success. A nonzero response indicates a failure.

<CmResponse>
  <StatusId>0</StatusId>
</CmResponse>

Note that with 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 this page.


When to Delete Feeds

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

  • 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. Secure content does not appear in search results because the authorization check fails.


When to Restart the Connector Service

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). Alternatively, 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.
  • When you install a connector or connector manager JAR file.

Serving

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 FileNet to search an IBM FileNet 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

Each FileNet connector instance uses a FileNet super user name and password to authenticate to the repository for traversal. These credentials are specified in the configuration of each connector instance. See Configuring the Connector on the Admin Console for more information.

The connector provides a configuration parameter for determining the viewing of public and secure results. See details on isPublic in the Configuring the Connector on the Admin Console section of this document.

Query-time authentication and authorization for the connector are handled through the FileNet Java application programming interfaces (APIs). The connector handles authentication and authorization in the connector-independent manner described in Introducing Connectors. You do not need to perform any additional configuration of FileNet or the Google Search Appliance to provide authentication and authorization.

You can make all content public by checking the Make Public checkbox on the connector configuration page.


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.
  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 8 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

    If you accepted the terms, the installer offers you a choice of installing a new connector or updating the existing connector.

  4. Select the connector to upgrade and click Next.

    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.

  5. On the Dependencies panel, navigate to the location of the required files for your connector.
  6. To start the connector service automatically when the update is complete, check the checkbox.
  7. Click Next.
  8. Review the information panel and click Install.

    The connector is updated.

  9. 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 first unregister the connector manager from the Admin Console, then uninstall the connector manager on the Tomcat host.

Before you unregister a connector manager, you must delete all connector instances associate with that connector manager. If you have a large number of connector instances, you can first stop the Tomcat instance where the connector manager is running, then unregister the connector manager.

It is also possible to uninstall the connector manager on the Tomcat host, then unregister the connector manager on the Admin Console.

Unregistering a Connector Manager from the Admin Console

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 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 FileNet

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. See Logging Feed Record and Metadata Information to a Text File for information on generating this 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. This failure is more common with metadata-and-URL feed connectors.

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.

The Documentum connector is slow to index content, but is sending feeds. The connector performs the following three main actions:

1. A query to find documents to add (including updates)
2. A query to find documents to delete
3. The retrieval and feeding of the documents

Usually when the batches are slow the problem is the query performance. Turn the logging level up to FINE to verify that the query execution is slow.

To improve query performance, there are recommended database indexes.

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 metadata-and-URL feeds or policy ACLs, this is where you will find the information you need. For connector authorization, the connector log has more details about failures than the search appliance authorization log.

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 FileNet.

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 FileNet 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.

Starting with GSA version 6.14 when using connector manager 2.8.x 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 restaring 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.

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 Log Messages

The following table lists some entries that are commonly found in FileNet connector log files:

Log Entry Description
Found connector type: Filenet_P8 version: 2.0.0 Shows the connector type and version of connector
Configuring connector: demo_conn Configuring connector with connector instance name  For e.g. demo_conn
Setting included_meta to (CONFIG mode) It displays all the metadata which will be fetched for the document by the connector from FileNet Content repository.
Setting excluded_meta to It displays metadata list which will excluded from included_meta or SuperSet while fetching them for document by the connector from FileNet Content repository
User does not have sufficient permission to retrive the content of document for This Warning occurs when user does not have sufficient permission to access the Object Store.
Unable to retrieve the content of file for If user is unable to retrieve the content of a particular docId then this message occurs.
Number of documents sent to GSA: The number of documents being sent to GSA after a traversal cycle.
Number of documents whose index will be deleted from GSA: The number of documents whose index will be deleted from GSA after a traversal cycle.
Resuming traversal... Traversal has been resumed from the last checkpoint in incremental crawl.
Connection to Content Engine URL is Successful Displays the status of connection to Content Engine server
Connection to Content Engine URL is Failed Displays the status of connection to Content Engine server
Connection to Object Store Object_Store_ Name is Successful Displays the status of connection to Object Store
Connection to Workplace URL is Successful Displays the status of connection to Workplace
Connection to Workplace URL is Failed Displays the status of connection to Workplace
Getting property: Metadata/Property to be fetched
Checkpoint: Displays the checkpoint saved.
Authentication succeeded for user user_name Displays the success of authentication for a user
Authentication Failed for user user_name Displays the failure of authentication for a user
User: user_name is authorized for document ID Message to point out that user is authorized for a particular document id while search.
User:user_name is NOT authorized for document ID While search if a user does not gets authorized for a particular document ID
Starting traversal... Traversal has begun for the first time and connector will be in a full crawl mode and will crawl all the documents

Error Messages

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

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."

Admin Console 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.

HTTP 401 Error When Configuring a Connector

When creating the connector, GSA admin may get the following error:

Cannot connect to the given SharePoint Site URL with the supplied Domain/Username/Password. Reason:(401) Unauthorized

  1. Check that the username and password are correct. Configure the crawler access under Crawl and Index > Crawler Access and perform a manual fetch under Status and Reports > Real-time Diagnostics in the Admin Console to verify connectivity and validate the credentials. If you get a 401, then please confirm the username and password again. If you get a http status of 200, check logs for information below.
  2. Check the connector log. If you see the following error, please check that the user has contribute access.
Aug 23, 2011 11:18:56 AM com.google.enterprise.connector.sharepoint.wsclient.WebsWS checkConnectivity
WARNING: Unable to connect.
AxisFault
faultCode: {http://xml.apache.org/axis/}HTTP
faultSubcode:
faultString: (401)Unauthorized
faultActor:
faultNode:
faultDetail:
{}:return code: 401
401 UNAUTHORIZED
{http://xml.apache.org/axis/}HttpErrorCode:401
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.

This section describes some commonly encountered error messages and their solutions:

Error Message Cause Solution
Invalid credentials. Please enter correct credentials. A user-provided user name or password is incorrect. Provide the correct credentials.
Object Store is invalid. Please enter a valid Object Store name. the object store specified is invalid or the FileNet server is not reachable through the workspace URL specified Verify that the FileNet server is running and verify that the object store exists on the FileNet server.
Required field not specified. Fields marked with an asterisk (*) on the Configuring Connector Instances form are required. Provide appropriate values for these fields.
Unable to validate Workplace URL. Could not connect to the Workplace. Either the remote server is down or the URL is not in proper format. This message occurs when the Workplace URL is incorrect. It might also occur if the remote server is down and connector is unable to connect to the server. Check the protocol used for the URL, which should be HTTP. Ensure that the server name and port number are correct. Ensure that there are no extra forward slashes in the URL.
Unable to validate Content Engine URL. Could not connect to the Content Engine. Either the Content Engine server is down or the URL is not in proper format. This message will occurs when the Content Engine URL is incorrect. Ensure that the Content Engine server is running. Check the URL and ensure that it is in the correct format.

Logging Feed Record and Metadata Information to a Text File

You can log all URLs and metadata fed to a Google Search Appliance without recording all content. There are two ways to implement this logging technique.


Using the feedLoggingLevel Property

To use the feedLoggingLevel property to log URLs and metadata:

  1. Log on to the Apache Tomcat host with the user account under which Tomcat runs.
  2. Shut down the Tomcat instance that hosts the connector manager.
  3. Navigate to the webapps/connector-manager/WEB-INF/ directory.
  4. Open the applicationContext.properties file in a text editor.
  5. Set the feedLoggingLevel property to the value ALL:

    feedLoggingLevel=ALL

  6. Save the applicationContext.properties file.
  7. Restart Tomcat.

    The logging information is recorded in the $CATALINA_BASE/logs/google-connectors.feed%g.log files, where %g is a generation number used to distinguish among rotated logs.


Using a logging.properties Configuration File

To use a logging.properties configuration file to log URLs and metadata:

  1. Log on to the Apache Tomcat host with the user account under which Tomcat runs.
  2. Shut down the Tomcat instance that hosts the connector manager.
  3. Navigate to the logging.properties file.
    • If you installed the connector using the installer, the file is in the connector_directory/Tomcat/webapps/connector-manager/WEB-INF/classes/ directory.
    • If you installed the connector manually, navigate to the location where you created a logging.properties file. The logging.properties file is probably in the $CATALINA_HOME/webapps/connector-manager/WEB-INF/classes directory. If not, copy the logging.properties file from the $JAVA_HOME/lib/ directory to the $CATALINA_HOME/webapps/connector-manager/WEB-INF/classes directory. You might have to create the /classes directory manually.
  4. Open the logging.properties file in a text editor.
  5. Add the following line to the file:

    com.google.enterprise.connector.pusher.DocPusher.FEED_WRAPPER.FEED.level=FINER

  6. Save the logging.properties file.
  7. Restart Tomcat.

    The logging information is recorded in connector_directory/Tomcat/logs/google-connectors.feed%g.log, where %g is a generation number used to distinguish among rotated logs.


Related Documentation

For more information on the connector manager, see Introducing Connectors. For release notes, see the connector open-source project site.

For information on advanced configuration options for the FileNet connect, see Advanced Configuration for the FileNet Connector on the open-source project hosting site.

Related Filenet documentation is installed with the Workplace application. See these documents for more information on Filenet configuration and security settings:

  • Security manager: http://<workplace server host>:<workplace server port>/ecm_help/nav/com_java_start.htm?../developer_help/content_java_api/guide/sec_manager.htm
  • WcmApiConfig file: http://<workplace server host>:<workplace server port>/ecm_help/nav/ae_adm_start.htm?../ae_help/ae_admin/aeadm_config_file_wcmapiconfig.htm
  • Working with security: http://<workplace server host>:<workplace server port>/ecm_help/nav/com_java_start.htm?../developer_help/content_java_api/guide/sec_working_with.htm

For more information about the connection parameters or error messages, see the Livelink API Developer's Reference Guide from Open Text.

Was this article helpful?
How can we improve it?