Extension
Une extension permet d'ajouter à Any une fonctionnalité que le produit ne fournit pas, en déléguant le traitement à du code externe. Ce module permet de déclarer cette extension et l'endroit d'où l'utilisateur y accède : une entrée de menu, un onglet, une section ou une tuile.
Deux types d'extensions existent :
- Appel REST : exécute une action sans afficher d'interface, en appelant les API REST de Any ou une URL externe.
- Extension HTML : affiche une application web externe dans Any, intégrée dans une iframe.
Ce module couvre la configuration de l'extension dans Any. La manière d'écrire l'extension elle-même (paramètres reçus, déclenchement d'actions Any en retour, exemples de code) est décrite dans la page Extensions de la section Intégrations.
Configuration du module
Usages : emplacement de l'entrée donnant accès à cette extension :
- Menu de la section des rooms
- Menu de la sélection
- Menu de la multi-sélection
- Menu général d'une room
- Cycle de vie
- Onglet
- Section
- Tuile
Type d'extension : Appel REST ou Extension HTML.
Interface utilisateur :
- Icône : icône choisie dans la liste.
- Libellé : libellé de l'entrée de menu, dans toutes les langues.
Selon leurs usages, les extensions sont ajoutées automatiquement aux modules « Sections » et « Onglets », masquées par défaut. Elles apparaissent parmi les « éléments disponibles » des modules de menus correspondants, et peuvent être sélectionnées comme tuiles dans la configuration des pages.
Appel REST
Ce type ne peut être déclenché que par un menu, un bouton ou un cycle de vie. Il permet d'appeler les API REST de Any (pour créer une room ou un groupe, mettre à jour un document) aussi bien que des URL externes. Un appel à une URL externe peut, par sa réponse, déclencher des actions dans l'interface de Any.
- Formulaire : boîte de dialogue permettant, si nécessaire, de saisir les paramètres de l'extension. Ce formulaire n'est pas affiché lorsque l'extension est appelée par un cycle de vie.
- Service REST : services à exécuter.
- Service Rest : service choisi dans la liste.
- Paramètres : cliquer pour modifier le JSON des paramètres (consulter la documentation des services REST). Saisir
$pour afficher les paramètres de la boîte de dialogue sélectionnée.
Dans l'URL comme dans le corps de la requête, insérer une métadonnée du document avec le joker ${<aspect>.<metadata>}, par exemple ${core.name}. Pour transmettre le contenu du document dans la requête, choisir le type de contenu multipart/form-data.
Extension HTML
L'application web externe est affichée dans une iframe. Ouverte depuis un menu, elle s'affiche dans une boîte de dialogue. Elle peut aussi occuper un onglet du panneau de sélection, une section ou une tuile.
- Taille de la boîte de dialogue : taille de la boîte de dialogue utilisée.
- URL : URL à appeler.
Any ajoute automatiquement à cette URL des paramètres décrivant le contexte de l'utilisateur (origine, utilisateur connecté, ticket de session, sélection courante…). Ces paramètres, et la façon de renvoyer des actions à Any depuis l'extension, sont détaillés dans la page Extensions.