Configuration globale¶

L'outil en ligne de commande requiert une configuration lors de son exécution. La configuration se fait via un fichier d'environnement .env qui est passé en paramètre de la ligne de commande avec l'option --settings.

Il est donc possible de créer plusieurs fichiers d'environnement et de passer l'un ou l'autre à chaque exécution pour s'adapter à différents cas d'usage.

Environnement global¶

Option	Explication	Exemple
DEBUG	Booléen. Détermine le niveau de journalisation. Si activé, tous les messages sont journalisés.	1

Réseau¶

Option	Explication	Exemple
HTTP_PROXY	Adresse et paramètres du proxy pour le protocole HTTP	"http://user:pass@ip.proxy.local:port/"
HTTPS_PROXY	Adresse et paramètres du proxy pour le protocole HTTP	"https://user:pass@ip.proxy.local:port/"
FULL_OFFLINE_MODE	Booléen. Active/désactive le mode déconnecté. Si activé, aucune requête réseau ne sera envoyée.	0
SSL_VERIFICATION	Booléen. Active/désactive la vérification des certificats SSL. Utile pour les infrastructures ou le proxy est capricieux avec les connections HTTPS.	0

Processor¶

Option	Explication	Exemple
ISOGEO_MD_PROCESSOR_WORKER_NAME	Identifiant du service Isogeo	wk-8 premiers chiffres de l'id du groupe de travail
ISOGEO_MD_PROCESSOR_INPUT_FOLDER	Répertoire duquel charger les métadonnées à gérer	"D:\Isogeo\Scan\MetadataProcessor_input"
ISOGEO_MD_PROCESSOR_OUTPUT_FOLDER	Répertoire de stockage des fichiers traités	"./_output"
ISOGEO_MD_PROCESSOR_LOGS	Répertoire de stockage des logs	"./_logs"
ISOGEO_MD_PROCESSOR_DATABASE_TYPE	Type de base de données dans laquelle importer les métadonnées traitées. Voir plus bas	"elastic-search" # or "isogeo"
ISOGEO_MD_PROCESSOR_CLEAN_FREQUENCY	Période de nettoyage des dossiers ci-dessus (jours)	31

Isogeo¶

Uniquement lorsque l'outil est utilisé pour synchroniser les métadonnées avec Isogeo.

Option	Explication	Exemple
ISOGEO_PLATFORM	Indique vers quelle version de la plateforme Isogeo pointer.	`qa` ou `prod`
ISOGEO_API_URL	URL de base vers l'API Isogeo	"https://v1.api.isogeo.com"
ISOGEO_ID_URL	URL de base de l'auhtentification à l'API Isogeo	"https://id.api.isogeo.com"
ISOGEO_GROUP_ID	Identifiant du groupe de travail	"08c30547575"
ISOGEO_USER_NAME	Adresse email du compte Isogeo à utiliser pour la création/l'édition des métadonnées
ISOGEO_USER_PASSWORD	Mot de passe du compte Isogeo à utiliser pour la création/l'édition des métadonnées
ISOGEO_API_USER_LEGACY_CLIENT_ID	`ClientId` de l'application oAuth2 à utiliser pour écrire avec l'API Isogeo
ISOGEO_API_USER_LEGACY_CLIENT_SECRET	`ClientSecret` de l'application oAuth2 à utiliser pour écrire avec l'API Isogeo

Base de données¶

Uniquement lorsque l'outil est utilisé pour synchroniser les métadonnées avec une base de données autre qu'Isogeo. les paramètres dépendent beaucoup de type de base de données sélectionné.

Option	Explication	Exemple
DATABASE_FOLDER	Répertoire de stockage de la base de données. Uniquement lorsque `ISOGEO_MD_PROCESSOR_DATABASE_TYPE=sqlite`	"./_database/"
DATABASE_HOST	Hôte (serveur) de la base
DATABASE_PORT	Port de connexion à la base	`5432`
DATABASE_SSL		1
DATABASE_USER	Utilisateur en base avec droits d'écriture	`postgres`
DATABASE_PASSWORD	Mot de passe de l'utilisateur
DATABASE_POOL_CONNECTIONS	Nombre de connexions concurrentes à la base autorisées	10

Développement¶

Options réservées à l'équipe Isogeo.

Option	Explication	Exemple
WORKGROUP_TEST_UUID	Identifiant unique du groupe de travail de test
FIXTURES_DIR	Répertoire contenant des fichiers de test
SYNCHRONOUS_MODE	Option pour que les scripts FME soient exécutés en mode synchrone (1 par 1). Lent mais pratique pour le support/débogage	0

Fichier exemple¶

L'application est livrée avec un fichier de configuration d'exemple qui donne également les valeurs par défaut :

# - GLOBAL ENVIRONMENT ---------------------------
DEBUG=1
LANGUAGE=fr_FR

# -- NETWORK -----------------------------------
# PROXIES - CAN BE:
#   - HTTP: 'http://user:pass@ip.pr.ox.y:port/'
#   - SOCKS: 'socks5://user:pass@host:port'

HTTP_PROXY=
HTTPS_PROXY=
FULL_OFFLINE_MODE=0
SSL_VERIFICATION=1
URLS_TO_CHECK="./urls_network_check.txt"

# METADATA PROCESSOR
ISOGEO_MD_PROCESSOR_CLEAN_FREQUENCY=31
ISOGEO_MD_PROCESSOR_DATABASE_FOLDER="./_database/"
ISOGEO_MD_PROCESSOR_DATABASE_TYPE="elastic-search"  # or "isogeo" | "postgresql" | "sqlite"
ISOGEO_MD_PROCESSOR_INPUT_FOLDER="./_input"
ISOGEO_MD_PROCESSOR_LOGS="./_logs"
ISOGEO_MD_PROCESSOR_NAME=
ISOGEO_MD_PROCESSOR_OUTPUT_FOLDER="./_output"

# ISOGEO - Most used with azure FaaS - no need when deployed in local
ISOGEO_API_URL=
ISOGEO_API_USER_LEGACY_CLIENT_ID=
ISOGEO_API_USER_LEGACY_CLIENT_SECRET=
ISOGEO_GROUP_ID=
ISOGEO_ID_URL=
ISOGEO_PLATFORM=qa
ISOGEO_USER_NAME=
ISOGEO_USER_PASSWORD=

# DATABASE
DATABASE_TYPE="elastic-search"  # or sqlite | postgresql
DATABASE_HOST=  # for a SQLite database, specify the path to the parent folder
DATABASE_PORT=
DATABASE_SSL=
DATABASE_USER=
DATABASE_PASSWORD=
DATABASE_POOL_CONNECTIONS=10

# DEVELOPMENT
FIXTURES_DIR=
SYNCHRONOUS_MODE=0
WORKGROUP_TEST_UUID=

Dernière mise à jour: 22 avril 2020