Composants & Tools à usage des utilisateurs
Accountix Webservice
connecteur EMAsphere
Dossier Accountix - WS - EMASphere
Nom du tools ACWS
Statut :W:
Dossiers

Rédacteur(s)

Manu Fernandes 11/10/2017 08:55 create

Manu Fernandes 23/10/2017 10:28 mise à jour suite à la réunion du 20/10/2017

Généralités

  • Access point de lecture des données Integrix/Accountix depuis le web service ; description orientée vers le client 'EMASphere'
  • Les méthodes d'accès sont discutées à part.

Description du composant

  • Liste des webservices à exploiter

Manu Fernandes 20/10/2017 demande

Manu Fernandes 23/10/2017 complémenté

  • :V: count sur tout (et cache=1 pour les suivants)
  • :V: ajouter des lettrages (Document=Id, Objet, Date, Montant)
  • :V: ajouter la ventilation analytique (Analytique, CostCenter(Id, Description, Groupe), Montant, Quantité) (:!: pas de données pour l'instant)
  • FIXME spec. de deploy vers un client / fiduciaire : connecteur, gateway, param acx, log d'activité

WebServices

Par principe,

  1. les web services répondent à la norme RESTFull et exploitent le protocole HTTP
  2. les web services détaillent leurs structures via la méthode http OPTIONS qui retourne une structure de type http://json-schema.org/
  3. Le json-schema détaille la structure à recevoir (objet, propriétés ) et les links (méthodes et structures gérées par les objets)

Les webservice ouverts pour EMAsphere

L'accesspoint de l'environnement de test est http://samples.infodata.lu selon les clients, l'accesspoint sera spécifié.

Pour le test, les appels doivent être chargé avec un header X-SSO-USER-ID=DT

uri méthode Description
Les bases
/accountix/dos HTTP/1.1 OPTIONS, GET retourne la liste des dossier comptables autorisés
/accountix/dos/AC.EMA/defn HTTP/1.1 OPTIONS, GET retourne les données de définitions du dossier comptable sélectionné ici AC.EMA
/accountix/exe HTTP/1.1 OPTIONS,GET les exercices et leurs périodes
/accountix/jnl HTTP/1.1 OPTIONS,GET les journaux
/accountix/gcf HTTP/1.1 OPTIONS,GET le plan comptable ; les comptes
/accountix/gcf/count HTTP/1.1 GET nombre d'éléments
Les mouvements
/accountix/mvt/ HTTP/1.1 OPTIONS la structure des mouvements
/accountix/mvt?start, ... limit ... cache
/accountix/…?width= HTTP/1.1 GET Permet de palcer des filtre 'sql like where' sur n'importe quel objet
/accountix/mvt?\\with=IdDocument|=|1%232016%23%23AC1%231025&limit=1000 HTTP/1.1 GETles lignes de la facture 1#2016##AC1#1025 (les # sont encodés %23)
/accountix/mvt/gcf/F177 HTTP/1.1 GET le grand livre du compte F177; les mouvements du tiers F177
/accountix/mvt/jnl/V01 HTTP/1.1 GET les mouvements du journal V01
/accountix/mvt/count HTTP/1.1 GET renvoie la qte de record à attendre
Chronologie à respecter :
  1. /accountix/dos ; pour recevoir la liste des dossiers autorisés.
  2. /accountix/dos/AC.EMA/defn ; pour prendre un 'login' dans le dossier AC.EMA ; tous les appels suivants travailleront sur AC.EMA
    1. la variable du header 'x-witoken doit être reprise dans les appels successifs (id de session)

Limiter le nombre d'item à retourner

Lire X items

Pour lire plusieurs données, l'application WEB exécutera une requête GET en passant des paramètres à l'url.

  • url = GET /objectname?with=field|operator|value{&with=field|operator|value{…}}&by=field{&by=field{…}&sep=OR ou AND
    • la clause with prend pour valeur un champ composé par des pipes (|) tel que :
      • field est le nom d'un field
      • operator est le nom d'un opérateur.
        • = = égale
        • # = différent
        • > = plus grand que
        • < = plus petit que
        • >= = plus grand ou égale que
        • = plus petit ou égale que
      • value est la valeur appliquée au test
      • plusieurs clause with peuvent être utilisées; le système utilise une conjonction AND entre elles
    • la clause by est utilisée pour demander un tri selon le field
      • le fieldname peut éventuellement être précédé par un (-) pour demander un tri en ordre inverse (BY-SDND)
      • plusieurs clause by peuvent être utilisées ; elles sont insérées successivement dans la phrase passée au système.
    • sep permet de spécifier que les WITH seront séparés par des “AND” ou “OR” .
      Par défaut, la valeur est AND. Valeur possible
      • OR
      • AND

Exemple :

Limiter le nombre de résultat

Pour limiter le résultat, il faut ajouter dans l'url ou dans les paramètres application de l'url du compte WEB le paramètre “LIMIT”.

  • url = 'GET /objectname?limit=..'

limit Le nombre de record qu'on veut recevoir au maximum

Lire une pagination

Lire du item x au item y

Pour obtenir uniquement du record X au record Y, il est possible de le splitter pour le mettre par exemple dans une grid avec pagination.

  • url = 'GET /objectname?start=…&limit=..&cache=…'
  • start la position du premier record
  • limit Le nombre de record qu'on veut recevoir au maximum
  • cache 1 si on ne veut pas exécuter de nouveau la sélection des clés mais qu'on veut les rechercher dans un cache (FWI.TMP).

Id de FWI.TMP :

  • si cacheID # ? cle “RFLOBJ_”:{RFLOBJ}:“_”:{cacheID})
  • sinon = cle “RFLOBJ_”:{RFLOBJ}:“_”:{witoken})
  • cacheid : L'id du cache. permet de savoir dans quel record sont stockées les clés. Paramètre pris en compte si CACHE = 0 ou 1
    • Le fichier FWI.TMP est nettoyé tous les jours à minuit par le WI.HDL.MNG

Aspect commercial

Devis type 171364 (divers) — Alain Stéphan 05/12/2017 09:09 dc171364_emasphere_dec2017.pdf

par site, nombre de dossiers non impacté

  • infrastructure
    • Wb service pool de 1 à 2 handler
  • installation chez le client + gateway : 8h00
  • 1 licence bunddle UV/sbxa : suivant le nombre d'utilisateurs, nous pourrions être amené à augmenter le nombre de licence UV/SBXA
  • gateway + service 50 € par mois
  • facturation trimestre
  • contrat de 3 ans
insoft/ac/doc/webservice/emasphere.txt · Dernière modification: 05/12/2017 14:19 par Alain Stéphan
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki