| API / API Web | |
| Version ACE : 1.2 | ||
|
Package : fr.ACE.metier.bc4j.commun.common GestionCommungererZoneParametree |
||
| Schémas d’entrée et de sortie : | IN | OUT |
|
|
Attention Cette API, disponible depuis la version ACE 1.2, est aussi implémentée en version ACE 4.5.00. |
Cette API permet de gérer les accès en lecture/écriture aux zones paramétrées (appelées aussi zones datées) des tables suivantes :
| ADR | Adresses |
| CAE | Eléments du catalogue |
| EVE | En-têtes d’évènement |
| EVP | Postes d’évènement |
| OPE | Opérations commerciales |
| PRO | Produits |
| TIE | Tiers |
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
|
Les zones paramétrées des autres tables (EVS, CTC, etc) ne sont pas concernées par cette fonctionnalité et sont mémorisées dans la table ZOD. En outre, cette fonctionnalité (gestion des zones paramétrées dans les structures XXX_CMP) n’est pas gérée pour les points suivants :
|
Paramétrage (PPE)
| Cette fonctionnalité est gérée par le paramètre ZODMOD. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | PASSAGE DE PARAMÈTRES À L’API :
Le contexte d’origine permet la propagation des zones paramétrées. Ex : Un produit vers un autre dans le cas de la duplication d’un produit. |
| 2 | LECTURE DU PARAMÉTRAGE DE ZODMOD
Détermination du mode de gestion
des zones paramétrées pour la table concernée par le contexte (zone
paramétrée de la table EVE si le contexte en
entrée de l’API est l’Evenement, table CAE pour
un Element, etc.)
Pour connaître la zone gérée en mode datée ou non, un indicateur « Indcmpzod » est utilisé dans la table ZON. |
| 3a | MODE « R » : LECTURE DES ZONES PARAMÉTRÉES
Si une liste de
ZoneParametree est renseignée en entrée de l’API :
Si aucune ZoneParametree n’est renseignée en entrée :
Même principe que pour la lecture d’une zone paramétrée. |
| 3b | MODE « C », « U », « M » : MISE À JOUR DES ZONES PARAMÉTRÉES
Si
une liste de ZoneParametree est renseignée en entrée de l’API :
|
| 3c | MODE « D » : SUPPRESSION DES ZONES PARAMÉTRÉES
Si une liste de
ZoneParametree est renseignée en entrée de l’API :
Si aucune ZoneParametree n’est renseignée en entrée :
|
Erreurs possibles
| CAUSE | EFFET |
|
Le contexte à gérer ou le contexte d’origine n’existe pas :
|
Exception « ELT_PASTRO » |
| Le produit à gérer ou le produit d’origine n’existe pas | Exception « PRO_PASTRO » |
| Le tiers à gérer ou le tiers d’origine n’existe pas | Exception « TIE_PASTRO » |
| Le numéro de la zone paramétrées est < 100 alors que la zone est gérée en mode « daté » dans la table ZOD. | Exception « ERR_PARAM » |
| Si la zone paramétrée existe et que l’on est en mode « C » - création. | Exception « ELT_EXISDE » |
Exemple(s) d’utilisation
|
Cette API est déployée partout dans les sources où l’on doit accéder en lecture comme en écriture aux données paramétrées des tables EVE, EVP, TIE, ADR, PRO, CAE ou OPE dans la limite du cadre fonctionnel définie ci-dessus. Ex. Lors de la duplication d’un évènement, on duplique en autres, les zones paramétrées du poste et de l’entête. Dans ce cadre, on appelle l’API en lui passant l’évènement d’origine à dupliquer, l’évènement à créer et le mode « M » pour Manage signifiant que l’API doit créer la donnée complémentaire si elle n’existe pas pour ce nouvel évènement. |