IBM FileNet Connector

Provides a CMIS-compatible connector for integrating Grooper with IBM FileNet Content Engine repositories.

Remarks

Overview

The IBM FileNet Connector enables Grooper to connect to IBM FileNet Content Engine repositories, allowing you to import, browse, and manage FileNet content using Grooper's CMIS infrastructure. This connector translates FileNet object types and operations into CMIS-compliant models, supporting both standard and custom FileNet classes.

Key Features

• Object Store Discovery: Automatically lists available FileNet Object Stores for import as CMIS Repositories.
• Type Mapping: Dynamically maps FileNet classes and properties to CMIS type definitions, supporting custom metadata.
• Document and Folder Operations: Supports creation, update, deletion, navigation, and property management for FileNet documents and folders.
• Versioning: Implements check-in, check-out, and version management for FileNet documents.
• Query Support: Executes CMISQL queries for advanced search and retrieval.

Repository Structure

• Each FileNet Object Store is exposed as a logical CMIS Repository.
• Folders and documents within an Object Store are presented as a hierarchical structure, mirroring the organization in FileNet.
• The root of each repository corresponds to the root folder of the Object Store.
• All FileNet classes (including custom document and folder classes) are available for browsing and query, subject to user permissions.

CMIS Type Exposure

• Folder Type:
  FileNet folders are exposed as the cmis:folder type, with custom folder classes appearing as subtypes.
• Document Type:
  FileNet documents are exposed as the cmis:document type, with custom document classes appearing as subtypes.
• Custom Types:
  All custom classes defined in FileNet (both document and folder types) are exposed as additional CMIS types.
  These appear as children of the standard cmis:document and cmis:folder types, allowing you to work with custom metadata fields and structures defined in FileNet.
• No Secondary Types:
  This binding does not expose any CMIS secondary types. All FileNet classes are mapped as primary types.

Search Capabilities

• Metadata Search:
  You can search on any standard or custom property exposed by the selected CMIS type using the WHERE clause in CMISQL. Supported predicates include =, <>, <, >, <=, >=, LIKE, IN, and IS NULL/IS NOT NULL (with some restrictions).
• Full-Text Search:
  Full-text search is supported using the CONTAINS() predicate in CMISQL, provided the FileNet repository is configured for content-based retrieval.
• Scope Predicates:
  The IN_FOLDER() and IN_TREE() predicates are supported for restricting queries to specific folders or subtrees.
• LIKE Operator:
  The LIKE operator is supported for string properties, with standard SQL wildcard support.
• IN Predicate:
  The IN predicate is supported for string, ID, and numeric properties.
• Limitations:
  • Some advanced CMISQL features, such as JOINs and secondary types, are not supported.
  • Not all FileNet properties may be queryable, depending on repository configuration and permissions.
  • The NOT operator may have limited support depending on the FileNet version and configuration.
• Examples:
  • SELECT * FROM cmis:document WHERE DocumentTitle LIKE '%invoice%' AND CreatedBy = 'jsmith'
  • SELECT * FROM CustomDocType WHERE Amount > 1000 AND Status IN ('Open', 'Pending')
  • SELECT * FROM cmis:document WHERE CONTAINS('contract AND \"service agreement\"')

Configuration & Usage

1. Configure Connection Settings
   • Set the 'Content Engine Service URL', 'Content Engine User ID', and 'Content Engine User Password' properties to connect to your FileNet instance.
   • The service URL should use HTTPS and point to the FileNet Content Engine web service endpoint.
2. Import Object Stores
   • Use Grooper's UI to list and import available FileNet Object Stores as CMIS Repositories.
3. Repository Operations
   • Once imported, repositories can be browsed, queried, and managed using standard CMIS operations in Grooper.

Implementation Notes

• Requires HTTPS for FileNet API connections. (Consult IBM and Microsoft documentation for non-HTTPS options if needed.)
• Caches type definitions for performance.
• Handles property and type translation between FileNet and CMIS models.

Security Considerations

• Credentials are required and should be protected. Passwords are stored encrypted and masked in the UI.
• HTTPS is strongly recommended to protect credentials and data in transit.

References

• IBM FileNet Content Engine API Documentation
• IBM FileNet Developer's Redbook (PDF)
• Microsoft Web Services Environments for non-HTTPS

Properties

Name	Type		Description
CE Service URL	String	►	The URL to the IBM FileNet Content Engine instance. Specifies the endpoint address for connecting Grooper to the IBM FileNet Content Engine. Format: Typically an HTTPS URL, e.g. https://filenet-server:9081/wsi/FNCEWS40MTOM/. Usage: This value is required for all FileNet operations. It must point to a valid and accessible FileNet Content Engine web service. Security: HTTPS is strongly recommended to protect credentials and data in transit. Example: https://your-filenet-server:port/wsi/FNCEWS40MTOM/ > Note: If your environment does not support HTTPS, refer to IBM and Microsoft documentation for enabling non-HTTPS connections.
CE User ID	String	►	The IBM FileNet user ID. Requiredtrue Specifies the username used to authenticate with the IBM FileNet Content Engine. Usage: This account must have sufficient permissions to access the required Object Stores and perform repository operations. Security: Avoid using highly privileged or shared accounts unless necessary. Example: filenet_admin > Tip: Use a dedicated service account for Grooper integration when possible.
CE User PW	String	►	The IBM FileNet user password. Requiredtrue Specifies the password for the FileNet user account defined in CEUserID. Security: The password is stored in encrypted form and is never displayed in plain text. Usage: Required for authentication to the FileNet Content Engine. UI: This property is masked in the user interface for security. > Important: Update this value if the FileNet account password changes.

Used By

CMIS Connection