Domino AppDev Pack

1.0.10

Welcome

Welcome to the Domino AppDev Pack.

The AppDev Pack primarily adds Node.js support to HCL Domino Server. It includes these components:

  • The Proton Domino server add-in task. An administrator installs and configures Proton on one or more Domino servers. If you are a Domino administrator, start with the Administration Overview page.
  • The @domino/domino-db Node.js module. A developer uses this module from a Node.js application. This module uses Proton to perform operations on documents in a server database. If you are a developer, start with the API Documentation page.
  • The com.hcl.domino.db Java API. A developer uses this API from a Java application. The API uses Proton to perform operations on documents in a server database. If you are a developer, start with the java-docs jar provided in AppDev pack kit.
  • The Node.js based Identity and Access Management service, IAM. An administrator deploys IAM aside Domino. For more information, start with the IAM Overview page. A developer uses the IAM client library in their Node.js application to build applications that access Domino resources through:
    • RESTFul APIs with standard OAuth2.0 authorization flows
    • Act-as-User requests in @domino/domino-db

What's New in Release 1.0.10

Release 1.0.10 includes following changes

  • Added 'Act-as-User Configuration' in AppDev Pack configuration database. Administrator needs to add the application's functional IDs to allow an application to perform 'Act-As-User' operations.
  • You can no longer use Proton scopes to perform 'Act-as-User' operations. For existing applications, administrators need to add the configuration to allow 'Act-as-User' operations.

For more information, Refer to 'Act-as-User configuration'.

What's New in Release 1.0.9

Release 1.0.9 includes the following changes:

  • IAM Server
    • CSS of IAM server user login/grant pages slightly tweaked.
    • Install instructions changed slightly. Use npm install vs npm ci.
  • Export DXL
    • Design elements and other non-data documents can be exported selectively from a database.
    • Added support for actAsUser tokens
  • Get the ACL entries and roles of the Domino database
  • Update the ACL entries and roles of the Domino database
  • Replace the ACL entries and roles of the Domino database
  • Get Domino file system entries
  • New setup tooling for Proton and the domino-db clients that is based on the Domino 12 Certificate Store. Requires Domino 12. See here for more details.

What's New in Release 1.0.8

Release 1.0.8 includes the following changes:

  • Node.js version 14 is required.

  • A major version update (2.0.0) to the domino-iam-service and domino-iam-client packages.

    • Implicit flows are deprecated
    • Single Page Applications are no longer supported as an Application type in IAM Server (see deprectation above). SPAs were primarily for using implicit flows.
    • Any existing SPAs should be migrated to a new Application configuration in the IAM Admin site.
    • As described in the above link, authorization + PKCE is the best choice flow to replace the use of implicit flows. This flow is now supported in the domino-iam-service.
    • The underlying implementation for the http client in the domino-iam-client has changed. An attempt was made to continue to support options like ca and rejectUnauthorized (example), however all other http options that make their way to the got node module should now use the updated options structure.

  • OAuth2 Support for Domino Web Applications.

  • Act-as-user support added for create database and delete database

  • New API added for upsert a document i.e. update a document if exists, else create new document

  • A change to writing duplicate items in @domino/domino-db, requiring all items to be in canonical format. See here for more details.

What's New in Release 1.0.7

Release 1.0.7 includes the following changes:

Older Versions

What's New in Release 1.0.6

Release 1.0.6 includes the following changes:

  • New Java API documentation. See here and here.
  • New Java API support for rich text, agent and Act-as-User operations.
  • New Exclusive OAuth2 scopes for calendar API access. See here and here.
  • Removed support for Domino V10.0.1 FP5.
  • New Node.js API to export a Domino database as DXL. For details see exportDXL.

Release 1.0.6 supports:

  • Domino server V11.0.1 or later
  • Node.js V12
  • (Preview) Java 1.8 or later

What's New in Release 1.0.5

Release 1.0.5 includes the following changes:

  • Support for the following:

    • Domino server V10.0.1FP5 or later
    • Domino server V11.0.1 or later
    • Node.js V12
    • (Preview) Java 1.8 or later

  • (Preview) A new JAR file with the com.hcl.domino.db API. This API is similar to the Node.js @domino/domino-db API, but does not yet support, rich text, agents, and Act-as-User operations. See install kit for information about the Java Doc.

  • (Preview) Support for working with rich text content. See here and here for more details.

  • A new way to configure the Domino server AppDev pack components. The AppDev Pack kit contains a new database template from which the Domino administrator creates the configuration database, adpconfig.nsf. For installation details see here.

  • Improved reliability for long running Proton applications.

  • Instructions for the make_certs.* and make_keyring.* scripts.

  • @domino/domino-db support for duplicate items using the duplicateItems property. Use this optional property to read and write items in a document with the same name. See here for more details.

    • Support for a related property, canonicalFormat. Use this property to request that item data be provided in a canonical format. See here for more details.

What's New in Release 1.0.4

Release 1.0.4 includes the following changes:

  • Support for Domino 11.01 or later and Domino 10.0.1FP4 or later. The AppDev Pack install kit includes separate archives for each major Domino release. See installation instructions for more details.
  • domino-db support for rich text items in Notes documents. See here for more details.
  • domino-db support for running agents in a Notes database. See here and here for more details.
  • Proton request rate limiting for rogue applications. See here for more details.
  • Proton console log messages are now written to log.nsf on the Domino server. See the PROTON_USE_LOGNSF Notes.ini in Proton Administration to revert to the old behavior of only writing to the console.log file.

What's New in Release 1.0.3

Release 1.0.3 includes the following changes:

  • Bug fix to a corruption bug for some attachments uploaded using Proton on Windows.
  • A Step-by-Step Setup Guide to configure the AppDev Pack components.
  • Requires either Domino Server 10.0.1 Fix Pack 4 or Domino Server 11. Note that Domino 11 will be available before Domino 10.0.1 Fix Pack 4.

What's New in Release 1.0.2

Release 1.0.2 includes the following new features:

  • (Preview) A domino-db application may now request the ability to make Proton requests on behalf of a user. The feature, collectively named Act-as-User is implemented across multiple components from the AppDev pack. For details, see:

  • IAM service

    • Efficiently leverage multiple CPU cores on the server.
    • The ability to configure token expiration. See Configure Token Expiration.
    • Support 3rd party statistics server integration through 'StatsD' protocol. See IAM statistics.

  • The ability to create and read Names, Readers and Authors items.

  • The ability to create, read and delete attachments. See Attachments for details.

  • The ability for Proton to update the Domino directory with an application's certificate. See details here.

What's New in Release 1.0.1

Release 1.0.1 includes the following new features:

  • IAM service is officially released.
  • Microsoft Windows support. Both Proton and IAM can now be deployed to Windows.
  • Compute with form support for create, read and update operations. See Compute with form for details.
  • The ability to read and write $REF items. For more information, see NOTEREF_LIST.
  • A test script for verifying your connection to Proton. For more information, see Proton Test Script.
  • Node.js 10.x support. This version of domino-db was tested with Node.js 10.x. Previous versions of Node.js are deprecated, and subsequent versions are not yet supported.