ArcGIS Survey123 peut être intégré à d’autres applications par le biais de liens vers l’application de terrain ou l’application Web Survey123. Les liens vers l’application Web commencent par https://survey123.arcgis.com/share. Les liens vers l’application de terrain peuvent être des liens Survey123 ou des liens de structure d’URL personnalisée.
Les liens Survey123Survey123 commencent par https://survey123.arcgis.app et fonctionnent uniquement sous iOS et Android. Les liens Survey123 sont conformes aux exigences définies par l’App Store et Google Play, permettent la liaison à davantage d’applications, et prennent en charge les liens abrégés, qui sont plus faciles à partager.
Les liens de structure d’URL personnalisée commencent par arcgis-survey123:// et fonctionnent sous Windows, sous Android et avec un groupe d’applications précis sous iOS. Les liens de structure d’URL personnalisée ne peuvent pas être abrégés et peuvent être difficiles à ouvrir sous Android. Envisagez de présenter les liens de structure d’URL personnalisée sous forme d’hyperliens, comme suit :
<a href="arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19">Open survey</a>
Avant d’utiliser un lien qui contient des paramètres permettant de lancer une enquête dans l’application de terrain, il est préférable que l’application soit déjà installée sur l’appareil. Pour plus d’informations, reportez-vous à la rubrique Installer l’application de terrain Survey123.
Paramètres d’une application de terrain
Les paramètres suivants permettent de personnaliser le mode d’ouverture d’une application de terrain :
| Paramètre | Description | Exemple | Type |
|---|---|---|---|
center | Centre la carte sur la latitude connue, la longitude et éventuellement l’altitude. | center=37.8199,-122.4783,20 | Chaîne |
field:fieldname | Renseigne les questions de l’enquête avec des valeurs de champ. | field:surname=Klauser | Chaîne |
portalUrl | Spécifie l’URL du portail où l’élément d’enquête est hébergé. | portalUrl=https://myorg.arcgis.com | Chaîne |
itemID | Spécifie le formulaire à ouvrir. | itemID=36ff9e8c13e042a58cfce4ad87f55d19 | UUID |
download | Télécharge automatiquement l’enquête lorsque l’appareil est en ligne. La valeur par défaut est true. | download=false | Booléen |
action | Spécifie le mode d’ouverture de l’enquête. Les valeurs prises en charge sont collect (par défaut), edit, view et copy. | action=edit | Chaîne |
folder | Spécifie le dossier à parcourir lorsque le paramètre filter est utilisé. Les valeurs prises en charge sont inbox, drafts, outbox, sent et * (tous les dossiers). | folder=drafts | Chaîne |
callback | Spécifie l’URL de renvoi lorsqu’une action de formulaire (par exemple envoyer, ajouter aux brouillons, annuler ou quitter) est réalisée. | callback=https://quickcapture.arcgis.app | URL |
callback:status | Spécifie le statut de l’enquête lorsque le rappel est activé. Les valeurs prises en charge pour le statut sont cancel, draft, submit et close. Le statut close peut être utilisé uniquement lorsque action=view. | callback:draft=https://quickcapture.arcgis.app | Chaîne |
filter | Recherche une chaîne spécifique dans les enquêtes existantes sur l’appareil. Fournissez le nom d’un champ spécifique pour ne rechercher la chaîne désirée que dans ce champ. | filter=Klauser | Chaîne |
update | Actualise le champ Inbox (Boîte de réception) et tente d’envoyer les enquêtes vers le champ Outbox (Boîte d’envoi). La valeur par défaut est false. | update=false | Booléen |
q:queryparameter | Recherche un enregistrement existant dans la couche d’entités. Ce paramètre peut servir à extraire du contenu qui n’est pas présent sur l’appareil. | q:where=ws_stationnumber=5171 q:where=waterbodytype='Lake' q:globalId=1d392670-33e2-456d-8435-7fad3abd8bb9 | Chaîne |
Paramètres d’une application Web
Les paramètres suivants permettent de personnaliser le mode d’ouverture d’une application Web :
| Paramètre | Description | Exemple | Type |
|---|---|---|---|
center | Centre la carte sur la latitude connue, la longitude et éventuellement l’altitude. | center=37.8199,-122.4783,20 | Chaîne |
field:fieldname | Renseigne les questions de l’enquête avec des valeurs de champ. | field:surname=Klauser | Chaîne |
portalUrl | Spécifie l’URL du portail où l’élément d’enquête est hébergé. | portalUrl=https://myorg.arcgis.com | Chaîne |
| open | Spécifie l’application utilisée pour ouvrir l’enquête. Les valeurs valides sont web, qui ouvre l’enquête dans l’application Web (par défaut), native, qui ouvre l’enquête dans l’application de terrain si cette dernière est installée et menu, qui ouvre une page Web qui permet d’indiquer l’application qui ouvrira l’enquête. | open=web | Chaîne |
| hide |
Masque les éléments de l’enquête dans l’application Web. Le paramètre peut accepter plusieurs valeurs séparées par une virgule. Les valeurs valides sont navbar (barre en haut de l’enquête, avec les options permettant de se connecter, de se déconnecter et de changer de langue), header, description, footer, submit, theme et leaveDialog (message d’avertissement affiché lorsque l’utilisateur s’éloigne de la page ou la ferme). Vous pouvez également utiliser le paramètre field:fieldName pour masquer une question, un groupe, une page ou une répétition spécifique, en en spécifiant le nom au lieu de fieldName. Remarque :Les questions dans les répétitions ne peuvent pas être masquées individuellement. | hide=header,description,footer,theme | Chaîne |
| locale | Permet à l’enquête de passer d’une langue à l’autre. Fonctionne uniquement si l’enquête comprend plusieurs langues. | locale=zh-cn | Chaîne |
| mode | Définit le mode de l’application Web. Les valeurs valides sont edit, qui permet à l’enquête de modifier une entrée existante plutôt que d’en créer une ; view qui ouvre une entrée existante en lecture seule et copy, qui crée une enquête dont le contenu correspond à l’entrée spécifiée. Lorsque vous utilisez ce paramètre, le paramètre globalId doit également être indiqué. | mode=edit&globalId=42db492cb06111ea... | Chaîne |
| globalId | Spécifie l’enregistrement de l’enquête qui est chargé dans le formulaire. Les valeurs valides sont les ID globaux des enregistrements existants de l’enquête. Le nom de ce paramètre est sensible à la casse. | globalId=42db492cb06111ea... | Chaîne |
recalculate | Peut uniquement être utilisé avec mode=edit. Force les questions spécifiées à être recalculées lorsque l’enquête est chargée, sans utiliser le bouton Recalculate (recalculer). | recalculate=field:question1,field:question2 | Chaîne |
| version | Définit la version de l’application Web qui sera utilisée. La seule valeur valide est latest, qui utilise la dernière version de l’application Web, même si la version de l’enquête est verrouillée. | version=latest | Chaîne |
| token | Transmet un jeton valide pour une enquête. Vous pouvez utiliser ce paramètre pour autoriser les participants à répondre à une enquête nécessitant un compte ArcGIS sans se connecter. | token= E60M4Gsc-h4Q8plqQ... | Chaîne |
autoReload | Recharge l’enquête après la soumission. Spécifiez le délai (en secondes) avant le rechargement de l’enquête. Était auparavant appelé autoRefresh. Le paramètre autoRefresh est pris en charge dans le cadre de la rétrocompatibilité. | autoReload=3 | Entier |
| encodeUrlParams | Masque les paramètres d’URL. L’URL obtenue comprend en revanche un paramètre code qui représente tous les paramètres codés. Les paramètres inclus en dehors de ce paramètre code sont ignorés. | encodeUrlParams=true | Booléen |
width | Définit la largeur de l’enquête, en pixels. Cela affecte également d’autres contrôles dans l’enquête, par exemple les zones de texte. | width=1000 | Entier |
Remarque :
Le paramètre field:fieldname prend en charge les questions de type géopoint, géotrace et géoforme dans l’application Web. Pour les questions de type géopoint, indiquez la latitude, la longitude et l’altitude (facultatif) séparées par des espaces. S’agissant de la géotrace et de la géoforme, indiquez pour chaque sommet la latitude et la longitude séparées par un espace, chaque paire de coordonnées étant séparées par un point-virgule. Cet exemple fonctionne pour une question de type géoforme :
field:geoshape=-37.842156723211474 144.95942945338243;-37.83554486071995 144.9726235713864;-37.85681405373047 144.98240735651922;-37.85954045531896 144.97715349053766
Lien vers Survey123 à partir d’un navigateur Web de bureau
Vous pouvez créer un lien pour ouvrir l’application de terrain qui peut être incorporée dans une autre application. Ce même lien peut servir au test dans un navigateur Web.
Remarque :
Une fois le lien créé, vous pouvez remplacer arcgis-survey123:// par https://survey123.arcgis.app comme lien Survey123 à utiliser sur iOS ou Android.
Procédez comme suit pour créer une structure d’URL personnalisée et l’utiliser dans un navigateur Web de bureau :
- Tapez arcgis-survey123:// dans votre navigateur.L’application de terrain Survey123 s’ouvre (ou vous êtes invité à l’ouvrir).
Remarque :
Pour lancer et télécharger une enquête depuis un portail donné, incluez le paramètre d’URL du portail, par exemple, arcgis-survey123://?portalUrl=host.domain.com/webadaptor (où host, domain et webadaptor sont remplacés par les informations de votre portail).
- Pour ajouter votre enquête à l’URL que vous construisez, ajoutez ?itemID= et l’ID d’élément de votre formulaire à l’URL.L’URL doit ressembler à ce qui suit :
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19Si vous testez votre URL, celle-ci doit maintenant ouvrir l’application de terrain Survey123 et ouvrir immédiatement votre enquête.
Remarque :
Si l’enquête n’est pas encore sur votre appareil, elle est téléchargée.
- Incluez une référence au champ utilisant le nom qui lui est attribué dans XLSForm (et non son étiquette) dans votre URL. Par exemple, pour renseigner le champ Surname (Nom), saisissez &field:Surname= et la valeur.
Le paramètre & joue le rôle de séparateur et field: désigne le nom de la question à renseigner.
L’URL doit ressembler à ce qui suit :arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=KlauserVous pouvez maintenant utiliser l’URL pour ouvrir l’application de terrain Survey123 et l’enquête, puis renseigner la question donnée avec la réponse que vous avez définie. Vous pouvez renseigner plusieurs questions dans une seule URL d’enquête. Les noms de champ sont sensibles à la casse.
- Saisissez ¢er=, puis entrez les coordonnées. Entrez les coordonnées de la latitude de la longitude en degrés décimaux, séparées par une seule virgule. Vous pouvez également ajouter l’altitude en mètres comme troisième valeur, également séparée par une seule virgule.
L’URL doit ressembler à ce qui suit :
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser¢er=37.8199,-122.4783,20Cette URL ouvre maintenant l’application de terrain Survey123 et l’enquête que vous avez choisie, renseigne une question de texte et fournit un emplacement par défaut pour la question géopoint.
- Sélectionnez Configure Pop-up (Configurer la fenêtre contextuelle) pour une couche existante de votre carte Web. Dans le menu déroulant d’affichage, sélectionnez A custom attribute display (Un affichage d’attribut personnalisé), cliquez sur Configure (Configurer), puis insérez un lien vers votre enquête.
Cette URL complèterait le champ Surname (Nom) avec le contenu de l’attribut du nom de l’entité plutôt qu’avec une valeur définie :
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname={name}Cette URL complèterait le champ hydrantGlobalID avec l’ID global de la bouche d’incendie sélectionnée :
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:hydrantGlobalID={globalid}
Vous pouvez également ajouter une référence unique à une enquête et l’ajouter à l’URL. Identifiez dans un premier temps l’ID d’élément de l’enquête à ouvrir. C’est la chaîne de caractères que ArcGIS Online utilise pour identifier de manière unique votre enquête, contenue dans l’URL de votre élément de formulaire dans ArcGIS Online. Par exemple, si l’URL de votre enquête est https://exampleurl.maps.arcgis.com/home/item.html?id=36ff9e8c13e042a58cfce4ad87f55d19, l’ID d’élément de votre formulaire est 36ff9e8c13e042a58cfce4ad87f55d19.
Remarque :
Par défaut, les valeurs peuvent uniquement être transmises pour sélectionner une ou plusieurs questions dans une fenêtre contextuelle d’une application Web si le nom et l’étiquette du choix correspondant sont identiques. Si les noms et étiquettes de votre liste de choix sont différents, vous pouvez utiliser les fonctions DomainCode ou UrlEncode dans une expression ArcGIS Arcade dans la fenêtre contextuelle pour transmettre la valeur de votre choix.
Les questions dans les répétitions ne peuvent pas être renseignées.
Lien vers Survey123 à partir d’une autre application
Vous pouvez créer un lien à utiliser dans des applications ArcGIS pour ouvrir Survey123 et capturer une enquête. Procédez comme suit pour créer un lien Survey123 et l’utiliser dans la fenêtre contextuelle d’une carte Web. Ce lien est entré dans la fenêtre contextuelle d’une carte Web dans votre organisation ArcGIS. Vous pouvez tester le lien à l’aide d’un navigateur Web (en procédant comme dans la section ci-dessus) sur un appareil iOS ou Android.
- Sélectionnez Configure Pop-up (Configurer la fenêtre contextuelle) pour une couche existante d’une carte Web qui sera affichée sur l’appareil.
- Dans le menu déroulant d’affichage, sélectionnez a custom attribute display (Un affichage d’attribut personnalisé), cliquez sur Configure (Configurer), puis insérez un lien vers votre projet.
- Pour URL, saisissez https://survey123.arcgis.app et pour Link Text (Texte du lien), saisissez Launch Survey123 (Lancer Survey123). Cliquez sur OK.
- Ouvrez votre carte Web sur un appareil mobile depuis un navigateur ou une application ArcGIS.
- Sélectionnez une entité et cliquez sur le lien Launch Survey123 (Lancer Survey123) dans la fenêtre contextuelle pour ouvrir Survey123.
- Pour ajouter votre enquête à l’URL que vous construisez, ajoutez ?itemID= et l’ID d’élément de votre formulaire à l’URL. L’URL doit ressembler à ce qui suit :
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19Si vous testez votre URL, celle-ci doit maintenant ouvrir l’application de terrain Survey123 et ouvrir immédiatement votre enquête.
Remarque :
Si l’enquête n’est pas encore sur votre appareil, elle est téléchargée.
- Incluez une référence au champ utilisant le nom qui lui est attribué dans XLSForm (et non son étiquette) dans votre URL. Par exemple, pour renseigner le champ Surname (Nom), saisissez &field:Surname= et la valeur.
Le paramètre & joue le rôle de séparateur et field: désigne le nom de la question à renseigner.
L’URL doit ressembler à ce qui suit :https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=KlauserVous pouvez maintenant utiliser l’URL pour ouvrir l’application de terrain Survey123 et votre enquête, puis renseigner la question donnée avec la réponse que vous avez définie. Vous pouvez renseigner plusieurs questions dans une seule URL d’enquête. Les noms de champ sont sensibles à la casse.
- Saisissez ¢er=, puis entrez les coordonnées. Entrez les coordonnées de la latitude de la longitude en degrés décimaux, séparées par une seule virgule. Vous pouvez également ajouter l’altitude en mètres comme troisième valeur, également séparée par une seule virgule.
L’URL définitive doit ressembler à ce qui suit :
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser¢er=37.8199,-122.4783,20Cette URL complète ouvre maintenant l’application de terrain Survey123 et l’enquête que vous avez choisie, renseigne une question de texte et fournit un emplacement par défaut pour la question géopoint.
Transmettre des paramètres à l’application Web Survey123
L’application Web Survey123 peut accepter des paramètres au même format que ceux de l’application de terrain. La seule différence réside dans le fait qu’un point d’interrogation doit être utilisé pour séparer l’ID d’élément de l’enquête et le premier paramètre, à la place du caractère esperluète (qui continue d’être utilisé pour séparer les paramètres). Dans l’URL figurant dans l’exemple suivant, le nom de famille et les paramètres de coordonnées sont transmis à une enquête dans l’application Web Survey123 :
https://survey123.arcgis.com/share/36ff9e8c13e042a58cfce4ad87f55d19?field:surname=Klauser¢er=37.8199,-122.4783L’application Web Survey123 prend également en charge un certain nombre de paramètres avec lesquels l’application de terrain Survey123 n’est pas compatible. Ces paramètres concernent la présentation de l’enquête dans un navigateur.
Remarque :
Si une valeur de paramètre contient des espaces, des signes plus (+) ou d’autres caractères spéciaux, ces caractères doivent être codés avec le signe pour cent. Pour plus d’informations, reportez-vous à la rubrique Coder des paramètres d’URL.
Transmettre des paramètres à Survey123 Connect
La structure d’URL utilisée par Survey123 Connect est arcgis-survey123connect://, où l’utilisateur peut automatiquement télécharger et ouvrir une enquête pour la modifier.
Cette structure d’URL accepte d’autres paramètres que l’application de terrain ou Web ; elle accepte l’ID d’élément du formulaire et l’URL du portail où l’élément est stocké. Cet exemple d’URL ouvre une enquête spécifique dans Survey123 Connect depuis le portail ArcGIS Enterprise fourni, en la téléchargeant le cas échéant :arcgis-survey123connect://?portalUrl=https://exampleportal.esri.com/arcgis&itemID=36ff9e8c13e042a58cfce4ad87f55d19
Si l’enquête est enregistrée dans ArcGIS Online, vous devez quand même indiquer l’URL du portail de ArcGIS Online, par exemple :
arcgis-survey123connect://?portalUrl=https://www.arcgis.com&itemID=36ff9e8c13e042a58cfce4ad87f55d19Remarque :
Ces paramètres d’URL ne permettent d’ouvrir que les formulaires dont vous êtes déjà propriétaire. Ils ne vous permettent pas d’ouvrir des enquêtes auxquelles vous avez accès mais que vous n’avez pas créées.
Lien vers d’autres applications à partir de Survey123
De nombreuses applications peuvent être ouvertes à partir de liens. Vous pouvez créer une URL qui ouvre une autre application et l’insérer dans votre enquête. Ces applications peuvent également accepter des paramètres personnalisés dans leur URL de la même façon que Survey123.
Pour commencer, vous devez ajouter une question de type remarque à l’enquête avec une étiquette contenant l’URL.
Remarque :
Sur les appareils iOS, les structures d’URL autres que HTTP et HTTPS doivent être ajoutées à une liste de structures approuvées dans l’application. Les structures d’URL suivantes sont approuvées dans Survey123 :
- arcgis-appstudio-player
- arcgis-quickcapture
- arcgis-collector ArcGIS Collector sur Windows uniquement
- arcgis-trek2there
- arcgis-navigator
- arcgis-workforce Workforce pour ArcGIS (Classic) uniquement
- comgooglemaps
- foreflightmobile
- waze
- spike-partner
Pour référencer Field Maps et la nouvelle version de Workforce, vous devez utiliser un lien d’application qui commence par HTTP ou HTTPS.
Pour obtenir des informations sur les applications Esri courantes qu’il est possible d’ouvrir via Survey123, reportez-vous aux rubriques d’aide suivantes :
Coder des paramètres d’URL
Même si les paramètres d’URL non codés fonctionnent dans certains environnement, il est conseillé de les coder. Le codage remplace les caractères non valides par le signe de pourcentage (%) suivi de leur équivalent hexadécimal.
Par exemple, voici un lien Survey123 qui utilise un rappel pour revenir à un projet spécifique dans QuickCapture avec des paramètres qui ne sont pas codés :
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https://quickcapture.arcgis.app?itemID=867895a71a1840399476fc717e76bb43Voici la même URL avec des paramètres codés :
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https%3A%2F%2Fquickcapture.arcgis.app%3FitemID=867895a71a1840399476fc717e76bb43Un signe égal qui indique une rupture entre une clé et sa valeur ne doit pas être codé.
Pour créer des paramètres codés, vous pouvez utiliser ArcGIS Arcade. La fonction UrlEncode vous permet de définir un ensemble de paires clés-valeurs représentant chaque paramètre et de générer une URL avec le codage approprié.
L’auteur d’une enquête peut également masquer les paramètres URL de sorte que les données sensibles ne soient plus visibles dans l’URL. Dans ce cas, lorsque vous créez une URL à utiliser dans l’application Web, ajoutez encodeUrlParams=true. Pour plus d’informations, reportez-vous à la rubrique Paramètres de l’application Web.
Vous avez un commentaire à formuler concernant cette rubrique ?