Skip to content

Quickstart

Jump to bottom
Serdar Basegmez edited this page Jun 17, 2025 · 1 revision

Using Langchain4j Domino on XPages

Follow these steps to install and use the Langchain4j Domino integration with XPages.

1. Unpack the Release

  • Download and unzip the release file: domino-langchain4j-X.Y.Z.zip

2. Install on Domino Server

  1. Create an Update Site Database

  2. Import the Plug-in

    • Import the DominoUpdateSite folder from the unzipped release into the Update Site database.

  3. Configure Server to Use Update Site

    • Set the OSGI_HTTP_DYNAMIC_BUNDLES notes.ini parameter to include your Update Site database in the OSGi bundles.

  4. Restart HTTP Task

    • From the server console, run: 
      restart task HTTP

  5. Verify the Plug-in is Loaded

    • Check plugin status with: 
      tell http osgi ss langchain4j
    • You should see output similar to: 
      osgi> "Framework is launched."
id   State       Bundle
259  RESOLVED    org.openntf.langchain4j.xsp_1.0.0
osgi> gosh: stopping shell

3. Install on Domino Designer

  1. Remove Older Version (if applicable)

    • If a previous version is installed, remove it first.

  2. Enable Eclipse Plug-in Install

    • In Domino Designer, go to File → Preferences.
    • Under Domino Designer, ensure Enable Eclipse plug-in install is checked.

    Enable Eclipse plug-in install

  3. Install the Plug-in

    • Go to File → Application → Install.
    • In the wizard, choose "Search for new features to install".
    • Use the folder location option and point to the DominoUpdateSite folder from the extracted files.

  4. Restart Domino Designer

    • Restart Domino Designer after installation.

  5. Verify XPages Library

    • In any Domino database, go to XSP Properties → Page Generation tab.
    • Confirm that org.openntf.langchain4j.xsp.library appears in the list of XPages libraries.

Using Langchain4j Domino with Maven

To use Langchain4j Domino in your Maven project, follow these steps:

1. Add the OpenNTF Repository

Add the OpenNTF repository to the <repositories> section of your pom.xml:

<repositories>
    <repository>
        <id>artifactory.openntf.org</id>
        <name>artifactory.openntf.org</name>
        <url>https://artifactory.openntf.org/openntf</url>
    </repository>
</repositories>

## 2. Add Langchain4j Domino as a Dependency

Add the following dependency to the <dependencies> section of your pom.xml:

```xml
<dependency>
    <groupId>org.openntf.langchain4j-domino</groupId>
    <artifactId>langchain4j-domino</artifactId>
    <version>1.0.0</version>
</dependency>

You can now use Langchain4j Domino classes and features in your Maven-based Java project.

Clone this wiki locally