EBX® peut être utilisé comme composant web d'une interface utilisateur, appelé par protocole HTTP. Un composant web EBX® peut être intégré à n'importe quelle application accessible via un navigateur web compatible. Ce mode d'accès permet de profiter des fonctionnalités majeures d'EBX®, telles que l'authentification utilisateur, la validation des données, ainsi que la génération automatique de l'interface utilisateur, tout en permettant également d'axer la navigation utilisateur sur certains éléments du référentiel.
Les composants web d'EBX® sont généralement intégrés à la structure intranet de l'organisation ou aux applications qui gèrent l'attribution de tâches spécifiques aux utilisateurs.
Une application web qui appelle un composant web d'EBX® peut être :
Une application non-Java, le cas le plus basique étant une page HTML statique.
Dans ce cas, l'application doit envoyer une requête HTTP qui respecte les spécifications de requête du composant web EBX®.
Une application Java, par exemple :
Une application web Java exécutée sur la même instance de serveur d'application que le référentiel EBX® qu'il référence ou sur une instance de serveur d'application différente.
Un Service utilisateur ou un Widget personnalisé EBX®, auquel cas la nouvelle session héritera automatiquement de la session parent d'EBX®.
En Java, la méthode recommandée pour établir des requêtes HTTP qui appellent les composants web d'EBX® est la classe UIHttpManagerComponent
Quand un composant web d'EBX® est appelé, l'utilisateur doit d'abord être authentifié dans la session HTTP nouvellement instanciée. Le composant web sélectionne alors un élément du référentiel et l'affiche conformément au paramètre de mise en page du scope défini dans la requête.
Le paramètre firstCallDisplay peut changer cet affichage automatique en fonction de sa valeur.
Les éléments du référentiel qui peuvent être sélectionnés sont les suivants :
Espace de données ou image
Jeu de données
Noeud
Table ou vue publiée
Enregistrement de table
Le périmètre, défini par le paramètre 'scope', détermine quelle partie de l'interface est affichée à l'utilisateur et définit les limites de navigation de l'utilisateur pendant la session. Le périmètre par défaut utilisé par le composant web est le plus petit possible dépendant de l'entité ou du service sélectionnés ou invoqués par la requête.
Il est également possible de sélectionner une perspective particulière ainsi qu’une action de perspective.
Par défaut, la sélection de l'élément est faite dans le cadre de la perspective de l'utilisateur si le périmètre de l'affichage ("scope") est complet ("full").
Une URL de composant Web peut spécifier une perspective ainsi qu’une action ou une entité (espace de données, jeu de données, etc). Ainsi, pour un composant Web ayant dans son URL une perspective et une entité (mais pas d’action), si une action de la perspective correspond à cette entité, alors cette action est automatiquement sélectionnée.
Sinon, si aucune action ne correspond à cette entité, aucune action n'est sélectionnée mais l’entité est ouverte.
Si une action est spécifié en même temps qu’une entité, cette dernière est ignorée et l’action sera sélectionnée.
Si l'entité cible est un enregistrement et qu'une action correspond à la table de l'enregistrement, alors cette action est sélectionnée et l'enregistrement sera ouvert à l'intérieur de l'action.
De même, si un bon de travail est ciblé par le composant Web, et si une action de type « inbox » existe dans la perspective, alors cette action sera sélectionnée et le bon de travail sera ouvert à l'intérieur de l'action.
Si le composant Web spécifie un prédicat pour filtrer une table, il faut que l'action de perspective spécifie exactement le même prédicat pour pouvoir être sélectionnée.
De même, si l'action spécifie un prédicat de filtrage sur une table, le composant Web doit spécifier exactement le même prédicat pour que la correspondance soit établie.
Dans un déploiement par défaut, l'URL de base doit avoir la forme suivante :
http://<host>[:<port>]/ebx/
L'URL de base doit faire référence au servlet FrontServlet, défini dans le descripteur de déploiement /WEB-INF/web.xml de l'application web ebx.war.
Paramètre | Description | Requis |
|---|---|---|
| Définit les propriétés d'authentification de l'utilisateur. Si le login/mot de passe ou le jeton utilisateur lié au répertoire ne sont pas fournis, l'utilisateur sera invité à s'authentifier via la page de connexion du référentiel. Voir | Non |
| Définit les informations de suivi de la nouvelle session. Les informations de suivi sont recueillies dans les tables de l'historique. Parallèlement, ces informations peuvent être utilisées pour restreindre programmatiquement les autorisations d'accès. Voir | Non |
| L'URL vers laquelle l'utilisateur sera redirigé à la fin de la session du composant, lorsqu'il clique sur le bouton 'Fermer'. Le bouton 'Fermer' est systématiquement affiché lors de la sélection d'enregistrements, cependant il faut toujours spécifier via le paramètre Pour plus d'informations, voir Exit policy. | Non |
| Spécifie la locale à utiliser. La valeur est soit | Non, la locale par défaut est celle enregistrée pour l'utilisateur. |
Paramètre | Description | Requis |
|---|---|---|
| Sélectionne l'espace de données spécifié. | Non |
| Sélectionne l'image d'espace de donnée spécifiée. | Non |
| Sélectionne le jeu de données spécifié. La valeur doit être la référence d'un jeu de données qui existe dans l'espace de données ou dans l'image sélectionnés. | Seulement si |
| Définit le nom de publication de la vue tabulaire ou hiérarchique à appliquer au contenu choisi. Ce nom de publication est celui déclaré lors de la publication de la vue. Il se trouve dans l'espace 'Administration' sous Configuration des vues > Vues. Tous les paramètres de la vue, tels que ses filtres, l'ordre de tri et les colonnes affichées, sont appliqués au résultat. Un espace de données et un jeu de données doivent être sélectionnés afin que cette vue s'applique. Le choix d'une table cible n'est pas nécessaire, puisqu'elle peut être automatiquement déterminée sur la base de la définition de la vue. Ce paramètre peut être associé au prédicat spécifié dans le paramètre | Non |
| Définit la sélection d'un noeud dans le jeu de données. La valeur peut être un chemin absolu valide situé dans le jeu de données sélectionné. L'écriture doit être conforme à un XPath simplifié, avec une syntaxe abrégée. Il peut aussi s'agir d'un prédicat entouré par "[" and "]" si une table peut être automatiquement sélectionnée à l'aide d'autres paramètres de composants web (par exemple, Voir aussi XPath supported syntax pour la syntaxe XPath Voir | Non |
| Définit le service auquel accéder. Pour plus d'informations sur les services utilisateurs intégrés, voir Services built-in. Dans l'API Java, voir | Non |
| Définit la section du workflow à sélectionner. Voir | Non |
| Définit le nom de la perspective à sélectionner. Si ce paramètre est défini, le paramètre | Seulement si |
| Déprécié. Merci de considérer l'utilisation de Définit l'identifiant de l'action de perspective à sélectionner. | Non |
| Définit le nom unique de l'action de perspective à sélectionner. | Non |
Paramètre | Description | Requis |
|---|---|---|
| Définit le périmètre utilisé par le composant web. Il peut prendre la valeur Voir | Non, la valeur par défaut sera calculée pour être la plus petite possible en fonction de la sélection cible. |
| Définit l'affichage qui doit être utilisé à la place de celui déterminé par la combinaison de la sélection et du paramètre Les valeurs possibles sont :
Par exemple,
Voir Voir Voir | Non, la valeur par défaut sera calculée en fonction de la sélection cible. |
| Définit la manière dont le bouton de fin de session sera affiché. La valeur peut être Voir | Non. Si le périmètre n'est pas |
| Définit les fonctionnalités à afficher dans un service utilisateur au niveau du jeu de données ou d'un formulaire en dehors d'une table. Ces options se rapportent uniquement aux fonctionnalités au sein de l'espace de travail. Il est recommandé d'utiliser cette propriété avec le plus petit Syntaxe :
où
Par exemple,
Voir | Non. |
| Définit les fonctionnalités à afficher dans une vue tabulaire ou hiérarchique (au niveau de la table). Ces options se rapportent uniquement aux fonctionnalités au sein de l'espace de travail. Il est recommandé d'utiliser cette propriété avec le plus petit Syntaxe :
où
Par exemple,
Voir | Non. |
| Définit les fonctionnalités à afficher dans un formulaire au niveau de l'enregistrement. Ces options se rapportent uniquement aux fonctionnalités au sein de l'espace de travail. Il est recommandé d'utiliser cette propriété avec le plus petit Syntaxe:
où
Par exemple,
Voir | Non. |
| Précise le nombre d'enregistrements affichés par page dans une vue table (qu'elle soit tabulaire ou hiérarchique). | Non. |
| Précise qu'un élément de travail doit être automatiquement pris et démarré. La valeur peut être Voir | Non. La valeur par défaut est |
URI minimale :
http://localhost:8080/ebx/
Se connecte en tant qu''admin' et sélectionne l'espace de données 'Référence' :
http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference
Sélectionne l'espace de données 'Référence' et accède au service de validation intégré :
http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference&service=@validation
Sélectionne la table des rôles dans le répertoire par défaut :
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/roles
Sélectionne l'enregistrement 'admin' dans le répertoire par défaut :
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/users[./login="admin"]
Accède à l'interface pour créer un nouvel utilisateur dans le répertoire par défaut :
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/users&service=@creation
Compare l'enregistrement 'admin' du répertoire par défaut avec l'enregistrement 'jSmith' :
Compare l'enregistrement 'R1' du jeu de données 'instanceId' dans l'espace de données 'Reference' avec l'enregistrement 'R0' :
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/users[./login="admin"]&service=@compare&compare.branch=ebx-directory&compare.instance=ebx-directory&compare.xpath=/directory/users[./login="jSmith"]