Web Integration - Custom Tool

Property

Description

URL of external page

Full URL of external web page/application

Tool tip

Tool name shown as tool tip

Use tool?

Specify whether this Tool is available in the WebOffice 10.4 SP2 clients (Yes) or not (No).

Pass mode

Pass mode

•HTTP: Pass coordinates and/or object keys from WebOffice 10.4 SP2 to the external web page via HTTP (parameters are added in the query string of the HTTP request)

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

•JavaScript: Pass coordinates and/or object keys from WebOffice 10.4 SP2 to the external web page calling a JavaScript function of the configured web page

Note: The custom tool form needs to be accessible by javascript from inside the WebOffice 10.4 SP2 application window, therefore the tool form has to run inside the same HTTP domain. Parameters are sent to the javascript function of the custom tool configured in 'JavaScript function'.

JavaScript callback on close

JavaScript method called before closing the tool

Use HTTP Get

Pass parameters to external application via HTTP Get (or HTTP Post).

Note: These settings are only relevant if the pass mode HTTP is active.

URL of external page for passing parameters

Full URL of external web page/application used for passing parameters (Pass mode HTTP).

Pass user context?

Specifies if the user context of the user logged on to WebOffice 10.4 SP2 will get passed in the HTTP header.

Provide snap functionality?

Specifies if the snap functionality should be provided in the tool form or not.

JavaScript function

JavaScript function of external web page/application called by WebOffice 10.4 SP2.

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

Tool icon

In WebOffice 10.4 SP2 folder pub/images 10 icons are available (tool_01.gif to tool_10.gif). Icon size 16x16 pixel

Tool icon (mobile)

In WebOffice 10.4 SP2 folder pub/images/mobile the icon customtool_default.png is available.

External Tool-ID

Tool id used for external calls

Access control ID

Access control ID needed for access control based on WebOffice usermanagement.

If an ID is configured here (eg 'MY_CUSTOM_TOOL') and WebOffice usermanagement is used, the user role is checked whether it provides the necessary application right or not (according to the example the application right would be MY_CUSTOM_TOOL). If the necessary application right is not available, the button/link for accessing the external application will not be available in the WebOffice 10.4 SP2 client.

Visible in toolbar?

Tool visible?

Visible in Client

Tool visible in client?