installer et configurer le site Web ArcGIS Survey123

Résumé

Certaines organisations sont parfois contraintes de travailler dans des environnements complètement déconnectés, sans accès externe à Internet. D'autres sont connectées mais doivent héberger le site Web ArcGIS Survey123 et/ou l'API REST Survey123 dans leur infrastructure propre.

L'API REST Survey123 permet de convertir vos configurations d'enquête dans des formats utilisable dans les applications Survey123 (application de champs/formulaire Web), telles que des fichiers .xlsx créés en ligne ou des configurations créées sur site Web. Le site Web, lui, offre les fonctionnalités de création et de gestion des enquêtes et permet de consulter et d'analyser les données collectées. Les deux composants sont distincts mais ils collaborent pour offrir les fonctionnalités présentées sur le site Web ArcGIS Survey123 (https://survey123.arcgis.com).

Qu'est-ce qui est inclus ‏?
L'installation en local de l'API REST Survey123 et du site Web, qui permet de créer et publier les enquêtes de Survey123 Connect, ou le site Web sur votre infrastructure propre. Vous avez ainsi accès à la quasi totalité des fonctionnalités du site Web ArcGIS Survey123, à l'exception notable que l'API de reporting ne peut pas être hébergée en local.

Qu'est-ce qui est requis ?
Il faut télécharger le fichier d'installation sur le site Web My Esri. Les étapes d'installation décrites ci-dessous concerne les installations sous Windows uniquement. Sont également requis des identifiants de connexion en tant qu'administrateur au portail ArcGIS Enterprise, ainsi qu'un accès d'administrateur au serveur Web. L'installation du site Web Survey123 peut être déployée sur le même poste que l'instance du Portail ou sur un serveur Web autonome. Le site Web Survey123 installé a été testé avec succès avec le portail ArcGIS Enterprise version 10.5.1 et versions ultérieures. En revanche, la version initiale ne prend officiellement en charge que la version 10.7 et les versions ultérieures.

Procédure

Type
Décompressez le fichier téléchargé sur le poste désiré et exécutez le fichier Setup.exe. Acceptez le contrat principal, choisissez l'emplacement de l'installation et cliquez sur Install (Installer). Le processus peut prendre jusqu'à 30 minutes environ. Lorsqu'il est terminé, cliquez sur Finish (Terminer) pour quitter l'installation.

Post-installation
Les étapes de configuration du site Web Survey 123 installé varient selon l'environnement ArcGIS Enterprise. Reportez-vous à la section qui vous correspond ci-dessous.

Remarque : votre navigateur peut rencontrer un avertissement de sécurité. Acceptez-le et continuez sur le site Web. Il sera résolu en configurant un certificat en phase de post-installation.

Remarque : faites une sauvegarde du fichier config.json (l'emplacement par défaut est C:\Program Files\ArcGIS\Survey123website) avant d'exécuter la post-installation. Si l'installation est mal configurée, ce fichier permet de restaurer et de redémarrer (ou de mettre à jour manuellement le fichier config.json existant).

ArcGIS Enterprise avec authentification intégrée
Exécutez la post-installation en ouvrant https://localhost:5443/share/post-install.html sur le poste de l'installation.

La post-installation se présente sous forme d'assistant de type enquête qui vous guide dans la mise à jour du fichier config.json. Cela permet de configurer les éléments suivants :

• URL par défaut d'ArcGIS Portal (points d'installation avec ArcGIS Online par défaut)
• Identifiants de connexion en tant qu'administrateur à ArcGIS Portal (nécessaires pour définir l'URI de redirection pour la connexion au portail)
• API JavaScript ArcGIS (requise pour les environnements déconnectés)
• Ports HTTP(s)
• Certificat(s) SSL
• URL hôte du site Web Survey123 (il s'agit de l'URL http ou https du post qui héberge votre site Web Survey123 - n'oubliez pas d'inclure le numéro du port) Elle est ajoutée en tant que redirectURI à votre portail pour permettre de se connecter.
• Paramètres pour environnements déconnectés. Si vous répondez Oui à la question 'Are you installing the Survey123 website in a disconnected environment with no internet access?' (Installez-vous le site Web Survey123 dans un environnement déconnecté sans accès à Internet ?), les propriétés de Survey123 Organization sont paramétrées pour empêcher Survey123 Connect de passer des appels Internet (pour des didacticiels vidéo, Twitter, Geonet ou autres).

Lorsque vous confirmez les paramètres et cliquez sur Submit (Envoyer), le fichier config.json est mis à jour et :

• Le ou les fichiers de certificat sont importés dans ~ArcGIS\Survey123website\server\dist\cert\ folder
• L'URL hôte du site Web Survey123 est ajoutée en tant que redirectURI à l'AppID (ID de l'application) survey123hub.
• Les propriétés de Survey123 Organization sont mise à jour (basemapsGroupQuery, showCommunityContent et showTutorialContent)

Ouvrez le fichier config.json dans un éditeur de texte pour afficher les paramètres mis à jour.

ArcGIS Enterprise avec authentification Windows (IWA)

• Si le site Web Survey123 n'est pas installé sur la même URL hôte qu'ArcGIS Enterprise, reportez-vous à la section Exécuter la post-installation manuellement.
• Si le site Web Survey123 est installé sur la même URL hôte qu'ArcGIS Enterprise, accédez à l'URL de post-installation suivante pour autoriser l'utilisation des identifiants de connexion ArcGIS Enterprise (IWA) depuis le navigateur :
  https://<survey123website.domain.com>:5443/share/post-install.html
  Cela permet d'utiliser les identifiants de connexion ArcGIS Enterprise (IWA) depuis le navigateur.

La post-installation configure tous les éléments répertoriés ci-dessus mais requiert qu'un administrateur ArcGIS Enterprise ajoute manuellement l'URL hôte du site Web Survey123, https://<survey123website.domain.com>:5443, en tant que redirectURI au portail pour autoriser la connexion :

1. Connectez-vous à l'interface REST administrateur du portail, par exemple :
   https://portal_webadaptorhost.domain.com/portal_webadaptorname/portaladmin
2. Allez à to Security (Sécurité) > OAuth > Get App Info (Obtenir les infos de l’application), saisissez l'App ID (ID de l'application) survey123hub, puis cliquez sur Get App Info (Obtenir les infos de l’application).
3. Copiez le contenu de la réponse.
4. Revenez à OAuth et cette fois, allez à Update App Info (Mettre à jour les infos de l’application).
5. Copiez et collez la réponse dans la zone de saisie en veillant à ajouter l'URL que vous utiliserez pour accéder à votre site Web Survey123 à la liste des redirectURIs et cliquez sur Update App (Mettre à jour l'application). Elle peut très bien inclure le point d'accès au proxy inversé si vous comptez en paramétrer un, par exemple :
   https://survey123website.domain.com/survey123
6. Répétez l'étape 2 pour confirmer que votre redirectURI supplémentaire a bien été ajoutée à la liste.

Exécuter la post-installation manuellement

1. Dans un navigateur du serveur de votre site Web Survey123, allez à https://localhost:5443/api/setupPyxform. Vous devez obtenir une réponse 'success':true. Ce processus est exécuté automatiquement lors de l'utilisation de l'assistant de post-installation.
2. Copiez vos fichiers de certificats (.pfx ou .pem) dans le dossier cert de l'installation, par exemple :
   C:\Program Files\ArcGIS\Survey123website\server\dist\cert\
   • Si vous utilisez un fichier .pfx, vous devez chiffrer le mot en passe en faisant une demande à votre API REST Survey123 installée. La réponse peut ensuite être copiée dans votre fichier config.json (voir plus bas).
   • Cela s'effectue en ajoutant votre mot de passe .pfx à l'URL API à l'aide de encrypt?text= parameter, par exemple :
     https://localhost:5443/api/encrypt?text=<your_pfx_password>
   • La réponse sera au format : {'result':'a6c2812bed063dd9be'} ; copiez simplement le résultat, à savoir a6c2812bed063dd9be, dans le fichier config.json pour l'utiliser ultérieurement.
   
   
3. Un administrateur ArcGIS Enterprise doit ajouter manuellement l'URL hôte du site Web Survey123, par exemple :
   https://<survey123website.domain.com>:5443 - Il s'agit de la redirectURI vers votre portail.Reportez-vous aux étapes 1 à 5 de la section précédente.
4. Vérifiez si votre portail limite les domaines pouvant se connecter via CORS (Cross-Origin Resource Sharing) à ArcGIS REST API.
   1. Connectez-vous à votre organisation ArcGIS Online en tant qu'administrateur et accédez au groupe Organization (Organisation) > Settings (Paramètres) > Security (Sécurité) > Allow origins (Autoriser les origines). Par défaut, tous les domaines sont autorisés, ce qui signifie qu'aucune URL n'est répertoriée ici. Si vous limitez déjà les domaines, ajoutez votre URL hôte Survey123 à la liste.
   2. Cliquez sur Add (Ajouter) et ajouter l'URL hôte de votre site Web Survey123. Par exemple :
      https://<survey123website.domain.com>:5443
   3. Cliquez sur Add domain (Ajouter un domaine). Cela autorise votre domaine de l’application Web Survey123 à se connecter via CORS (Cross-Origin Resource Sharing) à ArcGIS REST API.
   
   
5. Ouvrez le fichier config.json dans un éditeur de texte. Il se trouve dans le dossier racine du site Web Survey123, par exemple :
   C:\Program Files\ArcGIS\Survey123website
   1. Mettez à jour les paramètres suivants en fonction de vos besoins :
      • portalUrl : URL ArcGIS Enterprise, par exemple :
        https://portal_webadaptorhost.domain.com/portal_webadaptorname
      • arcgisJsAPi3Url : URL de l'API JavaScript v3.x ArcGIS, par exemple :
        https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi/init.js
      • arcgisJsApiUrl : URL de l'API JavaScript v4.x ArcGIS, par exemple :
        https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi4/init.js
      • httpPort : port HTTP du site Web Survey123 (5080, par défaut)
      • httpPort : port HTTPS du site Web Survey123 (5443, par défaut)
      • https.cert : chemin d'accès à votre site Web Survey123 HTTPS certificat du serveur Ascii Base64 (.pem) ('./server/dist/cert/cert.pem' par défaut).
      • https.key : chemin d'accès à votre site Web Survey123 HTTPS clé du certificat du serveur Ascii Base64 (.pem) ('./server/dist/cert/key.pem' par défaut).
      • https.pfx : chemin d'accès à votre site Web Survey123 HTTPS certificat de fichier binaire (.pfx), par exemple :
        './server/dist/cert/your_certificate.pfx'
      • https.passphrase : mot de passe chiffré pour votre site Web Survey123 HTTPS certificat de fichier binaire. Utilisez le résultat stocké dans https://localhost:5443/api/encrypt?text=<your_pfx_password> comme expliqué plus haut pour obtenir le mot de passe chiffré.
      
      
   2. Enregistrez le fichier config.json.
   3. Redémarrez le service Windows du site Web ArcGIS Survey123 pour que les modifications prennent effet.