How to register your module and its views

Automatic registration via API (v3)

Prerequisites

Creation of your module at Multitenant Access Control (MACMA) with the "Web Portal Registration" role assigned.
Understanding of Multitenant Access Control concepts such as tenants, resources, roles, permissions, and token scopes/audiences

Registration flow

Figure 1. Registration sequence diagram

The registration is done in a single HTTP PUT: http://example.com/api/core/api/v3/{tenantId}/registry/{moduleId} request, containing all the resources you want to register. A full description of the API can be found in the registration API specification.

The single request contains all resources you want to register, including the module itself, views, widgets, documents, and contexts. If your module does not offer widgets, documents, or contexts, you must pass an empty array for these resources.

Each widget, context, view or document (except public api documents) must have a Multi-Tenant Access Control resource ID and type assigned. It’s important to set up the correct permissions in Multi-Tenant Access Control for the resources you want to register.

When the registration request is send, it will be immediately processed by Web Portal. If the request is valid, the module will be registered and the resources will be available in Web Portal. You can check the registration status in the Integration status page. If the registration request is invalid, the request will be rejected with details about the errors/issues. The registration request is validated as one transaction, meaning that if one resource is invalid, the entire request will be rejected.