Généralités
Introduction
Le WebService (ou Service Web) permet à des applications de dialoguer à distance via Internet et indépendamment des plates-formes et des langages sur lesquels ces applications reposent (interopérabilité).
Cette unité d’application logique fournit des données et des services à d’autres applications Web. Ces applications communiquent entre elles grâce à des langages standards et des normes d’échange (XML, WSDL, Soap et UDDI).
Véritable standard en terme d'intégration et d'échanges B2B, le WebService est l’un des principaux composants de l’offre ACE RETAIL .
Le principe de base est simple : le WebService utilise une chaîne de caractères en entrée et restitue une chaîne de caractères en retour. Ces chaînes de caractères sont convertibles au format XML.
Principes
La publication d’un acte de gestion d’ACE sous forme de WebService n’impacte pas le comportement de cet acte de gestion.
ACE vous propose plusieurs WebServices :
- sWSGCEService (API GCEServiceassimilate ), entièrement dédié à l’intégration de données (les événements notamment),
- sWSCRUDManager , un service qui permet d’échanger avec notre base de données, en effectuant des actes aussi basiques que la création d’une donnée, sa consultation, sa modification ou sa suppression,
- sWSGestionAnalytique qui, dans le module Finance, permet de s’interfacer avec Excel,
- sBusinessViewRendererrenderXml pour générer le flux de présentation XML d’une businessView.
Aspects techniques
Accès
Les WebServices ACE sont des WebServices standards activés via SOAP, une norme d'échange de messages au format XML. Les paramètres d’entrée sont d’ailleurs organisés au format XML.
Le serveur de webservice se présente sous la forme d'un web module.
Le déploiement de WebService est limité uniquement aux serveurs d'application Oracle (9.0.4 10g).
Installation
Dans le web module contenant les webservices, la Servlet "ServletControl" doit être paramétrée afin de se charger automatiquement au démarrage. En effet, elle initialise les variables d'environnements pour l'ensemble des API .
Par contre, on ne publie pas la "ServletControl" dans le web module (fichier web.xml).
<servlet>
<servlet-name>ServletControl</servlet-name>
<display-name>ServletControl</display-name>
<servlet-class>fr.ACE.technicalframework.application.ServletControl</servlet-class>
<load-on-startup>1</load-on-startup> <!-- This is requiered for webservices. Don't remove. -->
<security-role-ref>
<description>root</description>
<role-name>root</role-name>
<role-link>super-user</role-link>
</security-role-ref>
</servlet>
Fichier de configuration
Une section "webservice_def" du fichier de configuration (dans l'élément "application") vous permet de personnaliser vos WebServices.
|
Pour en savoir plus, consultez la documentation de référence « Web : le fichier de configuration ». |
Le nœud "webservice_def" contient les valeurs par défaut.
Les nœuds "webservice" représentent la définition d'un webservice particulier :
| Nom de l'attribut | Description |
| name | Clé primaire d'accès à la définition d'un webservice. |
| entity | Entité (voir documentation Multi-entités) |
| target | Cible (ex: VCLI, GART,…) |
| user | Nom de l'utilisateur qui exécute le service. |
| language | Langue des messages d'erreur. |
Exemple :
Cet exemple définit le webservice "GestionEvenement"
<webservice_def entity="1" target="MENU" user="DECONNINCK" language="FRA">
<webservice name="GestionEvenement" target="VCDT"/>
<webservice name="LoginManager"/>
</webservice_def>
