Documentation de GTF¶
GTF (Gestionnaire de Tâches pour FME) est une application 100% web qui permet de publier sur internet des traitements conçus avec FME et de les mettre à disposition d’un grand nombre d’utilisateurs.
C’est un outil de partage, de planification et de supervision de traitements FME.
Bienvenue dans GTF¶
GTF (Gestionnaire de Tâches pour FME) est une application 100% web qui permet de publier sur internet des traitements conçus avec FME et de les mettre à disposition d”un grand nombre d”utilisateurs. C”est un outil de partage, de planification et de supervision de traitements FME.
GTF offre des fonctions d”administration pour la création et la gestion des utilisateurs et l”attribution des droits sur les traitements.
GTF est particulièrement bien adapté pour répondre à des besoins de :
- conversion de fichiers
- extraction de données
- contrôle qualité
- génération de rapport
- gestion d”alertes
GTF se compose d”une application cliente, d”une API REST qui permet d”exploiter GTF sous forme de service web et d”une API Formulaire :
- GTF Client permet à l”administrateur de publier des traitements préalablement conçus avec FME Workbench. Par cette interface, l”administrateur gère les utilisateurs en leur attribuant des droits sur les traitements publiés, et peut également s”appuyer sur un annuaire MS-Active Directory pour assurer l”authentification et la gestion des droits. Il dispose par ailleurs de fonctions de supervision et de consultation de statistiques. Les utilisateurs soumettent des demandes de traitements, chargent leurs propres données et téléchargent les résultats. Les traitements sont exécutés en mode asynchrone ce qui permet aux utilisateurs de continuer à travailler sans attendre la fin du traitement. Un e-mail avertit l”utilisateur de la disponibilité du résultat. GTF Client permet également de s”abonner à un traitement à la fréquence souhaitée pour automatiser la production d”un traitement.
- L”API REST de GTF permet à n”importe quelle application de faire appel aux services de GTF de manière transparente pour les utilisateurs. C”est la solution idéale pour les développeurs souhaitant offrir leur propre interface graphique.
- L”API Formulaire permet de mettre en forme le formulaire de saisie des paramètres en intégrant des composants (cartes open layer, arborescences de fichiers…)
Les composants logiciels de GTF¶
L”architecture de GTF est constituée de plusieurs composants logiciels.
Composants | Description |
GTF client | Applications Web permettant aux utilisateurs l’accès aux services GTF |
Apache HTTPD | Logiciel serveur HTTP. |
PHP | Langage de programmation |
PostgreSQL | Système de gestion de base de données relationnelle utilisé pour le stockage des informations : demandes de traitements, traitements publiés, droits des utilisateurs... |
PYCRON | Service Windows assurant l'exécution de tâches planifiées.Remplacé par le service Cron sur Linux. |
GTF Engine | GTF Engine désigne le moteur de GTF, la partie logicielle capable d’exécuter les traitements FME. GTF exploite au minimum un moteur GTF. Les moteurs supplémentaires permettent de répartir la charge sur plusieurs process ou machines. L'ajout de moteurs supplémentaires et soumis à l'acquisition des licences correspondantes. |
FME | Logiciel FME Professional Edition ou supérieure en licence fixe ou flottante. FME ne fait pas partie du logiciel GTF, mais il est indispensable à son fonctionnement. |
composants logiciels de GTF
Installation¶
Procédure d”installation¶
GTF dispose d’un installateur spécifique VAI qui permet d’assurer l’installation et la mise à jour du produit sans perte de configuration ni de données.
1. Préconisations techniques¶
Poste | Configuration minimale | Configuration recommandée |
CPU | 2 coeurs | 4 coeurs |
Mémoire vive | 4 GB (8Gb sur un système 64-bit) | 8 GB (16Gb sur un système 64-bit) |
Espace disque disponible | 8 GB | 60 GB |
Base de données | PostgreSql 9.3 ou plus | PostgreSql 9.3 ou plus |
Serveur http | Apache 2.4.13 ou plus (avec mod_ssl) | Apache 2.4.13 ou plus (avec mod_ssl) |
2. Installation des prérequis¶
Installation de FME¶
Dans GTF, FME est en charge de l’exécution des projets. Procéder en premier lieu à l”installation de FME pour que GTF puisse fonctionner et exécuter des traitements.
Procédure d”installation de FME en Anglais
Procédure d”installation de FME en Français
Si vous utilisez une version FE Database Edition de FME (Oracle), installer le client Oracle sur le serveur.
Sur Linux, si vous voulez utiliser FME 2018, exécuter le script suivant :
cd /opt/fme-desktop-2018/metafile
sudo cp *.fmi ./dependencies/
sudo cp *.fmf ./dependencies/
Installation d”Apache 2.4¶
GTF utilise le protocole sécurisé https qui assure le cryptage des échanges entre le Serveur d’Application Vitis et le poste client. Il est donc nécessaire d’installer une version spécifique du serveur http Apache compilé avec le module SSL.
Installation de Postgresql¶
GTF utilise une base Postgresql pour stocker les informations sur les projets FME et les demandes de traitement ainsi que sur les utilisateurs et leurs droits. Si Postgresql est déjà installé sur votre poste, cette étape est facultative.
Procédure d’installation Postgresql pour Windows
Procédure d’installation Postgresql pour Linux
La base de données contenant l”application GTF doit utiliser le fuseau horraire UTC.
Pour identifier le fuseau horraire utilisé par défaut dans votre base de données, exécuter la requête suivante :
SHOW timezone;
show tz
Vous pouvez changer cette valeur en éditant la variable timezone qui se trouve dans la partie Locale and Formatting avant de lancer l”installation.
postgres conf
Si votre base est déjà existante, vous pouvez utiliser la requête suivante en remplaçant [db_name] par le nom de votre base de données :
ALTER DATABASE [db_name] SET timezone ='UTC';
3. Installation de GTF¶
Pour installer GTF, éditez le fichier install.cmd (Windows) ou install.sh (Linux) afin de définir les paramètres de votre installation.
Les variables à modifier pour l’installation sont :
Variable | Description |
dir | Répertoire d'installation (/var/www/gtf préférable pour Linux C:/server/gtf conseillé pour Windows) |
serveur | Serveur de la base de données |
port | Port d'accès à la base de données |
bdd | Nom de la base de données (La base de données peut être existante) |
dblogin | Compte d'un superutilisateur de la base |
dbpswd | Mot de passe du compte superutilisateur |
apacheService | Nom du service Apache exploité par l'application |
apachePort | Port du service https du serveur Apache |
appAdmin | Compte PostgreSql de l'administrateur de l'application. Ce compte sera créé s'il n'existe pas. |
appPswd | Mot de passe du compte précédent s'il doit être créé. Si le compte existe déjà cette valeur n'est pas exploitée. Il faut néammoins saisir une valeur car ce paramètre est obligatoire. |
L’installateur de GTF assure les opérations suivantes :
- Copie du code du serveur d’application Vitis
- Copie du code du moteur GTF
- Installation et configuration de Pycron comme un service (Uniquement sur Windows)
- Installation du PHP
- Configuration du serveur HTTPS Apache
- Création de la base de données dans PostgreSQL
- Création d’un compte administrateur dans PostgreSQL
Sur Linux, donner les droits d’exécution aux fichiers install.sh et setup_gtf-[version_gtf].[build_gtf].
chmod +x install.sh
chmod +x setup_gtf-[version_gtf].[build_gtf]
Exécuter le script install.cmd ou install.sh pour lancer l’installation.
Sur Windows, il faut attendre une minute environ pour avoir un retour dans la console.
Un rapport d’installation install_report_dd-mm-yyyy.txt est généré, il permet de savoir si l’installation s’est déroulée correctement.
4. Configuration de PostgreSQL¶
Il est nécessaire de configurer le serveur PostgreSQL pour permettre à l’application d’accéder à la base de données.
La procédure ci-dessous s’applique si le serveur PostgreSQL est sur la même machine que GTF. Si ce n’est pas le cas, il faut prévoir une configuration spécifique.
Editer le fichier pg_hba.conf de PostgreSQL :
Immédiatement après « # IPv4 local connections » insérer la ligne :
# IPv4 local connections host gtfdatabase u_vitis 127.0.0.1/32 trust host gtfdatabase u_scheduler 127.0.0.1/32 trust
Immédiatement après « # IPv6 local connections » insérez la ligne :
# IPv6 local connections host gtfdatabase u_vitis ::1/128 trust host gtfdatabase u_scheduler ::1/128 trust
Redémarrer le service PostgreSQL
5. Test de l”installation de GTF¶
L”instance de GTF doit désormais être disponible à l’adresse :
https://[serveur]/gtf
Où
La connexion à GTF par l’adresse localhost est impossible.
Si vous vous connectez avec le protocole http, la connexion sera automatiquement redirigée vers https.
Si vous avez créé vous-même votre propre certificat, votre serveur n’est pas sécurisé et votre navigateur va sans doute afficher un message d’alerte.
Vous devrez créer une exception de sécurité dans votre navigateur avant de pouvoir accéder à votre site.
Si vous utilisez un certificat valide ou si vous avez créé une exception de sécurité, vous devez arriver à la page de connexion :
Vous pouvez vous connecter en utilisant le compte et le mot de passe définis lors de l’installation.
La première chose à faire après la connexion est de s”attribuer des privilèges pour vous permettre d’exploiter toutes les fonctions d’administration et d’utilisation de GTF.
Cliquez sur l’icône pour passer en mode « Gestion des utilisateurs », choisissez l’onglet « Utilisateurs » (activé par défaut) et éditez votre compte.
- Attribuez les privilèges : gtf_admin et gtf_user à l’utilisateur
- Attribuez le groupe Administration à l’utilisateur
Vous disposez maintenant de tous les droits pour administrer et utiliser GTF. Reconnectez-vous pour accéder aux nouvelles fonctionnalités.
6. Configuration de GTF¶
1. Configuration Générale¶
Cliquer sur l’icône pour passer en mode « Configuration ».
Il est préférable de configurer un serveur SMTP pour pouvoir utiliser GTF.
Il faut sauvegarder la configuration avant de pouvoir la tester.
Si vous avez créé vous-même votre propre certificat, désactivez l’option « Vérifier la validité du certificat SSL ».
A partir de la version 2019.01.01, il est conseillé de générer un identifiant d”instance GTF.
Allez dans « Configuration GTF », et cliquez sur le bouton « générer » pour avoir un identifiant GTF puis sauvegardez la configuration.
Config_Instance_GTF
2. Activation de votre licence GTF¶
Toujours dans le mode configuration, cliquer sur la section « licence » pour demander/activer la licence GTF.
Si vous ne disposez pas de licence GTF, vous pouvez envoyer un mail à l”adresse codes@veremes.com, ou cliquer sur le bouton « Demander le fichier de licence » (à condition d”avoir configurer un serveur SMTP).
Si vous avez un fichier de licence GTF vous pouvez l”activer via le formulaire de cette section.
3. Création d”un moteur GTF¶
Cliquer sur l’icône pour gérer vos moteurs. Cliquer sur l”objet serveur.
La déclaration du serveur permet de définir les répertoires contenant l’ordonnanceur Pycron et le moteur GTF.
Par défaut le serveur localhost est défini, il fonctionne pour une installation classique de GTF.
Déclaration de serveur
Ensuite, il faut définir les moteurs FME. Cliquer sur l”objet moteur FME du même mode.
Un moteur FME est l”instance de FME en charge de l”exécution des projets. GTF permet d”exploiter différents moteurs hétérogènes. On peut ainsi exploiter un moteur FME 2015 en 32 bits et une instance de FME 2016 en 64 bits.
A partir de la version 2019.01.00 de GTF, il est aussi possible d”exploiter une instance FME Serveur et/ou FME Cloud. Cette fonctionnalité est documentée en détail dans la partie Administration.
La première étape consiste à déclarer un moteur FME exploitable par GTF.
Déclaration de moteur FME
Il est conseillé de nommer le moteur FME en indiquant le numéro de version, le numéro de build et le nombre de bits. Par exemple : « FME2016 b16494-32b ».
Le bouton “Test” permet de vérifier la validité de la licence FME. Avec FME 2016, pour que la licence soit valide, copier le fichier de licence présent dans le répertoire C:\ProgramData\SafeSoftware\FME\Licenses) dans le répertoire \licenses du répertoire d”installation de FME2016.
Il faut encore créer un moteur GTF.
On entend par Moteur GTF la capacité d”exploiter un moteur FME dans GTF. La création d”un moteur GTF permet d”associer à un serveur un moteur et de définir une période de déclenchement de l”activité spécifique. Un moteur GTF est associé à un seul moteur FME mais plusieurs moteurs GTF peuvent exploiter le même moteur FME.
L”ajout de moteurs GTF supplémentaires permet à l”administrateur d”appliquer une stratégie de traitement de projets en spécialisant par exemple certains moteurs et en permettant la parallélisation des traitements.
cliquez sur l”objet moteur GTF du même mode et cliquez sur le bouton « Ajouter un moteur GTF » pour ouvrir le formulaire de création de moteur GTF.
Attribuer un nom au moteur GTF et définir la période d”activité en minutes de ce dernier (période de déclenchement du moteur). On peut choisir de rendre inactif ce moteur, puis on sélectionne le serveur et le moteur FME à associer. Associer ensuite un ou plusieurs mots clés au moteur.
Déclaration de moteur GTF
Associer un ou plusieurs mots clés à un moteur permet à l”administrateur de mettre en place une stratégie de distribution des traitements sur plusieurs moteurs GTF : quand un utilisateur crée une demande de traitement, un moteur spécifique est spécifiquement attribué. Chaque moteur GTF est associé à un ou plusieurs mots clés. Chaque projet FME est ensuite associé à un mot clé. L”affiliation d”un projet à un moteur GTF se fait ainsi à partir de mots clés.
L”administrateur peut choisir des mots clés existants et déjà affiliés à d”autres moteurs dans la partie de gauche “Mots clés disponibles”, ou saisir directement le nom d”un nouveau mot clé dans le bloc de droite “Mot clé lié au moteur”. Un simple clic sur un mot clé disponible permet de le lier au moteur GTF.
Il est recommandé de nommer le moteur GTF selon cette règle : ID (auto) FME Version Service Pack. Par exemple : « #3 FME 2013 SP 3 ».
Cliquer ensuite sur le bouton “Créer” pour finaliser la création du moteur GTF.
4. Test du moteur GTF¶
A ce stade, pour s”assurer du bon fonctionnement de GTF, il est recommandé de procéder à l”import de nouveaux traitements. Pour cela, Veremes met à disposition sur son site de téléchargement vStore un projets exemples au format .gex ou .fmw.
Vous pouvez aussi ajouter un de vos propre projet via le mode « Publication ».
Le projet “Admin_Import” (associé au groupe Administration et installé automatiquement lors de l”installation de GTF) permet l”import de nouveaux traitements stockés dans un fichier .gex. Au préalable, l”administrateur doit être associé au groupe Administration pour pouvoir exploiter ces deux projets.
Se connecter à GTF (compte administrateur) puis ajouter une demande.
Import du fichier d'exemples.
Choisir le traitement « Admin-Import » puis dans « Fichier d”export GTF à importer (.gex) : », cliquer sur « Parcourir » et sélectionner le fichier .gex préalablement téléchargé. Définir ensuite le nom du rapport html à générer. Il indique la liste des projets importés, leurs clé et ID ainsi que le statut de l”importation : Inséré dans GTF, Mis à jour dans GTF ou Non mis à jour dans GTF.
Associer un ou plusieurs mots clés à un moteur permet à l”administrateur de mettre en place une stratégie de distribution des traitements sur plusieurs moteurs GTF : quand un utilisateur crée une demande de traitement, un moteur spécifique est spécifiquement attribué. Chaque moteur GTF est associé à un ou plusieurs mots clés. Chaque projet FME est ensuite associé à un mot clé. L”affiliation d”un projet à un moteur GTF se fait ainsi à partir de mots clés.Il est obligatoire d”insérer l”extension .html dans le champs Nom du rapport à générer.
Le paramètre “Que faire des projets existants déjà dans la base GTF (même Clé)” indique à GTF s”il doit charger ou pas les projets déjà existants dans la base GTF et identifiés de façon unique par l”attribut Clé (cet attribut est généré automatiquement et est associé de façon unique à chaque projet).
- Si ce paramètre vaut “Ne pas importer” et que le fichier .gex contient un projet FME avec une clé déjà existante dans la base GTF, alors le fichier n”est pas chargé.
- Inversement, si ce paramètre vaut “Remplacer les projets existants”, alors les projets dont la clé existe déjà dans la base de données GTF seront écrasés.
- Choisir “Importer le projet avec un nouvel identifiant et un nouveau nom”, si le projet FME avec la même clé existe déjà en base et que vous souhaitez importer le même projet mais avec un nouveau nom. Le projet est renommé en étant suffixé par la chaîne “(import date de l”import)”.
Cliquer sur « Créer la demande ». La demande est prise en compte et se retrouve dans la file d”attente du moteur GTF.
S”assurer que la Demande ait bien été traitée en consultant le mode Supervision, puis retourner dans le mode Publication pour consulter la liste des traitements nouvellement importés.
7. Import des traitements d”administration¶
Le projet “Nettoyage des fichiers temporaires” est disponible sur notre site de téléchargement. Il permet les fonctions d”administration suivantes :
- le nettoyage des fichiers temporaires stockés dans les répertoires temporaires de GTF et FME.
Pour importer ce fichier, procéder de la même manière que précédemment en téléchargeant sur le site vStore (répertoire gtf/gex) la ressource Cleaner.
Se connecter ensuite à GTF et faire une demande du Traitement Admin-Import. Choisir le fichier précédemment téléchargé. Assurez-vous que dans le mode Publication, ce nouveau traitement ait bien été importé.
L”administrateur peut procéder à la configuration spécifique de GTF en définissant le compte public, et mettant en place une stratégie de sécurité utilisateur.
Il créé ensuite les utilisateurs et/ou les importe depuis un annuaire Active Directory.
Procédure de mise à jour¶
GTF dispose d’un installateur spécifique VAI qui permet d’assurer l’installation et la mise à jour du produit sans perte de configuration ni de donnée.
1. Prérequis¶
Avant toute mise à jour de GTF, penser à sauvegarder tous les fichiers que vous avez pu modifier, en dehors de l”application. (properties du moteur, licence GTF, license(s) FME, templates de mail pour la création de compte / récupération de mot de passe, …).
2. Mise à jour de GTF¶
Pour mettre à jour GTF, éditer le fichier update.cmd (Windows) ou update.sh (Linux) afin de définir les paramètres de l”installation.
Les variables à modifier pour la mise à jour sont :
Variable | Description |
dir | Répertoire d'installation (/var/www/gtf préférable pour Linux C:/server/gtf conseillé pour Windows) |
dblogin | Compte d'un superutilisateur de la base |
dbpswd | Mot de passe du compte superutilisateur |
apacheService | Nom du service Apache exploité par l'application |
apachePort | Port du service https du serveur Apache |
L’installateur de GTF (en mise à jour) assure les opérations suivantes :
- Copie du code du serveur d’application Vitis
- Copie du code du moteur GTF
- Mise à jour du PHP
- Configuration du serveur HTTPS Apache
- Mise à jour de la base de données dans PostgreSQL
Sur Linux, donner les droits d’exécution aux fichiers update.sh et setup_gtf-[version_gtf].[build_gtf].
chmod +x update.sh
chmod +x setup_gtf-[version_gtf].[build_gtf]
Exécuter le script update.cmd ou update.sh pour lancer l’installation.
Sur Windows, attendre une minute environ pour avoir un retour dans la console.
3. Spécificités liées aux versions¶
Version 2019.01.01¶
Tâches planifiées¶
Dans GTF vous pouvez désormais planifier l”éxécution d”une demande. Pour que cette fonctionnalité fonctionne correctement il faut que votre base de données utilise le fuseau horraire UTC. Si ce n”est pas le cas vous devrez éxecuter la requête suivante en remplaçant [db_name] par le nom de la base de GTF :
ALTER DATABASE [db_name] SET timezone ='UTC';
SMTP¶
Les properties liées aux paramètrage SMTP ont été déplacées dans les properties de Vitis.
Liste des properties concernées :
$properties['mail_sender'] = '************';
$properties['nickname_sender'] = 'GTF v2019';
$properties['smtp_host'] = '************';
$properties['smtp_port'] = 587;
$properties['smtp_authentification'] = true;
$properties['smtp_login'] = '************';
$properties['smtp_password'] = '************';
Pour éviter que l”application n”utilise les informations de GTF à la place des properties de Vitis, il est préférable de déplacer la configuration SMTP du fichier [dir]/vas/rest/conf/gtf/properties.conf dans le fichier [dir]/vas/rest/conf/properties.conf.
Template de mail par défaut¶
Vous pourrez mettre à jour votre template de mail par défaut pour intégrer les nouvelles fonctionnalités :
- Cryptage du résultat des traitements FME
- Utilisation de l”interface de fichier pour délocalisation du système de fichiers
- Utilisation d”un proxy interne à l”application pour améliorer la sécurité de vos logs et résultats FME.
Dans la version 2019.01.01, un nouveau template de mail fait son apparition default-v2019.01.01.
Si vous avez modifié le template de mail default, il faudra reprendre votre template pour intégrer les nouveautés de default-v2019.01.01.
Sinon, vous pourrez simplement copier-coller default-v2019.01.01 dans default. Vous pouvez aussi ne pas tenir compte des ses améliorations, mais il est possible que votre template ne fonctionne plus lors de l”activation d”une nouvelle fonctionnalité.
Utilisation de FME Serveur et FME Cloud¶
Il faut générer un identifiant pour votre application GTF.
Cliquez sur l’icône pour passer en mode « Configuration ». Allez dans « Configuration GTF », et cliquez sur le bouton « générer » pour avoir un identifiant GTF puis sauvegardez la configuration.
Config_Instance_GTF
Utilisation¶
Demandes de traitements¶
Un utilisateur avec des droits d’utilisation de GTF (gtf_user) peut faire une demande de traitement sur un traitement appartenant à un groupe dont ce même utilisateur fait partie.
Demande de traitement¶
Un utilisateur GTF peut faire une demande d”exécution sur un traitement GTF publié par un auteur/administrateur GTF à condition que :
- le workspace GTF soit associé à un groupe dont fait parti le demandeur
Ajouter une demande de traitements¶
Dans le mode « Mon travail » , dans l”onglet demande. Il est possible d”ajouter une demande en cliquant sur le bouton Ajouter une demande.
Description des champs :
- Catégorie : Permet de n”afficher que les projets associé à une catégorie.
- Projet FME : Permet de choisir le projet que vous voulez exécuter.
- Envoyer un e-mail de notification : Permet de choisir si un mail doit être envoyé à la fin du traitement et dans quel cas.
- Envoyer une copie de l”email à : Permet de saisir des adresses mail qui seront en copie du mail de notification.
- Date de planification : Permet de définir une date d”exécution minimale pour votre traitement.
Une fois votre traitement choisi le formulaire de demande sera chargé dans la partie droite de cette page.
Vous devez remplir se formulaire et cliquer sur le bouton Demander.
Votre demande de traitement sera alors ajouté à la file des demande en attente de traitement. Elle sera visible par l”administrateur en mode supervision qui pourra intervenir dessus si besoin.
Gestion de mes demandes de traitements¶
Le tableau sur lequel vous étiez avant d”ajouter une demande, contient toute vos demandes de traitements. Vos demandes sont également visible dans la supervision par l”auteur du traitement FME et les administrateurs de GTF.
Si vous supprimez une demande, elle ne sera plus visible dans votre interface et ne sera pas traitée par GTF. En revanche elle sera toujours visible pour l”auteur et les administrateurs et il sera clairement identifier dans l”interface de supervision que votre demande a été effacée.
Description des colonnes :
- ID : Identifiant unique de votre demande.
- Projet FME : Nom du projet dans GTF.
- Etat : Etat actuel de votre demande.
- Résultat : Vous permet de télécharger les fichiers résultant du traitement (dans une archive zip sauf exception)
- Date de la demande : Date à laquelle vous avez fait la demande.
- Paramètres : Liste des paramètres publiés passé au traitement FME.
- Durée : Durée d”exécution du traitment FME.
- Date de planification : Date à laquelle sera exécuté votre demande.
- Notification : Cas de notification suite au traitement de la demande.
- Copie à : Liste des adresse mail en copie de la notification.
Abonnement et Surveillance¶
Un utilisateur GTF peut faire une demande d”exécution sur un traitement GTF publié par un auteur/administrateur GTF à condition que :
- le workspace GTF soit associé à un groupe dont fait parti le demandeur
- l”auteur est autorisé la définition d”abonnements et de surveillances sur son traitement
Abonnements¶
Ajouter un abonnement¶
Dans le mode « Mon travail » , dans l”onglet demande. Il est possible d”ajouter un abonnement en cliquant sur le bouton Ajouter un abonnement.
Description des champs :
- Actif ? : Permet de définir si l”abonnement est actif ou non.
- Catégorie : Permet de n”afficher que les projets associé à une catégorie.
- Projet FME : Permet de choisir le projet que vous voulez exécuter.
- Période d”abonnement : Permet de définir la fréquence d”insertion de la demande (Les périodes sont définies par l”administrateur)
- Envoyer un e-mail de notification : Permet de choisir si un mail doit être envoyé à la fin du traitement et dans quel cas.
- Envoyer une copie de l”email à : Permet de saisir des adresses mail qui seront en copie du mail de notification.
Ensuite comme lors de l”ajout d”une demande, il faut remplir le formulaire contenant les paramètres publiés, et cliquer sur Demander
Gestion de mes abonnements¶
Le tableau sur lequel vous étiez avant d”ajouter un abonnement, contient tous vos abonnements. Vos abonnements sont également visible dans la supervision par les administrateurs de GTF.
Un administrateur peut activer ou désactiver vos abonnements.
Une demande GTF faite avec votre utilisateur sera ajouté à la fréquence choisie, vous pourrez ainsi récupérer des résultat fichiers à travers l”interface et voir si l”itération de votre abonnement s”est bien déroulée;
Surveillances¶
Ajouter une surveillance¶
Dans le mode « Mon travail » , dans l”onglet demande. Il est possible d”ajouter un abonnement en cliquant sur le bouton Ajouter une surveillance.
Description des champs :
- Catégorie : Permet de n”afficher que les projets associé à une catégorie.
- Projet FME : Permet de choisir le projet que vous voulez exécuter.
- Actif ? : Permet de définir si l”abonnement est actif ou non.
- Période d”abonnement : Permet de définir la fréquence de surveillance du dépot de fichier (Les périodes sont définies par l”administrateur)
- Envoyer un e-mail de notification : Permet de choisir si un mail doit être envoyé à la fin du traitement et dans quel cas.
- Envoyer une copie de l”email à : Permet de saisir des adresses mail qui seront en copie du mail de notification.
- Type de surveillance : Permet de définir le type de surveillance à faire.
- Repertoire : Permet de choisir le dépot à surveiller (Les dépots sont définies par l”administrateur)
- Sous-répertoire : permet de définir un sous repertoire dans le dépot.
Ensuite comme lors de l”ajout d”une demande, il faut remplir le formulaire contenant les paramètres publiés, et cliquer sur Demander (Les champs de type fichier ne doivent pas être remplis)
Gestion de mes surveillances¶
Le tableau sur lequel vous étiez avant d”ajouter une surveillance, contient toutes vos surveillances. Vos surveillances sont également visible dans la supervision par les administrateurs de GTF.
Un administrateur peut activer ou désactiver vos surveillances.
Une demande GTF faite avec votre utilisateur sera ajouté dés qu”un fichier sera détecter dans le sous-dossier du dépot défini dans la surveillance, vous pourrez ainsi récupérer des résultats fichiers à travers l”interface et voir si la demande de votre surveillance s”est bien déroulée;
Publication de traitements¶
Un utilisateur avec des droits d’auteur peut publier un traitement. Après avoir généré un projet dans FME, il crée un traitement dans GTF puis l’associe au projet. Le mode Publication comporte l’ensemble des formulaires permettant la création et le paramétrage des traitements GTF.
Ajout de projet FME¶
Un utilisateur avec des droits d’auteur peut publier un traitement. Après avoir généré un projet dans FME, il crée un traitement dans GTF puis l’associe au projet. Le mode Publication comporte l’ensemble des formulaires permettant la création et le paramétrage des traitements GTF.
Il existe deux façons dans GTF de créer des Projets FME : l”ajout de projet et l”Import de projets par lot.
Ajout de projet FME¶
Le bouton Ajouter un Projet FME de l’onglet Projets FME permet d’accéder au formulaire de création de projet.
Formulaire de création de projet
Formulaire de création de projet
La première étape consiste à attribuer un nom au traitement.
Règles de nommage des projets
Plusieurs options sont possibles :
- L”auteur nomme le projet directement dans GTF. Dans l”exemple, ci-dessus, le projet se nomme « Zone_inondable ».
- L”auteur choisit d”utiliser le nom du script FME et laisse dans GTF le champ « Nom du traitement » vide. Le nom du traitement est le nom du script FME sans son extension. Dans l”exemple ci-dessus, le projet se nommerait « zone_inondableswfs2kml ».
- Si le nom du traitement existe déjà, alors le nom du nouveau projet est suffixé par la date du jour. Dans l”exemple ci-dessus, le nouveau projet serait nommé « Zone_inondable_jjmm.aaaa ». L’auteur charge ensuite le projet FME dans lequel il aura pris soin de publier certains paramètres comme par exemple le répertoire destination. Le paramètre « Ressources complémentaires » permet d’associer les ressources nécessaires pour l”exécution du projet FME, comme par exemple des données sources.
GTF détecte les formats de types multifichiers (Shape File, EDIGEO…) contenus dans un fichier compressé ZIP que l’utilisateur uploade sur le serveur. Les fichiers sont automatiquement décompressés dans le répertoire projet.
Il définit ensuite la disponibilité du traitement sur abonnement et pour Surveillance.
Le modèle d”email à associer au traitement doit ensuite être défini, ainsi que le moteur GTF auquel rattacher le traitement. La stratégie d”affiliation se fait à partir de la liste des mots clés/moteurs, définis au préalable par l”administrateur de l”application. Le bouton Créer permet ensuite de finaliser la première étape du processus de création de traitement en générant le formulaire correspondant.
La création d”un projet génère ensuite un attribut « Clé » qui correspond à un identifiant unique universel du projet. Il s”agit d”une clé unique qui permet par exemple en cas de réinstallation de GTF, d”assurer l”unicité et le référencement du projet. Sa valeur est conservée en cas d”installation du projet sur un nouveau serveur contrairement à l”identifiant système ID.
Tous les visualiseurs contenus dans un projet FME sont désactivés lors du processus d”import ou d”ajout de projets dans GTF.
Import de projets FME par lot¶
GTF offre des fonctionnalités de catalogage et de gestion du patrimoine de projets FME disponibles dans un organisme. A cette fin et pour faciliter la création de plusieurs projets en même temps, la fonction d”ajout par lot a été créée permettant le chargement de plusieurs projets FME en une seule fois.
Après avoir cliqué sur le bouton Ajout par lot, l”auteur clique sur le bouton Parcourir, et sélectionne les projets FME qu”il souhaite intégrer à GTF. Il clique ensuite sur le bouton Transférer;.
Import de projets par lot
Une fois chargés, les projets FME apparaissent dans la liste des projets FME du mode « Publication ». L”auteur est ensuite en charge de nommer ou renommer les fichiers, de gérer leur métadonnées et de leur associer les groupes et droits désirés.
Tous les visualiseurs contenus dans un projet FME sont désactivés lors du processus d”import ou d”ajout de projets dans GTF.
Appel externe¶
La section « Appel externe » permet l”intégration dans une page HTML d”un formulaire GTF. C”est un moyen de donner accès à un projet GTF depuis une quelconque page web, sans avoir GTF installé sur son poste. La section « Appel externe » du mode Projet permet de définir la façon dont l”utilisateur final aura accès au formulaire GTF puis génère le code à intégrer directement dans la page html désirée.
L”administrateur définit le type d”accès souhaité au formulaire GTF :
- soit via un bouton intégré dans la page Internet,
- soit via l”insertion telle quelle du formulaire GTF dans la page web.
Il associe ensuite un titre au formulaire et, dans le cas d”un bouton, il spécifie le texte associé au bouton d”accès du formulaire dans le champ « Texte du bouton ». La hauteur et largeur du formulaire peuvent également être paramétrées.
Appel externe
Jetons de connexion¶
Un jeton agit comme une clé permettant d”accéder à un formulaire GTF. Un jeton ne peut être donné qu”à un utilisateur authentifié. L”administrateur a la possibilité d”associer à un traitement un jeton privé ou un jeton public permettant l”accès et l”utilisation du formulaire GTF :
- Le jeton public est l”identifiant de connexion du compte public défini au préalable par l”administrateur dans le mode « Configuration ».
- Fournir un jeton privé est un moyen de donner accès à un compte de connexion à un traitement GTF particulier. Pour générer une clé privée, l”administrateur saisit le login et mot de passe de l”utilisateur pour lequel il souhaite générer un jeton privé puis définit une date de fin de validité de cette dernière. Après avoir cliqué sur le bouton Clé privée, la clé est retournée et intégrée dans le code à utiliser.
Jeton
Utilisation de CAPTCHA¶
Il est possible d”intégrer un captcha au formulaire pour s”assurer que la demande de traitement est bien générée par un être humain et non par un ordinateur.
L”insertion d”un captcha, nécessite l”obtention d”une clé sur le service Web de Google à l”adresse https://www.google.com/recaptcha/admin. Une fois la clé obtenue, l”administrateur saisit la clé fournie dans le champ « Clé Recaptcha ».
La clé est directement intégrée dans le code généré par GTF. Le motif captcha est généré automatiquement à chaque demande de traitement.
Le bouton Générer le code retourne le code à copier dans la page HTML permettant d”accéder au formulaire GTF. Le code contient le jeton de connexion défini au préalable (public ou privé), ainsi que le cas échéant la clé captcha.
Exemple de code:
<link rel="stylesheet" href="https://www.veremes.net/gtf.fake.app/forms/css/widgetStyle.css" type="text/css">
<script src="https://www.veremes.net/gtf.fake.app/forms/js/jquery/jquery-1.9.1.min.js"></script>
<button class="poplight" id="link_create_order" onclick="loadPopUp()"> Conversion</button>
<script src="https://www.veremes.net/gtf.fake.app/forms/js/GTFWidget.js"></script>
<script> initWidget("https://www.veremes.net/gtf.fake.app/forms", "Conversion de fichier", 600, 600, "optional", "CMJP3NM21", "mon_jeton", "gtf_widget", "6LfMJO8SAAAAB9rRfJR_serMCVygxj-aBXgT-Wf", "1"); </script>
exemple de code
Jeton de connexion public / Clé captcha
Ce code est à insérer directement dans la page HTML à l”emplacement désiré.
L”exemple ci-dessous illustre l”insertion d”une fenêtre de demande de création de gex (traitement administration « admin_export ») dans une page HTML :
exemple
Attribution de droits au traitement¶
Pour pouvoir être exploité, un traitement doit être associé à un groupe. Dans la section « Droits », l’auteur associe un groupe au projet nouvellement créé en faisant glisser le groupe choisi dans la partie de Groupes associés au traitement. Il clique ensuite sur le bouton Mettre à jour.
Gestion des connexions nommées¶
Les connexions nommées stockent les informations de connexions aux bases de données et services web. De la même manière que les formats et transformers personnalisés, les connexions nommées sont stockées dans des répertoires propres à chaque utilisateur. Elles sont ainsi stockées dans un fichier crypté « namedConnections.data » situé dans le répertoire
%userprofile%\AppData\Roaming\Safe Software\FME\
Ce fichier doit pouvoir être accessible par un utilisateur réel via FME Workbench pour créer et gérer les connexions, mais il doit également pouvoir être utilisé par le compte système local, compte qui, dans GTF, exécute le service Pycron pour lancer un traitement FME.
Or, contrairement aux utilisateurs classiques, le compte système local ne dispose pas de répertoire personnel %userprofile%
. Il ne peut donc pas exploiter les connexions nommées d”un projet FME publié sur un serveur GTF.
Pour pouvoir exploiter les connexions nommées dans GTF, le fichier crypté des connexions nommées doit donc être localisé, puis une clé de registre doit ensuite être créée : elle indiquera l”emplacement du fichier crypté, de sorte à en assurer son utilisation par tout compte ne disposant pas de répertoire personnel tel que le compte Système local.
- Rendre publiques les connexions nommées désirées
- Exporter les connexions nommées désirées dans un répertoire spécifique
- Créer une clé de registre contenant le chemin du répertoire par défaut, stockant le fichier des connexions nommées
- Tester
Rendre publiques les connexions nommées¶
Dans un premier temps, pour pouvoir être exploitables par d”autres utilisateurs, les connexions nommées doivent être rendues publiques. Dans FME, dans le Menu « Outils » > « Options FME » > « Connexions aux bases de données », sélectionner les connexions nommées que vous souhaitez exporter (et les attribuer ensuite à un compte système local) puis cocher la case Public.
Connexion nommées
Connexions nommées dans FME.
La possibilité de rendre publique une connexion nommée a été implémentée dans la version FME 2016. Or, FME exploite des connexions nommées créées dans d”anciennes versions. Dans ce cas, la colonne « Public » n”apparaît pas dans la fenêtre des connexions. Pour contourner ce problème et afficher la colonne « Public », exporter les connexions nommées dans un nouvel emplacement, supprimer les connexions initiales, puis les réimporter (cf. « procédure 6.1.9.2 »).
Exporter des connexions nommées¶
Sélectionner la ou les connexions nommées que vous souhaitez exporter puis dans le menu contextuel, choisir Exporter.
Export des connexions nommées
Export des connexions nommées.
Les connexions sélectionnées sont exportées dans un fichier XML : « exportConnectionData_x.xml ». Choisir ensuite son emplacement.
Dans FME, il est alors possible de modifier l”emplacement du fichier des connexions nommées en indiquant le nouveau répertoire dans le menu « Outils » > « Options FME » > « Chemins par défaut ».
Spécification du répertoire des connesions nommées
Spécification du répertoire des connesions nommées.
Vous pouvez, par exemple, supprimer les connexions nommées d”origine, puis importer celles que vous venez d”exporter et remplacer de la sorte les connexions initiales. Retourner dans le menu « Outils » > « Options FME » > « Connexions aux bases de données » et sélectionner Importer dans le menu contextuel dans la liste des connexions.
Import de connexions nommées
Sélectionner les connexions que vous souhaitez importer :
Sélection des connexions nommées à importer
Les connexions nommées précédemment exportées sont à nouveau importées.
Dorénavant, 5 connexions nommées sont listées dans le menu « Outils » > « Options FME » > « Connexions aux bases de données » :
Nouvelles connexions nommées
Création des clés de registre¶
Pour pouvoir attribuer au compte système local le répertoire par défaut des connexions nommées (nouvellement importées), un fichier de registre « cn32.reg » (ou « cn64.reg » selon les versions de FME) doit être créé et contenir le chemin du répertoire stockant le fichier crypté des connexions.
Windows Registry Editor Version 5.00
\\[HKEY_LOCAL_MACHINE\\SOFTWARE\\WOW6432Node\\Safe Software Inc.\\Feature Manipulation Engine\\Settings]
"Named Connection Db Type"=dword:00000000
"Named Connection Directory"="E:\\tmp\\connexion"
Clé de registre cn32.reg à créer.
Import de la clé de registre¶
Importer la clé de registre via la commande « Regedit » > « Import » ou par un double clic sur le fichier .reg.
- « cn32.reg » contient la clé de registre pour FME 32 bits
- « cn64.reg » contient la clé de registre pour FME 64 bits
Il est possible d”importer les deux clés.
Test¶
Veremes met à disposition sur son site de téléchargement le projet « ListSettings.fmw » qui génère un fichier texte (« settings.txt ») dans lequel sont listés les paramètres système FME du serveur tels que les builds, l”interpréteur Python utilisé… Pour vérifier l”emplacement du répertoire des connexions nommés, exécuter le projet « ListeSettings.fmw » et s”assurer que dans le fichier texte généré, le répertoire spécifié soit bien rajouté et correct :
Settings:
Python:
Use Custom Python: false
Named Connection Db Type: 0
Named Connection Directory: E:\tmp\connexion
Statistics:
enabled: no
Publier une connexion nommée¶
Un auteur de projet peut publier une connexion nommée. Avec GTF 2015 et 2016.0, pour publier une connexion nommée il est nécessaire de créer un paramètre publié de type « TEXTE ».
Puis il faut associer ce paramètre publié au paramètre du Reader ou du Transformer concerné :
Avec GTF 2016.1, les paramètres publiés de type Connexion Nommée sont automatiquement reconnus et transformés en paramètre de type Texte.
Gestion des métadonnées¶
GTF permet la gestion des métadonnées d”un projet et l”exploitation des métadonnées natives issues des projets FME. Les métadonnées d”un projet, définies dans FME via le Navigateur, sont chargées dans GTF.
- Les sections « Description », « Catégorie », « Conditions d”utilisation », « Utilisation », « Prérequis » et « Historique » sont directement issues du projet FME et peuvent être modifiées .
- La date de dernière sauvegarde, l”encodage et la version FME sont propres au projet FME source et sont modifiés automatiquement dans GTF en cas de rechargement du projet FME.
Attention Une catégorie définie dans un projet FME est importée dans GTF et créée dans le menu « Catégories » si elle n”existe pas.
Métadonnées d'un projet
Métadonnées d”un projet
La section « Métadonnées » du mode « Publication » permet à l”auteur, de modifier ces dernières et de les réécrire dans le projet FME.
- Le bouton Mettre à jour permet d”enregistrer les modifications des métadonnées dans GTF.
- Le bouton Relire le projet permet de recharger les métadonnées du projet FME initial. Les champs « Description », « Utilisation », « Prérequis » et « Conditions d”utilisation » saisis dans GTF sont remplacés par les valeurs issues du projet FME source.
- Le bouton Ecrire le projet permet de modifier les métadonnées du projet FME source. Les valeurs des champs « Description », « Utilisation », « Prérequis » et « Conditions d”utilisation » initiales sont remplacées par les valeurs saisies dans GTF. Le projet .fmw modifié est disponible dans la section « Répertoire Projet ».
Les métadonnées d”un projet sont chargées lors du premier chargement d”un projet FME. Si les métadonnées sont ajoutées et/ou modifiées dans GTF et que l”on procède à un nouveau chargement du projet FME, alors les métadonnées du projet FME, n”écrasent pas celles éditées dans GTF. Les métadonnées sont ainsi chargées que lors du premier chargement d”un projet FME. Le bouton « Relire le projet » permet de contourner ce fonctionnement pour permettre le rechargement des du projet FME source initialement chargé.
Gestion et personnalisation des paramètres publiés : travailler dans le studio¶
La section « Formulaire » du mode « Publication » permet de gérer l’affichage du formulaire de demande de traitement tel qu”il sera affiché lors d’une demande émise par un utilisateur.
Le studio permet de personnaliser graphiquement chaque paramètre publié importé depuis FME, et permet la mise en page générale du formulaire de demande.
Studio de personnalisation de formulaire
Studio de personnalisation de formulaire
Le studio de personnalisation des formulaires est composé de quatre fenêtres :
- Une fenêtre centrale de prévisualisation du formulaire. Elle permet de prévisualiser le formulaire tel qu”il sera affiché lors d”une demande de traitement, mais il est possible d”afficher le formulaire JSON ou JavaScript en sélectionnant le type d”affichage désiré en haut de la fenêtre.
- Une fenêtre des paramètres publiés, à droite de l”écran : elle liste l”ensemble des paramètres publiés du projet et leur ordre d”affichage. Il est possible de modifier l”ordre d”affichage des paramètres
, de les supprimer
et en d”en créer de nouveaux
.
- Une fenêtre de définition des paramètres, à gauche en bas de l”écran, qui permet leur édition et configuration.
- Une fenêtre formulaire, en haut à gauche de l”écran, qui permet l”enregistrement, la publication et le nommage de chaque formulaire. Il permet d”afficher le formulaire par défaut, le formulaire publié et le formulaire personnalisé.
Formulaire par défaut, formulaire personnalisé, formulaire publié¶
Le formulaire par défaut comporte les paramètres publiés du projet FME. Après visualisation, l”auteur peut choisir de conserver en l”état ce formulaire ou de le personnaliser.
Chaque projet FME chargé dans GTF est stocké dans le répertoire « \workspace » du répertoire d”installation de GTF. Le sous-répertoire « workspace\fme » stocke le projet .fmw et les ressources du projet, et le répertoire « workspace\form » stocke les fichiers de gestion et de personnalisation des formulaires du traitement.
Une fois un projet créé, GTF créé 3 fichiers identiques :
- « DsubForm.json » : formulaire par défaut du traitement, affiché dans le studio lorsque l”on sélectionne le bouton
défaut
- « SubForm.json » : formulaire publié par GTF, affiché dans le studio lorsque l”on sélectionne le bouton
Publié
- « WsubForm.json » : formulaire destiné à être personnalisé, affiché dans le studio lorsque l”on sélectionne le bouton de personnalisation
Perso
Lors de la publication d”un formulaire personnalisé, le fichier WsubForm est modifié puis écrase le fichier SubForm.
Lors de la création d”un projet, les 3 formulaires par défaut, personnalisé et publié sont identiques. L”auteur d”un projet peut ensuite personnaliser le formulaire par défaut. Il choisit de publier ou pas le formulaire personnalisé. A tout moment il peut revenir au formulaire par défaut et le publier à nouveau.
En cas de re chargement d”un projet FME, si le formulaire publié est identique au formulaire par défaut alors les 3 formulaires sont écrasés. En revanche, lorsque le formulaire publié est identique au formulaire personnalisé, alors seul le formulaire par défaut est écrasé. Dans ce cas de figure, les formulaires personnalisés et publiés sont donc conservés.
Dans la liste des projets, on peut distinguer les projets publiés exploitant un formulaire par défaut, des projets exploitant un formulaire personnalisé par la couleur du pictogramme du champ Formulaire : un pictogramme vert signifie que le formulaire par défaut est publié. Un pictogramme bleu indique que le formulaire publié est un formulaire personnalisé.
Liste des projets et formulaires exploités
Liste des projets et formulaires exploités
L”auteur d”un projet peut choisir d”agencer le formulaire de demande de traitement sous forme d”onglets. Il peut ainsi répartir les paramètres sur plusieurs onglets.
Le bouton « Edition » > Gestion des onglets de la fenêtre des formulaires personnalisés permet d”accéder à la fenêtre de gestion de ces derniers.
Gestion des onglets
Studio - Fenêtre de gestion des onglets d'un formulaire
Après avoir édité et nommé un onglet, cocher les paramètres devant le composer. Le bouton Ajouter un onglet en bas de la fenêtre permet la création d”un nouvel onglet. Un aperçu des onglets nouvellement créés s”affiche dans la partie de droite de la fenêtre. Cliquer sur Valider pour revenir au studio.
Edition d'onglets
Les onglets ne sont pas apparents dans le studio mais uniquement dans la fenêtre de gestion de ces derniers.
Un paramètre peut apparaître sur deux onglets différents. Lors de la demande d”un tel projet, l”édition d”un paramètre dans un onglet est automatiquement reportée dans le deuxième onglet.
Paramètres publiés FME et contrôles GTF¶
Les paramètres publiés de FME sont importés dans GTF et peuvent être modifiés dans le studio via des contrôles GTF. Un contrôle GTF est converti en paramètre publié FME lors du traitement du projet. Certains contrôles GTF ne sont pas issus de paramètres publiés de FME et correspondent à des composants de mise en page (interface) destinés à personnaliser l”interface du formulaire de demande de projet.
Il existe 20 types de contrôles GTF paramétrables dans la fenêtre de Définition des Paramètres :
Nom du contrôle GTF
- Bouton radio
- Carte Bing
- Carte OSM
- Carte vMap
- Champ caché
- Couleur
- Curseur
- Date et Heure
- Décimal
- Entier
- Fichier local
- Interface - Ligne de séparation
- Label
- Label Titre
- Liste
- Liste déroulante
- Texte en édition 1 ligne
- Texte en édition Mot de passe
- Texte en édition Multiligne
- Texte en édition URL
Un nom de paramètre ne peut pas contenir d”espace.
Les valeurs par défaut d”un paramètre publié FME sont importées dans GTF.
Un paramètre publié FME de type « Choix » est importé dans un GTF en contrôle de type « Liste déroulante ». La configuration de la liste se fait via le Gestionnaire de source de données. L”auteur du projet nomme le paramètre et son libellé tel qu”il sera affiché dans le formulaire de demande et définit le nombre de lignes. Il indique si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Il est possible de faire de cette liste une liste en cascade, en définissant la liste parent et les attributs sur lesquels doit reposer l”ascendance.
Paramètre publié de type Choix et Contrôle GTF de type Liste déroulante
Un paramètre publié FME de type Choix multiple est importé dans GTF en contrôle de type Liste. Le Gestionnaire de source de données permet de configurer la liste importée.
L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande et définit la valeur par défaut. Il paramètre le nombre de lignes à afficher. Il définit si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type Choix multiple et contrôle GTF de Type Liste
Il est possible de faire de cette liste une liste en cascade, en définissant la liste parent et les attributs sur lesquels doit reposer l”ascendance.
Un paramètre publié de type « Choix avec alias » est importé dans GTF en contrôle de type « Liste déroulante ». La configuration de la liste se fait dans le Gestionnaire de source de données. L”auteur du projet nomme le paramètre et son libellé tel qu”il sera affiché dans le formulaire de demande et définit sa valeur par défaut. Il paramètre le nombre de lignes à afficher. Il définit si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type Choix avec alias et Contrôle GTF de type Liste déroulante.
Il est possible de faire de cette liste une liste en cascade, en définissant la liste parent et les attributs sur lesquels doit reposer l”ascendance.
Un paramètre pubié de type « Choix avec alias multiple » est importé dans GTF en contrôle de type « Liste ». La configuration de la liste se fait dans le Gestionnaire de source de données. L”auteur du projet nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande, définit le nombre de lignes à afficher. Il définit si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type Choix avec alias multiple et contrôle GTF de type Liste
Il est possible de faire de cette liste une liste en cascade, en définissant la liste parent et les attributs sur lesquels doit reposer l”ascendance.
Un paramètre publié de tye « Choix de couleur » est importé dans GTF en contrôle de type « Couleur » . L”auteur nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande, définit la couleur par défaut. Il peut choisir la largeur du contrôle et définir si ce paramètre est obligatoire ou pas.
Un paramètre publié de type « Curseur » est importé sous la forme de contrôle de type « Curseur ». L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande et définit les valeurs minimales et maximales ainsi que la valeur par défaut du curseur.
Un paramètre publié de type « Date/Heure » est importé dans GTF sous la forme de contrôle « Date et Heure ». L”auteur nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande. Il peut définir la date et heure affichées par défaut. Il définit si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Un paramètre publié de type « Entier » est importé dans GTF en contrôle de type « Entier ». L”auteur nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande et définit la valeur par défaut . Il peut définir si ce paramètre est obligatoire ou pas en cochant la case « Requis ».
Paramètre publié et contrôle de type « Entier »
Un paramètre publié de type « Flottant » est importé dans GTF en contrôle de type « Décimal ». L”auteur nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande et définit la valeur par défaut. Il peut définir si ce paramètre est obligatoire ou pas en cochant la case « Requis ».
Paramètre publié de type « Flottant » et contrôle de type « Décimal »
Un paramètre publié FME de type « Mot de passe « est importé dans GTF sous la forme de contrôle de type « Texte en édition - mot de passe ». L”auteur nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande. Il peut définir un motif sous la forme d”expression régulière, pour contrôler l”affichage du mot de passe et s”assurer que la valeur respecte bien un modèle. Il peut définir si ce paramètre est obligatoire ou pas en cochant la case « Requis », et choisit la largeur du contrôle.
Paramètre publié de type « Mot de passe » et Contrôle de type « Texte en édition - mot de passe »
Un paramètre publié FME de type « Nom de fichier (Multiple) » est importé dans GTF sous la forme de contrôle de type « Fichier Local ». L”auteur du projet nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande, définit la largeur du contrôle et indique si le paramètre est obligatoire ou pas.
Paramètre publié de type « Nom de fichier Multiple » et Contrôle de type « Fichier local »
Les options avancées permettent d”affiner l”affichage du formulaire lors du chargement de fichiers en faisant apparaître ou pas la prévisualisation des fichiers, ainsi que les boutons de chargement et de suppression des fichiers.
Le paramètre publié de type « Fichier en sortie » est importé sous la forme de contrôle de type « Texte en édition - 1 ligne ». L”auteur du projet nomme le paramètre et définit le libellé tel qu”il sera affiché dans le formulaire de demande. Il peut insérer une expression régulière dans le champ « Motif » pour assurer un contrôle de la valeur saisie. Il peut définir une valeur par défaut, la largeur du contrôle à afficher et indique si le paramètre est obligatoire ou pas.
Paramètre publié de type « Nom de fichier en sortie » et Contrôle GTF de type « Texte en édition » - 1 ligne
Un paramètre publié de type « Nom de Système de coordonnées » est importé dans GTF sous la forme d”une « Liste déroulante ». Les valeurs de la liste sont automatiquement importées et visibles dans le gestionnaires de source de données.
Paramètre publié de type « Nom de système de coordonnées » et Contrôle de type « Liste déroulante ».
La configuration de la liste se fait via le Gestionnaire de source de données. L”auteur du projet nomme le paramètre et le libellé qui sera affiché dans le formulaire de demande et définit le nombre de lignes à afficher ainsi que la largeur du contrôle. Il indique si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Un paramètre publié de type « Répertoire existant » est importé sous la forme d”un contrôle de type « Fichier local ». L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande, il définit la largeur du contrôle et indique si ce paramètre est obligatoire ou pas.
Les options avancées permettent d”affiner les paramètres d”affichage lors du téléchargement du fichier.
Paramètre publié de type « Répertoire (Existant) » et contrôle de type « Fichier Local »
Un paramètre publié de type « Répertoire » en sortie est importé sous la forme d”un contrôle de type « Texte en édition 1 ligne ». L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande. Il peut définir la valeur par défaut du nom de répertoire à créer, et il peut saisir une expression régulière dans le champ « Motif » pour assurer un contrôle du nom créé. Il peut définir la largeur du contrôle et indiquer si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type Répertoire en sortie et contrôle de type Texte en édition- 1 ligne
Un paramètre publié de type « Texte » est importé sous la forme d”un contrôle de type « Texte en édition- 1 ligne ». L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande. Il peut définir la valeur par défaut à créer, et peut saisir une expression régulière dans le champ « Motif » pour assurer un contrôle de la valeur saisie. Il peut définir la largeur du contrôle et indiquer si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type « Texte » et Contrôle GTF de type « Texte en édition - 1 ligne »
Un paramètre publié de type « Texte multiligne » est importé sous la forme d”un contrôle de type « Texte en édition-multiligne ». L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande. Il peut définir la valeur par défaut et la largeur du contrôle et indiquer si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type « Texte multiligne » et contrôle de type « Texte en édition - Multiligne »
Un paramètre publié de type « Texte Multiligne ou Nombre » est importé sous la forme d”un contrôle de type Texte en édition-Multiligne. L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande. Il peut définir la valeur par défaut et la largeur du contrôle et indiquer si le paramètre est obligatoire en cochant ou pas la case « Requis ».
Paramètre publié de type Texte multiligne ou Nombre et contrôle de type Texte en édition - Multiligne
Un paramètre publié de type « URL » est importé sous la forme d”un contrôle de type « Texte en édition-URL ». L”auteur du projet nomme le paramètre et le libellé tel qu”il sera affiché dans le formulaire de demande. Il peut insérer un motif via une expression régulière pour assurer un contrôle sur la valeur saisie (type de protocole spécifique), définir la valeur par défaut et la largeur du contrôle et indiquer si le paramètre est obligatoire en cochant ou pas la case « Requis »
Paramètre publié de type « URL » et contrôle de type « Texte en édition - URL »
Un paramètre publié FME de type « Choix » est importé dans GTF en tant que contrôle de type « Liste Déroulante », mais il est possible de modifier ce dernier en exploitant un contrôle de type « Bouton radio ».
L”auteur du projet nomme le paramètre et son libellé tel qu”il sera affiché dans le formulaire de demande.
Il définit la valeur par défaut et détermine si les boutons radios seront désactivés ou pas. Il définit ensuite les options possibles en entrant le libellé du bouton et la valeur envoyée en base.
Le bouton permet de rajouter des boutons au paramètre.
Contrôle de type « Bouton Radio »
GTFpermet d”exploiter les services web OSM, Bing Maps ou Vitis vMap pour personnaliser un formulaire en exploitant leurs ressources cartographiques. Par exemple, dans FME, on peut définir une géométrie dans un champ de type texte définie par une chaîne de caractère WKT. Dans GTF, Il est plus simple de personnaliser le formulaire de saisie en exploitant une carte OSM comme support de saisie de la géométrie plutôt que de rentrer une chaîne WKT dans un contrôle de type « Texte ».
L”auteur du projet qui insère un élément (ou qui modifie un paramètre existant) de type « Carte OSM », nomme le paramètre, et définit le libellé qui sera affiché dans le formulaire de demande. Il définit la hauteur et la largeur de la carte et indique si ce paramètre est obligatoire ou pas en cochant la case « Requis ».
Il définit ensuite les options spécifiques aux éléments de type carte :
- La projection de la carte : WGS84 ou Lambert 93. En Lambert 93, l’étendue par défaut correspond à l”ensemble de la France métropolitaine.
- Méthode de centrage de la carte : l”auteur choisit si le centre de la carte est défini par un point défini via des coordonnées X/Y et une échelle d”affichage, ou si le centre de la carte est paramétrée par son étendue définie par les coordonnées X et Y Min et Max.
L”auteur choisit ensuite les éléments de dessin et de navigation qui seront affichés sur la carte du formulaire de demande :
- Position de la souris : affichage dynamique des coordonnées de la souris selon la projection définie.
- Boutons de zoom : affichage des boutons de navigation classique zoom avant, zoom arrière et retour à l”étendue par défaut.
- Echelle : affichage de lӎchelle.
- Projection de la carte : affichage de la projection Lambert 93 ou WGS 84.
- Multiples géométries : possibilité ou pas de saisir des géométries de type différent (point, ligne et polygone).
- Plein écran : permet d”afficher la carte en mode plein écran.
- Suppression générale : suppression de toutes les géométries saisies sur la carte.
- Edition : modification de la géométrie sélectionnée.
- Dessiner un point.
- Dessiner une ligne.
- Dessiner un polygone.
Le champ « Valeur » permet à l”auteur de définir une géométrie qui sera affichée par défaut dans le formulaire de demande. Cette géométrie est décrite via une chaîne WKT.
Contrôle « Carte OSM ». Exemple de valeur par défaut
Formulaire de demande d”un contrôle de type « Carte OSM » - Géométrie saisie par défaut
Tous les paramètres de personnalisation d”une carte Bing Maps sont identiques à ceux des cartes OSM. Il faut fournir en plus, une clé d”accès pour pouvoir exploiter ce service web cartographique.
Générer une clé Bing Maps sur le site https://www.bingmapsportal.com/ Une fois obtenue, entrer la clé dans le champs « Clé » et sélectionner la carte à afficher dans le formulaire de demande :
- Aerial
- Aerial WithLabels
- Road
Formulaire de demande de traitement avec contrôle de type « Carte Bing ».
Pour pouvoir exploiter une carte vMap dans GTF, Il faut au préalable, dans vMap, exporter la définition de la carte. L”export d”une carte vMap génère un fichier map.json que l”auteur du formulaire doit télécharger (champ « Fichier local ») pour pouvoir l”intégrer dans un formulaire. Il procède ensuite de la même façon qu”avec les autres ressources de type carte, en nommant le paramètre et son libellé, puis en paramétrant l”affichage des outils propres aux cartes.
Formulaire de demande de traitement avec contrôle de type « Carte vMap ».
Un contrôle de type Interface-Ligne de séparation permet d”améliorer l”affichage d”un formulaire de demande d”un traitement en y insérant des lignes et accroître de la sorte son organisation et sa lisibilité.
Il existe 2 contrôles de type Label :
Un contrôle GTF de type Label permet d”insérer un champ et sa valeur dans un formulaire de demande de projet, sans qu”il puisse être modifié. L”auteur nomme le paramètre et son libellé tel qu”il sera affiché dans le formulaire. Il définit ensuite la valeur à afficher, ainsi que la largeur du contrôle.
Un contrôle « Label Style Titre » permet d”insérer un titre dans le formulaire de demande. L”auteur définit le nom du paramètre et son libellé, puis définit la classe html à associer au titre.
Un contrôle GTF de type « Champ caché » permet de masquer un paramètre publié. Le paramètre est exploité dans le traitement mais n”est pas apparent. L”auteur nomme le paramètre et définit la valeur à exploiter.
Un paramètre publié FME caché, c”est-à-dire que son nom est par préfixé par H_, est directement importé dans GTF en contrôle de type Champ caché.
Contrôle de type « Champ caché »
Le gestionnaire de sources de données permet la création, l’édition et la suppression des sources de données à associer aux contrôles GTF de type « Liste » et « Liste déroulante »
Le Gestionnaire de sources de données permet d”exploiter des données :
- Texte : valeurs saisies directement dans le gestionnaire ou importées depuis un paramètre FME de type Choix.
- Valeurs de table locale : valeurs issues d”une table de base de données installée sur le même serveur que GTF.
- Base de données externe : valeurs importées d”une table de base de données externe à GTF.
- Service web Vitis : permet d”exploiter un service web pour en récupérer les ressources.
Le gestionnaire de source de données est accessible en cliquant sur le bouton en bas à droite de la fenêtre des paramètres publiés.
Fenêtre du Gestionnaire de source de données
On peut ajouter, éditer ou supprimer une source de données. Le bouton “Ajouter” permet de créer une nouvelle source de données. Le type de source détermine les paramètres de connexion devant être définis pour pouvoir importer les valeurs.
Cette option permet de saisir directement des valeurs de type texte qui s”afficheront dans le formulaire sous forme de liste déroulante.
Gestionnaire de source de données. Source de données de type Texte.
Après avoir nommé la source de données, saisir les libellés et les clés (stockées en base) séparés par le caractère |. Le bouton “Aperçu”, permet de visualiser la liste en cours de création. Le bouton “Valider” permet de valider la création de la liste, de fermer la fenêtre en cours et de revenir à la liste des sources de données. Cliquer à nouveau sur “Valider” pour fermer le gestionnaire de source de données et revenir au studio.
Pour associer la source de données créée à un paramètre de type liste , sélectionner le paramètre dans la fenêtre Paramètres publiés, puis l”éditer dans la fenêtre de Définition.
Sélection du paramètre publié dans le studio.
Sélectionner ensuite la source de données nouvellement créée dans le champs Source de données :
Sélection de la source de données.
Cliquer ensuite sur le bouton “Recharger les sources de données en haut à droite de la fenêtre de prévisualisation, pour pouvoir visualiser la liste.
Vous pouvez paramétrer le nombre de lignes à afficher dans la liste, sa largeur et définir si ce paramètre est obligatoire ou pas, en cochant le paramètre “Requis”.
Le Gestionnaire de source de données permet d”importer les valeurs d”une table de base de données installée sur le même serveur que GTF.
Gestionnaire de source de données. Source de données de type Valeurs de table locale.
Saisir le nom à attribuer à la source de données à créer, puis la base de données (facultatif). Appuyer sur le bouton Schémas pour obtenir la liste des schémas de la base, puis sur le bouton Tables pour sélectionner celles contenant les valeurs à utiliser. Le bouton “ Test” permet de tester la connexion en affichant la table dans la fenêtre Aperçu.
Il est possible de filtrer les données à importer via une clause de type Where, définie dans le champs “Filtre”. Dans l”exemple ci-dessus, on peut choisir de n”afficher que les bâtiments d”une commune et saisir dans le champs filtre la clause : id_com=”340003”.
Le bouton “Valider” permet de fermer la fenêtre en cours et de revenir à liste des sources de données. Cliquer à nouveau sur Valider pour fermer le gestionnaire de source de données et revenir au studio.
Pour lier cette liste à un paramètre publié, sélectionner le paramètre désiré dans la fenêtre des Paramètres publiés à droite de l”écran, pour pouvoir ensuite l”éditer dans la fenêtre de Définition :
Sélection de la source de données.
Nommer le paramètre, éditer son libellé puis sélectionner dans la liste déroulante la source de données nouvellement créée, dans l”exemple ci-dessus : “liste_moteurs ».
Définir ensuite la clé ainsi que le libellé qui sera affiché dans le formulaire : pour cela cliquer sur le bouton pour charger les valeurs et sélectionner celles à définir comme clé puis comme libellé :
Définition de l”attribut clé.
Dans la fenêtre de prévisualisation, cliquer ensuite sur le bouton “Recharger les sources de données” Recharger, pour pouvoir prévisualiser la liste, telle qu”elle s”affichera dans le formulaire de demande :
Prévisualisation du paramètre de type Liste.
Vous pouvez paramétrer le nombre de lignes à afficher dans la liste, sa largeur et définir si ce paramètre est obligatoire ou pas, en cochant le paramètre “Requis”.
Vous pouvez faire de cette liste une liste en cascade en cochant la case Cascade.
Il est possible d”affiner l”affichage des éléments de la liste via des commandes de tri (order_by et sort_order) sur les attributs dont on spécifie les noms dans le champs Attributs. Ils doivent êtres séparés par le caractère |. Pour distinguer les valeurs identiques, on peut définir une clause distinct. On peut également filtrer les valeurs à afficher via une clause Where dont on spécifie les arguments dans le champ “ filter”. Dans l”exemple ci-dessous, on choisit de n”afficher que le moteur n° 1 en insérant une clause Where sur l”attribut gtf_engine_id :
. Le bouton bouton table permet d”afficher la liste des tables de la base et de la sorte de s”assurer de la réussite de la connexion.
Il est également possible de filtrer les données à importer via une clause de type Where, saisie dans le champs Filtre.
Dans l”exemple ci-dessus, seuls les ESI en instruction et inscrits seront listés dans le formulaire.
Le bouton “Valider” permet de fermer la fenêtre en cours et revenir à liste des sources de données. Cliquer, à nouveau, sur Valider pour fermer le gestionnaire de source de données et revenir au studio.
Pour lier cette liste à un paramètre publié, sélectionner le paramètre désiré dans la fenêtre des Paramètres publiés à droite de l”écran, pour pouvoir ensuite l”éditer dans la fenêtre de Définition :
Nommer le paramètre, éditer son libellé puis sélectionner dans la liste déroulante la source de données nouvellement créée, dans l”exemple ci-dessus : “esi”.
Définir ensuite la clé ainsi que le libellé : pour cela, cliquer sur le bouton Recharger pour charger les valeurs et sélectionner celles à définir comme clé puis comme libellé :
Recharger
Cliquer ensuite sur le bouton “Recharger les sources de données”
Recharger dans la fenêtre de prévisualisation, pour pouvoir prévisualiser la liste, telle qu”elle s”affichera dans le formulaire de demande :
Vous pouvez paramétrer le nombre de lignes à afficher dans la liste, sa largeur et définir si ce paramètre est obligatoire ou pas, en cochant le paramètre “Requis”.
Vous pouvez faire de cette liste une liste en cascade en cochant la case Cascade.
Il est possible d”exploiter les ressources des services web Vitis et Gtf pour configurer les paramètres de type liste.
- Gestionnaire de source de données. Source de données de type Service Web.*
Après avoir sélectionné le service à exploiter (Vitis ou Gtf), sélectionner la ressource dont vous voulez importer les données. Dans l”exemple ci-dessus, on exploite la ressource Groups du service Vitis. Les groupes d”utilisateurs de Vitis seront importés dans le paramètre publié de type liste, en cours de création.
L’accès aux services web diffère selon les privilèges liés à l’utilisateur. Il faut donc s”assurer que le compte connecté ait bien les droits requis pour accéder au service web de son choix. Consulter la liste des droits par service.
Le bouton “Valider” permet de fermer la fenêtre en cours et revenir à liste des sources de données. Cliquer à nouveau sur Valider pour fermer le gestionnaire de source de données et revenir au studio.
Pour lier cette liste à un paramètre publié, sélectionner le paramètre désiré dans la fenêtre des Paramètres publiés à droite de l”écran, pour pouvoir ensuite l”éditer dans la fenêtre de Définition :
Nommer le paramètre, éditer son libellé puis sélectionner dans la liste déroulante la source de données nouvellement créée, dans l”exemple ci-dessus : “groupes”.
Définir ensuite la clé ainsi que le libellé. Pour cela cliquer sur le bouton Recharger pour charger les valeurs et sélectionner celles à définir comme clé puis comme libellé :
Cliquer ensuite sur le bouton “Recharger les sources de données” Recharger dans la fenêtre de prévisualisation, pour pouvoir visualiser la liste, telle qu”elle s”affichera dans le formulaire de demande :
Vous pouvez paramétrer le nombre de lignes à afficher dans la liste, sa largeur et définir si ce paramètre est obligatoire ou pas, en cochant le paramètre “Requis”.
Vous pouvez faire de cette liste une liste en cascade en cochant la case cascade.
On peut choisir d”afficher une liste dont le contenu varie en fonction des valeurs sélectionnées dans une autre liste. L”option Cascade permet le paramétrage de telles listes en spécifiant le paramètre publié parent et l”attribut enfant sur lequel effectuer le filtre d”affichage.
Attributs de filtrage et Signe de comparaison Après avoir défini quel est l”élément parent, il faut définir le champ enfant sur lequel repose l”ascendance ainsi que le signe de comparaison sur lequel doit reposer la comparaison entre les champs liant la table parent à la table enfant. Les signes de comparaison sont :
- = Egalité parfaite entre le champ parent et le champ enfant
- > Ne seront affichés dans la liste enfant que les enregistrements dont la valeur est supérieure à l”attribut de filtre parent.
- < Ne seront affichés dans la liste enfant que les enregistrements dont la valeur est inférieure à l”attribut de filtre parent.
Attendre le parent Pour forcer l”affichage de la liste des éléments enfants uniquement lorsqu”un élément parent est sélectionné, il faut cocher la case “Attendre le parent”. Ainsi, si aucun élément parent n”est sélectionné, aucun élément enfant n”apparaîtra dans la liste.
Exemple On veut faire apparaître les sections d”une commune sélectionnée préalablement. Un premier paramètre nommé “commune” est créé. Il exploite les valeurs d”une table “commune” d”une base de données. Un deuxième paramètre nommé “section” est créé. Il exploite les valeurs d”une table “section” de la même base. Dans la fenêtre de la définition du paramètre “section”, après avoir lié le paramètre à la source de données, sélectionner la boîte à cocher “cascade” puis sélectionner le paramètre parent “commune” :
Seules les 2 sections de la commune sélectionnée d”Abeilhan apparaissent désormais dans la liste Section :
Gestion des catégories¶
L’attribution de catégorie à un traitement permet à l’administrateur d’organiser par thématique les traitements disponibles. L’onglet Catégorie du mode Publication permet d’accéder au formulaire de création de catégorie dans lequel l’administrateur nomme cette dernière et peut lui associer une description.
Gestion des dépôts (répertoire de surveillance) et des abonnements¶
Abonnement à un traitement¶
Un abonnement permet à un utilisateur d”exécuter à fréquence régulière un projet.
Un auteur peut décider de rendre un traitement disponible pour abonnement ou pas. Dans le menu Mon travail, onglet Abonnements, un utilisateur peut choisir de s”abonner à un projet, à la fréquence de son choix, et peut choisir d”être notifié par mail du bon déroulement ou pas du traitement. Il peut également saisir l”adresse mail à laquelle envoyer la copie du mail.
Surveillance des dépôts¶
Un dépôt est un répertoire de surveillance. Une surveillance correspond à un abonnement à un traitement en ajoutant un nouveau paramètre qu’est la disponibilité d’un fichier ou d’un répertoire dans un dépôt préalablement défini par l’administrateur. Ainsi, si un projet est rendu disponible pour surveillance, alors ce dernier est automatiquement exécuté (selon la période d’abonnement définie) dès lors que GTF détecte la présence d’un fichier dans le dépôt.
L’onglet Dépôt permet à l’administrateur de consulter la liste des dépôts, d’en créer et d’en supprimer. Il crée des nouveaux dépôts en spécifiant le chemin du répertoire à surveiller qu’il aura préalablement créé sur le serveur.
La stratégie d’attribution de dépôt se fait à l’échelle du groupe d’utilisateurs. Un utilisateur en ayant-droit, peut alors associer à un traitement une surveillance dans un dépôt. GTF scrute la présence de fichiers dans le dépôt. Si un fichier est présent, alors le traitement est lancé en exploitant le fichier.
Le bouton ‘Ajouter un dépôt’ permet d’accéder au formulaire de création de dépôt en spécifiant le chemin du répertoire à surveiller, un alias et les groupes y ayant accès. Il clique ensuite sur ‘Créer’ pour valider sa création et rendre le dépôt disponible pour les groupes en ayant droit.
Formulaire de création de dépôt.
Formulaire de création de dépôt.
GTF personnalise automatiquement le dépôt en fonction du compte utilisateur de connexion en suffixant le dépôt avec la variable
$user
. L’utilisateur final ne voit ainsi que son propre répertoire dans le dépôt. Au préalable, l’administrateur doit avoir créé dans chaque dépôt, un répertoire par utilisateur (des groupes ayant accès à chaque dépôt). Le nom du répertoire doit être parfaitement identique au compte de connexion qu’il s’agisse d’un utilisateur « PostgreSQL » ou importé d’Active Directory.
Gestion des périodes¶
Un abonnement permet de s’inscrire à un traitement répété au cours du temps selon une fréquence choisie. Dans l’onglet Périodes, l’administrateur peut accéder au formulaire de définition des périodes d’abonnement. Le bouton ‘Ajouter période’ permet à l’administrateur de définir une nouvelle période d’abonnement en lui affectant un libellé puis en y insérant le code correspondant.
Sur Linux, l”administrateur de GTF doit mettre à jour les périodes, définies par défaut, pour que les abonnements s”inscrivent dans le fichier contrab du serveur et qu”elles puissent, de la sorte, être exploitées par les abonnements et surveillances.
Il est ensuite possible de tester le bon déroulement de l’ajout de Période en cliquant sur le bouton ‘Test’. Le bouton ‘Créer’ finalise le processus de création d’une période.
Pycron est le composant assurant l’exécution des tâches à heures fixes. L’instruction à saisir doit respecter la syntaxe de la fonction contrab. Pour plus d’information sur le programme crontab et la syntaxe à respecter, consulter le site : http://fr.wikipedia.org/wiki/Crontab
Modèles d”E-mail¶
L”onglet Modèles-email du mode Publication permet la création de modèles d”e-mails envoyés après exécution d”un traitement. Via cette onglet, l”administrateur (ou l”auteur) a la possibilité de personnaliser un e-mail, en définissant la ou les personnes destinataires, les circonstances d”envoi de ce dernier ainsi que son contenu. Il choisit ensuite pour chaque modèle, la définition à utiliser.
Chaque traitement est associé à un modèle d”e-mail.
L”onglet Informations générales permet de créer un nouveau modèle de mail, en le nommant et en définissant son contexte à GTF et de définir le type de définition de ce dernier :
Définition simple¶
L”administrateur exploite les balises disponibles pour personnaliser le corps du mail.
Nom de la balise | Descriptif | Code correspondant |
---|---|---|
[order.order_id] | Identifiant de la demande de traitement | $properties['order.order_id']['value'] = $this->aObjects["oOrder"]->aFields['order_id']; |
[order.order_date] | Date et heure de la demande de traitement | $properties['order.order_date']['value'] = $this->aObjects["oOrder"]->aFields['order_date']; |
[order.execution_date] | Date et heure de fin de traitement | $properties['order.execution_date']['value'] = $this->aObjects["oOrder"]->aFields['order_execution_date']; |
[order.result_url] | Adresse de téléchargement du résultat du traitement | $properties['order.result_url']['value'] = $this->aObjects["oOrder"]->aFields['result_url']; |
[order.log_url] | Adresse du log du traitement | $properties['order.order_log']['value'] = $this->aObjects["oOrder"]->aFields[log_url']; |
[order.length_sec] | Durée du traitement en secondes | $properties['order.length_sec']['value'] = $this->aObjects["oOrder"]->aFields[length_sec']; |
[order.email_notifications] | Adresse Email du destinataire en copie de mail | $properties['user.email']['value'] = $this->aObjects["oOrder"]->getUser()->aFields['email']; |
[gtf_engine. Name] | Nom du moteur GTF | $this->aObjects["oOrder"]->getGtfEngine()->aFields['name']; |
[fme_engine.name] | Nom du moteur FME utilisé | $this->aObjects["oOrder"]->getFmeEngine()->aFields['name']; |
[order.user.name] | Nom du demandeur de traitement | $properties['user.name']['value'] = $this->aObjects["oOrder"]->getUser()->aFields['name']; |
[order.user_email] | Adresse mail du demandeur de traitement | $properties['user.email']['value'] = $this->aObjects["oOrder"]->getUser()->aFields['email']; |
[order.user.login] | Compte de connexion du demandeur | $properties['user.login']['value'] = $this->aObjects["oOrder"]->getUser()->aFields['login']; |
[order.worksapce.category.name] | Catégorie du traitement | $properties['catgory.name']['value'] = $this->aObjects["oOrder"]->getWorkspace()->getCategory()->aFields['email']; |
[order.workspace.name] | Nom du traitement | $properties['order.workspace.name']['value'] = $this->aObjects["oOrder"]->getWorkspace()->aFields['name']; |
[worksapce.fmw_file] | Nom du projet FME | $properties['order.workspace.fmw_file']['value'] = $this->aObjects["oOrder"]->getWorkspace()->aFields['fmw_file']; |
La balise [order.email_notifications] doit être insérée dans les champs CC et CCi de sorte à ce qu”une notification de traitement soit envoyée aux adresses mail définies dans le formulaire de demande de traitement dans le champ “Envoyer une copie de l”e-mail à” :
Lorsque plusieurs destinataires doivent être en copie du mail de notification, séparer les adresses mail par un retour charriot.
Définition avancée¶
L”administrateur saisit directement le code du mail. Il peut, pour cela, utiliser le code généré via l”édition simple en cliquant sur le bouton Générer le code à partir de l”édition simple.
Exemples de publication de traitements¶
Traitement de conversion d”un fichier statique sur le serveur¶
Objectif¶
Création d”un traitement simple de conversion d”un fichier Shape, disponible sur le serveur, en fichier MapInfo, avec publication du répertoire destination à créer.
Le fichier source est statique (toujours le même) et il se trouve à un emplacement quelconque du serveur. L”emplacement du jeu de données sur le serveur est défini dans le paramètre source dans FME et ce paramètre est dépublié.
Création du projet FME¶
- Lancer FME Workbench
- Cliquer sur Fichier >Nouveau> Générer un projet
- Indiquer le fichier Shape en source et le format Mapinfo en sortie. Cocher Schéma statique puis cliquer sur OK.
Après validation, un projet simple de conversion d”un fichier Shape vers un fichier MapInfo est généré.
Par défaut, deux paramètres sont publiés : « sourceDataset_SHAPE » et « DestDataSet_MAPINFO ».
Chaque paramètre publié d”un projet FME génère une entrée dans le formulaire GTF. Dans cet exemple, le formulaire GTF permet de modifier le répertoire source et le répertoire destination. Or nous souhaitons que GTF ignore la publication des données sources, empêchant les utilisateurs finaux de sélectionner et modifier les fichiers sources.
Supprimer la publication du paramètre [SourceDataset_SHAPE] pour forcer les utilisateurs à utiliser le fichier Shape mis à disposition sur le serveur.
Editer, si désiré, le paramètre publié DestDaraset_MAPINFO
Enregistrer le projet, par exemple sous le nom « extraction_departements.fm ».
Avant de publier ce projet dans GTF, il convient de le tester localement.
- Lancer le traitement depuis FME Workbench
- Vérifier le bon déroulement du traitement
- S”assurez que le résultat soit correctement généré.
Publication du traitement dans GTF¶
- Se connecter à GTF.
- Dans le menu Publication, cliquer sur Ajouter Projet FME. Donner un nom au traitement (par exemple, « Conversion_dept_shp2mapinfo »).
- Cliquer sur Parcourir et charger le projet FME. Choisir de ne pas rendre ce traitement disponible sur abonnement et ni pour une surveillance. Sélectionner le mot-clé associé au moteur GTF désiré. Cliquer sur Créer.
- Dans la section « Droits », associer un groupe au traitement et cliquer sur Mettre à jour.
- Dans la section « Formulaire », visualiser le formulaire publié par défaut. Constater que le paramètre publié source du projet FME n”est pas publié et que seul le paramètre « Nom du dossier Destination MapInfo » est publié. La valeur par défaut configurée dans FME a été importée.
Exécution du traitement¶
- Dans le Mode “Mon travail” cliquer sur Ajouter demande, et choisir le traitement préalablement publié « Extraction Départements ».
- Cliquer sur Demander. La demande de traitement est créée et celle-ci est en attente de traitement.
- Une fois traité, le voyant passe au vert. Le résultat est téléchargeable.
Le fichier .zip généré contient un répertoire « Mon résultat » contenant les fichiers MapInfo générés par le traitement.
Ajout de Paramètres publiés supplémentaires¶
Objectif¶
Compléter le projet exemple n°1. Publication d”un paramètre publié supplémentaire pour spécifier une emprise d”extraction de données.
Création du projet FME¶
- Ouvrir le précédent projet « extraction-departements.fmw » dans FME Workbench. Dans le Navigateur, publier les 4 paramètres : X minimum, Y minimum, X maximum et Y maximum des données sources. Entrer les valeurs par défaut correspondant à l”emprise de l”ensemble des données, par exemple : X minimum = 50000 ; X maximum = 1 200 000 ; Y minimum = 1 700 000 ; et Y maximum = 2 700 000.
- Enregistrer le projet « extraction_depts_emprise.fmw ».
Publication du traitement dans GTF¶
- Se connecter à GTF.
- Dans le menu Publication, cliquer sur Ajouter Projet FME. Donner un nom au traitement GTF, par exemple, « extraction depts emprise ». Aucune ressource complémentaire ne doit être chargée puisque la donnée source est intégrée dans le projet FME. Choisir de ne pas rendre ce traitement disponible sur abonnement ni pour une surveillance. Sélectionner le mot-clé associé au moteur GTF désiré. Cliquer sur Créer. Dans la section « Droits », associer un groupe au traitement et cliquer sur Mettre à jour.
- Dans la section « Formulaire », visualiser le formulaire publié par défaut. Constater que les 4 paramètres de l”emprise apparaissent dans le formulaire avec les valeurs par défaut définies dans le projet FME.
Exécution du traitement¶
- Dans le mode « Mon travail » cliquer sur Ajouter demande, et choisir le traitement préalablement publié « Extraction Département emprise ».
- Indiquer comme valeurs d”emprise X min = 500 000, Y min = 2 000 000, X max = 1 000 000 et Y max = 2 500 000, et « Mon_résultat_emprise » comme nom de répertoire destination.
- Cliquer sur Créer la Demande.
- Une fois la demande traitée (voyant vert), télécharger le .zip généré.
Remarquer que le nom du fichier ZIP correspond à l’identifiant de la demande de traitement : par exemple 19.zip pour la demande n°19. Ce numéro est unique car issu d’une séquence PostgreSQL.
- Ouvrir le fichier MapInfo généré dans FME Data Inspector et constater que les données ont été extraites selon l”emprise spécifiée.
Conversion de fichiers sources statiques chargés sur le serveur lors du chargement du projet FME¶
Objectif¶
Le fichier source est statique et il est chargé sur le serveur par GTF comme ressource du projet FME. Les utilisateurs finaux n”uploadent pas de fichiers sources, ils se trouvent sur le serveur au même endroit que le projet FME.
Il s”agit ainsi de reconstituer la même arborescence que celle du poste de développement.
Création du projet FME¶
Créer un nouveau projet FME pour convertir un fichier Shape vers un fichier MIF/MID.
Deux paramètres doivent être publiés : la source et la destination. La source pointe vers un fichier Shape en local. Pour que GTF puisse accéder à ce fichier, il faut uploader le shapefile et ses dépendances sur le serveur GTF. Ces données seront stockées dans le même répertoire que le projet FME lors de la création du traitement dans GTF.
Modifier le chemin de la source comme tel :
$(FME_MF_DIR_UNIX) est une variable FME qui indique l’emplacement d’un projet FMW. Le fichier source (dpt2.shp et fichiers dépendants) est uploadé à cet emplacement. Il sera directement utilisable dans GTF (sans avoir à l’uploader à chaque demande de traitement).
- Les données sources étant fixes, il convient de dépublier ce paramètre, en cliquant sur Supprimer le lien du paramètre publié.
- Enregistrer le projet.
Publication du traitement dans GTF¶
- Se connecter à GTF.
- Dans le menu « Publication », cliquer sur Ajouter Projet FME. Donner un nom au traitement GTF, par exemple « Conversion_dept_shp2mif ».
- Charger le projet FME. Choisir de ne pas rendre ce traitement disponible sur abonnement ni pour une surveillance. Sélectionner le mot-clé associé au moteur GTF désiré puis dans la section Droits associer un groupe au projet.
- Pour uploader le fichier Shape et ses dépendances, compresser les fichiers dans un fichier ZIP. Dans le champ Ressources complémentaires, cliquer sur Parcourir et chercher le fichier ZIP précédemment créé. Cliquer sur Créer.
Ces ressources complémentaires sont décompressées dans le répertoire contenant le projet .fmw. L”arborescence du poste de développement est ainsi reconstituée sur le serveur.
La section « Répertoire Projet » permet de visualiser l”intégralité du répertoire projet du serveur :
- Dans la section Formulaire, visualiser le formulaire publié par défaut. Constater que seul le fichier destination est paramétrable. Le fichier des départements dpts.shp est automatiquement associé au projet.
Exécution du traitement¶
- Dans le Mode « Mon travail » cliquer sur Ajouter une demande, et choisir le traitement préalablement publié conversion_dept_shp2mif ».
- Indiquer le nom répertoire à créer en destination. Cliquer sur Créer la demande.
- Une fois la demande traitée (voyant vert), télécharger le .zip généré.
Remarquer que le nom du ZIP correspond à l’identifiant de la demande de traitement : par exemple 19.zip pour la demande n°19. Ce numéro est unique car issu d’une séquence PostgreSQL.
Traitement de conversion avec sortie générique¶
Objectif¶
Publication d”un traitement de conversion d”un fichier dont le format destination est générique. L”utilisateur final choisit le format destination. Le fichier source au format Shape est statique.
Création du projet FME¶
- Ouvrir le traitement créé dans l”exercice n°2 « extraction_depts_emprise.fmw » dans FME Workbench. Supprimer le jeu de données destination MapInfo et ajouter un nouveau jeu de données au format « Generic ». Indiquer une destination temporaire.
- Cliquer sur Paramètres et choisir le format de sortie MapInfo :
- Dupliquer le type d”entités source, par un clic droit en choisissant l”option « Dupliquer »;
- Publier le paramètre « Système de coordonnées » du jeu de données Generic.
Le format Generic permet de spécifier le format de destination via un paramètre. Le paramètre « GENERIC_OUT_FORMAT_GENERIC » est publié par défaut. GTF ne supporte pas ce paramètre car tous les formats supportés par FME devraient être listés.
- Dans un premier temps, il faut donc dépublier ce paramètre par un clic droit > Supprimer.
- Il faut ensuite créer sa propre liste de formats dans un nouveau paramètre publié : ajouter un nouveau paramètre publié que vous nommerez « FORMAT » de type « Choix » et saisir les formats destination désirés.
Le nom des formats doit correspondre aux noms courts tels qu’ils sont listés dans la galerie des formats de FME Workbench (« Outils » > « Consulter la galerie des formats »). Il est également possible de choisir un type « Choix avec alias » pour afficher un texte plus explicite dans la liste.
- Associer ensuite le paramètre “FORMAT” au jeu de données générique. Faire un clic droit sur le paramètre « Format en sortie » et choisir Lier au paramètre publié.
- Enregistrer le projet, par exemple « shape2generic.fmw »
Publication du traitement dans GTF¶
- Se connecter à GTF.
- Dans le menu Publication, cliquer sur Ajouter Projet FME. Donner un nom au traitement GTF, par exemple « Extraction départements avec choix de l”emprise et du format destination ». Aucune ressource complémentaire ne doit être chargée puisque la donnée source est intégrée dans le projet FME. Choisir de ne pas rendre ce traitement disponible sur abonnement et ni pour une surveillance. Sélectionner le mot-clé associé au moteur GTF désiré. Cliquer sur Créer. Dans la section « Droits », associer un groupe au traitement et cliquer sur Mettre à jour.
- Dans la section « Formulaire », visualiser le formulaire publié par défaut. Constater que le paramètre Format destination est bien associé au projet.
Exécution du traitement¶
- Dans le mode « Mon travail », cliquer sur Ajouter demande, et choisir le traitement préalablement publié « Extraction départements avec choix de l”emprise et du format destination ».
- Indiquer le fichier ZIP source et le répertoire destination. Cliquer sur Créer la demande.
- Une fois la demande traitée (voyant vert), télécharger le .zip généré.
Remarquer que le nom du fichier ZIP correspond à l’identifiant de la demande de traitement : par exemple 19.zip pour la demande n°19. Ce numéro est unique car issu d’une séquence PostgreSQL.
Personnalisation de formulaire : exploitation du contrôle de type Carte OSM¶
Objectif¶
Extraction de types d”entités à partir d”une zone d”emprise saisie graphiquement sur une carte OSM par l”utilisateur final. Modification du formulaire directement dans GTF.
Création du projet FME¶
Créer un nouveau projet FME pour extraire un fichier GeoFla au format Esri Shape avec un paramètre qui permet de choisir une zone d”extraction sous la forme d”un polygone décrit par une chaîne WKT.
Dans FME, 3 paramètres sont publiés :
- Zone d”extraction WKT : chaîne de caractères WKT pour définir la zone d”extraction. Paramètre publié de type Texte.
- Couches à extraire : choix du type d”entités à extraire (« COMMUNES », « CANTONS », « DEPARTEMENTS »…). Paramètre publié de type Choix.
- Nom du Répertoire Destination à créer. Paramètre publié de type Répertoire en sortie.
Publication du traitement dans GTF¶
- Se connecter à GTF.
- Dans le menu Publication, cliquer sur Ajouter Projet FME. Donner un nom au traitement GTF, par exemple « Extraction GeoFla ». Entrer ensuite une description et attribuer une catégorie. Choisir de ne pas rendre ce traitement disponible sur abonnement et ni pour une surveillance.
- Pour uploader les fichiers GeoFla au format Shape, compresser les fichiers dans un fichier ZIP. Dans le champ “Ressources complémentaires” cliquer sur Parcourir et chercher le fichier ZIP précédemment créé. Cliquer sur Créer. Dans la section « Droits », associer un groupe au traitement et cliquer sur Mettre à jour.
- Dans la section « Formulaire », visualiser le formulaire publié par défaut. Constater que les 3 paramètres sont bien affichés.
Personnalisation du formulaire¶
La saisie de la zone d”extraction sous la forme d”une chaîne de caractères WKT n”est pas simple. Une alternative serait de proposer à l”utilisateur final la possibilité de saisir manuellement la zone d”extraction de son choix en dessinant ses contours directement sur une carte. GTF permet l”exploitation de contrôles de type carte :
- Carte OSM
- Carte Bing
- Carte Veremap
Dans notre exemple, nous proposons d”exploiter la carte OSM qui ne nécessite pas de clé.
Il est donc nécessaire de personnaliser le formulaire en cliquant sur le bouton
- Dans la fenêtre Paramètres publiés, sélectionner ensuite le paramètre « wktPolygon » de type Texte que vous souhaitez convertir en contrôle de type Carte OSM.
- Dans la fenêtre Définition, sélectionner dans la liste, le contrôle de type « Carte OSM ».
- Ajuster les paramètres d”affichage de la carte en définissant un libellé, par exemple « Dessiner la zone d”extraction », la largeur/hauteur de la carte, son échelle et projection, les coordonnées de son centre, ainsi que les outils qui seront affichés dans le formulaire de demande.
- Cliquer ensuite sur le bouton Sauvegarder le formulaire personnalisé
puis sur le bouton de Publication de ce dernier
.
- S”assurer que le formulaire a bien été mis à jour et que le paramètre « Zone d”extraction WKT » a été remplacé par un paramètre permettant la saisie du périmètre d”extraction directement sur une carte OSM.
Exécution du traitement¶
- Dans le Mode « Mon travail » cliquer sur Ajouter demande, et choisir le traitement préalablement publié « Extraction GeoFla ».
- Indiquer les couches à extraire, le répertoire destination et saisir directement sur la carte la zone d”extraction. Cliquer ensuite sur Créer la demande.
- Une fois la demande traitée (voyant vert), télécharger le .zip généré.
Administration¶
Gestion des utilisateurs¶
Un utilisateur vMap est un compte connu par l’application vMap qui peut se connecter et utiliser ses services.
Deux profils d’utilisateurs sont à distinguer :
- Utilisateurs PostgreSQL : utilisateurs authentifiés par la base de données interne à vmap, PostgreSQL, créés directement dans vMap.
- Utilisateurs Active Directory (AD) : utilisateurs d’un domaine et authentifiés par un annuaire Active Directory, importés dans vMap.
1. Création d”utilisateurs et de groupes PostgreSQL¶
Le mode Utilisateurs > Onglet Utilisateurs liste l’ensemble des utilisateurs. Il permet l’ajout de nouveaux utilisateurs, leur édition et suppression. Après avoir cliqué sur ‘Ajouter un utilisateur’, le formulaire suivant s’affiche :
image
2. Création d”utilisateurs et de groupes d”un annuaire Active Directory¶
Il est possible de gérer plusieurs domaines et d’exploiter des groupes de sécurité définis directement dans un annuaire Active Directory. L’administrateur a la possibilité d’importer des utilisateurs et des groupes depuis Active Directory. Cette méthode permet d’hériter des droits issus de la gestion centralisée AD des utilisateurs au sein d’un organisme. L’administrateur crée le nouveau domaine, puis importe les utilisateurs et les groupes. L’attribution des groupes ainsi que les mots de passe des utilisateurs ne pourront pas être changés.
2.1. Ajout de domaines Active Directory¶
Le mode Utilisateurs > Onglet Domaines liste les domaines Active Directory. Il permet de créer, modifier et supprimer des domaines. Le bouton ‘Ajouter un Domaine’ affiche le formulaire suivant.
L’administrateur saisit les informations suivantes :
- Type, Nom et Alias du domaine : le nom de domaine utilisé pour la connexion. Par exemple, ‘siege.entreprise.com’.
- IP ou nom de serveur : adresse IP ou nom du serveur assurant le rôle de serveur Active Directory.
- Dn de base de recherche (utilisateur) : point d’entrée pour la recherche des utilisateurs.
- Dn de base de recherche (groupe) : point d’entrée pour la recherche des groupes.
- Filtre (utilisateur) : permet de définir des filtres pour la recherche des utilisateurs.
- Filtre (groupe) : permet de définir des filtres pour la recherche des groupes.
- Vérifier les droits lors du lancement du robot : permet au robot de vérifier si un utilisateur du domaine possède toujours les droits lors de l’exécution du traitement. Pour cela le robot a besoin de connaître le login et le mot de passe d’un utilisateur du domaine.
- Login : login d’un utilisateur du domaine.
* Mot de passe : mot de passe de l’utilisateur du domaine. Le login et le mot de passe saisis ici permettent de vérifier les droits de l’utilisateur Active Directory lors de l’exécution du robot. En cliquant sur « Créer » la procédure de création de domaine Active Directory est finalisée.
image
L’administrateur doit ensuite modifier manuellement le fichier de configuration de la base de données PostgreSQL pour autoriser la connexion des utilisateurs du domaine. Dans le répertoire d’installation de PostgreSQL, modifier à l’aide d’un éditeur de texte le fichier pg_hba.conf situé dans le dossier data.
Avant modification vous devriez avoir la configuration suivante :
host all u_scheduler 127.0.0.1/32 trust
host all +superusers 127.0.0.1/32 md5
host all all 127.0.0.1/32 md5
# IPv6 local connections:
host all u_scheduler ::1/128 trust
host all +superusers ::1/128 md5
host all all ::1/128 md5
Vous devez rajouter les deux lignes suivantes :
host all +gtf_nomdomaine 127.0.0.1/32 ldap ldapserver=nomduserveur ldapprefix=""
host all +gtf_nomdomaine ::1/128 ldap ldapserver=nomduserveur ldapprefix=""
Pour obtenir :
host all u_scheduler 127.0.0.1/32 trust
host all +superusers 127.0.0.1/32 md5
host all +gtf_nomdomaine 127.0.0.1/32 ldap ldapserver=nomduserveur ldapprefix=""
host all all 127.0.0.1/32 md5
# IPv6 local connections:
host all u_scheduler ::1/128 trust
host all +superusers ::1/128 md5
host all +gtf_nomdomaine ::1/128 ldap ldapserver=nomduserveur ldapprefix=""
2.2. Import d”utilisateurs d”Active Directory¶
Dans l”onglet Utilisateurs, le bouton « Importer de l’AD » permet d’importer des utilisateurs à partir d’un serveur Active Directory. Une interface de connexion apparaît à l’écran. L’administrateur saisit son login et mot de passe Active Directory afin de se connecter au domaine précédemment créé. Une fois la connexion effectuée, l’administrateur peut soit naviguer dans l’arborescence de l’annuaire du domaine, soit effectuer une recherche à partir de critères.
3. Gestion des privilèges¶
Les privilèges préfixés par « vitis_ » correspondent aux droits propres au socle de développement Vitis :
- Le privilège vitis_user permet de se connecter à l”application et d”accéder au mode Utilisateur.
- Le privilège vitis_admin permet l”accès aux modes Utilisateurs, Configuration, Logs. Il a en charge la gestion des paramètres système et de la configuration de GTF. Il accède également dans le mode Aide à la documentation relative à l”API Vitis.
Des profils d”utilisateurs propres à vMap et GTF sont disponibles, chacun ayant des privilèges spécifiques. L”accès aux modes dépend des privilèges attribués à l”utilisateur.
- vmap_user = utilisateur de vMap ayant accès aux modes Visualisation cartographique.
- vmap_admin = l”administrateur de l”application vmap a tous les droits.
- gtf_admin = dans GTF, en plus des privilèges vitis_admin, il accède au mode Moteurs dans lequel il configure les moteurs FME et GTF. Il a en charge la gestion des utilisateurs de GTF et de la base de données.
- gtf_author = l”auteur publie des projet FME sur GTF et les met à la dispsotion des utilisateurs en ayant droit.
- gtf_user = utilisateur de GTF qui éxécute des projets FME auxquels il a accès.
- vmap_cadatsre_user = utlisateur du module Cadastre de vMap
- vm4ms_admin = administrateur de vMap4MapServer
Supervision¶
On entend par « supervision » le suivi des demandes de traitements, des abonnements et des surveillances de tous les utilisateurs GTF. A tout moment, l”administrateur doit pouvoir consulter la liste des demandes de projets émises par tous les utilisateurs, en supprimer certaines, identifier les erreurs et obtenir une vision synthétique de l”utilisation de l”application.
Il dispose pour cela du mode « Supervision » dans lequel est listé l”ensemble des traitements demandés, des abonnements et des surveillances.
Supervision des demandes¶
L”onglet « Demandes » offre à l”administrateur une vision de l”état du serveur. Il a une connaissance fine de l”ensemble des traitements demandés par utilisateur, des dates de demandes, des priorités ainsi que le numéro de moteur ayant traité chaque projet. Il peut télécharger les résultats des traitements, consulter les paramètres des traitements et consulter les logs FME associés.
Le champ « Supprimé » lui permet d”être informé de la suppression d”une demande par un utilisateur.
Enfin, le champ « Etat » permet, via un code couleur, d”identifier si une demande est en attente, en erreur, traitée, non traitable, en cours de traitement ou non autorisée.
Mode supervision
L”administrateur dispose de différents boutons d”administration : le bouton Réinitialiser lui permet de relancer un (ou des) traitement(s) sélectionné(s).
Suppression des demandes¶
L”administrateur est responsable de la suppression définitive des demandes une fois que ces dernières ont été supprimées par les utilisateurs. Il existe ainsi deux niveaux de suppression :
- La suppression utilisateurs
- La suppression définitive par l”administrateur
Le bouton Purger les demandes permet à l”administrateur de procéder à la suppression définitive d”une demande de traitement préalablement supprimée par un utilisateur.
Le bouton Supprimer les demandes permet de supprimer les demandes des traitements sélectionnés.
Modification des moteurs¶
L”administrateur peut choisir de modifier le moteur d”exécution d”un (ou des) traitement(s) préalablement sélectionné(s) en cliquant sur le bouton Modifier le moteur. En cas d”échec de traitement, modifier le moteur est une bonne méthode pour identifier l”origine du problème et comprendre si la configuration des versions de moteurs FME en est à l”origine.
Modifier moteur
Supervision des abonnements¶
L”onglet « Abonnement » permet à l”administrateur de consulter la liste des abonnements aux projets FME et d”identifier ceux étant actifs et inactifs. Il peut choisir de supprimer définitivement un abonnement en cliquant sur Supprimer les abonnements.
Supervision des surveillances¶
De la même façon, l”onglet Surveillance permet à l”administrateur de consulter la liste des demandes de surveillance créées par les utilisateurs.
Il peut choisir de supprimer définitivement une surveillance : après avoir sélectionné le ou les abonnements à supprimer, il clique sur le bouton Supprimer les abonnements.
Gestion des messages¶
Le projet « GTFMessageSender », disponible sur notre site de téléchargement http://download.veremes.com (répertoire gtf/gex) permet à un traitement FME d”envoyer un message à GTF, et de déclencher des actions via l”application WAB, Workflow Application Builder for FME.
Les messages sont destinés à être exploités par WAB mais ils sont consultables dans le mode Supervision de GTF.
Exemple¶
« GTFMessageSender » peut être utilisé pour envoyer des messages suite à un contrôle des géométries d”un fichier source. En fin de traitement, un message est envoyé à GTF.
Deux types de messages peuvent être envoyés selon la présence ou non d”erreur dans le fichier source. Deux classes peuvent être créées : « traitement ok » et « traitement Ko ». Chacune enclenche des traitements spécifiques dans WAB.
Dans GTF, l”administrateur pourrait ainsi consulter la liste des messages envoyés par « GTFMessageSender », leur classe et corps, leur date de création et l”expéditeur.
Statistiques¶
Le mode « Statistiques » permet aux administrateurs d”avoir une vision graphique et synthétique de l”utilisation des ressources de GTF (moteur, traitement, temps machine, par date et/ou utilisateur) à travers des graphiques et des tableaux de synthèse.
L”affichage des statistiques peut être graphique ou tabulaire (export dans Excel) et il est possible d”obtenir une représentation journalière, hebdomadaire, mensuelle et annuelle de l”activité sur le serveur à partir d”une date spécifiée en paramètre.
La liste déroulante « Variable » permet de choisir la variable devant être représentée dans les tableaux ou graphiques :
- Nombre de traitements exécutés
- Temps total des traitements
- Durée des traitements par projet FME
Pour les deux dernières variables, le temps total des traitements et le temps par projet peuvent être représentés par :
- Seconde
- Minute
- Heure
- Pourcentage du temps total d”utilisation
L”administrateur choisit ensuite de regrouper ces variables par :
- Utilisateur
- Projet FME
- Etat du traitement (traitement en erreur ou traité)
- Moteur utilisé
Puis il choisit la période d”analyse et la date à partir de laquelle produire les statistiques :
- Jour
- Semaine
- Mois
- Année
Le « Nombre d”éléments max » permet de n”afficher que les éléments les plus importants en termes de durée ou de nombre, les autres étant regroupés dans la classe « Autres ». Dans l”exemple ci-dessous, il a été choisi de n”afficher que deux éléments maximum : les traitements « Conversion de fichier » et « Extraction ZI » sont les deux traitements les plus longs, ils sont donc affichés et détaillés ; tous les autres traitements sont regroupés dans la classe « Autres ».
Il est possible de tronquer les libellés pour réduire la taille de la légende et des info-bulles.
Il est possible d’augmenter le niveau de détail directement dans le graphique, en cliquant sur une barre d’histogramme. Le niveau d’analyse s’affine, passant, selon les cas, de l’année au mois, à la semaine, au jour et aux heures. Inversement, un clic droit > Zoom out, sur une barre d’histogramme permet de passer à une analyse statistique plus large passant, selon les cas, des heures, au jour, au mois et à l’année.
Annexes¶
Syntaxe des expressions CRON pour la définition des périodes d”abonnement¶
Le code à saisir doit respecter la syntaxe : « mm hh jj MMM JJJ tâche » où
- mm représente les minutes (de 0 à 59)
- hh représente l’heure (de 0 à 23)
- jj représente le numéro du jour du mois (de 1 à 31)
- MMM représente l’abréviation du nom du mois (jan, feb,…) ou le numéro du mois (de 1 à 12)
- JJJ représente l’abréviation du nom du jour ou bien le numéro du jour dans la semaine (0 = dimanche, 6 = samedi)
- * : signifie à chaque unité (0,1,2,3,4…)
- 5,8 : signifie les unités 5 et 8
- 2-5 : signifie les unités de 2 à 5
- /3 : signifie toutes les 3 unités (0,3,6,9…)
Exemples de syntaxe¶
- Tous les jours à 12h : 0 12 ***
- Tous les lundis à 22h15 : 15 22 * *1
- Toutes les heures passées de 15 min : 15 * * * *
- Tous les premiers du mois à 4h42 : 42 4 1 * *
- Du 2 au 5 de chaque mois à 10h12 : 12 10 2-5 **
Services web et privilèges¶
L”accès à un service web dépend du profil du compte connecté. Ainsi par exemple, un utilisateur ayant pour privilège gtf_user, ne peut pas accéder à la ressource “Workspaces” qui retourne la liste des projets puisqu”un privilège gtf_author est requis. Le tableau ci-dessous présente les privilèges requis pour pouvoir accéder aux différents services de l”API :
Service | Ressource | Privilèges requis |
GTF | Catégories | gtf_user |
GTF | EmailContexts | gtf_user |
GTF | EmailOptions | gtf_user |
GTF | EmailTemplates | gtf_author |
GTF | FMEEngines | gtf_admin |
GTF | GtfEngines | gtf_admin |
GTF | GTFGroups | vitis_admin |
GTF | Inboxes | gtf_author |
GTF | License | gtf_admin |
GTF | MessageClasses | gtf_user |
GTF | MessageClassTypes | gtf_user |
GTF | Messages | gtf_user |
GTF | Orders | gtf_author |
GTF | OrderStatutes | gtf_user |
GTF | Periods | gtf_user |
GTF | Priorities | gtf_user |
GTF | Servers | gtf_admin |
GTF | Statistics | gtf_author |
GTF | Subscriptions | gtf_author |
GTF | SupervisionStatues | gtf_author |
GTF | Surveys | gtf_author |
GTF | SurveyType | gtf_user |
GTF | Tags | gtf_user |
GTF | UserOrders | gtf_user |
GTF | UserSubscriptions | gtf_user |
GTF | UserSurveys | gtf_user |
GTF | Versions | gtf_user |
GTF | Workspaces | gtf_author |
Vitis | Domains | vitis_user |
Vitis | GenericQuerys | vitis_user |
Vitis | Groups | vitis_user |
Vitis | Logs | vitis_admn |
Vitis | Modes | vitis_user |
Vitis | Phpinfo | vitis_admin |
Vitis | Privileges | vitis_user |
Vitis | Properties | vitis_user |
Vitis | Ressources | vitis_user |
Vitis | Tabs | vitis_user |
Vitis | Users | vitis_admin |
Vitis | Versions | vitis_user |
Vitis | VitisSections | vitis_user |
Vitis | WebServices | vitis_user |
Liste des contrôles GTF¶
Nom du contrôle GTF
Projets FME intégrés¶
3 projets FME sont intégrés initialement à GTF : « Admin Export », « Admin Import » et « Vérification des formulaires ».
Projet « Admin Export »¶
Le projet « Admin Export » permet d”exporter des projets FME au format d”échange de gtf : .gex. On peut exporter 1 à n projets FME.
Projet « Admin Import »¶
Le projet Admin-Import permet l”import dans GTF de traitements FME contenus dans un répertoire gex. Un projet FME dans GTF est identifié de façon unique par une clé. Le projet d”import permet, en cas d”import de projet dont la clé est existante en base de données, de choisir que faire de ce dernier :
- Remplacer le projet existant : le projet est mis à jour et son nom, sa clé et son identifiant sont conservés.
- Importer le projet avec une nouvelle clé et un nouveau nom :on ajoute de la sorte un nouveau projet en base.
- Ne pas importer le projet
Un rapport d”import est généré au format HTML. Il indique le nom et la clé du projet importé et le statut de l”import, c”est à dire « Mis à jour dans GTF », « Inséré dans GTF » ou « Non mis à jour dans GTF ».
L”import de projets au format gex, issus d”une version antérieure à GTF 2016, ne permet pas la création des formulaires au format json. Directement après avoir importé des projets via « Admin Import », lancer le traitement « Vérification des formulaires » pour permettre la génération des formulaires au format json.
Projet Vérification des formulaires¶
Ce traitement permet la vérification et/ou la génération des formulaires des traitements. Les formulaires des traitements importés depuis une version antérieure à GTF 2016 ne sont pas directement créés au format JSON. Ce traitement permet de définir les conditions de génération des formulaires par défaut et des formulaires publiés. Tous les traitements sont parcourus. 2 options sont possibles :
- Ne pas forcer la régénération des formulaires par défaut pour tous les traitements : ne sont traités que les traitements ne disposant pas de formulaire publié de type subform.json. Leurs formulaires sont donc invalides si le type de formulaire publié indiqué en base est de type “par défaut”, alors les 3 formulaires sont générés.
Sinon, si le formulaire source indiqué en base est de type “personnalisé”, alors un rapport indique que le traitement est invalide et que l”auteur doit créer lui même le formulaire.
formulaire invalide
- Forcer la régénération des formulaires par défaut pour tous les traitements : un formulaire par défaut est regénéré pour tous les traitements. Les formulaires par défaut sont publiés si le formulaire en base de données est de type « Défaut ». Sinon les formulaires publiés personnalisés sont conservés. En savoir plus sur les formulaires dans GTF.
Configuration¶
Configuration générale¶
Documentation en cours de rédaction..
Gestion de la documentation¶
Depuis la version 2018 l”utilisateur peut visualiser des liens de documentation depuis l”interface de l”application vMap, GTF etc..
image
Par défaut se trouvera le lien vers la documentation de l”application utilisée mais l”administrateur pourra ajouter des liens vers de la documentation propre.
Pour ajouter des liens de documentation il faut éditer le fichier de configuration client situé dans [répertoire de l”application]/client/conf/properties.json dans ce fichier JSON doit se trouver un tableau d”objets appelé « documentation ».
Exemple pour l”application vMap
"documentation": [{
"name": "Documentation vMap",
"url": "https://vmap.readthedocs.io/fr/latest/"
}]
Pour ajouter de la documentation propre il suffira d”enrichir ce tableau comme dans l”exemple ci-dessous:
"documentation": [{
"name": "Documentation vMap",
"url": "https://vmap.readthedocs.io/fr/latest/"
}, {
"name": "Documentation Cadastre",
"url": "https://...."
}, {
"name": "Documentation PCRS",
"url": "https://...."
}]
Attention: lors d”une mise à jour ce fichier sera remplacé, il est donc important de le sauvegarder avant de lancer cette dernière
Configuration et procédures d”exploitation¶
Configuration de l”application¶
Le mode « Configuration » permet d”éditer les paramètres de configuration stockés dans des fichiers de type « properties » et de consulter l”état de l”application.
Paramètres généraux de configuration¶
La section « Configuration » permet de consulter et modifier les paramètres généraux de l”application. Organisée en rubriques cette section permet l”édition des paramètres généraux de l”application, des serveurs HTTP, des paramètres de gestion d”écriture des logs et de sécurité, et la consultation des informations relatives à la base de données.
La taille maximale de fichier uploadé est définie par défaut à 100 Mo. Pour augmenter cette valeur, il est nécessaire de modifier les deux properties « upload_max_filesize » et « post_max_size » du fichier de configuration php.ini avant de configurer cette valeur directement dans le mode configuration de GTF.
L”administrateur personnalise l”application et améliore ses performances en déterminant les délais d”expiration de l”interface graphique, les taillles maximales des fichiers uploadés sur le serveur, ainsi que le type fichiers interdits…
Il définit également l”emplacement du répertoire temporaire exploité par GTF
Stratégie de sécurité : configuration du compte public et gestion des groupes¶
La partie « Sécurité » de la section « Configuration » permet de définir un compte de connexion public pour lequel un jeton de connexion doit être associé.
Le jeton de connexion est l”identifiant de connexion appelant un service GTF, intégré directement dans une page Internet. Créer un compte public avec son jeton de connexion est un moyen simple pour un administrateur de donner accès à un formulaire GTF à un utilisateur avec un minimum de droits.
L”administrateur choisit dans la liste déroulante quel compte est le compte public, il saisit ensuite son mot de passe, puis nomme le jeton tel qu”il le souhaite :
Le jeton de connexion public doit être une chaîne de caractères non vide et sans espace.
Le bouton Autoriser les connexions avec le compte PUBLIC permet d”activer/désactiver l”accès aux services GTF du compte PUBLIC.
La partie « Sécurité » de la section « Sécurité » permet la configuration de la gestion mixte des utilisateurs.
Gestion des journaux¶
Cette section permet de définir les journaux à générer, la période de journalisation ainsi que la taille maximale en Ko d”un fichier de log au delà de laquelle ce dernier ne pourra s”afficher dans l”interface.
Version des composants¶
La section Version permet de consulter le numéro de version de GTF et le build installé. L”état des composants installés est consultables ainsi que les informations relatives au serveur et serveur web.
Informations PHP¶
La section « PHP Info » permet de consulter les paramètres de la version PHP installée.
Fichier de licence FME¶
Cette section « Licence » permet de faire une demande de fichier de licence, de l”installer puis de l”activer.
Le bouton Demande de fichier de licence permet d”envoyer au service administratif de Veremes une demande de génération de fichier de licence. Indiquer le numéro de licence fourni dans l”accusé de réception de votre commande, ainsi que l”adresse mail à laquelle le fichier doit être envoyé.
Une fois obtenu, indiquer l”emplacement du fichier de licence délivré par Veremes dans le champ « Fichier .txt », puis cliquer sur Activer.
Configuration du module GTF¶
Cette section permet l”édition des paramètres de configuration spécifiques au module GTF.
Le répertoire du Pycron est à définir dans le champ « Répertoire de Pycron », ainsi que le modèle d”e-mail utilisé par défaut pour l”envoi des notifications des résultats des traitements.
On peut exclure des formats de la compression en définissant les extensions de fichiers non compressibles.
Les formats de fichiers uniques tels que .xls, .html, .htm sont par défaut non compressibles.
Configuration du serveur SMTP¶
Les paramètres du serveur SMTP sont configurables dans cette rubrique.
L”adresse mail et le nom de l”expéditeur des mails de notification sont définis ainsi que le nom du serveur SMTP et le port qu”il utilise.
L”authentification SMTP permet de définir si l”expéditeur peut envoyer des mails sans avoir à s”authentifier. Si une authentification est requise, alors le compte SMTP et le mot de passe SMTP doivent être renseignés.
Configuration des moteurs GTF¶
L”administrateur de GTF peut définir les heures creuses d”exécution des moteurs au format « hh:mm » ainsi que le nombre maximum de demandes exécutées en même temps.
Configuration des répertoires Public et Upload¶
Les répertoires Upload et Public, installés dans le répertoire d”installation de GTF, stockent respectivement les ressources chargées avec un projet et les résultats d”un traitement. Il est possible de déplacer ces deux répertoires sur un autre disque et d”assurer de la sorte une répartition des données pour faciliter les processus de sauvegarde.
Pour cela, l”administrateur doit opérer en deux étapes :
- Dans le fichier de configuration « properties_post.inc » du répertoire « .\gtf.client », modifier les deux properties suivantes en indiquant le chemin complet des répertoires upload et public :
- $properties[“upload_dir”] = $properties[“gtf_home”] . “/upload”;
- $properties[“dir_export”] = $properties[“gtf_home”] . “/public”;
- Dans le fichier de configuration « httpd.conf » du répertoire .\server\Apache2.4\conf du répertoire d”installation de GTF, modifier la configuration :
- Alias /public « C:/serveur/gtf_2015-01.00.b12674_betax64/public » en indiquant le chemin complet
- <Directory C:/serveur/gtf_2015-01.00.b12674_betax64/public> en indiquant le chemin complet du répertoire public.
Nettoyage et suppression des fichiers temporaires¶
L”administrateur doit veiller à supprimer régulièrement les fichiers temporaires générés par l”application.
Il dispose pour cela du projet FME « nettoyage_des_fichiers_temporaires.fmw » contenu dans le fichier « admin.gex », disponible sur notre site de téléchargement. Après avoir importé et publié ce projet dans GTF, l”administrateur peut s”abonner au traitement et assurer de la sorte une suppression régulière des fichiers temporaires.
3 types de fichiers peuvent être supprimés :
- Les fichiers temporaires produits par GTF
- Les fichiers temporaires produits par FME
- Les jeux de données sources chargés sur le serveur par les utilisateurs finaux contenus dans le répertoire <gtf>\upload
Le paramètre « Age minimum des fichiers à supprimer » permet de définir l”ancienneté minimale (en jours) des fichiers à supprimer évitant ainsi la suppression de fichiers déposés sur le serveur sans avoir été traités ou en cours d”exécution.
Un rapport de nettoyage dont le nom est défini par l”utilisateur est généré au format.txt.