Dynamic Module Enabler for Unstructured Information Management Architecture Component Analytics

Operating systems: Any Java™-enabled system

Software:

• Java 1.5.x
• OSGi Framework R.4
• UIMA Java Framework 1.4.x or Apache UIMA Java Framework 2.1.x
• Eclipse 3.2.x or above with EMF for Eclipse IDE users

For all users:

Build the bundle of UIMA run-time libraries by running the following command:

java –jar buildUimaRuntimeBundle.jar 
   <options>

The options are described in the help available with the -help option. This utility builds the com.ibm.uima.osgi.runtime.internal bundle and takes the following command line arguments:

• -uima.home uima_home_dir: required -- UIMA home directory
• -uima.version uima_version: required -- UIMA version string in OSGi-compatible format
• -output.dir output_directory: optional -- output directory; by default, current working directory
• -apache: optional flag for creating runtime libraries bundle for Apache UIMA
• -verbose: optional flag indicating that the application should print all informative messages; by default, it prints only basic informative messages
• -help: optional flag for printing this help text.

Further installation steps differ for two groups of users, as described below. The first step is to unzip the enablement package (osgi_enablemet_package.zip) and extract the files.

For Eclipse IDE users:

1. All the package bundles, including the UIMA run-time libraries bundle, should be made visible to the Eclipse PDE workspace by copying them to the Eclipse "plugins" folder or to appropriate extension location.
2. The uima.osgi.annotator.template and uima.osgi.typesystem.template bundles can be imported as sourceprojects into the PDE workspace to help in creating UIMA component bundles.
3. The com.ibm.uima.osgi.app.ae_runner and com.ibm.uima.examples.AERunnerAggregate bundles can also be imported as source projects into the PDE workspace in order to enable the testing of custom AE bundles. The com.ibm.uima.osgi.app.ae_runner project contains the "launch" file; so after it is imported into the PDE workspace, its launch configuration is added to the workspace "run" configuration as the uima_osgi_ae_runner Equinox OSGi Framework application.

For plain OSGi Framework users:

1. All the package bundles, including the bundle of UIMA run-time libraries, should be copied to an appropriate "bundle" folder in order to make them visible to the OSGi container.
2. The following package bundles should always be included in any OSGi container "run" configuration:
   • com.ibm.uima.osgi.runtime
   • com.ibm.uima.osgi.runtime.internal or org.apache.uima.osgi.runtime.internal
   • com.ibm.uima.osgi.service (with start level above the default)
   • com.ibm.uima.osgi.service.internal (with start level above the default)

Additional documentation:

• User guide for the enablement package
• Reference guide for OSGi Service Adaptor
• Zip file for the service adaptor javadoc file

Package Content:

The Modularity Enabler for Unstructured Information Management Architecture (osgi_enablemet_package.zip) consists of the following parts:

• OSGi Service Adaptor bundles, including
  • com.ibm.uima.osgi.service: the API bundle
  • com.ibm.uima.osgi.service.internal: the implementation bundle
• UIMA run-time facade bundle for OSGi platform: com.ibm.uima.osgi.runtime
• Java utility for building UIMA run-time libraries bundle for OSGi platform from existing UIMA Java Framework run-time libraries: buildUimaRuntimeBundle.jar.
• Java utility for updating DocumentAnnotation classes in UIMA run-time libraries bundle: updateUimaRuntimeBundle.jar
• Eclipse plug-in for viewing the JavaDoc of the OSGi Service Adaptor API through Eclipse Help/Help Contents menu under OSGi UIMA Documentation: com.ibm.uima.osgi.help.doc
• UIMA component bundle templates, including
  • uima.osgi.annotator.template: the annotator bundle template
  • uima.osgi.typesystem.template: the type system (TS) bundle template
• OSGi bundles for testing custom UIMA analysis engine (AE) bundles, including
  • com.ibm.uima.osgi.app.ae_runner: UIMA application bundle that runs the predefined aggregate AE
  • com.ibm.uima.examples.AERunnerAggregate: predefined aggregate AE bundle for testing custom AE bundles
  • com.ibm.uima.examples.XCasWriterCasConsumer: predefined CAS Consumer that generates XCAS results for the custom AE tests
• Sample UIMA component bundles, including
  • com.ibm.uima.examples.DateTimeAnnotator: sample date and time annotator bundle
  • com.ibm.uima.examples.RoomNumberAnnotator: sample room number annotator bundle
  • com.ibm.uima.examples.RoomDateTimeAggregate: sample aggregate AE bundle that refers to the room number and date and time annotators
  • com.ibm.uima.tutorial.TypeSystem: sample TS bundle that is used in the room number and date and time annotators.