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 können dabei über den Parameter &action= in der URL http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action= Befehle ausgeführt werden.

 

Dabei müssen folgende Parameter enthalten sein:

client

user

password

action

weitere eventuell nötige Parameter

 

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.

 

icon_cross-reference

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.

icon_comment

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 R4 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

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

http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=restart

 

action=reload_resources

ermöglicht ein Ressourcen neu laden eines bestimmten Projekts (in Verbindung mit Parameter &project=)

http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=reload_resources&project=<project>

 

action=recreate_fts_index

ermöglicht eine Neuberechnung eines bestimmten Index. Angabe der kompletten Subindex-Bezeichnung erforderlich.

http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=recreate_fts_index&subindex=<subindexname>

 

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

admin_Batch_Administration_Request2

 

Beispiel: http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=recreate_fts_index&subindex=user@http://<server>:6080/arcgis/SampleProject/SampleProject_Cadaster/MapServer//Properties

 

 

Thematischer Subindex - Vollständiger Name eines Thematischen Subindex wie in WebOffice SynAdmin aufgelistet - siehe nachfolgender Screenshot über die Schaltfläche Subindex Details anzeigen

admin_Batch_Administration_Request3

 

Die Bezeichnung thematischer Subindizes setzt sich aus Projektname und der externen Kennung des Suchlayers (Projektname_KennungfürexterneSuche) zusammen.

Beispiel: http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=recreate_fts_index&subindex=PGIS_standorte

subindex=ALL - Berechnung aller definierten Subindices

Beispiel: http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=recreate_fts_index&subindex=ALL

 

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: http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=recreate_fts_index&subindex=ALL_OUTDATED

 

 

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)

 

icon_comment

Bei der Verwendung der Uhrzeit der Index-Neuerstellung werden ALLE Subindizes periodisch aktualisiert.

icon_comment

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.

start Recreate Subindex http://<server>:8080/<WebOffice-Anwendung>/synadmin?client=adminbatch&action=recreate_fts_index&subindex=ALL&user=batchadmin&password=<Batchadmin Passwort

 

 

icon_warning

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:

 

start http://<server>:8080/<WebOffice application>/synadmin?client=adminbatch&action=recreate_fts_index&subindex=user@http://<server>:6080/arcgis/SampleProject/SampleProject_Cadaster/MapServer//Properties&user=batchadmin&password=xxx

 

icon_comment

Alternativ zum Öffnen der Batch-URL in einem grafischen Browser, kann der Befehl auch silent geschickt werden, z.B. mit einem Tool wie curl.

Als Beispiel kann das Tool curl unter http://www.paehl.com/open_source/ bezogen werden.

Ein Befehl könnte dann etwa so aussehen:

<Path_to_curl>\curl.exe http://<Server>/<Anwendung>/synadmin?client=adminbatch&action=recreate_fts_index&subindex=ALL&user=batchadmin&password=<Batchadmin_Passwort_verschlüsselt>

 

icon_comment

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

Passwort des SynAdmin

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"

admin_Batch_Administration_Request2

 

Beispiel: http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=status_fts_index&subindex=user@http://<server>:6080/arcgis/SampleProject/SampleProject_Cadaster/MapServer//Properties

 

Thematischer Subindex - Vollständiger Name eines Thematischen Subindex wie in WebOffice SynAdmin aufgelistet - siehe nachfolgender Screenshot über die Schaltfläche Subindex Details anzeigen

admin_Batch_Administration_Request3

 

Die Bezeichnung thematischer Subindizes setzt sich aus Projektname und der externen Kennung des Suchlayers  (Projektname_KennungfürexterneSuche) zusammen.

Beispiel: http://<server>:<port>/<WebOfficeAnwendung>/synadmin?client=adminbatch&user=batchadmin&password=<batchadmin_passwort_verschlüsselt>&action=status_fts_index&subindex=PGIS_standorte

 

subindex=ALL - Berechnung aller definierten Subindices

Beispiel:

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)

icon_comment

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)

 

icon_cross-reference

Bitte beachten Sie ebenfalls das Kapitel WebOffice Projektüberwachung zur Überwachung ihrer ArcGIS Server Dienste (Esri System Monitor) und ihrer WebOffice 10.9 R4 Projekte.