Installation

JAddin Framework

Installation Architecture Download

Search…

JAddin Framework

Download

GitHub

Installation

How to install the JAddin framework

1. Prerequisites
HCL Domino 9.0.1 FP8 or higher (Java Virtual Machine 1.8+ requirement)
To avoid out-of-memory errors in the Java Virtual Memory (JVM), make sure the JVM heap size is set to at least 256 MB in the Notes.ini on the HCL Domino server, e.g. JavaMaxHeapSize=256MB
2. Installation
​Download and unzip the installation package.
Copy the JAddin.class and JAddinThread.class from the installation package to your development environment.
Copy the notes.jar file from your HCL Notes or HCL Domino installation to your development environment.
3. Application Distribution
To distribute and install your add-in, you must create a JAR container which includes:
a valid MANIFEST.MF file 
The framework files JAddin.class and JAddinThread.class.
Your application class (e.g. AddinName.class)
MANIFEST.MF
Make sure that the last line of the file is terminated with a newline character.
Manifest-Version: 1.0
Class-Path: .
Main-Class: AddinName
JAR container
There are several tools available to create JAR containers. The easiest way is to use the command line.
jar cvmf MANIFEST.MF AddinName.jar AddinName.class JAddin.class JAddinThread.class
This example creates a new AddinName.jar file with the application AddinName.class and the two JAddin framework files.
Install Application
Copy the JAR container to the domino/ndext directory. This directory is automatically searched by the RunJava task for any Java classes to load.
4. Run Application
There are several ways to start the application:
Option 1: Program Document
The easiest and recommended way is to add a program document in the HCL Domino directory.
Sample Program Document
Option 2: Console Command
Enter the command Load RunJava JAddin AddinName in the HCL Domino console.
> Load RunJava JAddin HelloWorld
03.02.2019 09:31:47   JVM: Java Virtual Machine initialized.
03.02.2019 09:31:47   RunJava: Started JAddin Java task.
03.02.2019 09:31:47   HelloWorld: Started with parameters null
03.02.2019 09:31:47   HelloWorld: Running on Release 10.0.1 November 29, 2018
03.02.2019 09:31:47   HelloWorld: User code is executing...
03.02.2019 09:32:02   HelloWorld: User code is executing...
03.02.2019 09:32:17   HelloWorld: User code is executing...
03.02.2019 09:32:32   HelloWorld: User code is executing...
Option 3: Notes.ini
You may change the line starting with ServerTask= to include the task to be started, e.g.
ServerTasks=Replica,Router,Update,RunJava JAddin AddinName,AMgr,...

JAddin Framework

Debugging Tips

Last modified 1yr ago

Copy link

On this page

1. Prerequisites

2. Installation

3. Application Distribution

MANIFEST.MF

JAR container

Install Application

4. Run Application

Option 1: Program Document

Option 2: Console Command

Option 3: Notes.ini