Setting Up FileNet Image Services Sources


The FileNet Image Server connector is deprecated in this release, so that maintenance will be provided only when issues are raised by existing customers. No active development, testing, or certification will be provided for this connector.

Documents in FileNet Images Services are organized into Folders. A FileNet Image Services source navigates through the folder hierarchy to crawl all documents in FileNet Image Services (IS). Oracle SES creates the index and stores the metadata of the documents retrieved from FileNet Images Services in Oracle SES to provide search according to the end users' permissions.

A FileNet Image Server instance can have one or more Libraries. A Library is the document repository and contains documents within Folders and sub-Folders. A FileNet Image Services source can crawl multiple Libraries.

Images stored in Image Services can have annotations. Some annotations contain text, and these annotations are crawled. The annotations crawled are:

  • Stamp

  • Transparent Text

  • Stick note

You can search on the content of these annotations after the IS library has been crawled.

Important Notes for FileNet Image Services Sources

A user belonging to IS SysAdmin group must be used to crawl documents and metadata in IS.

Required Software

  • FileNet Image Services Server version 4.0 or 3.6 SP2

  • Image Services Resources Adapter version 3.2.1

Required Tasks

Because FileNet Image Services software is not included with Oracle SES, you must perform these tasks manually to integrate with Oracle SES:

  • Deploy the ISCrawlerWeb.war file in the same application server on which ISRA has been deployed.

  • For application servers that require context root to be specified while deploying a WAR file, specify Context Root as ISCrawlerWeb.

  • If the application server is WebSphere Application Server, then activate URL rewriting: Click Servers - Application Servers - server_name- Web Container - Session Management - Enable URL Rewriting.

Known Issues

  • If additional document types are configured after the first crawl, then these document types are not indexed on subsequent re-crawls. The same applies if the Document Size parameter is changed after first crawl. For example, Document Size was 10 MB at the time of first crawl and it is changed to 20 MB before re-crawl, then documents with greater than 10 MB are rejected. As a workaround: update the crawler re-crawl policy to Process All Documents on the Home - Schedules - Edit Schedules page, and re-crawl the source.

  • XML documents are crawled by default without configuring the source for XML documents: Oracle SES provides an option of configuring the documents types, including XML, to be crawled. Currently, even if XML document type is not configured, XML documents still are crawled.

Setting Up Identity Management for FileNet Image Services

Activate an identity plug-in on the Global Settings - Identity Management Setup page.

To configure the identity plug-in for Image Services: 

  1. On the Global Settings - Identity Management Setup page, select FileNet Image Services identity plug-in, and click Activate.

  2. Set the following parameters:

    • Authentication Attribute: Select NATIVE.

    • Web Component URL: Enter the host name and port number of the Web component URL; for example, http://webserverhost:port/ISCrawlerWeb.

    • Administrator user name: Enter the Image Services user name.

    • Administrator password: Enter the password of the Image Services user.

    • Library name of IS Server: Enter the name of the Image Services library, such as ISCF. The library name is the ISRA connection factory name that is created when ISRA is deployed.

  3. Click Finish.

See the ISRA documentation for information about these tasks: 

  • The FileNet Image Services Resource Adapter (ISRA) must be deployed on a supported application server. See the ISRA documentation for supported application servers.

  • A connection Factory must be created for ISRA. The connection factory should be configured for the target IS libraries. See the ISRA documentation for deployment instructions.

  • ISRA comes with a viewer application for viewing images and annotations, the FNImageViewer.ear application should be deployed on the same application server as ISRA. This viewer would be invoked to display images for example jpeg, tiff, bmp, gif, and annotations. See the ISRA documentation for deployment instructions.

  • To support secure search, the Image Services server must be synchronized with the Active Directory server. See the section titled LDAP configuration in ISRA deployment guides for importing Microsoft Active Directory users and groups to Image Services.

  • After Active Directory users and groups have been imported into Image Services, ISRA must be configured to authenticate with Active Directory. See the section titled LDAP Configuration in the ISRA deployment guide for details.

Creating a FileNet Image Services Source

Create a FileNet Image Services source on the Home - Sources page. Select FileNet Image Services from the Source Type list, and click Create. Enter values for the following parameters:

  • Container names: The names of the containers to be crawled by Oracle SES. You can crawl an entire FileNet Image Services Library or a specific Folder. The format is LibraryName/FolderName/SubFolderName(cache_name). Library name is the ISRA connection factory name created when ISRA is deployed. Cache name is where the document content can be found. Multiple comma-delimited container names can be entered. Required.

    For example:

    • Container name: LibraryName1(cache name): The entire LibraryName1 is crawled

    • Container name: LibraryName2/Folder1/(cache name): Folder1 and its sub-folders are crawled.

    • Container name: LibraryName1, LibraryName2/Folder1(cache name): The entire LibraryName1 and Folder 1 in LibraryName2 are crawled

    • Cache name: The format is cache name: DomainName:Organization. This is an optional parameter. If the cache name is not provided, then the plug-in tries to retrieve document content from the default page cache. However, the plug-in throws an error if an invalid page cache or empty brackets () are specified. Ask the Image Services administrator for cache details.

  • User name: Enter the user name of a valid FileNet Image Services user. The user should be a SysAdmin user or a user who has access to all Folders and Documents of the Libraries configured in the Container name parameter. The user should be able to retrieve content, metadata and ACL from folders, documents and other custom sub classes. The user should be defined in the configured LDAP server and should be imported into IS. Required.

  • Password: The FileNet Image Services user password. Required.

  • Web component URL: The URL of J2EE application server where the crawler plug-in Web component module is deployed. The format of the URL is http://host:port. Required.

    The Web component is also used to view the search results. On clicking an Oracle SES search result, the user is prompted to log in. After the user successfully logs in, the document is displayed.

    To display images and annotations, you must deploy the FileNet Image viewer FNImageViewer.ear. FNImageViewer.ear is a part of ISRA CD. If the viewer is not deployed, the images are displayed in the native viewer or the user is prompted to download the document.

  • Attribute Names: The comma-delimited list of Image Services attributes along with their data types to search. The format is attributeName:attributeType, attributeName:attributeType. Valid values are String, Number, and Date. Table 7-5 identifies equivalent FileNet and Oracle SES data types.

    In a Library, the crawler indexes an attribute only if both name and type of the attribute in the library match the configured name and type; otherwise, it is ignored. Optional.

    For example, to make the following FileNet Image Services attributes searchable:

    • Attribute name: account name attribute type: String

    • Attribute name: account ID attribute type: Integer

    • Attribute name: creation date attribute type: Date

    The value of Attribute List is:

    Account Name: String, Account Id: Number, Creation Date: Date

  • Set source hierarchy: Indicates whether the source should set the source hierarchy of the document, either true or false. The default value is false. Any other value is interpreted as false.

    A document in Image Services can be filed in multiple folders. A user may have READ permissions on a document but not on all the folders in which the document is filed. If Set Source Hierarchy is true, then a user could view a source hierarchy on which he or she does not have permissions in Image Services. However, the user cannot view the documents on which he or she does not have READ permissions.

  • Set Public Access: Indicates whether the source sets the public access of the documents whose ACL is Anyone. Set this parameter to true or false. The default value is false. Any other value is interpreted as false.

  • Authentication Attribute: This parameter is used to get the LDAP authentication attribute. The appropriate value varies based on the identity plug-in used for authentication. For Microsoft Active Directory, set it to USER_NAME. For FileNet Image Services identity plug-in, set it to NATIVE.

Table 7-5 FileNet Image Services Data Type Mapping

Sr. No FileNet Image Services Data Type Oracle SES Data Type