Aller au contenu principal

Un écran sur un point d'accès d'API

Un écran n'a pas besoin d'une base de données. Il peut lire les lignes renvoyées par une API et enregistrer par les appels de cette API : la grille, les filtres, la fiche, les actions, les permissions et l'assistant IA fonctionnent comme sur tout écran, et chaque enregistrement passe par l'application propriétaire des données — avec ses règles, ses valeurs par défaut et ses messages.

Deux montages :

MontageLectureEnregistrement
Un écran sur une APIUn point d'accèsDes points d'accès
Enregistre parUne requête SQL — rapide, toutes les colonnes, paginationLes points d'accès d'un autre connecteur

Vue d'ensemble​

Deux montagesUN ÉCRAN SUR UNE APIPoint d'accès de lectureses lignes, ses paramètreslitÉCRAN — GRILLE + FICHEenregistrePoints d'accèsinsertion · mise à jour · suppressionLes règles de l'applicationENREGISTRE PARRequête SQLrapide, toutes colonnes, paginationlitÉCRAN — GRILLE + FICHEenregistrePoints d'accèsinsertion · mise à jour · suppressionLes règles de l'applicationDes lignes d'une APIfiltres = ses paramètresLa lecture reste en SQLseul l'enregistrement changeMarqués « Modifie des données »chacun avec sa permissionLe refus du serveurest l'erreur affichéeAucune correspondancepar nom ou élément du dictionnaire

Lire un point d'accès​

Dans le Concepteur d'écran, étape Données : choisir le connecteur d'API dans Connecteur, puis le point d'accès dans Requête de lecture. La liste propose les points d'accès qui indiquent où se trouvent leurs lignes (Lignes, dans l'éditeur de point d'accès).

La grille est la même. Ses colonnes sont nommées par le point d'accès ; leurs libellés viennent de l'écran, puis du dictionnaire, puis des titres du serveur. La page porte le libellé de l'écran.

Filtres​

  • Les paramètres du point d'accès s'affichent au-dessus de la grille — leur exemple en indication, leur aide en infobulle, une liste déroulante pour une liste fermée de valeurs. Un paramètre qui a une colonne de filtre du même nom rejoint le panneau de filtres.
  • Toute colonne marquée comme filtre figure dans les filtres avancés, avec les opérateurs d'une requête — contient, égal, différent, commence par, se termine par, intervalle — et une liste de choix quand la colonne a une énumération ou un lookup. Ces filtres s'appliquent aux lignes renvoyées par le point d'accès.
  • Les paramètres propres à un écran — l'en-tête d'un formulaire de détail — peuvent être obligatoires : le point d'accès n'est alors jamais appelé avec un en-tête vide.

Limite de lignes​

Le nombre de lignes est celui du point d'accès, plafonné de nouveau par l'écran, sans pagination. Quand le point d'accès désigne son Paramètre du nombre de lignes, l'écran le renseigne avec son propre Max lignes. L'écran signale un résultat tronqué quand le serveur indique qu'il reste des lignes. Le tri et le regroupement portent sur ce qui a été renvoyé.

Un serveur qui n'a rien à lister​

Certains serveurs répondent par une erreur quand une liste est vide. Le point d'accès peut désigner les refus qui signifient aucune ligne : l'écran affiche alors une liste vide au lieu d'une erreur.


Enregistrer par des points d'accès​

Requête de mise à jour, Requête d'insertion et Requête de suppression désignent des points d'accès marqués Modifie des données. La grille et la fiche enregistrent comme d'habitude :

  • les valeurs de la ligne vont aux paramètres du point d'accès par leur nom ; la valeur qu'avait une ligne à son chargement est disponible sous <COLONNE>_ORIGINAL ;
  • les paramètres propres à l'écran accompagnent chaque enregistrement ;
  • ce que le serveur refuse est l'erreur de l'enregistrement, dans les termes du serveur ; ses avertissements reviennent avec l'enregistrement ;
  • une valeur retournée par le point d'accès — un numéro attribué par le serveur — revient dans la fiche ;
  • une colonne que l'écran n'envoie pas est laissée intacte par le serveur ; une colonne vidée par l'utilisateur est envoyée vide ;
  • pour une modification, seul ce que l'utilisateur a changé est transmis à un point d'accès servi par une fonction.

Les règles de notification se déclenchent, et les outils d'écriture de l'assistant passent par le même enregistrement.


Enregistre par — lire en SQL, enregistrer par l'API​

Quand les données peuvent être lues dans une base mais doivent être écrites par l'application — un formulaire JD Edwards, l'API d'un ERP —, garder l'écran sur sa requête et choisir le connecteur d'API dans Enregistre par. La mise à jour, l'insertion et la suppression désignent alors des points d'accès de ce connecteur.

Aucune correspondance n'est à écrire : un paramètre du point d'accès prend la valeur de la colonne de même nom, sinon de la colonne qui porte le même élément du dictionnaire (ALPH à partir de ABALPH).

La lecture reste rapide et complète ; l'enregistrement applique les règles de l'application. L'intégrité, Rechercher les usages, le renommage et les paquets suivent le connecteur d'enregistrement.


Ce qui diffère d'un écran sur une requête​

Sur une requêteSur un point d'accès
Pagination par le serveurLa limite de lignes du point d'accès, sans pagination
Filtres traduits en SQLLes paramètres du point d'accès, puis des filtres sur les lignes renvoyées
Import de lignesNon disponible
Export de classeur configuréNon disponible — l'export de la grille fonctionne
Synthèse côté serveurNon disponible
Miroir d'audit, paquets de changements sur ses enregistrementsNon disponibles
Règles d'écriture du dictionnaire (séquence, utilisateur, date)Le serveur décide
Source d'un modèle de l'explorateur de donnéesNon disponible

Accès​

La permission est celle du point d'accès — api:<connecteur>:<point d'accès> — pour la lecture comme pour chaque enregistrement ; un écran dont l'utilisateur ne peut pas appeler le point d'accès de lecture ne figure pas dans son menu. La règle modifiable si de l'écran est appliquée, et le périmètre de données de l'appelant s'applique aux lignes renvoyées.


Dans les paquets​

Un écran voyage entier : les points d'accès par lesquels il lit ou enregistre figurent sous Points d'accès d'API dans un paquet, cochés par défaut comme ses requêtes ; un point d'accès servi par un service emporte ce service. L'historique de l'écran les consigne également.


Conseils & bonnes pratiques​

  • Lire en SQL et enregistrer par l'API dès que les deux sont possibles : le meilleur de chaque voie.
  • Déclarer les champs d'erreur du point d'accès : un enregistrement refusé doit apparaître comme tel.
  • Marquer comme filtres les colonnes sur lesquelles on recherche ; désigner le paramètre du nombre de lignes pour que Max lignes pilote le serveur.
  • Laisser un générateur construire l'écran quand il en existe un — Créer à partir de… crée les points d'accès et l'écran ensemble.

Voir aussi​