Skip to main content
Version: 13.x (Current)

Create your extension

Following this tutorial you will learn how to add the Backoffice as an extension within a Project, in order to consult it directly from the Console.

Prerequisites

This guide requires that you have:

  • A Company on which you are Company Owner. Its identifier should be used each time there is the my-tenant-id occurrence.
  • The Company has a project reachable externally, otherwise create one by referring to this guide.
  • The Microfrontend Composer Toolkit application created and exposed to view the Backoffice frontend. Follow this section of the guide to do so.
  • The response from the Backoffice endpoint can be embedded within an iframe. See this link for more information.

1. Register Backoffice Extension

Once that all requisites are satisfied, you can register the Backoffice as an extension using the PUT /api/extensibility/tenants/{tenantId}/extensions API:

registration example registration example routes

Path Params

{
"tenantId": "my-tenant-id"
}

Body Params

{
"contexts": ["project"],
"description": "Extension to integrate Backoffice on Console",
"entry": "https://<my-domain>/mfe-application/home",
"extensionType": "iframe",
"name": "Integrated Backoffice",
"routes": [
{
"destinationPath": "/backoffice",
"icon": {
"name": "PiProjectorScreenChartLight"
},
"id": "backoffice-route",
"labelIntl": {
"en": "Integrated Backoffice",
"it": "Backoffice integrato"
},
"locationId": "project",
"parentId": "my-menu-group"
},
{
"id": "my-menu-group",
"labelIntl": {
"en": "My Menu Group",
"it": "Il mio gruppo menu"
},
"locationId": "project",
"renderType": "category"
}
]
}
info

These registered routes are rendered as a menu item with label Integrated Backoffice that is attached to a category menu group with label My menu group. If you do not want to introduce new menu group, you can remove the second route from routes array and edit the parentId field of the remained route with one of that options:

  • undefined, so that the menu item will not be attached on any menu group
  • parentId of the existing menu groups corresponding to the chosen location (e.g. runtime for the project location)

Response on success

{
"extensionId":"my-extension-id"
}

Edit the registered extension

If you need to correct or modify your newly registered extension, you can do so using the same API, but remember to specify the extensionId within the body (see here for more info).

edit registered extension

See the complete example

Path Params

{
"tenantId": "my-tenant-id"
}

Body Params

{
"contexts": ["project"],
"extensionId": "my-extension-id",
"description": "Extension to integrate Backoffice on Console",
"entry": "https://<my-domain>/mfe-application/home",
"extensionType": "iframe",
"name": "Integrated Backoffice",
"routes": [
{
"destinationPath": "/backoffice",
"icon": {
"name": "PiProjectorScreenChartLight"
},
"id": "backoffice-route",
"labelIntl": {
"en": "Integrated Backoffice Edited",
"it": "Backoffice integrato Modificato"
},
"locationId": "project",
"parentId": "my-menu-group"
},
{
"id": "my-menu-group",
"labelIntl": {
"en": "My Menu Group",
"it": "Il mio gruppo menu"
},
"locationId": "project",
"renderType": "category"
},
]
}

Response on success:

204 No Content

In this example, the labelIntl of the menu item has been modified.

2. Check that the new extension is registered

You can use the GET /api/extensibility/tenants/{tenantId}/extensions API to verify that the registration is done correctly:

retrieve extensions example

Path Params

{
"tenantId": "my-tenant-id"
}

Response on success

[
{
"extensionId":"my-extension-id",
"name":"Integrated Backoffice",
"description":"Extension to integrate Backoffice on Console"
}
]

3. Activate the extension

After registering you can proceed with its activation on a project using the POST /api/extensibility/tenants/{tenantId}/extensions/{extensionId}/activation API:

activate extension example

Path Params

{
"tenantId": "my-tenant-id",
"extensionId": "my-extension-id"
}

Body Params without overrides (Option 1)

{
"contextType": "my-project-id",
"contextId": "project",
"overrides": []
}

Body Params with overrides (Option 2)

{
"contextId": "project",
"contextType": "company",
"overrides": [
{
"routeId": "backoffice-route",
"icon": {
"name": "PiAcorn"
}
},
{
"routeId": "my-menu-group",
"labelIntl": {
"en": "Overrided Label for menu group",
"it": "Etichetta Sovrascritta per gruppo menu"
}
}
]
}

Response on success

{
"activationId": "my-activation-id"
}
info

The extension can be activated on any projects inside the Company my-tenant-id.

4. Enjoy the final result

Once that the new extension is correctly registered and activated (without overrides), the final result should be similar to this:

backoffice extension overview

5. Deactivate the Backoffice extension

To restore the initial state of the Console, you can deactivate the new extension using the DELETE /api/extensibility/tenants/{tenantId}/extensions/{extensionId}/{contextType}/{contextId}/activation API:

delete extension activation

Path params

{
"tenantId": "my-tenant-id",
"extensionId": "my-extension-id",
"contextType": "project",
"contextId": "my-project-id"
}

Response on success

204 No Content

Now, the extension should no longer be visible in the Console.

6. Remove definitely the Backoffice extension

To perform a complete cleanup and remove the newly registered extension, you can use the DELETE /api/extensibility/tenants/{tenantId}/extensions/{extensionId} API:

delete registered extension

Path Params

{
"tenantId": "my-tenant-id",
"extensionId": "my-extension-id"
}

Response on success:

204 No Content

You can repeat step 2 to verify that the extension has been successfully removed.