Installieren und Konfigurieren der ArcGIS Survey123-Website

Zusammenfassung

Organisationen müssen manchmal in vollständig abgetrennten Umgebungen arbeiten, in denen sie keinen externen Zugriff auf das Internet haben. Andere Organisationen haben zwar eine Verbindung, müssen aber die ArcGIS Survey123-Website und/oder Survey123-REST-API in ihrer eigenen Infrastruktur hosten.

Die Survey123-REST-API können Sie verwenden, um Ihre Survey-Konfigurationen in die Formulare zu konvertieren, die in den Survey123-Apps (mobile App bzw. Web-App) verwendet werden, wie zum Beispiel verbunden erstellte XLSX-Dateien oder auf einer Website erstellte Konfigurationen. Die Website ihrerseits stellt die Funktionalität zum Erstellen und Verwalten der Surveys und zum Anzeigen und Analysieren der gesammelten Daten bereit. Obwohl dies separate Komponenten sind, wirken sie zusammen, um die Funktionalität auf der ArcGIS Survey123-Website (https://survey123.arcgis.com) bereitzustellen.

Umfang
Eine lokale Installation von Survey123-REST-API und -Website, die das Erstellen und Veröffentlichen von Surveys über Survey123 Connect oder die Website in Ihrer eigenen Infrastruktur ermöglicht. Damit wird der größte Teil der gesamten Funktionalität der ArcGIS Survey123-Website bereitgestellt. Die Ausnahme ist die API für Berichte, die noch nicht lokal gehostet werden kann.

Voraussetzungen
Es ist notwendig, die Installer-Datei von der Website 'My Esri' herunterzuladen. Die unten angegebenen Installationsschritte gelten nur für Windows-Installationen. Außerdem sind Anmeldeinformationen eines ArcGIS Enterprise-Portal-Administrators sowie der Administratorzugriff für den Webserver erforderlich. Das Programm zum Installieren der Survey123-Website kann auf demselben Computer wie die Portal-Instanz oder auf einem eigenständigen Webserver installiert werden. Obwohl die installierte Survey123-Website mit ArcGIS Enterprise-Portal-Versionen ab 10.5.1 erfolgreich getestet wurde, unterstützt die erste Version offiziell nur die Versionen ab 10.7.

Vorgehensweise

Installation

Windows:
Entpacken Sie die heruntergeladene Datei auf dem gewünschten Computer, und führen Sie die 'Setup.exe' aus. Akzeptieren Sie die Rahmenvereinbarung, wählen Sie das Installationsverzeichnis aus, und klicken Sie auf Installieren. Der Vorgang kann bis zu 30 Minuten dauern. Wenn dies abgeschlossen ist, dann klicken Sie auf Fertig stellen, um die Installation zu beenden.

Linux:

Achtung: Die hier enthaltenen Archiv-Dateien müssen auf einem Unix-Computer extrahiert werden. Beim Extrahieren auf einem Windows-Computer, verlieren sie die nötigen Berechtigungen, um das Setup ordnungsgemäß auszuführen, und einige Dateinamenbegrenzungen können verändert werden.

1. Extrahieren Sie den Inhalt der .tar.gz-Datei auf dem Computer, auf dem Sie die Survey123-Website installieren möchten, indem Sie den Befehl gunzip [Dateiname].tar.gz und dann tar xf [Dateiname].tar im Terminal ausführen.
2. Führen Sie nach dem Extrahieren ./Setup im Terminal aus, akzeptieren Sie die Lizenzvereinbarung, wählen Sie das Installationsverzeichnis aus, und klicken Sie auf Installieren. Der Vorgang kann zwischen 5 und 10 Minuten dauern. Wenn dies abgeschlossen ist, dann klicken Sie auf Fertig stellen, um die Installation zu beenden.

Hinweis: In Ihrem Browser könnte eine Sicherheitswarnung angezeigt werden. Diese sollten Sie vorerst einfach akzeptieren. Das zugrunde liegende Problem wird beim Konfigurieren eines Zertifikats während der Postinstallation behoben.

Hinweis: Fertigen Sie eine Sicherungskopie der Datei config.json (Standardverzeichnis: C:\Program Files\ArcGIS\Survey123website) an, bevor Sie die Postinstallation ausführen. Wenn die Installation falsch konfiguriert wurde, kann diese Datei verwendet werden, um nach einer Wiederherstellung noch einmal zu beginnen (oder manuelle Änderungen an der vorhandenen 'config.json' vorzunehmen).

Überprüfen Sie, ob Ihr Portal die Domänen, die über Cross-Origin Resource Sharing (CORS) eine Verbindung mit der ArcGIS REST API herstellen können, beschränkt:

• Melden Sie sich als Administrator bei der Instanz von ArcGIS Enterprise an, und navigieren Sie zur Gruppe Organisation > Einstellungen > Sicherheit > Startpunkte zulassen. Standardmäßig werden alle Domänen zugelassen, das heißt, diese Liste enthält keine URL. Wenn die Domänen bereits beschränkt werden, dann fügen Sie Ihre Survey123-Host-URL der Liste hinzu.
• Klicken Sie auf Hinzufügen, und fügen Sie die Survey123-Website-Host-URL hinzu. Beispiel:
  • https://<survey123website.domain>:5443
  
  
• Klicken Sie auf Domäne hinzufügen. Damit kann die Survey123-Webanwendungsdomäne über Cross-Origin Resource Sharing (CORS) eine Verbindung mit der ArcGIS REST API herstellen.

ArcGIS Enterprise mit integrierter Authentifizierung
Führen Sie die Postinstallation aus, indem Sie 'https://localhost:5443/share/post-install.html' auf dem Installationscomputer öffnen.

Die Postinstallation wird als Assistent ähnlich einem Survey zum Bearbeiten der Datei 'config.json' angezeigt. Folgendes wird konfiguriert:

• ArcGIS Portal-Standard-URL (die Installation verweist standardmäßig auf ArcGIS Online)
• Anmeldeinformationen eines ArcGIS Portal-Administrators (zum Festlegen des Umleitungs-URI für Portal-Anmeldung erforderlich)
• ArcGIS-JavaScript-API (für nicht verbundene Umgebungen erforderlich)
• HTTP(S)-Ports
• SSL-Zertifikat(e)
• Survey123-Website-Host-URL (dies ist die HTTP- oder HTTPS-URL für den Computer, auf dem Ihre Survey123-Website gehostet wird – die Portnummer muss mit angegeben werden). Diese Adresse wird als Umleitungs-URI zu Ihrem Portal hinzugefügt, um die Anmeldung zu ermöglichen.
• Einstellungen für nicht verbundene Umgebungen. Wenn Sie die Frage, ob Sie die Survey123-Website in einer nicht verbundenen Umgebung ohne Internetzugriff installieren, mit Ja beantworten, dann werden für die Survey123-Organisation Eigenschaften festgelegt, die verhindern, dass Survey123 Connect Internetanrufe (für zum Beispiel Lernprogramm-Videos, Twitter und Geonet) tätigt.

Wenn Sie die Einstellungen bestätigen und auf Senden klicken, wird die Datei config.json aktualisiert. Außerdem werden:

• Die Zertifikatsdateien in den Ordner '~ArcGIS\Survey123website\server\cert\' importiert
• Die Survey123-Website-Host-URL als Umleitungs-URI an die survey123hub-AppID angehängt
• Die Eigenschaften der Survey123-Organisation (basemapsGroupQuery, showCommunityContent und showTutorialContent) aktualisiert

Öffnen Sie die Datei 'config.json' in einem Texteditor, um die aktualisierten Einstellungen anzuzeigen.

ArcGIS Enterprise mit Windows-Authentifizierung (IWA)

• Wenn die Survey123-Website nicht unter derselben Host-URL wie ArcGIS Enterprise installiert wurde, dann führen Sie Schritte im Abschnitt Manuelles Ausführen der Postinstallation weiter unten aus.
• Wenn die Survey123-Website unter derselben Host-URL wie ArcGIS Enterprise installiert wurde, dann müssen Sie, damit die Anmeldeinformationen für ArcGIS Enterprise (IWA) im Browser verwendet werden können, die folgende URL für die Postinstallation aufrufen:

https://<survey123website.domain >:5443/share/post-install.html

Dies ermöglicht die Verwendung der Anmeldeinformationen für ArcGIS Enterprise (IWA) im Browser.

Bei der Postinstallation werden die oben aufgeführten Eigenschaften festgelegt. Zusätzlich muss allerdings ein ArcGIS Enterprise-Administrator manuell die Survey123-Website-Host-URL 'https://<survey123website.domain>:5443' als Umleitungs-URI (redirectURI) zum Portal hinzufügen, um die Anmeldung zu ermöglichen:

1. Melden Sie sich bei der REST-Schnittstelle 'portaladmin' an, zum Beispiel:
   • https://portal_webadaptorhost.domain /portal_webadaptorname/portaladmin
   
   
2. Navigieren Sie zu Security > OAuth > Get App Info, geben Sie die App-ID 'survey123hub' ein, und klicken Sie auf Get App Info.
3. Kopieren Sie den Inhalt der Antwort.
4. Kehren Sie zu OAuth zurück, und navigieren Sie zu 'Update App Info'.
5. Fügen Sie die kopierte Antwort in das Eingabefeld ein, fügen Sie die URL, die Sie für den Zugriff auf Ihre Survey123-Website verwenden möchten, zur Liste der Umleitungs-URIs hinzu, und klicken Sie auf 'Update App'. Dies könnte auch den Reverseproxy-Zugriffspunkt einschließen, falls Sie einen solchen Zugriffspunkt einrichten möchten, zum Beispiel:
   • https://survey123website.domain /survey123
   
   
6. Wiederholen Sie Schritt 2, um zu bestätigen, dass Ihr zusätzlicher Umleitungs-URI erfolgreich zur Liste hinzugefügt wurde.

Manuelles Ausführen der Postinstallation

1. Kopieren Sie Ihre Zertifikatsdateien (.pfx oder .pem) in den Ordner cert für Ihre Installation, zum Beispiel:
   • ~\ArcGIS\Survey123website\server\cert\
   • Wenn eine PFX-Datei verwendet wird, dann müssen Sie das Kennwort verschlüsseln, indem Sie eine entsprechende Anforderung an Ihre installierte Survey123-REST-API senden. Die Antwort kann dann in Ihre Datei 'config.json' kopiert werden (siehe unten).
     • Dazu müssen Sie mit dem Parameter 'encrypt?text=' Ihr PFX-Kennwort an die API-URL anhängen, zum Beispiel:
     • https://<survey123website.domain>:5443/api/encrypt?text=<Ihr_PFX_Kennwort>
     
     
   • Die Antwort hat dann das Format: {'result':'a6c2812bed063dd9be'}. Kopieren Sie das Ergebnis 'a6c2812bed063dd9be' einfach für die spätere Verwendung in die Datei 'config.json'.
   
   
2. Ein ArcGIS Enterprise-Administrator muss manuell die Survey123-Website-Host-URL hinzufügen, zum Beispiel:
   • https://<survey123website.domain >:5443 - Dies ist der Umleitungs-URI zu Ihrem Portal. Führen Sie die Schritte 1 bis 5 im vorherigen Abschnitt durch.
     
     
   
   
3. Öffnen Sie die Datei 'config.json' in einem Texteditor. Sie befindet sich im Stammordner der Survey123-Website, zum Beispiel: ~\ArcGIS\Survey123website
   • Aktualisieren Sie die folgenden Parameter entsprechend Ihren Anforderungen:
     • portalUrl: ArcGIS Enterprise-URL, zum Beispiel: https://portal_webadaptorhost.domain.com/portal_webadaptorname
     • arcgisJsAPi3Url: URL der ArcGIS JavaScript v3.x API, zum Beispiel: https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi/init.js
     • arcgisJsApiUrl: URL der ArcGIS JavaScript v4.x API, zum Beispiel: https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi4/init.js
     • httpPort: HTTP-Port der Survey123-Website (Standardwert: 5080)
     • https.port: HTTPS-Port der Survey123-Website (Standardwert: 5443)
     • https.cert: Pfad zu Ihrem HTTPS-Base64-ASCII-Serverzertifikat (.pem) Ihrer Survey123-Website (Standardwert: './server/cert/cert.pem').
     • https.key: Pfad zu Ihrem HTTPS-Base64-ASCII-Serverzertifikatschlüssel (.pem) Ihrer Survey123-Website (Standardwert: './server/cert/key.pem').
     • https.pfx: Pfad zur HTTPS-Binärzertifikatsdatei (.pfx) Ihrer Survey123-Website, zum Beispiel: './server/cert/your_certificate.pfx'.
     • https.passphrase: Verschlüsseltes Kennwort für das HTTPS-Binärzertifikat Ihrer Survey123-Website. Bitte verwenden Sie das Ergebnis von 'https://<survey123website.domain>:5443/api/encrypt?text=<Ihr_PFX_Kennwort>' (siehe oben), um das verschlüsselte Kennwort abzurufen.
     
     
   
   
4. Speichern Sie die Datei 'config.json'.
5.     Starten Sie den Windows-Dienst der ArcGIS Survey123-Website und den survey123-Dienst auf Linux neu, damit die Änderungen wirksam werden.