Skip to content

Lab 02 - Quick config

What you will learn

  • How to navigate the Admin UI.
  • How to configure the "Approval Central" database using the Admin UI.
  • Understand the difference between a Schema and a Scope.

Before you begin

  • You have completed Lab 01 - Log in to the REST API.
  • Your Domino server must be running.
  • You have deployed the database ApprovalCentral.nsf on your Domino server.

Procedure

The procedure guides you in creating a schema and a scope using Quick Config in the Admin UI.

  1. Log in to Admin UI.
  2. Expand the side panel and click Quick Config.

    Quick config

  3. Select ApprovalCentral.nsf from Available Databases, and fill in the form.

    • Schema Name: default
    • Scope Name: approvals
    • Description & Schema Icon: at your discretion

    Quick config

  4. Click Add.

Alternative procedure

The procedure guides you in creating a schema and a scope using curl, Postman, or KEEP CLI.

  • Use the request in Postman's Lab 01 Create QuickConfig for ApprovalCentral.
  • Use curl, Postman or the KEEP cli to post this JSON:
{
  "scopeName": "approvals",
  "nsfPath": "ApprovalCentral.nsf",
  "schemaName": "default",
  "create": true
}

How to verify

In the Admin UI, you will find one entry each for schema and scope as shown:

Schema available

Scope available

You can also check the following URLs:

  • {{ HOST }}/api/setup-v1/schemas?nsfPath=ApprovalCentral.nsf
  • {{ HOST }}/api/setup-v1/schema?nsfPath=ApprovalCentral.nsf&configName=default
  • {{ HOST }}/api/v1/scopes

Things to explore

Next step

Proceed to Lab 03 - Schema exploration.