6.12 Configuring the Connector for IBM FileNet

LiveCycle supports IBM FileNet, versions 4.0, 4.5, and 5.0 only. Make sure your ECM is upgraded accordingly.

If you installed Connector for IBM FileNet as part of your LiveCycle, you must configure the service to connect to the FileNet object store.

Note: Ensure that installing client for the connectors, copying of JAR's file and configuration changes tasks are performed on all the nodes of the cluster.

Complete the following procedure to configure Connector for IBM FileNet.

Configure Connector for IBM FileNet using FileNet 4.x or FileNet 5.0 and CEWS transport

  1. Open the application server run file in a text editor. The run file is as follows:

    • (JBoss 5.1, Windows) [appserver root]/bin/run.conf

    • (JBoss 5.1, Non-Windows) [appserver root]/bin/run.conf

    • (JBoss 4.2.1, Windows) [appserver root]/bin/run.bat

    • (JBoss 4.2.1, Non-Windows) [appserver root]/bin/run.sh

  2. (Only for FileNet 4.x) Add the location of the FileNet Configuration files as a Java option to the application server start command, and then save the file.

    Note: If JBoss is running as a service, add the Java option in the registry where other JVM arguments are defined.
  3. -Dwasp.location= <configuration files location>

    For example, using a default FileNet Application Engine installation on a Windows operating system, add this Java option: 

    -Dwasp.location=C:/Progra~1/FileNet/AE/CE_API/wsi

  4. If your deployment uses the Process Engine Connector service, copy the file [appserver root]\client\logkit.jar to the following directory:

    • (Manually-configured JBoss 5.1, cluster) [appserver root]/server/all/lib

    • (Manually-configured JBoss 5.1, single server) [appserver root]/server/standard/lib

    • (Adobe-preconfigured JBoss, cluster)[appserver root]/server/lc_<db-name>_cl/lib

    • (Adobe-preconfigured JBoss, single server)[appserver root]/server/lc_<db-name>/lib

    • (Manually-configured JBoss 4.2.1, cluster, upgrade only)[appserver root]/server/all/lib

    • (Manually-configured JBoss 4.2.1, single server, upgrade only) [appserver root]/server/all/lib

  5. Locate the adobe-component-ext.properties file in the [appserver root]/bin folder (if the file does not exist, create it).

  6. Add a new system property that provides the location of these FileNet Application Engine JAR files:

    For Filenet 4.x add following JAR files.

    • javaapi.jar

    • soap.jar

    • wasp.jar

    • builtin_serialization.jar (FileNet 4.0 only)

    • wsdl_api.jar

    • jaxm.jar

    • jaxrpc.jar

    • saaj.jar

    • jetty.jar

    • runner.jar

    • p8cjares.jar

    • Jace.jar

    • (optional) pe.jar

    For FileNet 5.0 add following JAR files

    • Jace.jar

    • javaapi.jar

    • log4j.jar

    • pe.jar

    • stax-api.jar

    • xlxpScanner.jar

    • xlxpScannerUtils.jar

    Note: Add the pe.jar file only if your deployment uses the IBMFileNetProcessEngineConnector service. The new system property should reflect this structure:
    [component id].ext=[JAR files and/or folders]

    For example, using a default FileNet Application Engine installation on a Windows operating system, add the following system property on a new line with no line breaks and end the line with a carriage return:

    Note: The following text contains formatting characters for line breaks. If you copy this text to a location outside this document, remove the formatting characters when you paste it to the new location.
    com.adobe.livecycle.ConnectorforIBMFileNet.ext= 
C:/Program Files/FileNet/AE/CE_API/lib2/javaapi.jar, 
C:/Program Files/FileNet/AE/CE_API/lib2/log4j-1.2.13.jar

  7. (FileNet Process Engine Connector only) Configure the connection properties for the process engine as follows:

    • Using a text editor, create a file with the following content as a single line and end the line with a carriage return: 

      RemoteServerUrl = cemp:http://[contentserver_IP]:[contentengine_port]/ wsi/FNCEWS40DIME/

    • Save the file as WcmApiConfig.properties in a separate folder, and add the location of the folder that contains the WcmApiConfig.properties file to the adobe-component-ext.properties file.

      For example, if you save the file as c:/pe_config/WcmApiConfig.properties, add the path c:/pe_config to the adobe-component-ext.properties file.

      Note: The filename is case-sensitive.

  8. Locate the login-config.xml file in the following folder and add the following application policy as a child of the <policy> node:

    • (Manually-configured JBoss 5.1, single server)[appserver root]/server/standard/conf

    • (Manually-configured JBoss 5.1, cluster)[appserver root]/server/all/conf

    • (Adobe-preconfigured JBoss, single server)[appserver root]/server/lc_<dbname>/conf

    • (Adobe-preconfigured JBoss, cluster)[appserver root]/server/lc_<dbname>_cl/conf
              <application-policy name = "FileNetP8WSI"> 
         <authentication>  
         <login-module code = "com.filenet.api.util.WSILoginModule" flag = 
                "required" /> 
         </authentication>  
        </application-policy>

    • (Manually-configured JBoss 4.2.1, single server, upgrade only)[appserver root]/server/all/conf

    • (Manually-configured JBoss 4.2.1, cluster, upgrade only)[appserver root]/server/all/conf

  9. (FileNet Process Engine Connector only) If your deployment uses the process engine, add the following node to the login-config file:

            <application-policy name = "FileNetP8"> 
            <authentication> 
                <login-module code = "com.filenet.api.util.WSILoginModule" flag = 
                "required" /> 
            </authentication> 
        </application-policy>

  10. If the application server is not currently running, start the server. Otherwise, stop and then restart the server.

  11. If JBoss runs as a service, start (or restart) the JBoss for Adobe LiveCycle ES3 Service.

  12. (Cluster only) Repeat all previous steps on each instance on the cluster.

  13. Open a web browser and enter this URL:

    http://[host]:[port]/adminui

  14. Log in using the default user name and password:

    User name: administrator

    Password: password

  15. Click Services > LiveCycle ES3 Connector for IBM FileNet.

  16. Provide all of the required FileNet repository information and, under Repository Service Provider Information, select IBM FileNet Repository Provider.

    If your deployment uses the optional process engine service, under Process Engine Settings, select Use Process Engine Connector Service and specify the process engine settings. For more information, click the Help link in the upper-right corner of the page.

    Note: The credentials that you provide in this step are validated later when you start the IBM FileNet repository services. If the credentials are not valid, an error is thrown and the services will not start.

  17. Click Save and navigate to Services > Applications and Services > Service Management.

  18. Select the check box next to each of these services and then click Start:

    • IBMFileNetAuthProviderService

    • IBMFileNetContentRepositoryConnector

    • IBMFileNetRepositoryProvider

    • IBMFileNetProcessEngineConnector (if configured)

    If any of the services do not start correctly, verify the Process Engine settings.

  19. Do one of the following tasks:

    • To use the FileNet Authorization service (IBMFileNetAuthProviderService) to display content from a FileNet object store in the Resources view of Workbench, continue with this procedure. Using the FileNet Authorization service overrides the default LiveCycle authorization and must be configured to log in to Workbench by using FileNet credentials.

    • To use the LiveCycle repository, log in to Workbench by using the LiveCycle super administrator credentials (by default, administrator and password). The credentials provided in step 16 use the default LiveCycle authorization service for accessing the default repository in this case.

  20. Restart your application server.

  21. Log in to Administration Console and click Settings > User Management > Domain Management.

  22. Click New Enterprise Domain and then type a domain ID and name. The domain ID is the unique identifier for the domain. The name is a descriptive name for the domain.

    When using MySQL for your LiveCycle database, use only single-byte (ASCII) characters for the ID. (See “Adding enterprise domains” in LiveCycle Administration Help

  23. Add a custom authentication provider:

    • Click Add Authentication.

    • In the Authentication Provider list, select Custom.

    • Select IBMFileNetAuthProviderService and then click OK.

  24. Add an LDAP authentication provider:

    • Click Add Authentication.

    • In the Authentication Provider list, select LDAP and then click OK.

  25. Add an LDAP directory:

    • Click Add Directory and, in the Profile Name box, type a unique name, and then click Next.

    • Specify values for the Server, Port, SSL, Binding, and Populate page with options. If you select User for the Binding option, you must also specify values for the Name and Password fields.

    • (Optional) Select Retrieve Base DN to retrieve base domain names, as required. When finished, click Next.

    • Configure the user settings, click Next, configure group settings as required, and then click Next.

      For details about the settings, click Help link in the upper-right corner of the page.

  26. Click OK to exit the Add Directory page, and then click OK again.

  27. Select the new enterprise domain and click Sync Now. Depending on the number of users and groups in your LDAP network and the speed on your connection, the synchronization process may take several minutes.

    (Optional) To verify the status of the synchronization, click Refresh and view the status in the Current Sync State column.

  28. Navigate to Settings > User Management > Users and Groups.

  29. Search for users that were synchronized from LDAP and perform these tasks:

    • Select one or more users and click Assign Role.

    • Select one or more LiveCycle roles and click OK.

    • Click OK a second time to confirm the role assignment.

    Repeat this step for all users you want to assign roles to. For more information, click the Help link in the upper-right corner of the page.

  30. Start Workbench and log in using the following credentials for the IBM FileNet repository:

    User name:[username]@[repository_name]

    Password: [password]

    The FileNet object store should now be visible in the Resources view within Workbench. If you do not log in using the username@repository name, Workbench attempts to log in to the default repository specified in step 16.

  31. (Optional) If you intend to install the LiveCycle Samples for Connector for IBM FileNet, create a FileNet object store named Samples and install the samples in that object store.

    After you configure Connector for IBM FileNet, it is recommended that you see LiveCycle Administration Help for information about configuring Workbench functions properly with your FileNet repository.

    // Ethnio survey code removed