ONYX - 9.0 - Concepts

Différence entre versions

De MappingDoc
(Protocole des services)
 
(4 révisions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
Donne accès aux fonctions essentielles de Mapping (maquettage, conversion) à travers un simple webservice Rest.
+
ONYX Xpress regroupe les fonctions essentielles d'ONYX Server (maquettage, conversion) à travers un web service Rest.
  
 
===Séquence de conversion===
 
===Séquence de conversion===
 
Une '''Séquence de conversion''' est le regroupement de 3 étapes :
 
Une '''Séquence de conversion''' est le regroupement de 3 étapes :
* Un prétraitement appliqué aux données non maquettées (uniquement applicable à du XML-Draw) ;
+
 
* Un maquettage dont le format a déjà été importé (fichier spool, ou XML-Draw);
+
*Un prétraitement appliqué aux données non maquettées (uniquement applicable à du XML-Draw)
* Une conversion finale dont le profil à suivre est connu du serveur (liste affichée à la configuration de notre séquence).
+
*Un maquettage dont le format a déjà été importé (fichier spool, ou XML-Draw)
 +
*Une conversion finale dont le profil à suivre est connu du serveur (liste affichée à la configuration de notre séquence)
 +
 
  
 
D'autre part, aucune de ces étapes n'est obligatoire, mais une liste vide n'a aucun sens. De même, un prétraitement est forcément suivi d'un maquettage.<br />
 
D'autre part, aucune de ces étapes n'est obligatoire, mais une liste vide n'a aucun sens. De même, un prétraitement est forcément suivi d'un maquettage.<br />
On peut lister certaines associations classiques de ces 3 traitements :
 
* Un prétraitement + un maquettage<br />ex : xsl de modification des noeuds + maquettage de facture
 
* Un maquettage + une conversion<br />ex : maquettage de facture + conversion en PDF
 
* Une conversion (seule)<br />ex : conversion en PDF
 
* Un prétraitement + un maquettage + une conversion<br />ex : xsl de modification des noeuds + maquettage de facture + conversion en PDF
 
  
===Webservice===
+
Il est possible de lister certaines associations classiques de ces 3 traitements :
Un '''webservice''' est un ensemble de fonctions simples que l'on appelle en HTTP, mais qui ne sont pas de véritables pages Web.
+
 
 +
*Un prétraitement + un maquettage<br />ex : xsl de modification des noeuds + maquettage de facture
 +
*Un maquettage + une conversion<br />ex : maquettage de facture + conversion en PDF
 +
*Une conversion (seule)<br />ex : conversion en PDF
 +
*Un prétraitement + un maquettage + une conversion<br />ex : xsl de modification des noeuds + maquettage de facture + conversion en PDF
 +
 
 +
===Web service===
 +
Un '''web service''' est un ensemble de fonctions simples que l'on appelle en HTTP, mais qui ne sont pas de véritables pages Web.
  
 
Il s'agit plutôt d'un "Paquet requête" auquel le serveur va répondre par un "paquet réponse".
 
Il s'agit plutôt d'un "Paquet requête" auquel le serveur va répondre par un "paquet réponse".
  
Ex : Si l'on interroge le service ''runstream'' du webservice REST avec un paquet requête indiquant une ''séquence de conversion'' et contenant les données appropriées, alors il renverra un paquet réponse contenant le document produit.
+
Exemple : Si l'on interroge le service ''runstream'' du web service REST avec un paquet requête indiquant une ''séquence de conversion'' et contenant les données appropriées, alors il renverra un paquet réponse contenant le document produit.
  
 
===Protocole des services===
 
===Protocole des services===
Ligne 25 : Ligne 29 :
  
 
===Messages retournés===
 
===Messages retournés===
Les messages renvoyés suivent une norme simple mais efficace :
+
Les messages renvoyés suivent une norme simple et efficace :
* En cas de succès du traitement :
+
 
** ils contiennent des données
+
*En cas de succès du traitement :
** ils contiennent un objet d'erreur VIDE
+
**ils contiennent des données
* En cas d'échec du traitement :
+
**ils contiennent un objet d'erreur VIDE
** ils ne contiennent pas de données
+
*En cas d'échec du traitement :
** ils contiennent un objet d'erreur
+
**ils ne contiennent pas de données
 +
**ils contiennent un objet d'erreur

Version actuelle datée du 9 mai 2019 à 08:17

ONYX Xpress regroupe les fonctions essentielles d'ONYX Server (maquettage, conversion) à travers un web service Rest.

Séquence de conversion

Une Séquence de conversion est le regroupement de 3 étapes :

  • Un prétraitement appliqué aux données non maquettées (uniquement applicable à du XML-Draw)
  • Un maquettage dont le format a déjà été importé (fichier spool, ou XML-Draw)
  • Une conversion finale dont le profil à suivre est connu du serveur (liste affichée à la configuration de notre séquence)


D'autre part, aucune de ces étapes n'est obligatoire, mais une liste vide n'a aucun sens. De même, un prétraitement est forcément suivi d'un maquettage.

Il est possible de lister certaines associations classiques de ces 3 traitements :

  • Un prétraitement + un maquettage
    ex : xsl de modification des noeuds + maquettage de facture
  • Un maquettage + une conversion
    ex : maquettage de facture + conversion en PDF
  • Une conversion (seule)
    ex : conversion en PDF
  • Un prétraitement + un maquettage + une conversion
    ex : xsl de modification des noeuds + maquettage de facture + conversion en PDF

Web service

Un web service est un ensemble de fonctions simples que l'on appelle en HTTP, mais qui ne sont pas de véritables pages Web.

Il s'agit plutôt d'un "Paquet requête" auquel le serveur va répondre par un "paquet réponse".

Exemple : Si l'on interroge le service runstream du web service REST avec un paquet requête indiquant une séquence de conversion et contenant les données appropriées, alors il renverra un paquet réponse contenant le document produit.

Protocole des services

Le Web service suit le formalisme REST.

Messages retournés

Les messages renvoyés suivent une norme simple et efficace :

  • En cas de succès du traitement :
    • ils contiennent des données
    • ils contiennent un objet d'erreur VIDE
  • En cas d'échec du traitement :
    • ils ne contiennent pas de données
    • ils contiennent un objet d'erreur