Installation

Installation

Download

This first step is to download the software for the plug-in. The plug-in can be downloaded at https://bintray.com/ecmdeveloper/eclipse-plugin/ecmdeveloper or by using the Eclipse update site https://dl.bintray.com/ecmdeveloper/eclipse-plugin/ecmdeveloper/latest.

The plug-in uses the Java API based on the WSI protocol to access the FileNet P8 Content Engine. Because the Java API is not distributed with this plug-in, using this plug-in requires access to the Java API files. Therefore installing this plug-in is a little bit more complicated than a basic plug-in install.

Before you install this plugin you have to make sure that you have the Content Engine Client files available on your local machine. There a two ways to obtain these files:

  • The Content Engine Client files are located in a folder named CE_API in the FileNet installation folder on the Content Engine server. You can copy this folder to your local machine.
  • If you don’t have access to this folder the Content Engine Client files can also be downloaded using the IBM Administrative Console for Content Platform Engine (ACCE) application. Go to Domain > IBM FileNet Content Manager > Java CEWS client and download the client files.

Refer to the documentation of your Eclipse version how to install plug-ins. After the plug-in is installed do not restart Eclipse immediately. For the plug-in to work properly, first the Content Engine Client files must be made available within the Eclipse environment.

First you have to locate the plugins folder of your Eclipse installation. There are two possible situations:

  • If you installed Eclipse using the installer application then the plugins folder is in a folder relative to your user profile. So on a Mac look for the folder /Users/{username}/.p2/pool/plugins and on Windows for the folder C:\Users\{username}\.p2\pool\plugins and on Linux for the folder ~/.p2/pool/plugins.
  • If you installed Eclipse by unzipping the download then the plugins folder is directly under your eclipse folder.

The installation of the ECM Developer plug-in created a folder called com.ecmdeveloper.plugin.lib_2.3.0\lib underneath the plugins folder. Now the following files of the CE_API folder must copied to this folder:

  • Jace.jar
  • log4j.jar or log4j-1.2.14.jar
  • stax-api.jar
  • xlxpScanner.jar
  • xlxpScannerUtils.jar

After this the installation is completed and Eclipse must be restarted. If some of the jar-files are missing an error message will be shown, reporting the missing files. The next step is to import a Content Engine Object Store.

Import CE Object Store

To start using the ECM Developer plug-in you have to import the Object Stores you want to use with this plug-in in the workspace. There are two ways how you can start the import of an Object Store.

  • The first way is to  start the standard Eclipse import wizard using the File > Import command:
    Import Object Store
    In the ECM Developer category select Object Store and continue the wizard.
  • The second way is to go to Window > Show View > Other…, open the ECM Developer category and select the Object Stores view. In this view select the Import Content Engine Object Store menu item.

From here the wizards follow the same path.

  • If there are any existing connections then in the Select Connection page you can either choose to configure a new connection or use an existing connection:
    Selected Connection page
    Choose the appropriate option and continue the wizard.
  • If a new connection is selected or if there are no connections configure yet, then the Configure Connection page will be shown:
    Configure Connection page
    In this page you can enter the necessary connection parameters and use the Connect command to connect to the Content Engine. Every time you connect to this Content Engine these connection parameters will be used. The correct format of the URL can be copied from the ‘ping’ page of your installation. This page can be found at the following URL: http://ceserver:9080/P8CE/Health. Note that if for some reason the Content Engine cannot be reached using the URL supplied then it may take a while before a timeout occurs. After a successful connection is made, the wizard can be continued.
  • The final page of the wizard is the Select Object Store page:
    Select Object Store page
    Select the necessary Object Stores and finish the wizard. If there are no object stores left to import an error message will be displayed.

After you have completed these steps you can start using the Object Stores using the ECM developer plug-in. Browsing the Object Stores is described here.

If you have configured a proxy server within Eclipse, add the Content Engine server as a host for which no proxy server is necessary and restart Eclipse afterwards. This can be done in the Network Connections preference page using the Window > Preferences > General > Network Connections command:

Network Connections