Elément requis	Version
Harmony	> Harmony 405

Pré-requis

Les services web REST doivent être fonctionnels

Cloud

En mode Cloud, le service web RecordSql REST est opérationnel, mais le paramétrage des RecordSql autorisés est nécessaire.

Ce service web est géré nativement par Harmony, sans avoir besoin de décrire une action de service.

Il permet d'interroger directement la base de données de l'ERP au niveau de la couche d'accès physique que sont les RecordSql.

Le service web RecordSql REST ne permet que la lecture de données (requêtes sql de type SELECT)

Il y a trois fichiers qui permettent le paramétrage des services web RecordSql REST

DhsDivaltoServiceDivaApiRest_ListDHOQ.xml : liste des RecordSql autorisés
DhsDivaltoServiceDivaApiRest_ParamSystem.xml : options des appels aux RecordSql
DhsDivaltoServiceDivaApiRest_ParamERP.xml : non utilisé pour le moment

Ces fichiers sont par défaut dans C:\divalto\Internet\DhsDivaltoServiceDivaApiRest

Paramétrage des RecordSql autorisés - SW REST Liste DHOQ

Principe des RecordSql autorisés

Le fichier DhsDivaltoServiceDivaApiRest_ListDHOQ.xml liste les RecordSql autorisés par appel REST.

DhsDivaltoServiceDivaApiRest_ListDHOQ.xml

<?xml version="1.0" encoding="utf-8"?>
<params>
  <dhoqs>
    <!-- commentaire <dhoq Name="gtrstab.dhoq" /> -->
    <dhoq Name="gtrsart.dhoq" />
  </dhoqs>
</params>

En sous-niveau de la balise <dhoqs> il s'agit de lister tous les objets diva de type RecordSql (extension .DHOQ) qui seront autorisés a être manipulés par service web REST.

Par défaut, aucun fichier n’est autorisé (le fichier exemple fourni contient des lignes commentées) il est donc indispensable de renseigner des lignes avant d'utiliser ce serviceweb

Exemple: <dhoq Name="gtrsart.dhoq" /> autorise le RecordSql "GTRSART" (fiches du thème ARTICLES de l'ERP)

Paramétrage On Premise

Le paramétrage s'effectue directement par modification du fichier DhsDivaltoServiceDivaApiRest_ListDHOQ.xml tel qu'indiqué

Paramétrage Cloud

Il existe un utilitaire avec interface graphique qui permet de lister les RecordSql autorisés.

Cette opération s’effectue sur le programme d’Administration Cloud (Onglet ‘REST’).

En cas d’ajout ou de suppression de fichier dans cette liste, vous devrez patienter jusqu’à 10 minutes pour que la configuration soit effective.
Exemple : Ajout du dictionnaire ‘gtrstab.dhoq’ sur l’environnement ‘testing’ :

Paramétrage système - SW REST System

Le fichier DhsDivaltoServiceDivaApiRest_ParamSystem.xml indique des options générales aux appels REST, mais aussi des options spécifiques au traitement des RecordSql.

DhsDivaltoServiceDivaApiRest_ParamSystem.xml

<?xml version="1.0" encoding="utf-8"?>
<params>
  <options>
    <!-- <debug 	         		Value="0"  /> -->
    <!-- <modelogonuser		Value="2"  /> -->
    <!-- <ReloadCacheUser 		Value="30"  /> -->
    <!-- <FreeCacheUser 		Value="30"  /> -->
    <!-- <ReloadCacheDHOQ 	Value="30  /> -->
    <!-- <MaxRecordInCount 	Value="1000" /> -->
    <!-- <ReloadCacheDomaineInError Value="5"  /> -->
    <!-- <LimitValidToken 	    	Value="30" /> -->
    <!-- <FreeInstanceRecordSQL	Value="30"  /> -->
    <!-- <ControlFree       		Value="30"  /> -->
    <!-- <ReloadCacheEnv       	 Value="30"  /> -->
    <!-- <ReloadCacheDico     	 Value="30"  /> -->
    <!-- <Domaine            		 Value="xxx"  Forcer="0" /> -->
    <!-- <Env              		 Value="xxx"  Forcer="0" /> -->
  </options>
  </params>

Balise OPTIONS	Description	Valeurs indique celle a utiliser par défaut)
ReloadCacheDHOQ	Cache RecordSql	Nombre (minutes) 30 Détails On recharge le cache d’un dhoq déjà chargé au bout de n minutes afin de prendre en compte les modifications des RecordSql, et pour les sortir de la mémoire
MaxRecordInCount	Nom d'enregistrement retournés	Nombre (quantité) 1000 Détails Nombre maxi d’enregistrement renvoyés dans une requête REST (hors pagination)
FreeInstanceRecordSQL	Libération objets RecordSql	Nombre (minutes) 30 Détails On libère les instances recordsql au bout de n minutes s’ils elles ne sont pas utilisées
ControlFree	Libération ressources	Nombre (minutes) 30 Détails La plupart des control de validités se font quand une requête arrive, mais s’il n’y a pas de requête, alors on fait une vérification des limites de validités toutes les n minutes Ainsi même s’il n’y a plus d’activité du serveur REST, celui vérifiera s’il faut libérer des ressources toutes les n minutes.
ReloadCacheEnv	Cache environnement	Nombre (minutes) 30 Détails On recharge le cache d’environnement au bout de n minutes
ReloadCacheDico	Cache dictionnaires	Nombre (minutes) 30 Détails On recharge le cache de dictionnaires au bout de n minutes
Env	Authentification : environnement	Nom de l'environnement suivi de Forcer="0" ou "1" Détails On peut définir un environnement par défaut ou bien le forcer Si forcer = 0 alors on prend ce Nom de l'environnement par defaut s'il n'y a pas de champ env indiqué dans la requête d’authentification Si forcer = 1 alors on force toujours cet environnement Exemple <Env Value="ERP213" Forcer="1" /> a pour effet de toujours prendre l'environnement "ERP213" quelle que soit la valeur du paramètre 'env' lors de l'appel API d'authentification

Livre de bord

Un livre de bord spécifique a l'API Rest est disponible depuis la console d'administration, par le menu 'Journaux / consulter un autre journal'.

Le fichier de log porte le nom 'feventREST.log'. Il est activé par la balise debug à 1 dans le fichier DhsDivaltoServiceDivaApiRest_ParamSystem.xml

Paramétrage SW RecordSql REST