Comment initialiser une interface utilisateur

Prérequis

Afin de pouvoir suivre ce guide, il faut préalablement avoir

Créer une instance de Hub

Hub Instance

Anakeen platform est mis à disposition avec un système permettant de réaliser des interfaces pour les utilisateurs sans pour autant faire de code.

Une interface utilisateur - qui correspond à une URL - est appelée une instance de hub ou Hub Instance.

Par défaut, cette interface correspond aux éléments suivants :

  • des droits permettant d'identifier quels utilisateurs peuvent accéder à cette interface,
  • quatre zones - haut, bas, gauche, droite - dans lesquels on peut déposer des éléments d'interface (texte, bouton pour se déconnecter, liste de smart elements, etc.),
  • un ensemble d'éléments d'interfaces avec des droits associés.

Recommandation

Si vous n'êtes pas familier avec le module Anakeen Platform Hub Module, il est fortement recommandé de lire la documentation associée disponible ici

Maintenant que la plateforme est accessible, rendons-nous dans le Development Center (<context_url>/devel/hub/) afin de créer une nouvelle instance de Hub :

Création d'une instance de hub

Une fois le formulaire rempli, il ne reste plus qu'à cliquer sur le bouton Créer en haut à droite de l'interface.

Voilà, l'instance de Hub est créée. Elle est désormais accessible au travers du bouton Display hub instance présent en haut à droite de l'interface.

Instance de hub créée

Une fois créée, il est possible de la personnaliser en lui ajoutant divers éléments configurables.

Créer l'élément Business App Configuration?

Cette interface de recherche et de consultation se caractérise au travers d'un BusinessApp. Sélectionnons donc Business App Configuration dans le menu déroulant :

Ajouter un BusinessApp

Cela donne accès à un formulaire scindé en trois onglets permettant de paramétrer ce dernier.

Configuration

Identification Dock Hub element status
- Hub Station : Rappel de l'interface/instance de hub associée
- Name : Nom du nouvel élément de hub en cours de création
- Order in dock : Définit la position/l'ordre du nouvel élément de hub en cours de création
- Dock position : Indique l'endroit où sera positionné le nouvel élément
- Router entry : Spécifie le chemin permettant d'accéder à l'élément. Il sera concaténé avec l'url de l'instance de hub
Permet de choisir si le nouvel élément sera par défaut sélectionné lors de l'accès à cette instance de hub et/ou s'il sera extensible.

Business App onglet configuration

Element parameters

Parameters Welcome Tab options
- Business App icon : Indique quel icône choisir pour illustrer le nouvel élément

- Business App Titles : Internationalise le titre du nouvel élément (Anglais / Français)

- Business App collections : Permet d'indiquer à quelles Smart Collection l'utilisateur aura accès au travers de ce nouvel élément.
(Il faudra, une fois les SmartStructures générées et configurées, créer des instances de Recherche Détaillée (DSearch) associées aux SmartStructures voulues.
Nous reviendrons sur ce point plus en détails une fois que la création des SmartStructures ainsi que des Workflow auront été réalisées.)
- Enable : Indique s'il va y avoir un bouton de création de smart element
- Title HTML template : Nom de l'onglet
- Smart Structure creation : Spécifie le(s) smart(s) structures que l'on peut créer
- Grid collections : Défini des smart éléments à montrer par défaut

Business App onglet paramètres 1

Business App onglet paramètres 2


Business App Collection

Remarque

Le sujet de la création des collections à référencer ici est abordé dans la partie Comment créer une collection dynamique.

Une fois que les instances de recherche détaillé sont créées, il suffit de les renseigner dans le formulaire mis à disposition :

DSearchList

Le HubElement Référentiel une fois sauvegardé, disposera d'une liste déroulante permettant de choisir quelle collection l'on souhaite consulter :

DSearchList


Security

Roles to display hub element Role to access hub element API
Rôle(s) permettant de voir ce nouvel élément.
L'utilisateur doit posséder un des rôles défini dans cette liste pour voir l'élément.
Rôles permettant d'accéder à l'API de ce nouvel élément.
L'utilisateur doit avoir chacun des rôles défini dans cette liste pour accéder à l'api de l'élément.

BusinessAppSecurity

Une fois le formulaire complété, il ne reste plus qu'à sauvegarder et notre élément de Hub sera accessible dans l'instance de Hub nommé Restaurant, que nous avons créé dans la partie précédente.

Récapitulatif

  • Sélectionner dans la liste déroulante Business App Configuration
  • Renseigner au moins les champs obligatoires :
    • Onglet Configuration -> Name & Router entry
    • Onglet Element Parameters -> Business App Titles
  • Exporter le fichier de configuration associé

Et ensuite ?

Comment sécuriser une interface utilisateur