Integrieren in andere Apps

ArcGIS Survey123 kann mithilfe von Links zu der Survey123-Web-App oder der mobilen App mit anderen Apps integriert werden. Links zur Web-App beginnen mit https://survey123.arcgis.com/share. Bei Links zu der mobilen App kann es sich entweder um einen Survey123-Link oder einen Link mit einem benutzerdefinierten URL-Schema handeln.

Survey123-Links beginnen mit https://survey123.arcgis.app und funktionieren nur unter iOS und Android. Survey123-Links entsprechen den Anforderungen, die vom App Store und von Google Play festgelegt werden. Sie ermöglichen die Verknüpfung mit weiteren Apps und unterstützen verkürzte Links, die einfacher freigegeben werden können.

Links mit einem benutzerdefinierten URL-Schema beginnen mit arcgis-survey123:// und funktionieren unter Windows, Android und mit einer ausgewählte Gruppe von Apps unter iOS. Diese Links können nicht verkürzt werden und sind unter Android nur schwierig zu öffnen. Sie sollten in Erwägung ziehen, Links mit einem benutzerdefinierten URL-Schema in Form von Hyperlinks darzustellen. Hier ein Beispiel:

<a href="arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19">Open survey</a>

Damit Sie einen Link verwenden können, der Parameter zum Starten eines Survey in der mobilen App enthält, sollte die App bereits auf dem Gerät installiert sein. Weitere Informationen finden Sie unter Installieren von der mobilen Survey123-App.

Parameter für mobile Apps

Mit den folgenden Parametern kann das Öffnen einer mobilen App angepasst werden:

ParameterBeschreibungBeispielTyp

center

Zentriert die Karte auf einen bekannten Breitengrad, Längengrad und optional eine Höhe.

center=37.8199,-122.4783,20

Zeichenfolge

field:fieldname

Füllt Survey-Fragen mit Feldwerten.

field:surname=Klauser

Zeichenfolge

portalUrl

Gibt die URL zu dem Portal an, in dem das Survey-Element gehostet wird.

portalUrl=https://myorg.arcgis.com

Zeichenfolge

itemID

Gibt das zu öffnende Formular an.

itemID=36ff9e8c13e042a58cfce4ad87f55d19

UUID

download

Lädt den Survey automatisch herunter, wenn das Gerät online ist. Die Standardeinstellung ist true.

download=false

Boolesch

action

Gibt an, wie der Survey geöffnet wird. Unterstützte Werte: collect (Standardeinstellung), edit, view und copy.

action=edit

Zeichenfolge

folder

Gibt an, welcher Ordner durchsucht wird, wenn der Parameter filter verwendet wird. Unterstützte Werte: inbox, drafts, outbox, sent und * (alle Ordner).

folder=drafts

Zeichenfolge

callback

Gibt die URL an, die zurückgegeben werden soll, wenn eine Formularaktion (z. B. Senden, Verschieben nach Entwürfe, Abbrechen oder Beenden) abgeschlossen wird.

callback=https://quickcapture.arcgis.app

URL

callback:status

Gibt den Status des Survey bei aktiviertem Rückruf an. Unterstützte Werte für Status: cancel, draft, submit und close. Der Status close kann nur verwendet werden, wenn Folgendes gilt: action=view.

callback:draft=https://quickcapture.arcgis.app

Zeichenfolge

filter

Durchsucht vorhandene Surveys auf dem Gerät nach einer bestimmten Zeichenfolge. Geben Sie den Namen eines bestimmten Feldes an, um nur dieses Feld nach der gewünschten Zeichenfolge zu durchsuchen.

filter=Klauser

Zeichenfolge

update

Aktualisiert den Eingang und versucht, Surveys an den Ausgang zu übergeben. Die Standardeinstellung ist false.

update=false

Boolesch

q:queryparameter

Fragt den Feature-Layer nach einem vorhandenen Datensatz ab. Der Parameter kann verwendet werden, um auf dem Gerät nicht vorhandene Inhalte abzurufen.

q:where=ws_stationnumber=5171

q:where=waterbodytype='Lake'

q:globalId=1d392670-33e2-456d-8435-7fad3abd8bb9

Zeichenfolge

Parameter für Web-Apps

Mit den folgenden Parametern kann das Öffnen einer Web-App angepasst werden:

ParameterBeschreibungBeispielTyp

center

Zentriert die Karte auf einen bekannten Breitengrad, Längengrad und optional eine Höhe.

center=37.8199,-122.4783,20

Zeichenfolge

field:fieldname

Füllt Survey-Fragen mit Feldwerten.

field:surname=Klauser

Zeichenfolge

portalUrl

Gibt die URL zu dem Portal an, in dem das Survey-Element gehostet wird.

portalUrl=https://myorg.arcgis.com

Zeichenfolge

open

Gibt die App an, die zum Öffnen des Survey verwendet wurde. Gültige Werte sind web zum Öffnen des Survey in der Web-App (Standardeinstellung), native zum Öffnen des Survey in der mobilen App, sofern diese installiert ist, und menu zum Öffnen einer Webseite, auf der festgelegt ist, mit welcher App der Survey geöffnet wird.

open=web

Zeichenfolge

hide

Blendet Elemente des Survey in der Web-App aus. Der Parameter kann mehrere Werte akzeptieren, die jeweils durch Kommata voneinander getrennt werden müssen. Gültige Werte sind navbar (die Leiste oben auf dem Survey, einschließlich der Optionen zum Anmelden, Abmelden und Ändern der Sprache), header, description, footer, submit, theme und leaveDialog (die Warnmeldung, die angezeigt wird, wenn die Seite verlassen oder geschlossen wird). Sie können auch den Parameter field:fieldName statt fieldName verwenden, um eine bestimmte Frage, Gruppe, Seite oder Wiederholung durch Angabe des Namens auszublenden.

Hinweis:

Fragen innerhalb von Wiederholungen können nicht einzeln ausgeblendet werden.

hide=header,description,footer,theme

Zeichenfolge

locale

Ändert die Sprache des Survey. Funktioniert nur, wenn der Survey mehrere Sprachen umfasst.

locale=zh-cn

Zeichenfolge

mode

Legt den Modus der Web-App fest. Gültige Werte sind edit (legt für den Survey fest, dass keine neuen Einträge erstellt, sondern vorhandene Einträge bearbeitet werden), view (öffnet einen vorhandenen Eintrag im schreibgeschützten Modus) und copy (erstellt einen Survey, der mit dem Inhalt des angegebenen Eintrags gefüllt ist). Wenn Sie diesen Parameter verwenden, muss auch der Parameter globalId angegeben werden.

mode=edit&globalId=42db492cb06111ea...

Zeichenfolge

globalId

Gibt den Survey-Datensatz an, der in das Formular geladen wird. Gültige Werte sind die Global-IDs für vorhandene Survey-Datensätze. Für den Namen dieses Parameters muss die Groß- und Kleinschreibung beachtet werden.

globalId=42db492cb06111ea...

Zeichenfolge

recalculate

Kann nur mit mode=edit verwendet werden. Erzwingt die Neuberechnung bestimmter Fragen beim Laden des Survey, ohne dass die Schaltfläche Neu berechnen verwendet wird.

recalculate=field:question1,field:question2

Zeichenfolge

version

Legt die Version der zu verwendenden Web-App fest. Der einzige gültige Wert ist latest. Damit wird die neueste Version der Web-App verwendet, auch wenn der Survey auf eine bestimmte Version beschränkt ist.

version=latest

Zeichenfolge

token

Übergibt einen gültigen Token für einen Survey. Damit können Teilnehmer ohne Anmeldung einen Survey beantworten, für den ein ArcGIS-Konto erforderlich ist.

token= E60M4Gsc-h4Q8plqQ...

Zeichenfolge

autoReload

Lädt den Survey nach der Übermittlung erneut. Geben Sie die Verzögerung (in Sekunden) an, bevor der Survey neu geladen wird. Wurde zuvor "autoRefresh" genannt. Der Parameter autoRefresh wird aus Gründen der Abwärtskompatibilität unterstützt.

autoReload=3

Integer

encodeUrlParams

Verschleiert die URL-Parameter. Die resultierende URL enthält dann stattdessen den Parameter code mit allen codierten Parametern. Die einbezogenen Parameter außerhalb dieses code-Parameters werden ignoriert.

encodeUrlParams=true

Boolesch

width

Legt die Breite des Survey in Pixel fest. Dies wirkt sich auch auf andere Steuerelemente im Survey wie etwa auf Textfelder aus.

width=1000

Integer

Hinweis:

Der Parameter field:fieldname unterstützt Geopunkt-, Geotrace- und Geoshape-Fragen in der Web-App. Für Geopunkt-Fragen geben Sie Breitengrad, Längengrad und Höhe (optional), getrennt durch Leerzeichen, an. Für Geotrace- und Geoshape-Fragen geben Sie für jeden Stützpunkt den Breitengrad und den Längengrad, getrennt durch ein Leerzeichen, an. Die einzelnen Koordinatenpaare müssen durch ein Semikolon voneinander getrennt werden. Dieses Beispiel könnte für eine Geoshape-Frage verwendet werden:

field:geoshape=-37.842156723211474 144.95942945338243;-37.83554486071995 144.9726235713864;-37.85681405373047 144.98240735651922;-37.85954045531896 144.97715349053766

Erstellen eines Links zu Survey123 aus einem Desktop-Webbrowser

Sie können einen Link erstellen, um die mobile App zu öffnen, und diese in eine andere App einbetten. Derselbe Link kann auch in einem Webbrowser zu Testzwecken eingegeben werden.

Hinweis:

Beim Erstellen des Links können Sie arcgis-survey123:// durch https://survey123.arcgis.app als Survey123-Link zur Verwendung für iOS oder Android ersetzen.

In den folgenden Schritten wird beschrieben, wie ein benutzerdefiniertes URL-Schema erstellt und in einem Desktop-Webbrowser verwendet wird:

  1. Geben Sie arcgis-survey123:// in Ihrem Browser ein.
    Die mobile Survey123-App wird geöffnet (oder Sie werden dazu aufgefordert, sie zu öffnen).
    Hinweis:

    Um einen Survey aus einem angegebenen Portal zu starten und herunterzuladen, müssen Sie den Parameter für die Portal-URL angeben, z. B. arcgis-survey123://?portalUrl=host.domain.com/webadaptor (wobei host, domain und webadaptor durch die Informationen Ihres Portals ersetzt werden).

  2. Sie können auch eine eindeutige Referenz zu einem Survey und zur URL hinzufügen. Identifizieren Sie zunächst die Element-ID des Survey, den Sie öffnen möchten. Dies ist die Zeichenfolge, die ArcGIS Online zur eindeutigen Identifizierung Ihres Survey verwendet. Sie befindet sich in der URL des Formularelements in ArcGIS Online. Wenn Ihre Survey-URL beispielsweise https://exampleurl.maps.arcgis.com/home/item.html?id=36ff9e8c13e042a58cfce4ad87f55d19 lautet, ist die Formularelement-ID 36ff9e8c13e042a58cfce4ad87f55d19.

  3. Um Ihren Survey zur URL hinzuzufügen, die Sie erstellen, fügen Sie ?itemID= und Ihre Formular-Element-ID zur URL hinzu.
    Die URL sollte in etwa wie folgt aussehen:
    arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19

    Wenn Sie die URL testen, sollten nun die mobile Survey123-App und direkt Ihr Survey geöffnet werden.

    Hinweis:

    Wenn der Survey noch nicht auf Ihrem Gerät vorhanden ist, wird er heruntergeladen.

  4. Fügen Sie optional vorher festgelegte Antworten auf Fragen hinzu.
  5. Beziehen Sie eine Referenz zu dem Feld unter Verwendung des in XLSForm zugewiesenen Namens (nicht der Beschriftung) in die URL ein. Um beispielsweise das Feld "Surname" zu füllen, geben Sie &field:Surname= und den Wert ein.

    & dient als Trennzeichen zwischen den Parametern, und field: bezieht sich auf den Namen der Frage, die gefüllt werden muss.

    Die URL sollte in etwa wie folgt aussehen:
    arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser

    Nun können Sie über die URL die mobile Survey123-App und Ihren Survey öffnen und die entsprechende Frage mit der definierten Antwort ausfüllen. Sie können mehrere Fragen in einer Survey-URL füllen. Bei Feldnamen wird die Groß-/Kleinschreibung beachtet.

  6. Fügen Sie optional Koordinaten für die URL hinzu, um einen Ort für eine Geopunkt-Frage im Survey zu definieren.
  7. Geben Sie &center= und dann die Koordinaten ein. Geben Sie die Breitengrad- und Längengradkoordinaten, jeweils durch ein Komma getrennt, in Dezimalgrad ein. Fügen Sie optional als dritten Wert die Höhe in Metern als Dezimalzahl, ebenfalls durch ein Komma getrennt, hinzu.

    Die URL sollte in etwa wie folgt aussehen:

    arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser&center=37.8199,-122.4783,20

    Nun erfolgt über die URL das Öffnen der mobilen Survey123-App und des ausgewählten Survey, das Füllen einer Textfrage und das Bereitstellen eines neuen Standardortes für Ihre Geopunkt-Frage.

  8. Der Inhalt von Feldern kann auch über ein Pop-up in einer ArcGIS-Webkarte an Survey123 übergeben werden und ermöglicht dadurch die Integration in alle Esri Apps, die Pop-ups in einer Webkarte nutzen. Mit dieser Funktion kann ein Feld in Survey123 mit dem Inhalt eines Feature-Attributs statt mit einem festgelegten Wert gefüllt werden, indem der Name des Attributs in geschweiften Klammern angegeben wird.
  9. Wählen Sie für einen vorhandenen Layer in Ihrer Webkarte Pop-up konfigurieren aus. Wählen Sie im Dropdown-Menü "Anzeigen" die eine benutzerdefinierte Attributanzeige aus, klicken Sie auf Konfigurieren, und fügen Sie den Link in den Survey ein.

    Den Link für das URL-Schema im benutzerdefinierten Attribut festlegen

    Mit dieser URL kann das Feld "Surname" mit dem Inhalt des Attributs "Name" des ausgewählten Features statt mit einem festgelegten Wert gefüllt werden:

    arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname={name}

    Mit dieser URL kann das Feld "hydrantGlobalID" mit der Global-ID des ausgewählten Hydranten gefüllt werden:

    arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:hydrantGlobalID={globalid}

  10. Hinweis:

    Standardmäßig können in einem Pop-up in einer Webkarte nur dann Werte für Fragen mit Einfachauswahl oder Mehrfachauswahl übergeben werden, wenn der Name und die Beschriftung der entsprechenden Auswahlmöglichkeit identisch sind. Wenn die Namen und Beschriftungen in Ihrer Auswahlliste unterschiedlich sind, können Sie die Funktionen DomainCode oder UrlEncode in einem ArcGIS Arcade-Ausdruck im Pop-up verwenden, um den gewünschten Wert zu übergeben.

    Fragen innerhalb von Wiederholungen können nicht gefüllt werden.

Erstellen eines Links zu Survey123 aus einer anderen App

Sie können einen Link erstellen, mit dem Survey123 in ArcGIS-Apps geöffnet werden kann, um einen Survey zu erfassen. In den folgenden Schritten wird beschrieben, wie ein Survey123-Link erstellt und in einem Webkarten-Pop-up verwendet wird. Dieser Link wird in das Pop-up einer Webkarte in Ihrer ArcGIS-Organisation eingegeben. Sie können den Link mit einem Webbrowser auf einem iOS- oder Android-Gerät testen (die Schritte dafür ähneln den oben beschriebenen Schritten).

  1. Wählen Sie für einen vorhandenen Webkarten-Layer, der auf dem Gerät angezeigt werden soll, Pop-up konfigurieren aus.
  2. Wählen Sie im Dropdown-Menü "Anzeigen" eine benutzerdefinierte Attributanzeige aus, klicken Sie auf Konfigurieren, und fügen Sie einen Link in das Projekt ein.
  3. Geben Sie für URL https://survey123.arcgis.app und als Link-Text Launch Survey123 ein. Klicken Sie auf OK.
    1. Öffnen Sie die Webkarte über einen Browser oder eine ArcGIS-App auf einem mobilen Gerät.
    2. Wählen Sie ein Feature aus, und klicken Sie im Pop-up zum Starten von Survey123 auf den Link Survey123 starten
  4. Um Ihren Survey zur URL hinzuzufügen, die Sie erstellen, fügen Sie ?itemID= und Ihre Formular-Element-ID zur URL hinzu.
    Die URL sollte in etwa wie folgt aussehen:
    https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19

    Wenn Sie die URL testen, sollten nun die mobile Survey123-App und direkt Ihr Survey geöffnet werden.

    Hinweis:

    Wenn der Survey noch nicht auf Ihrem Gerät vorhanden ist, wird er heruntergeladen.

  5. Optional können Sie vorher festgelegte Antworten auf Fragen hinzufügen.
  6. Beziehen Sie eine Referenz zu dem Feld unter Verwendung des in XLSForm zugewiesenen Namens (nicht der Beschriftung) in die URL ein. Um beispielsweise das Feld "Surname" zu füllen, geben Sie &field:Surname= und den Wert ein.

    & dient als Trennzeichen zwischen den Parametern, und field: bezieht sich auf den Namen der Frage, die gefüllt werden muss.

    Die URL sollte in etwa wie folgt aussehen:
    https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser

    Nun können Sie über die URL die mobile Survey123-App und Ihren Survey öffnen und die entsprechende Frage mit der definierten Antwort ausfüllen. Sie können mehrere Fragen in einer Survey-URL füllen. Bei Feldnamen wird die Groß-/Kleinschreibung beachtet.

  7. Optional können Sie Koordinaten für die URL hinzufügen und so einen Ort für eine Geopunkt-Frage im Survey definieren.
  8. Geben Sie &center= und dann die Koordinaten ein. Geben Sie die Breitengrad- und Längengradkoordinaten, jeweils durch ein Komma getrennt, in Dezimalgrad ein. Fügen Sie optional als dritten Wert die Höhe in Metern als Dezimalzahl, ebenfalls durch ein Komma getrennt, hinzu.

    Die finale URL sollte in etwa wie folgt aussehen:

    https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser&center=37.8199,-122.4783,20

    Nun erfolgt über diese vollständige URL das Öffnen der mobilen Survey123-App und des ausgewählten Survey, das Füllen einer Textfrage und das Bereitstellen eines neuen Standardortes für Ihre Geopunkt-Frage.

Übergeben von Parametern an die Survey123-Web-App

In der Survey123-Web-App werden Parameter in demselben Format wie der mobilen App akzeptiert. Der einzige Unterschied besteht darin, dass Sie statt eines kaufmännischen Und-Zeichens ein Fragezeichen verwenden müssen, um die Element-ID des Survey vom ersten Parameter zu trennen (kaufmännische Und-Zeichen werden als Trennzeichen zwischen Parametern verwendet). Die folgende Beispiel-URL übergibt den Nachnamen (surname) und die Koordinaten als Parameter an einen Survey in der Survey123-Web-App:

https://survey123.arcgis.com/share/36ff9e8c13e042a58cfce4ad87f55d19?field:surname=Klauser&center=37.8199,-122.4783

Die Survey123-Web-App unterstützt zudem eine Reihe von Parametern, die von der mobilenSurvey123-App nicht unterstützt werden. Diese beziehen sich auf die Darstellung eines Survey im Browser:

Hinweis:

Wenn ein Parameterwert Leerzeichen, Pluszeichen (+) oder andere Sonderzeichen enthält, sollten diese Zeichen mit Prozentcodierung versehen werden. Weitere Informationen finden Sie unter Codieren von URL-Parametern.

Übergeben von Parametern an Survey123 Connect

Das von Survey123 Connect verwendete URL-Schema lautet arcgis-survey123connect://. Darüber kann der Benutzer einen Survey automatisch herunterladen, öffnen und sofort bearbeiten.

Für das URL-Schema werden jedoch andere Parameter als für die mobile App oder die Web-App akzeptiert. Es werden die Element-ID und die URL des Portals, in dem das Element gespeichert ist, akzeptiert. Mit folgender Beispiel-URL wird ein bestimmter Survey aus dem angegebenen Survey123 Connect-Portal in ArcGIS Enterprise geöffnet. Falls er noch nicht vorhanden ist, wird er heruntergeladen:

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

Selbst wenn Sie den Survey auf ArcGIS Online gespeichert haben, müssen Sie die Portal-URL für ArcGIS Online angeben, z. B.:

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

Diese URL-Parameter können nur dazu verwendet werden, Formulare zu öffnen, deren Besitzer Sie sind. Surveys, auf die Sie Zugriff haben, die Sie jedoch nicht erstellt haben, können damit nicht geöffnet werden.

Herstellen einer Verknüpfung zu anderen Apps aus Survey123

Viele Apps können mithilfe von Links geöffnet werden. Sie können eine URL erstellen, die eine andere App öffnet, und sie in Ihren Survey einfügen. Diese Apps können auch benutzerdefinierte Parameter in ihren URLs akzeptieren (wie Survey123).

Sie müssen Ihrem Survey eine Frage des Typs "note" hinzufügen, die eine Beschriftung mit der URL enthält.

Hinweis:

Auf iOS-Geräten müssen URL-Schemas außer HTTP und HTTPS einer Liste mit zugelassenen Schemas in der App hinzugefügt werden. Die folgenden URL-Schemas sind in Survey123 zugelassen:

  • arcgis-appstudio-player
  • arcgis-quickcapture
  • arcgis-collector ArcGIS Collector nur unter Windows
  • arcgis-trek2there
  • arcgis-navigator
  • arcgis-workforce (nur Workforce for ArcGIS (Classic))
  • comgooglemaps
  • foreflightmobile
  • waze
  • spike-partner

Zum Verknüpfen mit Field Maps und der neuesten Version von Workforce müssen Sie einen App-Link verwenden, der mit HTTP oder HTTPS beginnt.

Weitere Informationen über gängige Esri Apps, die mithilfe von Survey123 geöffnet werden können, finden Sie unter:

Codieren von URL-Parametern

Auch wenn nicht codierte URL-Parameter in einigen Umgebungen verwendet werden können, wird das Codieren der URL-Parameter empfohlen. Die Codierung ersetzt ungültige Zeichen durch das Prozentzeichen (%) gefolgt vom jeweils zugehörigen hexadezimalen Äquivalent.

Der folgende Link ist beispielsweise ein Survey123-Link mit Rückruffunktion für ein bestimmtes Projekt in QuickCapture mit nicht codierten Parametern:

https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https://quickcapture.arcgis.app?itemID=867895a71a1840399476fc717e76bb43

Dieselbe URL mit codierten Parametern lautet wie folgt:

https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https%3A%2F%2Fquickcapture.arcgis.app%3FitemID=867895a71a1840399476fc717e76bb43

Ein Gleichheitszeichen, das eine Unterbrechung zwischen einem Schlüssel und dessen Wert angibt, sollte nicht codiert werden.

Eine Möglichkeit zum Erstellen codierter Parameter ist die Verwendung von ArcGIS Arcade. Mit der Funktion UrlEncode können Sie eine Sammlung von Schlüssel-Wert-Paaren definieren und eine URL mit entsprechender Codierung erzeugen.

Der Autor eines Survey könnte damit auch URL-Parameter verschleiern, damit sensible Daten in der URL nicht sichtbar sind. Fügen Sie in diesem Fall beim Erstellen einer URL zur Verwendung in der Web-App encodeUrlParams=true ein. Weitere Informationen finden Sie unter Parameter für Web-Apps.