Skip to main content
Version: Any 26

Extension

An extension adds to Any a feature the product does not provide, by delegating the processing to external code. This module declares that extension and the place the user reaches it from: a menu entry, a tab, a section or a tile.

Two types of extensions exist:

  • External REST call: runs an action without displaying an interface, by calling the REST APIs of Any or an external URL.
  • HTML Extension: displays an external web application in Any, embedded in an iframe.

This module covers the configuration of the extension in Any. How to write the extension itself (received parameters, triggering Any actions in return, code examples) is described on the Extensions page of the Integrations section.

Module configuration​

Purposes: location of the entry giving access to this extension:

  • Rooms section menu
  • Selection menu
  • Multi-selection menu
  • General room menu
  • Lifecycle
  • Tab
  • Section
  • Tile

Extension type: External REST call or HTML Extension.

User interface:

  • Icon: icon chosen in the list.
  • Label: label of the menu entry, in every language.

Depending on their purposes, the extensions are added automatically to the "Sections" and "Tabs" modules, hidden by default. They appear among the "available items" of the matching menu modules, and can be selected as tiles in the pages configuration.

External REST call​

This type can only be triggered by a menu, a button or a lifecycle. It calls the REST APIs of Any (to create a room or a group, update a document) as well as external URLs. A call to an external URL can, through its response, trigger actions in the interface of Any.

  • Form: dialog box to enter, if needed, the parameters of the extension. This form is not displayed when the extension is called by a lifecycle.
  • REST service: services to run.
    • REST service: service chosen in the list.
    • Parameters: click to edit the JSON of the parameters (see the REST services documentation). Type $ to display the parameters of the selected dialog box.

In the URL as in the body of the request, insert a metadata of the document with the ${<aspect>.<metadata>} wildcard, for instance ${core.name}. To pass the content of the document in the request, choose the multipart/form-data content type.

HTML Extension​

The external web application is displayed in an iframe. Opened from a menu, it appears in a dialog box. It can also occupy a tab of the selection panel, a section or a tile.

  • Dialog size: size of the dialog box used.
  • URL: URL to call.

Any automatically adds to this URL parameters describing the context of the user (origin, signed-in user, session ticket, current selection). These parameters, and the way to send actions back to Any from the extension, are detailed on the Extensions page.