Dans le cadre d'une livrasion on-premises, il faut prendre en compte 3 particularités :

• la machine sur laquelle sera installée le plugin ne sera pas forcément connectée à Internet, il faudra donc nécessairement avoir recours à l'installation à partir d'un .zip;

• le plugin devra interragir avec l'API et l'APP on-premises installées chez le client et pas avec les versions SAAS comme c'est le cas dans le cas de figure standard, il faudra donc modifier le contenu du fichier config.json;

• le fichier client_secrets.json d'authentification à l'API Isogeo ne pourra pas être téléchargé depuis manage, il devra donc être créé manuellement.

Compte tenu de ces éléments, voici la marche à suivre pour livrer le plugin QGIS en on-premises :

• récupérer le .zip correspondant à la dernière version du plugin QGIS Isogeo (dans "Extensions (Dossier Produit)\QGIS\version_en_prod\isogeo_search_engine.zip")

• extraire tout le contenu du .zip de sorte à pouvoir l'enrichir

• faire le nécessaire pour passer de l'arborescence "...\isogeo_search_engine\isogeo_search_engine\..." à "...\isogeo_search_engine\..."

• dans le dossier "isogeo_search_engine" créer un fichier config.json

• se renseigner auprès de l'équipe technique pour obtenir l'équivalent des 3 URLs suivantes dans l'environnement on-premises du client :

  • https://v1.api.isogeo.com (api_v1_url)

  • https://id.api.isogeo.com (api_id_url)

  • https://app.isogeo.com (app_url)

• éditer le fichier config.json de la manière suivante :

  {
      "api_base_url": "<api_v1_url>",
      "api_auth_url": "<api_id_url>",
      "app_base_url": "<app_url>"
  }

• créer un sous-dossier "isogeo_search_engine\_auth"

• dans le sous-dossier "isogeo_search_engine\_auth" créer un fichier client_secrets.json

• se renseigner auprès de l'équipe technique pour obtenir :

  • l'identifiant de l'application "Plugin QGIS" inscrit dans la BDD on-premises du client (application_id)

  • le mot de passe de l'application "Plugin QGIS" inscrit dans la BDD on-premises du client (application_secret)

• éditer le fichier client_secrets.json de la manière suivante :

  {
      "web": {
          "client_id": "<application_id>",
          "client_secret": "<application_secret>",
          "scopes": [
              "resources:read"
          ],
          "auth_uri": "<api_id_url>/oauth/authorize",
          "token_uri": "<api_id_url>/oauth/token",
          "kind": "public",
          "isogeo_type": "group",
          "isogeo_staff": false
      }
  }

• zipper le dossier "isogeo_search_engine"

Le .zip ainsi obtenu est prêt à être envoyé au client qui pourra ainsi installer le plugin QGIS Isogeo depuis l'onglet "Installer depuis un ZIP" du gestionnaire des extensions QGIS. Une fois installé, l'extension doit être activée en cochant la case "Isogeo" dans l'onglet "Installées" du gestionnaire des extensions QGIS.

Au premier lancement du plugin, l'authentification à l'API Isogeo on-premises du client devrait se faire automatiquement, sans que le formulaire d'authentification ne s'ouvre grâce :

• au fichier config.json qui contient les URLs que le plugin QGIS doit utiliser pour interragir avec l'API et l'APP on-premises du client;

• au fichier client_secrets.json du sous-dossier "isogeo_search_engine\_auth" qui aura été rempli avec les credentials de l'application tels qu'ils sont inscrits dans la BDD on-premises du client.

Pour valider que l'authentification s'est déroulée correctement, il faut vérifier :

• que la valeur indiquée dans le champ "URL de l'API" de la fenêtre d'authentification correspond bien à la valeur api_v1_url indiquée dans le fichier config.json;

• que les informations sur l'application sont bien affichées dans la rubrique "Authentification" de l'onglet "Paramètres";

• que les listes déroulantes de l'onglet "Recherche" sont remplies et que le bouton d'affichage des résultats est orange.

Si aucun partage n'a encore été configuré dans APP pour alimenter l'application, ou qu'aucun catalogue ne lui est partagé, un bandeau s'affichera pour en informer l'utilisateur :

Il y est inscrit "Aucun partage n'alimente le plugin. Pour accéder à vos ressources via le plugin, au moins un catalogue contenant au moins une métadonnée doit lui être partagé.". Dans cette situation, l'onglet "Recherche" restera grisé et aucune information ne sera affichée dans la rubrique "Authentification" de l'onglet "Paramètres". Il est néanmoins possible de vérifier que la valeur indiquée dans le champ "URL de l'API" de la fenêtre d'authentification correspond bien à la valeur api_v1_url indiquée dans le fichier config.json.