A Note About Installing the OpenNTF API RC2 Release

Sep 26, 2014, 2:43 PM

Tags: oda

In the latest release of the OpenNTF Domino API, the installation process has changed a bit, which is most notable for Designer. The reason for this is due to the weird requirements in Designer for properly getting source and documentation working.

When downloading the file, instead of the previous Eclipse update sites, there are two Update Site NSFs: one for Designer and one for Domino. There are a couple ways you can use these:

  • If you're already using Update Sites for Designer or Domino, you can use the "Import Database..." action in your existing DB to import the appropriate NSF from the distribution.
  • For Domino, if you're only using the API as far as OSGi bundles go, you can copy the Update Site NSF up to the server and use the OSGI_HTTP_DYNAMIC_BUNDLES INI parameter to point to it.
  • If you'd like to install in Designer from the NSF directly, you can drop it in your data directory, open it in Notes, and go to the "Show URLs..." action on the menu:

    That will display URLs for HTTP and NRPC - the latter is the better one. You can use that to add an update site in the normal File → Application → Install... dialog.

There's an important note about the Designer install: due to the restructuring of the plugins since the last release, it's probably safest to remove any existing installation first. You can do this via File → Application → Application Management:

Find any "OpenNTF Domino" features and uninstall them each in turn:

After that, proceed with installing the API normally from the provided NSF Update Site or your own.

Commenter Photo

David Leedy - Oct 6, 2014, 1:43 PM

I'm not sure I get this bullet point:


  • For Domino, if you're only using the API as far as OSGi bundles go (though, if you are, you're missing out on other great plugins), you can copy the Update Site NSF up to the server and use the OSGI_HTTP_DYNAMIC_BUNDLES INI parameter to point to it.

It seems to imply that by installing via update site you get the API itself but not any of these additional bundled plugins.  Is there another install mechanism to activate them?


Commenter Photo

Jesse Gallagher - Oct 6, 2014, 1:45 PM

The parenthetical refers to the notion of not using any other OSGi plugins already. You're right that it's ambiguous, though - I'll scuttle it.

Commenter Photo

Shillem Volpato - Oct 14, 2014, 7:44 AM

I'm a little confused about this release now.
Before, I was using the plugin in the workspace-dots enviroment for my tasklets. Everything was working. The new plugin, which is also considerably bigger in size, makes references to org.openntf.domino package break. Simply the project doesn't find it anywhere anymore.

If I expand the plugin now I notice the presence of core.org.openntf.* packages.

Sorry for the dumb question but the rare times - sigh - I get back to OSGi I unfortunately have to wrap my head around this ever changing stuff.

Commenter Photo

Jesse Gallagher - Oct 14, 2014, 10:57 AM

I haven't done it, but I would imagine that the workspace-dots folder should get the same plugins/features that Domino-the-server gets, not the Designer ones. The core source of the trouble is the different (likely broken) handling of packaged jars between the server and Domino. With one method, the server will happily work with the library but Designer will balk (and see things like that faux "core.org.openntf.*" packages, which are not real but are instead a symptom of the problem). With the other method, Designer will see everything great, Javadoc and all, but Domino will refuse to load the included jars, breaking required dependencies.

In short: it's a drag, but it's an unfortunate side effect of the growing breadth of the API.

New Comment