API ACE Service assimilate

Version : ACE 1.0

Edition spéciale ES2

Package : fr.generix.metier.bc4j.integration.common

GCEServiceassimilate

Schémas d’entrée et de sortie :

OUT

Cette API fournit des services d’intégration (un peu l’équivalent de l’intégrateur en mode Client/Serveur INTEG, voir aussi Connecteur). Même si elle ne propose pas réellement de fonctionnalités directes en terme d’actes de gestion, elle sert de coordination entre les différents services existants.

Son intérêt consiste à intégrer un flux de données composé d’un nombre important de données, surtout dans leur diversité.

Pour exemple, cette API est capable de créer et gérer des commandes de vente ou d’achat. En une seule opération, elle est notamment capable de déclencher :

la création de la commande et des différents postes,
le déclenchement des conditions tarifaires complexes,
la valorisation de la commande,
le déclenchement de l’édition.

Elle peut également créer un client, de nouveaux produits, ou encore générer des réceptions ou des livraisons de marchandises.

API imbriquées :

GestionEvenementgenererEvenement,
GestionEvenementgenererFraisEntete,
GestionEvenementpanacher,
GestionEvenementrevaloriserEvenement,
GestionEvenementsupprimerEvenement,
GestionEvenementvaliderEvenement,
GestionEvenementvaloriserColisage,
GestionEvenementvaloriserMontant .

Comment utiliser le connecteur GCEServiceassimilate ?

Pour utiliser le connecteur du module Services, il suffit de :

ouvrir le fichier EAR correspondant à votre version,
extraire le module « Services »,
positionner ce module au niveau de votre version, dans le répertoire suivant : « C:\e-GX\V5.0-00ES2\oc4j\j2ee\home\applications\egx500ES2 »,
lancer votre OC4J afin de le déployer,
vérifier que le fichier « web.xml » contient l’information suivante plusieurs fois « gCEService » (fichier situé dans « C:\e-GX\V5.0-00ES2\oc4j\j2ee\home\applications\egx500ES2\egx500ES2-webservices\WEB-INF »),
lancer l’URL suivante pour démarrer le connecteur : « http://localhost:8888/egx500ES2/services/gCEService »,
Cliquer sur l’option « assimilate », le champ « value » permet de lancer un flux d’entrée.

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

RAS.

Paramétrage (PPE)

RAS.

Processus, contrôles et règles de gestion

ETAPE	DESCRIPTION DU PROCESSUS
1	Analyse du flux XML d’entrée.
2	Enchaînement, de manière logique et unitaire, des différents services demandés.
3	Enregistrement d’un historique des opérations effectuées.
4	Gestion des erreurs.
SCHÉMA D’ENTRÉE	Transaction Il est possible de renseigner plusieurs transactions à cette API. Chacune de ces transactions se compose d’une première partie qui permet de donner la cible, la société et l’utilisateur. Ensuite, plusieurs directions sont possibles : la gestion d’un ou plusieurs produits, d’un ou plusieurs tiers, d’un ou plusieurs événements (nœud « businessEvent »).
	Service Le nœud « Service » correspond au déclenchement de différentes API sur l’événement (génération, validation, valorisation,…) : « edit » è GestionEvenementcreerEdition « generate » è GestionEvenementgenererEvenement (voir documentation GCEServiceassimilate_generate . « generateExpenses » è GestionEvenementgenererFraisEntete « combine » è GestionEvenementpanacher « adjust » è GestionEvenementrevaloriserEvenement « delete » è GestionEvenementsupprimerEvenement « validate » è GestionEvenementvaliderEvenement “valuePacking” è GestionEvenementvaloriserColisage « valueAmount » è GestionEvenementvaloriserMontant
	Header Pour renseigner l’en-tête de commande, il suffit de renseigner les parties « key » et « info »/ La partie « key » permet d’identifier respectivement l’en-tête de commande (table EVE) pour lui appliquer une action (suppression ou remplacement) ou un service (nœud « Service ») La partie « info » permet de restituer les informations de l’en-tête de l’événement utiliseées lors de la création ou de la modification de l’événement. Les actions possibles : creation, replacement, deletion, modification, addition, generation. Liste des objets contenant une action (action par défaut entre parenthèses) : Address (addition), AnalyticalAllocation (generation), EventExpense (creation), EventHeader (creation) EventItem (creation), EventLine (modification), EventSubitem (creation), Lot (addition), Product (addition), Thirdparty (addition).
	BusinessEvent Le noeud “BusinessEvent/header/info” contient un noeud “item” afin de renseigner un ou plusieurs postes d’événement (avec un nœud « key » + « info ») et ainsi de suite pour les lignes d’événement (nœud « ligne ») et les sous-postes d’événement (nœud « subitem »).

Exemple(s) d’utilisation

Exemple de flux XML d’entrée

Voici un exemple d’un flux XML à intégrer dans ACE via le webservice « GCEService ».

<?xml version="1.0" encoding="utf-8"?>

</identification>

</context>

<info>

<key>

<identifier>BRFOU101</identifier>

</key>

</thirdparty>

<depot>ATELIER</depot>

<key>

<identifier>BRFOU101</identifier>

</key>

</deliveryThirdparty>

<description>Commande d'achat en EUR</description>

<item>

<info>

<key>

</key>

</product>

<secondary2>DIVERS</secondary2>

</analyticalAxis>

<secondary1>TRESO</secondary1>

<secondary2>DIVERS</secondary2>

</analyticalAxis>

</analyticalAxis>

</analyticalAxis>

</info>

</item>

</info>

</header>

</businessEvent>

</transaction>

</GCEServiceassimilateIn>

Exemple de flux XML de retour

<egx_ws>

<bean_out>

</eventHeaderKey>

</eventItemKey>

</result>

</GCEServiceassimilateOut>

</bean_out>

</egx_ws>