Concepts

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