Skip to main content

13. Gestion des services web locaux

La plate-forme Ontomantics permet de gérer des services Web à la fois en tant que client et en tant que serveur. Un service web (ou web service) est un programme qui permet la communication et l’échange de données entre applications et systèmes hétérogènes dans des environnements distribués. Dans notre cas, il s’agit d’une part, d’aller interroger des services en ligne via la plateforme Ontomantics, et d’autre part, de fournir des services Web interrogeables par des systèmes distants ou par d’autres plateformes Ontomantics. Ce chapitre est dédié à la gestion de services web locaux.

La plateforme Ontomantics permet de créer des services Web qui seront utilisables par des machines distantes.

13.1. Création du service web

Pour créer un nouveau service web, cliquer sur l’onglet fa-solid-toolbox.png (Projets) dans le menu de la plateforme Ontomantics, puis sur le bouton fa-solid-plus.png fa-solid-angle-right.png Nouveau service Web. Un popup permet de choisir de créer un service web ou d’en importer un à partir d’un fichier WSDL. Cliquer sur Nouveau.

Nouveau_ou_import.png

 

Un formulaire est à renseigner avec les informations suivantes :

  • le titre du service web

  • sa description

  • le type de service Web : REST HTTP GET, REST HTTP POST, SOAP, SOAP 1.2

  • le nom du service web

Le type REST est utilisé pour des accès via des formulaires. Il retourne du XML ou du JSON. Le type SOAP envoie et reçoit du XML.

Le nom du service web est ce qui apparaîtra dans l’URL après l’adresse de la plateforme.

 

Nouveau_SW.png

 

Cliquer sur le bouton Sauvegarder. Pour chaque adresse (celle du service web et celle du WSDL), une deuxième adresse apparaît sous la première : il s’agit d’une adresse accessible pour débogage, qui n’est plus accessible une fois l’application publiée en production.

 

Adresses_chiffres.png

Les adresses chiffrées ne sont accessibles qu’à des fins de débogage

 

L’onglet Avancé permet de définir et modifier les paramètres avancés du service web.

 

Avance.png

 

Il permet de définir le format des dates et des heures, et de modifier l’adresse du service web définie dans le WSDL. Il permet également de définir l’espace de noms du WSDL.

Pour chaque service Web, il est également possible de :

  • l’exporter au format .onto

  • le copier

  • le supprimer

  • le verrouiller

  • le publier

  • déboguer les méthodes web

 

13.2. Exportation et importation de services web

Export d’un service Web

L’export d’un service Web se fait en cliquant sur Exporter le service Web dans le cadre de droite Actions, ou dans le menu contextuel via un clic droit sur le service Web dans la colonne de gauche.

 

Export.png

 

Après quelques secondes, la plateforme génère un fichier .onto à enregistrer sur le disque dur de l’utilisateur via une boite de dialogue.

 

Import d’un service Web

L’import d’un service Web s’effectue en cliquant sur le bouton fa-solid-plus.png puis fa-solid-magic.png Importer depuis la liste des projets de l’onglet fa-solid-toolbox.png Projets. L’assistant d’import s’affiche et invite l’utilisateur à fournir un fichier d’import au format .onto ou .zip depuis sa machine. L’import commence dès que le fichier est sélectionné.

 

Import_WS.png

 

Si un ou plusieurs modèles de données compatibles sont détectés, une fenêtre popup demande à l’utilisateur s’il faut réimporter un nouveau modèle de données ou réutiliser l’existant.

 

13.3. Assistant de création de méthodes Web

Il est possible de créer des méthodes web en utilisant l’assistant. Pour cela, cliquer sur fa-solid-magic.png Assistant de création de méthodes dans le cadre de droite des propriétés du service web.

 

Assistant.png

 

Une fenêtre popup s’ouvre, invitant l’utilisateur à sélectionner une source de données ou un modèle de données existant. En cliquant sur Suivant, l’utilisateur doit sélectionner pour chaque table les colonnes à utiliser et ajuster leurs paramètres.

 

Assistant_1.png

 

Il faut ensuite ajuster les paramètres de création des méthodes. Il existe plusieurs mode d’accès aux méthodes. En mode public, l’accès se fait de façon anonyme. Le mode Passage d’un ID de session consiste à créer un attribut dans la méthode. Le mode Passage d’informations d’authentification ajoute deux arguments : l’identifiant et le mot de passe. Il existe également l’accès via authentification basique. L’utilisateur doit également sélectionner pour chaque table les types de méthodes web qu’il souhaite voir générées.

 

Assistant_2.png

 

Il faut ensuite sélectionner pour chaque entité les champs à utiliser pour chaque type de méthode ainsi que leur label.

 

Assistant_3.png

 

Cliquer sur le bouton Terminer pour générer les méthodes web.

 

13.4. Création manuelle de méthode Web

Il est possible de créer manuellement des méthodes Web. Elles peuvent être de deux types : REST et SOAP. L’accès à la création et l’édition de méthodes web se fait en cliquant sur l’onglet fa-solid-pencil-ruler.png Conception depuis l’onglet Propriétés du service web.

Cliquer sur le bouton fa-solid-plus.png du cadre de gauche Gérer les méthodes web puis sélectionner Nouvelle méthode REST ou Nouvelle méthode SOAP.

 

Nouvelle_methode.png

 

La création d’une nouvelle méthode REST ou SOAP implique de renseigner un titre, une description éventuelle, et un mode d’accès à la méthode.

 

Nouvelle_methode_REST.png

 

Après avoir sauvegardé, il est possible d’ajouter un nouvel argument ou un nouvel argument retour à la méthode. Un argument retour est un argument dont la valeur est retournée par la méthode.

 

Nouvel_argument.png

 

Les arguments peuvent être de type simple ou de type complexe. Un élément simple peut être de type :

  • Texte

  • Entier

  • Décimal

  • Booléen

  • Date

  • Date et heure

  • Heure

  • Binaire codé en Base 64

Un élément complexe est composé de plusieurs éléments simples. Le champ Titre doit être renseigné avec le nom de l’élément, qui est laissé au choix de l’utilisateur. Si l’élément peut être vide, cocher la case correspondante ; s’il peut être multiple, c’est-à-dire s’il peut renvoyer plusieurs valeurs, cocher la case Est une liste d’éléments. Sélectionner ensuite une variable à affecter à l’argument.

Les éléments complexes ne sont pas disponibles pour les méthodes REST.

 

Nouvel_argument_1.png

 

13.5. Création de comportement

Les comportements dans les méthodes Web fonctionnent de façon similaire à ceux des applications et planifications. Pour créer un comportement, cliquer sur l’icône fa-solid-cogs.png (Gérer les comportements) depuis l’onglet fa-solid-pencil-ruler.png Conception du service web. Cliquer sur le bouton fa-solid-plus.png du module de gestion des comportements. Il ne reste alors qu’à créer le comportement et sa règle. Pour créer un comportement directement rattaché à un déclencheur, faire un clic droit sur l’un des déclencheurs de la méthode web et cliquer sur Nouveau comportement.

 

Nouveau_comportement.png

 

Il est également possible de rattacher un comportement existant en choisissant Comportement existant dans le menu contextuel du déclencheur de la méthode. Une fenêtre popup invite l’utilisateur à choisir le comportement à rattacher parmi ceux disponibles, puis à cliquer sur Ajouter.

 

Rattachement.png