Skip to main content
Version: Latest (4.63.0)

FileNet Hybrid source connector

The FileNet Hybrid connector uses a FileNet proxy to connect to the FileNet web services, as well as a direct connection to the database. Currently, only Db2 and MSSQL are supported. The proxy is used to retrieve all principals (users and groups) from the FileNet realm and to set the display name on ACLs.

To setup the FileNet proxy, please contact your Xillio representative.

Supported Features​

  • Exporting content structure (folders, documents and custom objects)
  • Exporting binaries
  • Exporting versions
  • Exporting annotations
  • Exporting tasks
  • Exporting users and groups
  • Exporting access control lists

Features Currently Not Supported​

  • Relationships (linked objects)
  • Records management metadata
  • Audit logs
  • Workflows

Settings​

mongoConnection​

The Mongo connection string including the database name to connect to.

fileNetDBConnectionString​

The connection string to the FileNet database.

Example: db2://USERNAME:PASSWORD@filenet.yourcompany.com:50000/OS_DB

fileNetDBEngine​

The engine of the FileNet database. Currently, only Db2 and MSSQL are supported.

fileNetDBOwner​

The owner of the FileNet database schema. Each object store in FileNet has its own database schema.

fileNetUrl​

The URL of the FileNet web service. Example: http://filenet.yourcompany.com/wsi/FNCEWS40MTOM

fileNetUsername​

The username to use for the FileNet web service.

fileNetPassword​

The password to use for the FileNet web service.

fileNetProxyUrl​

The URL of the proxy server to use for the FileNet web service. When left empty, the proxy is not used and principals on ACLs are not resolved. Example: http://localhost:8081

note

When the proxy is not used, principal objects for principals that occur in the records and containers as source.created.principal or source.lastModified.principal will be created without source.email set. In this case, a mapping sheet for updating these principals with emails is required in the Transformation (3b. Principal Mapping) accelerator.

fileNetObjectStore​

The name of the FileNet object store.

fileNetStanza​

The stanza to use for the FileNet web service. Example: FileNetP8WSI

storageMapping​

FileNet stores binaries in different storage areas which can have their own configuration. Each object with content elements references a STORAGE_AREA_ID which is used by the connector to calculate the path of the binary. A storage mapping is required for the connector that describes these different storage areas.

In order to get a list of all storage areas, run a query on the database:

SELECT * FROM <fileNetDBOwner>.STORAGECLASS

Example of a storage mapping:

{
    "9022DB7F-0000-CA1D-8E95-C4BB894C163A" : {
        "path" : "//example/content",
        "structureType" : 1,
        "directoriesPerLevel" : 23,
        "bitsPerSlice" : 16
    }
}

The key of each object is the OBJECT_ID of the STORAGECLASS table. This OBJECT_ID references the STORAGE_AREA_ID value on each object. The path value can be retrieved from column FS_ADS_PATH and is used to calculate the absolute path of each binary. The other three field values can be retrieved from a file in the storage location named fn_stakefile.xml. When these values are not provided, the default values in the example will be used to calculate the relative paths.

retrieveACLs​

Enables retrieving all ACLs of an FileNet object. Can either be true or false.

retrieveAnnotations​

Enables retrieving all annotations of an FileNet object. Can either be true or false.

retrieveTasks​

Enables retrieving all tasks of an FileNet object. Can either be true or false.

retrieveUnfiledDocuments​

Enables retrieving all unfiled documents. Can either be true or false.

rootIds​

A list of comma-separated object ids.

Example: ["1F1F2D3C-4B5A-6978-8796-A5B4C3D2E1F1", "2F1F2D3C-4B5A-6978-8796-A5B4C3D2E1F2"]

discardMetadata​

Cleans the source.properties object for all stored objects by removing default extracted metadata and unused properties.

Only a minimal set of metadata fields required by schemas and processing logic is retained.

Retained metadata per object type

Containers​

For containers the properties in source.properties is reduced to:

["filenet.SECURITY_ID"]

Records​

For documents ("migration.flags.fileNetType" : "DocVersion") the properties in source.properties is reduced to:

["filenet.RNAME", "filenet.SECURITY_ID", "filenet.STORAGE_AREA_ID", "filenet.CONTENT_INFO", "filenet.CONTENT_INFO_2", "filenet.RETRIEVAL_NAMES", "filenet.RETRIEVAL_NAMES_2"]

For custom objects ("migration.flags.fileNetType" : "Generic") the properties in source.properties is reduced to:

["filenet.SECURITY_ID"]

For annotations ("migration.flags.fileNetType" : "Annotation") the properties in source.properties is reduced to:

["filenet.STORAGE_AREA_ID", "filenet.CONTENT_INFO", "filenet.CONTENT_INFO_2", "filenet.RETRIEVAL_NAMES", "filenet.RETRIEVAL_NAMES_2"]

For tasks ("migration.flags.fileNetType" : "Task") the properties in source.properties is reduced to:

["filenet.STATE", "filenet.COORDINATOR_ID", "filenet.START_DATE", "filenet.COMPLETE_DATE", "filenet.LAST_FAILURE_DESC"]

Furthermore, all custom metadata properties on documents, custom objects, annotations and tasks are retained.

Binaries​

For binaries the properties in source.properties is reduced to:

["contentType", "elementSeqNo", "uploadId"]

origin​

Specifies the origin of the document in the Content Store.