Web-Integration - generisches Werkzeug

Mit WebOffice 10.9 R3 ist es möglich generische Werkzeuge (Custom Tools) zu benutzen. Durch die Benutzung eines generischen Werkzeuges ist es möglich die WebOffice 10.9 R3 Funktionalität mit frei wählbarer Werkzeugfunktionalität zu erweitern. Die generische Werkzeug Funktionalität und das Formular des Werkzeuges können durch VertiGIS oder durch den Kunden nach den Bedürfnissen entwickelt werden. Dafür wird die ESRI API Technologie benützt. Zusätzlich stellt WebOffice 10.9 R3 eine leicht zu benutzende API bereit, welche wie folgt implementiert ist:

• HTTP GET/POST Protokoll Level (ähnlich zu ArcGIS Server REST API) oder

•JavaScript Level (ähnlich zu ArcGIS Server Javascript API)

 

icon_comment

•Den vollen Funktionsumfang an generischen Werkzeugen findet man nur für den WebOffice core Client. In anderen Clients sind generische Werkzeuge nur teilweise oder gar nicht verfügbar.

•Für den WebOffice mobile Client sind folgende generische Werkzeuge unterstützt: Statisches Custom Tool, Einfaches Custom Tool (Modus: Click point & Line) und Erweitertes Custom Tool (Modus: Click point)

•Ungruppiert, dh. als Unterknoten zu Werkzeuge, können maximal 25 generische Werkzeuge ankonfiguriert werden.

•In der Werkzeuggruppe Web-Integration können maximal 25 generische Werkzeuge ankonfiguriert werden.

•In anderen Werkzeuggruppen (z.B. Werkzeuggruppe Navigation) können maximal zwei generische Werkzeuge ankonfiguriert werden.

•In der Werkzeuggruppe Web-Integration für das MapWidget (Projektkonfiguration > WebOffice Map Widget > Werkzeuggruppe > Web-Integration) können maximal 10 generische Werkzeuge ankonfiguriert werden.

 

Nähere Details zum WebOffice 10.9 R3 generischen Werkzeugkonzept entnehmen Sie bitte der folgenden Darstellung. Die generische Werkzeugimplementierung benutzt möglicherweise frei wählbare Web-Technologie und ESRI API. Diese Entscheidung kann frei von dem Kunden, welcher das generische Werkzeug entwickelt, getroffen werden.

WebOffice 10.9 R3 generisches Werkzeug Konzept

WebOffice 10.9 R3 generisches Werkzeug Konzept

 

Web-Integration - Konfiguration generisches Werkzeug 

Web-Integration - Konfiguration generisches Werkzeug 

 

Eigenschaft

Beschreibung

URL der externen Seite

Vollständige URL für die externe Webseite/Anwendung

Tool tip

Name des Werkzeugs, der als Mouseover (Tool tip) angezeigt wird. Als Label kann dieser Tool tip weiterhin durch einen Namen in der Multifunktionsleiste überschrieben werden.

Übergabe-Modus

Legt den Übergabe-Modus der dynamischen Informationen an die externe Webseite/-anwendung fest:

•HTTP: Übergabe von Koordinaten und/oder Objektschlüssel von WebOffice 10.9 R3 zu einer externen Webseite via HTTP (Parameter werden im QueryString (?objectkeys=xxx&coords=xxx) des HTTP Requests übergeben). Die Ergebnisse werden in einem neuen Fenster angezeigt.

icon_comment

Das benutzerdefinierte Werkzeugformular benötigt ein Zielfenster (z.B. hidden iframe) namens weboffice_tool_target. Die Parameter werden zur konfigurierten URL der externen Seite für Parameteraustausch unter Verwendung des Ziels weboffice_tool_target gesendet.

•JavaScript: Übergabe von Koordinaten und/oder Objektschlüssel von WebOffice 10.9 R3 zu einer externen Webseite durch JavaScript Funktionsaufruf der konfigurierten Webseite.

icon_comment

Das benutzerdefinierte Werkzeugformular muss von Javascript aus innerhalb des WebOffice 10.9 R3 Anwendungsfensters zugänglich sein, daher muss das Werkzeugformular innerhalb der gleichen HTTP-Domäne ausgeführt werden. Parameter werden an die Javascript-Funktion des benutzerdefinierten Werkzeugs (konfiguriert in Javascript function) gesendet.

HTTP GET verwenden

Legt fest, ob die Parameter von WebOffice an die Externe Anwendung über HTTP GET oder HTTP Post (formularbasierend) übergeben werden.

icon_comment

Diese Einstellungen sind nur relevant bei Übergabemodus HTTP.

URL der externen Seite für Parameteraustausch

Vollständige URL für die externe Web-Seite/Anwendung, die für den Parameteraustausch benötigt wird (Übergabe-Modus HTTP).

Fang-Funktion bereitstellen?

Legt fest, ob die Fang-Funktion im Werkzeugformular bereitgestellt werden soll (Ja) oder nicht (Nein).

Kennung für externen Aufruf

Legt die Tool-ID für externe Aufrufe fest

Berechtigungskennung

Berechtigungskennung, die für die Zugriffskontrolle im WebOffice usermanagement benötigt wird.

Wird in diesem Attribut eine Kennung hinterlegt (z.B. MY_CUSTOM_TOOL) und das WebOffice usermanagement verwendet, so wird geprüft, ob die Benutzerrolle über das entsprechende Anwendungsrecht (gemäß Beispiel MY_CUSTOM_TOOL) verfügt. Ist dies nicht der Fall, so wird die Schaltfläche/der Link und damit der Zugriff auf die externe Anwendung aus dem WebOffice nicht erlaubt.

Kartenansicht

Gibt an, in welche Kartenansicht gewechselt werden soll, wenn dieses Werkzeug gewählt wird. Wird keine Ansicht angegeben, so bleibt die Kartendarstellung unverändert.

Werkzeug verwenden?

Legt fest, ob das Werkzeug bzw. die Funktion im WebOffice Client verwendet werden soll oder nicht.

Javascript Callback beim Schließen

Definiert eine Javascript Methode, die aufgerufen wird, bevor das Werkzeug geschlossen wird.

JavaScript-Funktion

JavaScript-Funktion in der externen Web-Seite, die von WebOffice 10.9 R3 aufgerufen wird, wenn die Benutzereingabe in WebOffice 10.9 R3 beendet ist.

Es wird eine Liste von Objektschlüsseln und eine Liste von Koordinaten (x/y) übergeben.

z.B. ProcessWebOfficeCall(objKeys[],geom[][]).

Benutzerkennung übergeben (x-syn-login)?

Legt fest, ob die Benutzerkennung des in WebOffice 10.9 R3 angemeldeten Benutzers im HTTP Header übergeben werden soll.

icon_comment

Falls ein Benutzerkontext an eine externe Anwendung übergeben wird, wird dieser umadressiert (URL ändert sich von https://extserver/extpage.htm?... nach https://webofficeserver/webofficeapplication/synredirect?...).

Alle in der externen Anwendung verwendeten Pfade müssen dann absolute Pfade sein!

Benutzerkennung übergeben (Base 64)?

Legt fest, ob die Benutzerkennung des in WebOffice angemeldeten Benutzers im HTTP Authorization-Header - Base64-codiert, Basic Authentifizierung - übergeben werden soll.

icon_comment

Falls ein Benutzerkontext an eine externe Anwendung übergeben wird, wird dieser umadressiert (URL ändert sich von https://extserver/extpage.htm?... nach https://webofficeserver/webofficeapplication/synredirect?...).

Alle in der externen Anwendung verwendeten Pfade müssen dann absolute Pfade sein!

WebOffice User Token im Header übergeben?

Legt fest, ob ein WebOffice Benutzer Token  im Header (WebOffice-User-Token) übergeben werden soll.

Assoziiertes Login im Header übergeben?

Legt fest, ob das assoziiertes Login des in WebOffice angemeldeten Benutzers im HTTP Header WebOffice-Associated-Login übergeben werden soll.

Voraussetzung ist, dass das assoziierte Login in der UMDB existiert, für den angemeldeten Benutzer

Werkzeug-Icon

In WebOffice 10.9 R3 stehen im Verzeichnis pub/images zehn verschiedene Vorlagen zur Verfügung (tool_01.gif bis tool_10.gif). Die Icons müssen alle die Größe 16x16 Pixel haben.

Werkzeug-Icon (mobile)

In WebOffice 10.9 R3 steht im Verzeichnis pub/images/mobile die Vorlage customtool_default.png zur Verfügung.

Werkzeug-Icon (flex)

In WebOffice 10.9 R3  stehen im Verzeichnis pub/images/customtool verschiedene Vorlagen zur Verfügung. Die Icons müssen mindestens eine Größe von 24x24 Pixel haben.

Sichtbar in Werkzeugleiste?

Legt fest, ob das Werkzeug in der Werkzeugleiste sichtbar (Ja) oder versteckt (Nein) ist.

Sichtbar in Clients?

Legt fest, in welchen Clients das Werkzeug sichtbar sein soll (Desktop Clients oder Mobile Client).

icon_comment

Bitte beachten Sie, dass der WebOffice mobile Client nur die generischen Werkzeuge Statisches Custom Tool, Einfaches Custom Tool (Modus: Click point & Line) und Erweitertes Custom Tool (Modus: Click point) unterstützt.

Web-Integration - Konfiguration generisches Werkzeug

 

Für Custom Tools kann die Selektionsgrafik und das Klick Icon individuell angepasst werden. Die folgenden Designeinstellungen können ausschließlich im WebOffice core Client genutzt werden.

Die Anpassungen erfolgen in der Datei <%BUILD%> Anwendung>\client_core\jss\vertigis_weboffice_user.xml. Es kann Einfluss auf die folgende Parameter ausgeübt werden:

<?xml version="1.0 encoding="UTF-8"?>

<data>

 <!--Icon for Click point, if show click symbol is set to true on the specific custom tool-->

 <record jsxid="toolcustom.click.icon jsxtext="http://w-ws-gimpl:8080/WebOffice_105_master/pub/images/dynsel_redcircle_small.gif"/

 <!--Width of icon-->

 <record jsxid="toolcustom.click.width jsxtext="24"/>

 <!--Height of icon-->

 <record jsxid="toolcustom.click.height jsxtext="24"/>

 <!--Offset X of icon-->

 <record jsxid="toolcustom.click.offset.x jsxtext="12"/>

 <!--Offset Y of icon-->

 <record jsxid="toolcustom.click.offset.y jsxtext="12"/>

 <!--Size of all vertices-->
 <record jsxid="toolcustom.vertex.size jsxtext="6"/>

 <!--Color of all vertices-->

 <record jsxid="toolcustom.vertex.color jsxtext="#DAA520"/>

 <!--Opacity of all vertices-->

 <record jsxid="toolcustom.vertex.opacity jsxtext="1"/>

 <!--Line width-->

 <record jsxid="toolcustom.line.width jsxtext="3"/>

 <!--Line color-->

 <record jsxid="toolcustom.line.color jsxtext="#FFC700"/>

 <!--Opacity of line-->

 <record jsxid="toolcustom.line.opacity jsxtext="1"/>

 <!--Opacity of fill (when operating with polygons)-->

 <record jsxid="toolcustom.fill.opacity jsxtext="0.5"/>

 <!--Color of fill (when operating with polygons)-->

 <record jsxid="toolcustom.fill.color jsxtext="#FDE17F"/>

<data>

 

Ersetzen Sie den Parameter toolcustom durch die entsprechende Tool-ID für externe Aufrufe (Kennung für externen Aufruf), welche für das entsprechende Custom Tool definiert wurde. Dadurch können je Custom Tool unterschiedliche Selektionsgrafiken und Kick Icons verwendet werden.

 

icon_comment

•Bitte beachten Sie, dass WebOffice 10.9 R3 aus sicherheitstechnischen Gründen gegebenenfalls die URL aus Basis-URL und angehängtem Parameter verändern kann. Wird die gewünschte Struktur der URL damit nicht erreicht, kann dies durch die Konfiguration von .jsp-Dateien erreicht werden. Beispiele dazu finden Sie unter ..\pub\custom_pages\forward*.jsp.

•Bitte beachten Sie die Beispiele der generischen Werkzeug Implementierung und die detaillierten technischen Informationen (CustomTools.txt) im Verzeichnis pub/custom_tools in Ihrer WebOffice 10.9 R3 Anwendung.

 

icon_cross-reference

Nähere Details zu einigen Beispielen im Zusammenhang mit generischen Werkzeugen finden Sie im Kapitel Kurzanleitung ... Generische Werkzeuge.

Ⓒ Copyright 2023 by VertiGIS GmbH