API UERP Manager spool Request

 

Version : 5.0-00

Edition spéciale ES1

Package : fr.ACE.technicalframework.businesscomponent.applicationmodule.common

UerpManagerspoolRequest

   
 

Cette API permet d’assurer la demande d'exécution d'une édition rapide ou d’un traitement différé qui occupe peu de temps CPU. Ce service est client du binaire UERP.

Avant toute demande d'édition, les tables des éditions (UT_PAR, UT_PRC, UT_SPL) doivent être renseignées.

API imbriquées : aucune.

Contraintes et limites de fonctionnement (hors périmètre)

Les demandes ne doivent concerner que des éditions "légères" telles que l'édition d'un événement, d'un tiers, ou encore d'un produit. Les éditions "lourdes" telles que la génération de BL, la validation de factures ou encore l’édition de plusieurs événements, ne doivent pas être lancées par cette API mais par les demandes d'éditions "classiques".

Paramétrage (PPE)

RAS.

Processus, contrôles et règles de gestion

Etape Description du Processus
Schéma d’entrée

spoolNumber : numéro de l'édition à exécuter.

entity : entité de l'édition à exécuter.

Schéma de sortie statut : état de la demande d'édition.

1. Préparer la demande à partir des données du bean d'entrée.

2. Faire l'invocation xmlRpc de la méthode "spoolRequest".

3. Interpréter le code de retour de l'invocation.

  • sSi l'interprétation se passe bien : 3 valeurs possibles :
valeurs Signification
SPOOLREQUEST_STATE_SUCCESS Demande acceptée
SPOOLREQUEST_STATE_WAITING Demande acceptée mais en attente
SPOOLREQUEST_STATE_FAILURE Demande refusée.

1. Mise à jour du champ statut du bean de retour avec l'une des valeurs ci-dessus.

2. Si le code est SPOOLREQUEST_STATE_FAILURE, création en plus d'une Error sur le bean de retour.

  • sSi l'interprétation se passe mal :

1. si la valeur est inconnue mais d'un format accepté (numérique) 1 valeur possible :

valeur Signification
SPOOLREQUEST_STATE_UNKNOWN Code de retour de l'invocation inconnu.

Le champ statut du bean de retour n'est pas mis à jour. Création d'une Error sur le bean de retour en signalant la valeur UNKNOWN comme valeur reçue.

2. si la valeur est inconnue et d'un format non accepté (pas un numérique)

Le champ statut du bean de retour n'est pas mis à jour. Création d'une Error sur le bean de retour en signalant la valeur brute (chaîne de caractères) du code de retour de l'invocation xmlRpc.

Cas d’erreur

Cause Effet
Le code de retour de l'invocation est inconnu Création d'une Error sur le « bean » de retour.
Exception lors de l'invocation. Création d'une Error sur le « bean » de retour.