IBM FileNet P8, Version 5.2.1            

Federating IBM FileNet Content Services documents with offline content

You can optionally federate IBM® FileNet® Content Services documents that have offline content. A document is considered offline if it was archived.

About this task

Federated documents that have offline content are represented in the target Content Platform Engine object store as document objects that have content elements that are subtyped as content references instead of content transfers. Content Platform Engine documents that have content references are also known as external documents. The difference between a content transfer and a content reference is that the former returns the actual content while the latter has a content location property that typically contains a URI that points to the actual location of the content. In the case of content that is federated from Content Services, the location property contains a unique identifier of the document in the source repository.

To enable federation of documents with offline content, the FileNet P8 connector for IBM Content Integrator must include the custom property federateOfflineContent with its value set to true. You can update this property in the Content Integrator administration tool by opening the Custom Properties editor for your connector. Restart the content federation exporter and the Content IntegratorVeniceBridgeServices process for the new setting to take effect.
Tip: The name of the federateOfflineContent property is case-sensitive, but the value is not.

Federated documents that have offline content can be declared as records. But IBM Enterprise Records must be aware that the actual content is not under the control of federateOfflineContent and therefore is not deleted when the federated document that the record points to is deleted. For that reason, federated documents with offline content must be treated much like physical records; that is, a manual procedure is required to look up the identity of the actual document in the source repository and ensure that its destruction is carried out appropriately.

Procedure

To configure IBM Enterprise Records to declare documents that have offline content as records automatically upon federation, make the following modifications to the auto-declaration event action script:

  1. Add logic so that documents that have offline content are detected before records are declared.
  2. If the target document has offline content, the appropriate class and destination folder must be specified when the record is declared. The record class and destination folder must be created in advance by the records administrator.

Example

public void onEvent(ObjectChangeEvent event, Id subId)
{

    // Get the source object and object store from the event context.
    IndependentObject source = event.get_SourceObject();
    com.filenet.api.core.ObjectStore srcOS = event.getObjectStore();
    srcOS.refresh();

    if (source instanceof com.filenet.api.core.Document
    && event instanceof CheckinEvent)
    {

        Id sourceDocId = ((Document) source).get_Id();

        // fetch the source document instance.
        // (Make sure property filter includes ContentElements property)
        Document doc = Factory.Document.fetchInstance(srcOS,

                    ((Document) source).get_Id(),
                    getPropertyFilter());


        ContentElement Content Engine = doc.get_ContentElements().getItem(0);
        if (ce instanceof ContentReference)
        {

            // This method sets appropriate record class and destination
            // for offline records
            doDeclareOfflineContentRecord(doc); 

        }

        else

        {

            // This method does normal electronic record declaration
            doDeclareElectronicRecord(doc);

        }

    }

} 


Last updated: October 2015
Planning_for_documents_with_offline_content003.htm

© Copyright IBM Corporation 2015.