Batchfähige Administrationsrequests
Administrationsrequests ermöglichen ein einfaches Administrieren über eine Skript- bzw. Batch-Datei. Administrationsrequests bewirken primär eine Veränderung des Status, während Projektüberwachungsrequests primär zur Abfrage eines bestimmten Status dienen und keine Veränderungen bewirken. Bei den Administrationsrequests werden über den Parameter action Befehle an die Adresse https://<server>/<WebOfficeAnwendung>/synadmin gesendet, als POST-Anfrage (siehe unten).
Dabei müssen folgende Parameter enthalten sein:
•client
•user
•password
•action
•weitere eventuell nötige Parameter
Aufruf per POST (empfohlen)
Senden Sie die Parameter im Rumpf einer POST-Anfrage (application/x-www-form-urlencoded) und nicht in der URL. Eine URL samt Passwort wird in den Zugriffsprotokollen von Apache Tomcat und von vorgeschalteten Proxy-Servern gespeichert. Bei Aufrufen mit dem Passwort in der URL protokolliert WebOffice 10.9 R5 je Anwendungsstart einmal die Warnung SECURITY_PASSWORD_IN_URL. Alle Beispiele in diesem Kapitel sind als POST-Anfrage mit curl.exe formuliert. Der Aufruf mit dem Passwort in der URL (GET) funktioniert weiterhin mit denselben Parameternamen, wird aber nicht empfohlen.
Beispiel mit curl.exe (in Windows 10 und Windows Server 2019 oder neuer enthalten):
curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=ALL" https://<server>/<WebOfficeAnwendung>/synadmin
Beispiel mit PowerShell:
Invoke-WebRequest -UseBasicParsing -Method Post -Uri https://<server>/<WebOfficeAnwendung>/synadmin -Body @{ client='adminbatch'; user='batchadmin'; password='<batchadmin_passwort_verschlüsselt>'; action='recreate_fts_index'; subindex='ALL' }
Mit --data-urlencode kodiert curl Sonderzeichen im Passwort und im Subindex-Namen selbst. In einer .bat-Datei muss ein Prozentzeichen als %% geschrieben werden.
Konfiguration und Auslesen des verschlüsselten batchadmin Passwortes aus der Anwendungskonfiguration
Die Konfiguration eines Passwortes für den batchadmin Benutzer wird in der Anwendungskonfiguration definiert.
|
Nähere Informationen zur Konfiguration des verschlüsselten Passwortes für den batchadmin Benutzer in der Anwendungskonfiguration finden Sie im Kapitel Admin User für Batch Requests. |
|
Aus Sicherheitsgründen sollte das Passwort des Benutzers batchadmin nicht identisch mit dem Passwort zum Zugriff auf SynAdmin sein. |
Nach der Festlegung und Speicherung des Passwortes kann dieses verschlüsselt aus der WebOffice 10.9 R5 Anwendungskonfigurationsdatei (application_config.xml) ausgelesen werden.
Dafür öffnen Sie die Anwendungskonfiguration unter folgendem Pfad C:\Tomcat\webapps\<WebOffice-Anwendung>\WEB-INF\classes\configuration\application_config.xml und suchen nach dem Begriff BATCHADMIN_USER. Das Passwort wird unter dem Attribut pwd in der Anwendungsdatei angezeigt.

Auslesen des verschlüsselten Passworts des batchadmin Benutzers in der Applikationskonfiguration
Administrationsparameter
Der Parameter action kann dabei folgende Inhalte annehmen:
•action=restart
ermöglicht ein Neuladen der Anwendung
curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=restart https://<server>/<WebOfficeAnwendung>/synadmin
•action=reload_resources
ermöglicht ein Ressourcen neu laden eines bestimmten Projekts (in Verbindung mit Parameter &project=)
curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=reload_resources --data-urlencode "project=<project>" https://<server>/<WebOfficeAnwendung>/synadmin
•action=recreate_fts_index
ermöglicht eine Neuberechnung eines bestimmten Index. Angabe der kompletten Subindex-Bezeichnung erforderlich.
curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=<subindexname>" https://<server>/<WebOfficeAnwendung>/synadmin
•action=status_fts_index
gibt Auskunft über den aktuellen Zustand eines bestimmten Subindex. Angabe der kompletten Subindex-Bezeichnung erforderlich.
Für den Parameter <subindexname> können folgende Werte verwendet werden:
•Globaler Subindex - Vollständiger Name eines Globalen Subindex wie in WebOffice SynAdmin aufgelistet - siehe nachfolgender Screenshot über die Schaltfläche Subindex Details anzeigen

Beispiel: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=user@http://<server>:6080/arcgis/SampleProject/SampleProject_Cadaster/MapServer//Properties" https://<server>/<WebOfficeAnwendung>/synadmin
• Thematischer Subindex - Vollständiger Name eines Thematischen Subindex wie in WebOffice SynAdmin aufgelistet - siehe nachfolgender Screenshot über die Schaltfläche Subindex Details anzeigen

Die Bezeichnung thematischer Subindizes setzt sich aus Projektname und der externen Kennung des Suchlayers (Projektname_KennungfürexterneSuche) zusammen.
Beispiel: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=PGIS_standorte" https://<server>/<WebOfficeAnwendung>/synadmin
•subindex=ALL - Berechnung aller definierten Subindices
Beispiel: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=ALL" https://<server>/<WebOfficeAnwendung>/synadmin
•subindex=ALL_OUTDATED - Berechnung aller definierten Subindices die ein Update benötigen weil diese derzeit einen Status von SCHEDULED, ABORTING, MISSING, OUT_OF_DATE oder FAILED haben
Beispiel: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=ALL_OUTDATED" https://<server>/<WebOfficeAnwendung>/synadmin
Antwort
Folgende Antworten können beim Parameter action=recreate_fts_index zurückgegeben werden:
•OK (Der oder die beschriebenen Subindizes werden sobald als möglich erstellt)
•FAILED (Es gibt keinen Subindex mit dem angegeben Namen)
|
Bei der Verwendung der Uhrzeit der Index-Neuerstellung werden ALLE Subindizes periodisch aktualisiert. |
|
Die Index-Erstellung kann/soll mittels Batch-Files automatisiert werden, wobei die Batch-Files über die Windows Aufgabenplanung (Scheduler) stündlich/täglich ausgeführt werden können. Während der Index neu generiert wird, kann im Projekt normal gesucht, etc. werden, da die Neuberechnung komplett im Hintergrund läuft. Beachten Sie, dass der Benutzer, der den Windows Task ausführt, auch Zugriff auf das Batch-File selbst hat. Wenn Sie den Befehl chcp 1252 am Anfang des Batch-Files anhängen, müssen Sie sich um eine Enkodierung der Sonderzeichen keine Gedanken mehr machen. Beispiel:
date /t time /t
@ECHO OFF chcp 1252 echo. curl.exe -s -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=ALL" https://<server>/<WebOffice-Anwendung>/synadmin
|
|
ACHTUNG! Denken Sie daran, dass Windows .bat Dateien eine spezielle Syntax benötigen und in einer URL Sonderzeichen wie & (kaufmännisches Und) oder | (Verkettungszeichen) oder (Leerzeichen) innerhalb von Anführungszeichen stehen müssen. Ein Beispiel, wie eine Batch-Datei aussehen könnte, wäre:
curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=user@http://<server>:6080/arcgis/SampleProject/SampleProject_Cadaster/MapServer//Properties" https://<server>/<WebOffice-Anwendung>/synadmin |
|
Statt die Batch-URL in einem grafischen Browser zu öffnen, sollte der Befehl per POST silent geschickt werden, z.B. mit einem Tool wie curl. In Windows 10 und Windows Server 2019 oder neuer ist curl als curl.exe bereits enthalten; für ältere Systeme kann es unter http://www.paehl.com/open_source/ bezogen werden. Ein Befehl könnte dann etwa so aussehen: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=recreate_fts_index --data-urlencode "subindex=ALL" https://<server>/<WebOfficeAnwendung>/synadmin |
|
Ein Beispiel für ein Batch-Skript zum Neu-Berechnen aller FTS-Indizes können Sie hier downloaden. In diesem Beispiel müssen Sie noch den •Host-Namen, •Namen der WebOffice-Anwendung und •das verschlüsselte Passwort des Benutzers batchadmin anpassen. |
Für den Parameter <subindexname> können folgende Werte verwendet werden:
•Globaler Subindex - Vollständiger Name eines Globalen Subindex wie in WebOffice SynAdmin aufgelistet - siehe nachfolgender Screenshot über die Schaltfläche Subindex Details anzeigen"

Beispiel: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=status_fts_index --data-urlencode "subindex=user@http://<server>:6080/arcgis/SampleProject/SampleProject_Cadaster/MapServer//Properties" https://<server>/<WebOfficeAnwendung>/synadmin
•Thematischer Subindex - Vollständiger Name eines Thematischen Subindex wie in WebOffice SynAdmin aufgelistet - siehe nachfolgender Screenshot über die Schaltfläche Subindex Details anzeigen

Die Bezeichnung thematischer Subindizes setzt sich aus Projektname und der externen Kennung des Suchlayers (Projektname_KennungfürexterneSuche) zusammen.
Beispiel: curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=status_fts_index --data-urlencode "subindex=PGIS_standorte" https://<server>/<WebOfficeAnwendung>/synadmin
•subindex=ALL - Berechnung aller definierten Subindices
Beispiel:
curl.exe -d client=adminbatch -d user=batchadmin --data-urlencode "password=<batchadmin_passwort_verschlüsselt>" -d action=status_fts_index --data-urlencode "subindex=ALL" https://<server>/<WebOfficeAnwendung>/synadmin
Antwort
Folgende Antworten können beim Parameter action=status_fts_index zurückgegeben werden:
•OK (Eine Liste aller definierten Subindices mit deren aktuellem Status wird zurückgegeben)
|
Der Status eines FTS Subindex kann folgende Werte aufweisen: •SCHEDULED •CREATING •CREATED •UNNEEDED •MISSING •FAILED •ABORTING •OUT_OF_DATE •NO_CONNECTION •PENDING_COMMIT |
Beispiel:
PGIS_standorte CREATED
siteadmin@http://w-cus-gca:6080/arcgis/PGIS_DYNAMISCH/MapServer//ANLAGEN//Standorte CREATED
siteadmin@http://w-cus-gca:6080/arcgis/PGIS_DYNAMISCH/MapServer//BAUAUFSICHT//Bauaufsicht OUT_OF_DATE
siteadmin@http://w-cus-gca:6080/arcgis/PGIS_DYNAMISCH/MapServer//KATASTER//Berge und Täler SCHEDULED
siteadmin@http://w-cus-gca:6080/arcgis/PGIS_DYNAMISCH/MapServer//KATASTER//Grundstücke CREATED
siteadmin@http://w-cus-gca:6080/arcgis/PGIS_DYNAMISCH/MapServer//KATASTER//Riede CREATED
•FAILED (Es gibt keinen Subindex mit dem angegeben Namen)
|
Bitte beachten Sie ebenfalls das Kapitel WebOffice Projektüberwachung zur Überwachung ihrer ArcGIS Server Dienste (Esri System Monitor) und ihrer WebOffice 10.9 R5 Projekte. |