Gestion des paramètres REST

L'API REST RecordSQL nécessite de déclarer au préalable la liste des fichiers DHOQ qui seront utilisés.
Cette déclaration permet d'autoriser l'accès à ces fichiers au travers de l'API REST RecordSQL mais également de générer les fichiers XML associés aux fichiers DHOQ.
Cette seconde étape est nécessaire afin de mettre en cache les éléments dans une optique d'optimisation des performances. Elle permet également de générer les documentations en lien avec chaque fichier DHOQ que vous pourrez ensuite consulter.

Fonctionnalités

Pour ajouter un nouveau fichier DHOQ, ajoutez une ligne puis vous pouvez utiliser le raccourci clavier 'F8' puis sélectionner le fichier souhaité dans la liste. En cas d'ajout ou de suppression de fichier dans cette liste, vous devrez patienter jusqu'à 10 minutes pour que la configuration soit prise en compte.

A noter qu’il est possible de change l’environnement courant avec le bouton prévu.

Lors de la validation de vos modifications, il vous sera proposé de générer les fichiers XML qui contiendront la liste des RecordSQL, les dictionnaires de données et les documentations associées. Il est important d'effectuer cette opération afin de bénéficier de l'ensemble des fonctionnalités et d'optimiser les performances de l'API. Vous pouvez réaliser cette opération à tout moment en utilisant le bouton « Liste des records SQL » notamment si vous réalisez des modifications sur les fichiers DHOQ ou les dictionnaires de données, mais veillez a voir les bon implicites en ligne.
La fenêtre de génération des fichiers XML requiert de vérifier le chemin des objets DHOQ puis éventuellement de compléter le chemin des surcharges des objets DHOQ.

Le traitement peut nécessiter plusieurs minutes selon le nombre de fichiers à traiter. Un rapport complet s'affiche à la fin de l'opération.

Remarques:

• la ligne ‘Chemin des surcharges des objets dhoq' ne sert pas quand on coche ‘Utiliser la liste des implicites’ car dans ce cas on restreint la recherche de chemins aux implicites

• dans le mode ‘Utiliser la liste des implicites’, tous les chemins sont parcourus à la recherche d’objets dhoq même en-dehors du ‘Chemin harmony des objets dhoq’

A la suite de la définition des fichiers DHOQ puis de la génération des fichiers XML, vous pouvez :

• Utiliser l'API REST RecordSQL (Se référer au chapitre concernant l'utilisation de ce service)

• Consulter les fichiers XML générés (Bouton « Lire les fichiers XML »)

• Consulter les documentations associées à chaque fichier DHOQ afin d'obtenir des informations sur la manière d'exploiter les RecordSQL (Bouton « Lire la doc sur un record SQL »)

Exemple d'affichage de la documentation du RecordSQL « CODEPOSTAL » lié au fichier « GTRSTAB.DHOQ » :