Intégration dans d’autres applications

ArcGIS Survey123 peut être intégré avec d’autres applications par le biais d’un lien Survey123 ou d’une structure d’URL personnalisée. Ces deux méthodes prennent en charge les mêmes paramètres, mais il existe des différences en fonction de la plateforme.

Les liens Survey123 commencent par https://survey123.arcgis.app. Ils peuvent s’ouvrir ou peuvent ouvrir d’autres applications ArcGIS prenant en charge la liaison d’applications et sont disponibles sur iOS Android uniquement. Les applications ArcGIS qui peuvent être ouvertes avec un lien Survey123 sont notamment ArcGIS QuickCapture, ArcGIS Collector, ArcGIS Navigator et Explorer for ArcGIS.

Les liens de structure d’URL personnalisée commencent par arcgis-survey123://. Ils peuvent s’ouvrir ou peuvent ouvrir d’autres applications ArcGIS sur Android et Windows. Pour utiliser un lien de structure d’URL personnalisée sur iOS, Survey123 doit également être approuvé dans l’autre application pour autoriser la liaison. Les applications ArcGIS qui peuvent être ouvertes avec une structure d’URL depuis Survey123 sont notamment ArcGIS QuickCapture et Collector for ArcGIS (Classic)

Lorsque vous utilisez une structure d’URL personnalisée sur Windows, vous pouvez créer et tester votre lien et ses paramètres avant de la déployer après de vos opérateurs de terrain comme structure d’URL personnalisée ou lien Survey123.

Les liens Survey123 sont la méthode de liaison préférée.

Paramètres de l’application de terrain

Les paramètres suivants permettent de personnaliser le mode d’ouverture de l’application de terrain :

ParamètreDescriptionExempleType

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, * (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 sont cancel, draft et submit.

callback:status=draft

Chaîne

filter

Parcourt les enquêtes existantes sur l’appareil.

filter=surname:Klauser

Chaîne

update

Actualise la boîte de réception et tente d’envoyer les enquêtes vers la 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:objectIds=12

Chaîne

Paramètres de l’application Web

Les paramètres suivants permettent de personnaliser le mode d’ouverture de l’application Web :

ParamètreDescriptionExempleType

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 pour déterminer l’application qui ouvrira l’enquête.

open=web

Chaîne

hide

Masque les éléments de l’enquête dans l’application Web. Ce 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, se déconnecter et changer de langue), header, description, footer et theme. 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

lang

Permet à l’enquête de passer d’une langue à l’autre. Fonctionne uniquement si l’enquête comprend plusieurs langues.

lang=zh_cn

Chaîne

mode

Définit le mode du formulaire web. Les valeurs valides sont edit, qui définit l’enquête de telle sorte qu’il faut mettre à jour une entrée existante plutôt que d’en créer une et view, qui ouvre une entrée existante en mode de lecture seule. 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

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

encodeUrlParams

Masque les paramètres d’URL.

encodeUrlParams=true

Booléen

Lien vers Survey123 depuis un navigateur Web de bureau

Vous pouvez créer un lien pour ouvrir l’application de terrain Survey123 qui peut être incorporée dans une autre application. Ce même lien peut servir au test dans un navigateur Web. Procédez comme suit pour créer une structure d’URL personnalisée et l’utiliser dans un navigateur Web de bureau :

Remarque :

Une fois le lien créé, vous pouvez remplacer arcgis-survey123:// par https://survey123.arcgis.app comme lien Survey123.

  1. 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).

  2. 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 qu'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.

  3. 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=36ff9e8c13e042a58cfce4ad87f55d19

    Si 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.

  4. Vous pouvez également ajouter des réponses prédéfinies aux questions.
  5. 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=Klauser

    Vous 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.

  6. Vous pouvez éventuellement ajouter des coordonnées à l’URL, ce qui définit une emplacement pour une question géopoint dans l’enquête.
  7. Saisissez &center=, 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. Si vous le souhaitez, vous pouvez 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&center=37.8199,-122.4783,20

    Cette 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.

  8. Les contenus des champ peuvent être également transmis à Survey123 à partir d’une fenêtre contextuelle dans une carte Web ArcGIS, ce qui permet l’intégration avec n’importe quelle application Esri utilisant des fenêtres contextuelles dans une carte Web. Cette fonctionnalité peut être utilisée pour compléter un champ dans Survey123 avec le contenu d’un attribut d’entités, plutôt qu’une valeur définie, en fournissant le nom de l’attribut joint entre parenthèses.
  9. 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.

    Définissez le lien de la structure d’URL dans l’attribut personnalisé.

    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}

  10. Remarque :

    En raison d’une limitation affectant les applications Esri qui utilisent des fenêtres contextuelles dans une carte Web, les valeurs peuvent être transmises uniquement aux questions de type sélection unique ou sélection multiple si le nom et l’intitulé du choix sont identiques dans une liste de 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 d’autres applications pour ouvrir Survey123 et capturer une enquête. Procédez comme suit pour créer un lien Survey123 et l’utiliser dans une fenêtre contextuelle Explorer. Ce lien est entré dans la fenêtre contextuelle d’une carte Web dans votre organisation ArcGIS. Vous pouvez également tester le lien à l’aide d’un navigateur Web (en procédant comme dans la section ci-dessus) sur un appareil iOS ou Android. Toutefois, le lien ne fonctionnera pas sur Windows.

  1. Sélectionnez Configure Pop-up (Configurer la fenêtre contextuelle) pour une couche existante de votre carte Web qui sera affichée dans Explorer.
  2. 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.
  3. Pour URL, saisissez https://survey123.arcgis.app et pour Link Text (Texte du lien), saisissez Launch Survey123 (Lancer Survey123). Cliquez sur OK.
    1. Ouvrez votre carte Web dans Explorer sur un appareil mobile.
    2. Sélectionnez une entité et cliquez sur le lien Launch Survey123 (Lancer Survey123) dans la fenêtre contextuelle pour ouvrir Survey123.
  4. 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=36ff9e8c13e042a58cfce4ad87f55d19

    Si 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.

  5. Vous pouvez également ajouter des réponses prédéfinies aux questions.
  6. 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=Klauser

    Vous 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.

  7. Vous pouvez éventuellement ajouter des coordonnées à l’URL, ce qui définit une emplacement pour une question géopoint dans l’enquête.
  8. Saisissez &center=, 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. Si vous le souhaitez, vous pouvez 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&center=37.8199,-122.4783,20

    Cette 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 dans le même format que 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’exemple d’URL 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&center=37.8199,-122.4783

L’application Web Survey123 est également compatible avec plusieurs 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 comporte le signe plus (+), vous devez à place utiliser %2B pour représenter +. Pour en savoir plus, reportez-vous à la section Coder des paramètres d’URL ci-dessous.

Transmission de 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 votre enquête est enregistrée dans ArcGIS Online, vous devez quand même fournir l’URL du portail de ArcGIS Online, par exemple :

arcgis-survey123connect://?portalUrl=https://www.arcgis.com&itemID=36ff9e8c13e042a58cfce4ad87f55d19

Remarque :

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 leurs URL de la même façon que Survey123.

Pour commencer, vous devez ajouter une question de type note à votre enquête avec une étiquette contenant l’URL.

Remarque :

Dans iOS 9 et versions ultérieures, 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-collector
  • arcgis-trek2there
  • arcgis-explorer
  • arcgis-navigator
  • arcgis-workforce
  • comgooglemaps
  • foreflightmobile
  • waze
  • spike-partner

Pour avoir 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 à une carte Web spécifique dans Explorer avec des paramètres qui ne sont pas codés :

https://survey123.arcgis.app/?itemID=36ff9e8c13e042a58cfce4ad87f55d19?callback=https://explorer.arcgis.app?itemId=867895a71a1840399476fc717e76bb43

Voici la même URL avec des paramètres codés :

https://survey123.arcgis.app/?itemID%3D36ff9e8c13e042a58cfce4ad87f55d19%3Fcallback%3Dhttps%3A%2F%2Fexplorer.arcgis.app%3FitemId%3D867895a71a1840399476fc717e76bb43

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é.

Attention :

Au lieu de coder des paramètres d’URL pour la compatibilité entre plateformes, l’auteur d’une enquête peut masquer le contenu d’une URL afin que les utilisateurs de l’enquête ne puissent pas lire les données confidentielles. Dans ce cas, lorsque vous créez une URL à utiliser dans l’application Web, ajoutez encodeUrlParams=true. Lorsque ce paramètre est inclus, tous les paramètres sont masqués.