WebOffice URL Call Schnittstelle

WebOffice 10.9 R3 unterstützt eine Reihe von Aktionen und Parametern in seinem URL Call Interface. Die komplette Liste der Aktionen und Parameter sind auch in der Datei pub/url-parameters.info zu finden.

icon_comment

Beachten Sie die Groß- und Kleinschreibung bei der Eingabe von Parametern und Eingabewerten. Prüfen Sie aus diesem Grund bitte die korrekte Eingabe Ihres HTTP Abfrage-Strings und der Eingabewerte.

Werte mit bestimmten Zeichen wie Hochkomma, doppelten Hochkomma/Anführungszeichen und diversen Arten von Klammern (rund/eckig) werden in der externalcall.jsp vom XSS (Cross Site Scripting) Check herausgefiltert. Der Grund dafür ist, dass aus Sicherheitsgründen bestimmte Zeichen nicht mehr unterstützt werden, um somit Sicherheitslücken schließen zu können.

Betroffene Sonderzeichen, welche in der externen Kennung vermieden werden sollen, sind beispielsweise: <> ()

Um HTML-Tags (eckige Klammern <>) dennoch zu erlauben, muss in der Datei "\Tomcat\webapps\<WebOffice-Applikation>\client_corejs\jss\properties_weboffice.xml" folgender Eintrag auf "true" gesetzt werden:
<record jsxid="result.allow.html" jsxtext="true"/>.
Bitte bedenken Sie dabei etwaige Sicherheitslücken, die durch diese Aktivierung entstehen können!

Immer wenn Sie Fließkommazahlen (Angaben zum Bildausschnitt, x/y Koordinaten etc.) in das Call Interface einfügen wollen, müssen Sie . (Punkt) als Trennsymbol verwenden. WebOffice 10.9 R3 parst Fließkommazahlen in mathematischer, von der Sprachumgebung unabhängiger Weise.

 

 

Untenstehend sehen Sie eine detaillierte Beschreibung der unterstützten Aktionen und Parameter:

Aktion/Parameter

Beschreibung

Basisinformation und Projektstart

project

Spezifiziert die Kennung des Projekts (Projektname), das vom WebOffice 10.9 R3 Client gestartet werden soll.

Verwenden Sie beispielsweise

project=WebOffice_SampleProject

um die Konfiguration des WebOffice 10.9 R3 Sample Projects zu starten.

client_app_referer

Wird ein Projekt mit diesem Eintrag aufgerufen, dann erfolgt ein neuer Eintrag in der WebOffice 10.9 R3 Statistik-Datei. Der Wert des Parameters wird in die Spalte APP_REFERER geschrieben. Mit diesem Parameter erhält man einen Überblick darüber wie viele Aufrufe an WebOffice von welcher Anwendung unternommen werden.

Beispiel: https://<server>/<WebOffice_application>/externalcall.jsp?project=abc&client_app_referer=xyz

In diesem Beispiel würde der Wert xyz in die Spalte APP_REFERER geschrieben werden.

icon_comment

Wird ein Projekt mit dem Parameter client_app_referer=... aufgerufen, dann erfolgt auch ein Eintrag in der Spalte REQUEST. Dafür gibt es zwei unterschiedliche Möglichkeiten:

Wird das Projekt über synserver aufgerufen, dann erfolgt der Eintrag PROJECT_START in der Spalte REQUEST.

Wird das Projekt über externalcall.jsp aufgerufen, dann erfolgt der Eintrag EXTERNAL_CALL in der Spalte REQUEST. Beachten Sie aber bitte, dass ein Aufruf über externalcall.jsp automatisch auf synservice umgeleitet wird, wodurch zwei Einträge in der Statistikdatei erfolgen; ein Eintrag mit EXTERNAL_CALL und ein Eintrag mit PROJECT_START.

group_id

Beinhaltet die ID der Projektgruppe, deren Standardprojekt gestartet werden soll. Die Projekt Gruppen ID wird in der Anwendungskonfiguration festgelegt.

language

Legt die Sprache der Benutzeroberfläche fest, die im WebOffice 10.9 R3 Client verwendet werden soll.

Falls Sie beispielsweise den WebOffice core Client in deutscher Sprache starten wollen, dann geben Sie language=de an. Verwenden Sie language=en wenn Sie Englisch bevorzugen.

language=ar für Arabisch.

language=bg für Bulgarisch.

language=es für Spanisch.

language=fa für Farsi.

language=fr für Französisch.

language=hu für Ungarisch.

language=it für Italienisch.

language=ro für Rumänisch.

language=ru für Russisch.

language=sk für Slowakisch.

language=tr für Türkisch.

client

Legt den Client fest, mit dem die WebOffice 10.9 R3 Anwendung gestartet wird. Wenn dieser Parameter nicht verwendet wird, dann startet die Anwendung mit dem WebOffice core Client.

client=core startet im WebOffice core Client

client=flex startet im WebOffice flex Client

client=mobile startet im WebOffice mobile Client

client=auto bewirkt, dass mobile Geräte mit dem WebOffice mobile Client starten und andere mit dem Standard Desktop Client (standardmäßig WebOffice core Client).

icon_comment

Mit dem temporär verfügbaren client=coresyn-Parameter lässt sich entgegen der standardmäßigen Konfiguration der ehemalige WebOffice core Client erzwingen.

Der client=auto-Parameter funktioniert nur in Kombination mit externalcall.jsp, nicht aber mit synserver.

icon_cross-reference

Detaillierte Informationen, wie Sie den Standard-Desktop Client ändern, finden Sie im Kapitel Konfiguration des Standard Desktop Client.

skin

Das zu verwendete Skin im WebOffice flex Client. Mögliche Werte sind grau, grün, braun oder blau (Standard-Skin).

Beispiel: client=flex&skin=green

icon_comment

Parameter gilt nur für den WebOffice flex Client.

icon_cross-reference

Mehr Details siehe Kapitel Skins für WebOffice flex.

action

Der Parameter action=log loggt Client-Aktionen, welche der Benutzer sich durch Tastenkombination CTRL+ALT+L anzeigen lassen kann.

icon_comment

Parameter gilt nur für den WebOffice flex Client.

stateID

Lädt den gespeicherten Stand, wenn der WebOffice 10.9 R3 Client gestartet wird, z.B. &stateID=<stateName>

icon_comment

Der WebOffice 10.9 R3 Client erzeugt z.B. einen Stand, wenn ein Symbol platzieren oder eine Markierung (Markieren) an einen anderen Nutzer via E-Mail geschickt wird.

userprofile

Lädt das spezifizierte Nutzerprofil, wenn der WebOffice 10.9 R3 Client gestartet wird; userprofile ist die Bezeichnung eines gespeicherten Profils auf dem Server.

startmode

icon_comment

Verwenden Sie externalcall.jsp anstelle von synserver, um diese Parameter zu übergeben.

popup: Der WebOffice 10.9 R3 Client startet in einem neuen Browser-Fenster ohne browserspezifische Navigationsschaltflächen.

popupfixed: Genauso wie startmode=popup, nur kann das Browser-Fenster vom Benutzer in der Größe nicht verändert werden.

winwidth

winheight

Die Parameter winwidth und winheight spezifizieren die Breite und die Höhe des öffnenden Browser-Fensters in Pixeln.

icon_comment

Diese Parameter können nur in Kombination mit startmode=popup/popupfixed verwendet werden.

ribbon

Verwenden Sie diesen Parameter, wenn Sie eine bestimmte Registerkarte im WebOffice core Client direkt geöffnet haben wollen.

icon_comment

Um diesen Aufruf nutzen zu können, muss die externe Kennung bei den Ribbons konfiguriert sein (Siehe Kapitel Multifunktionsleisten).

Falls z.B. die externe Kennung im WebOffice author standalone Navigation lautet, dann verwenden Sie: &ribbon=Navigation, um die zugehörige Registerkarte geöffnet zu haben.

Dieser Konfigurationsparameter ist WebOffice core Client spezifisch.

maximizemap=true

Durch die Angabe des Parameters maximizemap=true wird der WebOffice core Client im Maximierungsmodus (alle Registerkarten und Menüs sind eingeklappt) gestartet.

icon_comment

Dieser Konfigurationsparameter ist WebOffice core Client spezifisch.

time_slider_profile_id

Durch den Parameter time_slider_profile_id kann eines der definierten Zeitverläufe Profile durch die Kennung für externen Aufruf vorausgewählt werden.

icon_comment

Dieser Konfigurationsparameter ist WebOffice core Client spezifisch.

statusbar

Wenn der Parameter statusbar auf false gesetzt wird, dann wird der WebOffice html Client ohne Anzeige der WebOffice Statusbar gestartet.

icon_comment

Dieser Parameter steht nur im WebOffice core Client zur Verfügung.

toolbar

Wenn der Parameter toolbar auf false gesetzt wird, dann wird der WebOffice html Client ohne Anzeige der WebOffice Toolbar gestartet.

icon_comment

Dieser Parameter steht nur im WebOffice core Client zur Verfügung.

show_toc

Wenn der Parameter show_toc auf true gesetzt ist, dann wird der WebOffice flex Client mit geöffnetem Themenbaum gestartet.

icon_comment

Dieser Konfigurationsparameter ist WebOffice flex Client spezifisch.

maponly

Wenn der Parameter maponly auf true gesetzt wird, dann wird der WebOffice html Client in einem speziellen GUI-Modus gestartet, wobei nur die Karte angezeigt wird.

icon_comment

Dieser Parameter steht nur im WebOffice core Client zur Verfügung.

ct

cd

display

Diese Parameter werden verwendet, um Sachdaten an WebOffice 10.9 R3 zur Anzeige im Client und für den Ausdruck zu übergeben. Diese Sachdaten können aus einer Fremdapplikation kommen und können via URL Aufruf übergeben werden (http POST). Diese beiden Parameter werden zusammen verwendet, d. h. ein Wertepaar muss aus customtitle ct und customdata cd bestehen. Es ist möglich, mehrere Sachdatensätze dem URL Call Interface zu übergeben (ct<1>;cd<1> bis ct<n>;cd<n>)

ct1=ID; cd1=123;

ct2=Name; cd2=Huber;

ct3=Stadt; cd3=Wien;

icon_comment

Um diese Funktion nutzen zu können, muss zumindest ein Textfeldpaar (ct1 und cd1) in der genutzten Druckvorlage ankonfiguriert sein. Weitere Informationen erhalten Sie im Kapitel Druckvorlagen bearbeiten.

 

Für die Positionierung des Fensters (iFrame, welches die Sachdaten enthält) im WebOffice 10.9 R3 Client wird ein Zusatzparameter display übergeben:

topleft

topright

bottomleft

bottomright

floating

hidden

floating_minimized

 

icon_comment

Im WebOffice core Client wird durch die Werte topleft|topright|bottomleft|bottomright das Fenster im linken Bereich angedockt.

Die Werte floating|floating_minimized führen dazu, dass das Fenster übers Kartenbild gelegt wird und verschoben werden kann.

Mit dem Wert hidden wird das Fenster in den versteckten Bereich geladen.

 

Die Anzeige im Client erfolgt dabei tabellarisch mit zwei Spalten, die erste Spalte enthält den customtitle ct, die zweite customdata cd. Sofern die Werte zu lang sind, erfolgt automatisch ein Zeilenumbruch.

 

icon_comment

Ein automatischer Zeilenumbruch kann nur dann erfolgen, wenn die übergebene Zeichenkette einen Umbruch zulässt.

Ein im Sachdatenwert enthaltener Zeilenumbruch in der Form \n wird bei der Anzeige entsprechend interpretiert.

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?project=WebOffice_SampleProject&ct1=Währung&cd1=Schweizer Franken&ct2=BIP pro Kopf&cd2=$ 68.433&ct3=Inflationsrate (2008)&cd3=0,7 Prozent&ct4=Erwerbstätige (2009)&cd4=ca. 4,53 Mio&display=topright

 

Weiter ist es möglich, die übergebenen Sachdatensätze im Ausdruck zu verwenden (in Analogie zu Adresse, Ort, etc.) falls diese entsprechend auf der Druckvorlage konfiguriert sind. Für nähere Informationen siehe Kapitel Sachdaten auf Druckvorlage.

Kartendarstellung und Position

view

Definiert die verwendete Kartenansicht des Kartenbildes im WebOffice 10.9 R3 Client.

icon_comment

Die Konfiguration einer Kartenansicht enthält eine eindeutige Kennung (Kennung für externen Aufruf).

Falls z.B. die Kennung in WebOffice author standalone citymap lautet, verwenden Sie: view=citymap

basemapview

Bestimmt die initiale Hintergrundkarten Ansicht des Kartenbildes.

icon_comment

Die Konfiguration einer Hintergrundkarten-Ansicht enthält eine eindeutige Kennung (Kennung für externen Aufruf).

 

Falls z.B. die Kennung in WebOffice author standalone orthofoto lautet, verwenden Sie: basemapview=orthofoto

geo_bookmark

Verwenden Sie diesen Parameter, wenn Sie die Karte in einem bestimmten Bereich darstellen möchten.

icon_comment

Um diesen Aufruf zu nutzen, muss zumindest ein Geo-Bookmark konfiguriert sein (Siehe Kapitel Geo-Bookmark).

 

Falls z.B. die Kennung in WebOffice author standalone Wien lautet, dann verwenden Sie: geo_bookmark=Wien

xmin

ymin

xmax

ymax

Verwenden Sie diese 4 Parameter, um den initialen Kartenausschnitt festzulegen.

x

Verwenden Sie diesen Parameter, um für die Initialisierung den Zentrumspunkt (X-Koordinate) festzulegen

y

Verwenden Sie diesen Parameter, um für die Initialisierung den Zentrumspunkt (Y-Koordinate) festzulegen

lat

lon

Startet die Anwendung zentriert auf die angegebene Position (WGS84), welche durch die Parameter lat/lon (Dezimalgrad, Separator = .) festgelegt wird. Funktioniert mit jedem Projekt; lat/lon werden von WGS84 in das Projekt-Koordinatensystem projiziert.

scale

Verwenden Sie diesen Parameter, um für die Initialisierung den Maßstab festzulegen.

icon_comment

Dieser Parameter kann nur in Kombination mit den Parametern x und y verwendet werden!

rotation

Dieser Parameter dient dazu, einen externen Projektaufruf mit einer bestimmten Kartendrehung abzusetzen. Die Angabe erfolgt dabei in Grad (z.B. &rotation=55)

icon_comment

Bei einem externen Aufruf wird dieser Parameter nur dann berücksichtigt, wenn die Funktion zur Kartendrehung im WebOffice author standalone konfiguriert wurde und dort auch die Rotation über einen Parameter zugelassen wird (siehe dazu Gedrehte Kartendarstellung).

width

Breite (in Pixel) des Kartenbildes

height

Höhe (in Pixel) des Kartenbildes

dpi

Ermöglicht es hochwertige Kartenbilder für Fremdapplikationen bereitzustellen. Defaultmäßig erfolgt die Darstellung mit 96dpi; durch die Angabe dieses Parameters kann nun ein vielfaches von 96 angegeben werden, z.B.: dpi=192 oder dpi=288

icon_comment

Wird z.B. ein Kartenbild mit &dpi=288 abgefragt, dann handelt es sich um ein 288 dpi Bild, welches aber bezüglich 96 dpi dargestellt wird. Daher muss auch die Bildgröße dementsprechend angepasst werden. - In diesem Fall (288 dpi; dreifaches von 96 dpi) muss dann auch ein drei mal so großes Bild angezeigt werden (width/height).

exclude_north_and_scale=true

Durch die Angabe des Parameters exclude_north_and_scale=true wird nur das Kartenbild angezeigt. Der Nordpfeil, die Maßstabsleiste und das Copyright werden durch diesen Parameter in weiterer Folge unterdrückt.

geo_tf

Legt eine geographische Transformation fest (EPSG Code, z.B. geo_tf=1618: MGI zu WGS84), welche für Koordinatenprojektion verwendet wird.

icon_comment

EPSG Codes können aus dem Projection and Geotransformation Helper entnommen werden.

Eine geographische Transformation mit dem Befehl geo_tf ist nur für lat/lon Werte vorgesehen. Es ist nicht möglich eine andere Transformation zu verwenden, als im Projekt schon ankonfiguriert ist.

coordmarker_lat_lon

Zeigt ein Bild (standardmäßig pub\images\meet_x_20_20.png) zur Markierung jener Stelle, die durch die angegebenen Koordinaten (Latitude / Longitude) festgelegt ist. Trennen Sie die beiden Koordinaten entweder durch ein Leerzeichen oder durch %20.

icon_comment

Das Bild kann durch Angabe des Parameters coordmarker_id geändert werden.

 

Beispiel:

&coordmarker_lat_lon=47.069 15.435

&coordmarker_lat_lon=47.069%2015.435

coordmarker_x_y

Zeigt ein Bild (standardmäßig pub\images\meet_x_20_20.png) zur Markierung jener Stelle, die durch die angegebenen Koordinaten (X / Y) festgelegt ist. Trennen Sie die beiden Koordinaten entweder durch ein Leerzeichen oder durch %20.

icon_comment

Dieser Parameter kann auch mehrere, durch Strichpunkt getrennte Koordinatenpaare beinhalten.

Es werden pro Koordinate nur die ersten zwei Achsen berücksichtigt, zusätzliche Informationen wie beispielsweise z- oder m-Werte werden verworfen.

Bei den angegebenen Koordinatenpaaren wird die Reihenfolge X Y erwartet.

coordmarker_epsg

Optionaler Parameter, der jedoch im Zusammenhang mit dem Parameter coordmarker_x_y immer dann angegeben werden muss, wenn sich das Ausgangskoordinatensystem (Projektion der zu übergebenden Marker-Koordinaten) vom Zielkoordinatensystem (Projektion des Hauptkartendienstes im WebOffice 10.9 R3 Projekt) unterscheidet. Als Standardwert wird ansonsten immer das Koordinatensystem des Hauptkartendienstes verwendet.

coordmarker_geo_tf

Optionaler Parameter. Falls die Marker in X/Y Koordinaten übergeben werden sollen und sich das Ausgangskoordinatensystem (Projektion der zu übergebenden Marker-Koordinaten) vom Zielkoordinatensystem (Projektion des Hauptkartendienstes im WebOffice 10.9 R3 Projekt) unterscheidet, kann hier ein entsprechender Transformationscode angegeben werden.

icon_comment

Wenn in der WebOffice 10.9 R3 Projektkonfiguration bereits ein entsprechender Transformationscode am SynOutputService konfiguriert wurde, wird der im externen Aufruf übergebene Transformationscode nicht berücksichtigt.

Wenn weder die WebOffice 10.9 R3 Projektkonfiguration, noch der externe Aufruf einen entsprechenden Transformationscode beinhaltet, wird die von ArcGIS standardmäßig vorgeschlagene und verwendete Transformation zur korrekten Darstellung des Markers herangezogen.

coordmarker_id

Geben Sie hier jene ID an, die in WebOffice author standalone beim Werkzeug Symbol platzieren als Kennung für externen Aufruf konfiguriert ist. Dieses Bild wird an jener Stelle dargestellt, die im Parameter coordmarker_lat_lon oder coordmarker_x_y festgelegt ist.

marker

Wenn marker=true gesetzt ist, dann wird das Projekt mit einem zentrierten Marker gestartet, wenn es in Kombination mit x, y, scale oder lat, lon, scale aufgerufen wird.

service_url

service_type

layer_visibility

Fügt dynamisch zur Laufzeit einen Kartendienst hinzu (Der Aufruf soll auf externalcall.jsp gerichtet sein, kann aber von dort auf synserver umgelenkt werden).

Der Parameter service_url spezifiziert die URL des Kartendienstes, der eingebunden werden soll.

Der Parameter service_type spezifiziert den Typ des Dienstes, der eingebunden werden soll (aktuell WMS für OGC WMS Dienste oder AGS für ArcGIS Server Internet Dienste).

Der Parameter layer_visibility (on|off; Standardmäßig = off) definiert den Status der Layer des hinzugefügten Services.

geolocation

Ist das Werkzeug Standortbestimmung im Projekt konfiguriert, so lässt sich mit dem Parameter geolocation=false das Projekt ohne Standortbestimmung aufrufen.

Externe Suchanfragen an WebOffice

query

 

Um eine Suche in WebOffice 10.9 R3 auszuführen, kann dieser Parameter übergeben werden.

WebOffice 10.9 R3 führt dann die Suche im Client durch und zeigt die Ergebnisse im Suchergebnis und der Karte an.

Der Parameter query identifiziert eine vordefinierte Suche (siehe dazu Kapitel Suche/Abfrage).

icon_comment

Um Abfrage, Keyname- und Keyvalue-Parameter nutzen zu können, sind eine Externe-Layer-ID und ein Suchfeld nötig.

 

Suche mit mehreren Suchfeldern:
Es ist auch möglich, mehrere Suchfelder zu benutzen. Wenn Sie beispielsweise Adressdaten mit den Attributfeldern STRASSENNAME und HNR (=Hausnummer) haben, dann ist es möglich, spezifisch nach STRASSENNAME UND HAUSNUMMER zu suchen (Suche beispielsweise nach der Adresse Herrengasse, 1).
Dies geschieht durch die Übermittlung eines URL Aufrufs wie beispielsweise:
https://gisserver/WebOffice/externalcall.jsp?project=WebOffice_SampleProject&client=core&query=address&keyname=STRASSENNAME&keyvalue=Herrengasse&query1=address&keyname1=HNR&keyvalue1=1

Verwendung von Platzhalter:
Durch Verwendung des * Zeichens ist es möglich, nach Suchwerten mit einem Platzhalter zu suchen. So kann man z.B. durch Verwendung von keyvalue=M* nach Namen suchen, welche mit M beginnen.

Multilayer-Suchen:
Multilayer-Suchen können durchgeführt werden, indem die Parameter query, keyname und keyvalue wiederholt werden und ein Suffix angehängt wird.
Sie können jedes Suffix verwenden (Zahlen, Buchstaben etc.), solange es mit query, keyname und keyvalue verbunden wird.

 

icon_comment

Beachten Sie, dass der WebOffice-Aufruf mittels Multilayer-Suche nur im WebOffice core Client verfügbar ist, weil nur dort ein Objektbrowser verfügbar ist, der Multilayer-Ergebnisse anzeigen kann.

Zum Aufruf mehrfacher hierarchischer Suchen siehe Parameter processing.

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?project=name&query=queryid_layer1&keyname=field_layer1&keyvalue=value_layer1&query2=queryid_layer2&keyname2=field_layer2&keyvalue2=value_layer2

 

https://gisserver/WebOffice/externalcall.jsp?project=name&query_A=queryid_layer1&keyname_A=field_layer1&keyvalue_A=value_layer1&query_B=queryid_layer2&keyname_B=field_layer2&keyvalue_B=value_layer2

 

 

Geolocator-Abfrage:
WebOffice 10.9 R3 unterstützt auch Geolocator-Abfragen, indem die Parameter query und keyvalue übergeben werden. Der Parameter query beinhaltet jenen Wert, der in der Geolocator-Abfrage als Kennung für externe Suche vergeben wurde (siehe Kapitel Suche/Abfrage), keyvalue beinhaltet die Adresse für die Geolocator-Suche.
 
Beispiel:
https://gisserver/WebOffice/externalcall.jsp?project=name&query=geoloc&keyvalue=Herrengasse 1, 8010 Graz

keyname

 

Name des Suchfelds

icon_comment

Verwenden Sie für den keyname ausschließlich den technischen Feldnamen und nicht die Alias-Bezeichnung des Feldes.

keyvalue

Name des Suchwerts

m_from

m_to

Die Parameter m_from und m_to dienen der Suche nach Routensegmenten und funktionieren nur in Kombination mit den Parametern query, keyname und keyvalue. Zudem ist auch möglich eine Multiquery auf m_from und m_to zu definieren, um gegebenenfalls mehrere Abschnitte gleichzeitig selektieren zu können.

icon_cross-reference

Nähere Informationen zur Konfiguration finden Sie im Kapitel Suchen/Abfragen auf Layer (Parameter Dynamische Segmentierung).

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?project=SampleProject&query=road_routing&keyname=road_code&keyvalue=A23&m_from=13&m_to=18.5

separator

Der Parameter separator definiert die Trennung zwischen mehreren Suchwerten (keyvalue).

icon_comment

Folgende Trennzeichen können verwendet werden: @ ; - ! ~ / : =

Standardmäßig wird das Zeichen *;* (Strichpunkt) als Trennzeichen benutzt.

selection_type

Der Parameter selection_type definiert die Art, wie die Selektion ausgeführt wird:

new|add|subtract (Neu/Hinzufügen/Entfernen)

icon_cross-reference

Mehr Details zum Selektionsmodus im WebOffice core Client siehe Kapitel Selektieren.

gui

Der Parameter gui definiert die Anzeige der grafischen Ergebnis-Benutzeroberfläche:

hideresult zeigt die attributive Ergebnistabelle an, minimiert es aber, um eine größere Kartendarstellung zu ermöglichen;

maponly zeigt die WebOffice GUI in einem Modus mit maximierter Kartendarstellung an; die attributive Ergebnistabelle wird minimiert, der linke und rechte Bereich werden ebenfalls minimiert

icon_comment

Der Parameter maponly steht nur im WebOffice core Client zur Verfügung.

mode

Der Parameter mode definiert den Modus für die externen Suchaufrufe.

Mögliche Werte sind:

zoom_to
Kein attributives Suchergebnis wird angezeigt, die Objekte sind in der Karte selektiert, in der Karte wird auf den Extent der abgefragten Objekte gezoomt

zoomto_minimized
Minimierte attributive Ergebnisdarstellung, Merkmale werden auf der Karte ausgewählt dargestellt, Kartenzoom auf den Umfang der abgefragten Merkmale

icon_comment

Der Parameter zoomto_minimized ist nur im WebOffice mobile Client unterstützt

zoom_only
Kein attributives Suchergebnis wird angezeigt, keine Selektion der abgefragten Objekte in der Karte, in der Karte wird auf den Extent der abgefragten Objekte gezoomt

result_only
Nur das attributive Suchergebnis wird angezeigt, keine Selektion der abgefragten Objekte in der Karte, kein Karten Update

pan_only
Kein attributives Suchergebnis wird angezeigt, keine Selektion der abgefragten Objekte in der Karte, in der Karte erfolgt ein pan zum Zentrum des Extents der abgefragten Objekte

locate_features
Kein attributives Suchergebnis wird angezeigt, keine Selektion der abgefragten Objekte in der Karte, kein Karten Update aber die Position jedes abgefragten Objekts im aktuellen Kartenausschnitt wird für wenige Sekunden durch images angezeigt

clear_selected
Löscht die aktuelle Selektion, entfernt das attributive Suchergebnis, entfernt die Selektion in der Karte

processing

Der Parameter processing definiert die Verarbeitung mehrerer Abfragen, die durch keyname, keyvalue, ... spezifiziert sind:

combined (Standardwert)
Mehrere Abfragen werden zu einer minimalen Anzahl von Statements zusammengeführt (implizites AND).

separated
Für jede URL-Abfrage wird ein eigenes Statement erstellt (implizites OR). Durch Angabe von &processing=separated können mehrfache hierarchische Suchen über das URL Call Interface ausgelöst und dargestellt werden.

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?

query1=gst&keyname1=gemeinde&keyvalue1=Kehrsatz&keyname1=GST_NR&keyvalue1=890&query2=gst&keyname2=gemeinde&keyvalue2=Köniz&keyname2=GST_NR&keyvalue2=890;891&processing=separated

icon_comment

Mit Strichpunkt ; getrennte Werte werden OR-verknüpft.

 

Der Parameter &processing=separated bedeutet, dass intern zuerst query1=gst&keyname1=gemeinde&keyvalue1=Kehrsatz&keyname1=GST_NR&keyvalue1=890, dann

query2=gst&keyname2=gemeinde&keyvalue2=Köniz&keyname2=GST_NR&keyvalue2=890;891

ausgeführt wird und die Ergebnisse OR-Verknüpft. Alle Bedingungen, die zum selben Nummernkreis (1, 2) gehören, werden intern AND-verknüpft.

query_preset

Legt den standardmäßig verwendeten Layer oder die standardmäßig verwendete Suche fest.

icon_comment

Verwenden Sie die Kennung für externe Suche der Suche/Abfrage.

Externe Filter-Definitionen an WebOffice

filter

 

 

Definiert die externe Kennung für den Layer

icon_comment

Für die Möglichkeit externe Filter auf einen Layer abzusetzen, muss ein Extern aufrufbarer Filter konfiguriert sein.

 

Eine Kombination von Filtern über mehrere Layer ist erlaubt, wenn die gleichen Regeln wie bei Multilayer-Suchen eingehalten werden.

icon_cross-reference

Für mehr Details siehe Abschnitt Multilayer-Suchen und Beispiele.

 

Eine Kombination von Abfrage und Filter ist erlaubt, wenn die gleichen Regeln wie bei Multilayer-Suchen eingehalten werden.

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?query=queryid_layer1&keyname=field_layer1&keyvalue=value_layer1&filter2=queryid_layer2&keyname2=field_layer2&keyvalue2=value_layer2

keyname

Name des Suchfelds (Datenbank-Feldname, nicht der konfigurierter Alias)

keyvalue

Name des Suchwerts

query_filtered

Der Parameter query_filtered bietet eine einfache Möglichkeit, um eine Abfrage und einen Filter auf einen Layer mit den gleichen Parametern zu kombinieren.

 

Beispiel lange Form:

https://gisserver/WebOffice/externalcall.jsp?query=queryid_layer1&keyname=field_layer1&keyvalue=value_layer1&filter2=queryid_layer1&keyname2=field_layer1&keyvalue2=value_layer1

 

Beispiel kurze Form:

https://gisserver/WebOffice/externalcall.jsp?query_filtered=queryid_layer1&keyname=field_layer1&keyvalue=value_layer1

 

icon_comment

Damit Sie diesen Parameter verwenden können, müssen Sie auch einen Extern aufrufbarer Filter und eine Filternde Suche konfigurieren.

resetfilter

Definiert die externe Kennung für den Layer (setzt einen gesetzten Filter auf die Layer zurück)

Starten von WebOffice mit einem vordefinierten aktiven Werkzeug

tool

Verwenden Sie den Parameter tool, um ein bestimmtes Werkzeug beim Aufruf zu aktivieren.

icon_comment

Um ein Werkzeug mittels URL Call Schnittstelle aufzurufen, muss dem entsprechenden Tool in der Projektkonfiguration eine externe Kennung zugewiesen werden.

Es ist weder sinnvoll noch möglich, alle Werkzeuge mit der URL Call Schnittstelle aufzurufen. WebOffice 10.9 R3 unterstützt nur bestimmte Werkzeuge zum Aufruf über die URL Call Schnittstelle.

Neben Standardwerkzeugen können auch benutzerdefinierte Werkzeuge auf diese Weise direkt beim Projektstart geöffnet werden.

 

Untenstehend finden Sie eine Liste mit sämtlichen Kennungen von Werkzeugen, welche unterstützt werden:

EDIT
Öffnet Werkzeug Editieren

icon_comment

Für mehr Details zum Parameter tool=edit siehe WebOffice URL Call Schnittstelle zum Editieren.

HELP
Öffnet Werkzeug Hilfe

IDENTIFY_LAYER
Öffnet Werkzeug Identifizieren

IDENTIFY_MAPTIP
Öffnet Werkzeug Identifizieren - MapTip

LABEL
Öffnet Werkzeug Objekt beschriften

MARKUP
Öffnet Werkzeug Zeichnen

MEASURE_ARCLENGTH
Öffnet Werkzeug Winkel messen

MEASURE_AREA
Öffnet Werkzeug Fläche messen

MEASURE_LINE
Öffnet Werkzeug Entfernung messen

MEASURE_PERPENDICULAR
Öffnet Werkzeug Lotrecht messen

MEASURE_POINT
Öffnet Werkzeug Punkt messen

PRINT
Öffnet Werkzeug Drucken (Legacy)

RASTERINFO
Öffnet Werkzeug Rasterwert abfragen

UPLOAD_GEODATA
Öffnet Werkzeug Daten hinzufügen

WebOffice mit vordefiniertem Druckwerkzeug starten

tool=print

Öffnet beim Projektstart das Werkzeug Drucken (Legacy)

icon_comment

VertiGIS Printing wird dabei nicht unterstützt.

template_id

Dieser Parameter gilt nur in Verbindung mit dem Parameter tool=print für Werkzeug Drucken (Legacy).

Durch den Parameter template_id  kann eine bestimmte Druckvorlage vorausgewählt werden. Hierbei ist die Kennung für externen Aufruf zu übergeben, welche direkt auf der jeweiligen Druckvorlage im WebOffice author standalone konfiguriert wird.

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?project=WebOffice_SampleProject&client=core&tool=print&template_id=A3portrait&printfields=Referenznummer;Projektname;orgadr_value&printvalues=1234;Test-Projekt;Technologiestrasse 10

printfields

Dieser Parameter gilt nur in Verbindung mit dem Parameter tool=print für Werkzeug Drucken (Legacy), sowie den Parametern template_id und printfvalues.

Dabei kann über den Parameter printfields die Kennung des Feldinhaltes/der Feldbezeichnung von Druckfeldern und Generischen Funktionsfeldern (bei mehreren Werten durch Semikolon getrennt) übergeben werden.

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?project=WebOffice_SampleProject&client=core&tool=print&template_id=A3portrait&printfields=Referenznummer;Projektname;orgadr_value&printvalues=1234;Test-Projekt;Technologiestrasse 10

printvalues

Dieser Parameter gilt nur in Verbindung mit dem Parameter tool=print für Werkzeug Drucken (Legacy), sowie den Parametern template_id und printfields.

Dabei kann über den Parameter printvalues der Feldinhalt/die Feldbezeichnung (konkreter Wert) von Druckfeldern und Generischen Funktionsfeldern (bei mehreren Werten durch Semikolon getrennt) übergeben werden.

 

Beispiel:

https://gisserver/WebOffice/externalcall.jsp?project=WebOffice_SampleProject&client=core&tool=print&template_id=A3portrait&printfields=Referenznummer;Projektname;orgadr_value&printvalues=1234;Test-Projekt;Technologiestrasse 10

WebOffice mit vordefinierter Layerschaltung starten

map_layers_visibility

Dieser Parameter sorgt für die Aktivierung von Themen im Themenbaum (TOC) mittels URL Call Interface.

Format: "<extcallid>:<ON|OFF>"

":ON" kann weggelassen werden, d.h. "<extcallid>" ist gleichzusetzen mit "<extcallid>:ON"

Es können mehrere Konfigurationen mit ";" kombiniert werden

 

Als extcallid wird die konfigurierte externe Kennung „extcallid“ in "Suche/Abfragen auf Layer (LAYERLIST)" -> "ArcGIS Layer (LAYER)" -> "Suche/Abfrage (QUERY)" verwendet. Geschaltet wird der Layer, der als Überknoten "LAYER" definiert ist. Es werden nur Suchen verwendet, auf die der aktuelle Benutzer auch Berechtigungen hat.

 

icon_comment

Die Zeichen ";" und ":" sind in einer extcallid zu vermeiden, wenn diese für eine Layerschaltung über den Parameter map_layers_visibility benutzt werden soll.

 

Dieser Parameter greift sowohl initial, als auch bei externen Aufrufen zu einer bestehenden Session. Es werden nur die angegebenen Layer im aktuellen TOC geschaltet. Alle anderen Layer bleiben unverändert.

 

Wenn dieser URL-Parameter verwendet wird, wird im Dropdown "Kartenansicht" der Eintrag "<Freie Ansicht>" selektiert. Dies geschieht auch dann, wenn beim Projektstart zusätzlich eine spezifische Kartenansicht definiert wurde, da sich die Schaltung des Themenbaums von der originalen Konfiguration der Kartenansicht unterscheidet.

 

Es können nur einzelne Themen geschaltet werden, nicht Themengruppen oder Dienste. Falls das aktivierte Thema in einer Gruppe oder einem Dienst liegt, welcher nicht als sichtbar geschaltet ist, wird das Thema nicht auf dem Kartenbild dargestellt. Dies ist konsistent mit dem Verhalten wenn das entsprechende Kästchen vom Endbenutzer mit der Maus aktiviert wird, statt über den URL Parameter.

 

Um verschachtelte Layer über den URL Parameter einblenden zu können, wird empfohlen, eine Kartenansicht zu verwenden in der alle Dienste und Themengruppen bereits aktiv sind.

 

Beispiel: https://gisserver/WebOffice/externalcall.jsp?project=name&map_layers_visibility=emergency:OFF;poi:ON

WebOffice mit vordefiniertem Umgebungskreis starten

concentric_circle_radius

Der Radius muss in Double-Werten in Meter angegeben werden (z. B. 2, 5, 10).

concentric_circle_rings

Mit diesem Parameter kann die Anzahl der inneren Kreise gesteuert werden. Diese Konfiguration ist optional.
Erlaubt sind folgende Werte: 1, 2, 3, 4, 5, 6, 8, 10, 15, 20

 

Der Standardwert ist 3.

concentric_circle_label

Mit diesem Parameter wird gesteuert, ob die Kreise beschriftet werden sollen (true oder false). Die Konfiguration ist optional.

 

Standardmäßig ist hier true definiert.

concentric_circle_crosshair

Dieser Parameter steuert das Fadenkreuz. Hier kann man wählen zwischen NONE, FOUR oder EIGHT. Die Konfiguration ist optional.

 

Der Standardwert ist EIGHT.

concentric_circle_x_y

Dieser Parameter ist optional. Hier kann mit Double-Werten die Position des Umgebungskreises in X- und Y-Koordinaten bestimmt werden.

 

Standardmäßig wird hier die Bildschirmmitte zur Positionierung herangezogen.

concentric_circle_epsg

Dieser Parameter ist optional. Mit dieser Konfiguration können der EPSG-Code oder ein WKT (Well-Known-Text) zur Darstellung des Umgebungskreises definiert werden.

 

Standardmäßig wird hier die Projektion des Hauptkartendienstes verwendet.

concentric_circle_geo_tf

Dieser Parameter ist optional. Mit dieser Konfiguration können der EPSG-Code oder ein WKT (Well-Known-Text) zur Darstellung des Umgebungskreises definiert werden.

 

Standardmäßig wird hier keine Transformation verwendet.

concentric_circle_id

Dies ist auch eine optionale Konfiguration. Hier kann die External Call ID eines Markierungsstils angegeben werden.

 

Standardmäßig ist hier kein vordefinierter Stil festgelegt.

 

 

icon_comment

Beachten Sie, dass in einer WebOffice-Session die Definition mehrerer Umgebungskreise über URL-Parameter mit einem Parameter-Postfix 0...n Umgebungskreise definiert werden können.

 

Beispiel:

concentric_circle_radius_1, concentric_circle_radius_two, concentric_circle_radius_bahnhof

WebOffice 10.9 R3 URL Call Schnittstelle – Aktionen und Parameter

 

Um einen Eindruck zu bekommen, wie man die WebOffice URL Call Schnittstelle nutzt und, um eine Testmöglichkeit für die Aufrufe zu haben, stellt VertiGIS eine Testseite für externe Aufrufe (WebOffice - External call generator and test utility aus Datei testextcall.htm) zur Verfügung, um die Funktionalität ansehen und testen zu können.

Rufen Sie diese mit https://myserver.domain.com/<WebOffice web application>/testextcall.htm auf oder in der WebOffice Administrationsseite (SynAdmin) im Bereich Anwendung (Testseite für externe Aufrufe).

 

Testseite für externe Aufrufe

Testseite für externe Aufrufe

Ⓒ Copyright 2023 by VertiGIS GmbH