Desktop Integration - Custom Tool

The Desktop Integration - generic tool can be used to address any desktop integration via an external call/URL.

 

Configuration - Desktop-Integration - Custom Tool 

Configuration - Desktop-Integration - Custom Tool

 

 

Property

Description

Tool tip

Name of the tool that is displayed as a tooltip

Pass mode

Sets the dynamic information delivery mode to the external website/application:

HTTP: Transfer of coordinates and/or object keys from WebOffice 10.9 SP1 to an external Web page via HTTP (parameters are passed in the query string (?objectkeys=xxx&coords=xxx) of the HTTP request). The results are displayed in a new window.

Note: The custom tool form requires a target window (e. g. hidden iframe) called weboffice_tool_target. The parameters are sent to the configured URL of the external page for parameter exchange using the target weboffice_tool_target.

JavaScript: Transfer of coordinates and/or object keys from WebOffice 10.9 SP1 to an external web page by JavaScript function call of the configured web page.

Note: The custom tool form must be accessible from Javascript within the WebOffice 10.9 SP1 application window, so the tool form must run within the same HTTP domain. Parameters are sent to the Javascript function of the custom tool (configured in Javascript function).

JavaScript callback on close

Defines a Javascript method that is called before the tool is closed.

Use HTTP GET

Determines whether the parameters of WebOffice are passed to the external application via HTTP GET or HTTP Post ( form-based').

Note: These settings are only relevant for HTTP transfer mode.

URL of external page

Complete URL for the external Web page/application

URL of external page for passing parameters

Complete URL for the external Web page/application required for parameter exchange (transfer mode HTTP).

Pass user context (x-syn-login header field)?

Specifies whether the user ID of the user logged on in WebOffice 10.9 SP1 should be passed in the HTTP header.

 

Pass user context (base 64 Authorization header field)?

Specifies whether the user ID of the user logged on to WebOffice should be passed in the HTTP authorization header - Base64-coded, Basic Authentication.

Provide snap functionality?

Determines whether the snap function is to be provided in the tool form (true) or not (false).

JavaScript-function

JavaScript function in the external web page called by WebOffice 10.9 SP1 when the user input is finished in WebOffice 10.9 SP1.

A list of object keys and a list of coordinates (x/y) are transferred.

e. g. ProcessWebOfficeCall(objKeys[],geom[][]).

Tool icon

In WebOffice 10.9 SP1 there are ten different templates available in the pub/images directory (tool_01. gif to tool_10. gif). The icons must all have the size 16x16 pixels.

Tool icon (mobile)

In WebOffice 10.9 SP1 the template customtool_default. png is available in the directory pub/images/mobile.

External Tool-ID

Defines the tool ID for external calls

Access control ID

Authorization ID required for access control in WebOffice usermanagement.

If an ID is defined in this attribute (for example, MY_CUSTOM_TOOL') and the WebOffice usermanagement is used, the system checks whether the user role has the corresponding application right (according to the example MY_CUSTOM_TOOL). If this is not the case, the button/link and thus access to the external application from the WebOffice is not allowed.

Visible in Toolbar?

Sets the tool to be visible (true) or hidden (false) in the toolbar.

Visible in Client?

Tool visible in clients?

Map View

Specifies which map view to switch to when this tool is selected. If no view is specified, the map display remains unchanged.

Use Tool?

Specifies whether the tool or function is to be used in the WebOffice Client (true) or not (false).

Properties - Desktop-Integration - Custom Tool

 

 

Note: For Custom Tools, the selection graph and click icon can be customized. The following design settings can only be used in WebOffice core Client. For more information about configuration, see Web-Integration - Custom Tool.

Note: For more information on configuring the transfer values of the Integrator tool, see chapter Integrator-Client Configuration.

Note: For more information on how to troubleshoot the VertiGIS Integrator, please refer to the chapter Troubleshooting the VertiGIS integrator.

Note: For more information on how to display the Integrator tool in WebOffice html client, see the toolbar section of the results bar.