External GUI Module

<< Click to show table of contents >>

External GUI Module

With an External GUI Module a custom html site can be displayed in a defined GUI stack. Using the URL call interface or the WebOffice script API you can control WebOffice 10.9 R3 functionality from these GUI modules. This way it e.g. possible to use an external GUI module instead of the WebOffice search form (queries still have to be defined to have an external Layer ID, but no predefined queries need to be configured).

External GUI module configuration

Property

Description

Module URL

Configures the URL that gets embedded in the WebOffice GUI.

Application name

Name of external web application used for display in user interface (result page).

Use HTTP Get?

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

Javascript callback on close

Javascript method called before closing the tool.

Unique identifier:

Unique identifier that is used in the user profiles, logging, etc.

Use in the WebOffice flex (Flash) client

Defines whether you should use the external GUI module in the WebOffice flex (Flash) client (Yes) or not (No/Default).

This is a WebOffice flex (Flash) specific parameter.

Provide current client parameter?

Specifies if the client parameter is being added at the end of the URL. This is useful for sites which can change their styles accordingly with the value of the parameter.

Provide current language parameter?

Specifies if the language parameter is being added at the end of the URL. This is useful for sites which can change their language accordingly with the value of the parameter.

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

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

Support for passing user IDs to external hidden GUI modules is also provided for the WebOffice mobile client.

If a user context is passed to an external application, it will be readdressed (URL changes from https://extserver/extpage.htm?... to https://webofficeserver/webofficeapplication/synredirect?...).

All paths used in the external application must then be absolute paths

Pass user context (base 64)?

Specifies if the user context of the user logged on to WebOffice will get passed in the HTTP header Authorization, using base64 encoding, basic authentication.

Support for passing user IDs to external hidden GUI modules is also provided for the WebOffice mobile client.

If a user context is passed to an external application, it will be readdressed (URL changes from https://extserver/extpage.htm?... to https://webofficeserver/webofficeapplication/synredirect?...).

All paths used in the external application must then be absolute paths

Pass WebOffice user token in header?

Specifies if a User Token should be passed in the Header (WebOffice-User-Token).

Closeable?

Configures, if the user can remove the module from the user interface (Yes) or not (No / Default).

Dockable?

Configures, if the user can dock/undock the module in the user interface (Yes) or not (No / Default). Docking works only with pages that are referenced by HTTP GET, note that each change of state means that the page is requested from the server again.

This function is not available in the WebOffice core client.

Display only once?

Specifies if an accept button is shown in the GUI module (Yes) or not (No/standard). When clicking on the button the GUI module won’t be displayed when the project is opened next time. The function is only available when user management is set active.

You can reset the profile by deleting the txt files in the directory C:\Tomcat\webapps\<WebOffice-application>\WEB-INF\work\profiles. This means that after deleting the files the GUI module will be displayed again when the project is opened next time. However, this process also deletes the rest of the profile information.

This option requires a configured application name. Therefore, when using this function, ensure that an appropriate application name has been defined some lines above.

There is also a script provided to reactivate one single GUI module for all users selectively without deleting the rest of the profile information.

The script takes the path to the profile dictionary as well as the name of the GUI module (with spaces replaced with underscores), which is supposed to be reactivated for all users, as input parameters without quotes.

GUI module width

GUI module width in pixel.

Using the values 0 for width and height will cause the GUI module window to be automatically maximized and centered on the screen.

GUI module height

Legend width in pixel.

Using the values 0 for width and height will cause the GUI module window to be automatically maximized and centered on the screen.

Coordinates (pixel)

Coordinates (in pixel) of left top of GUI module. Using the values 0 0 will cause the GUI module window to be automatically centered (horizontal and vertical).

This is a WebOffice flex (Flash) specific parameter.

External GUI module properties

As a sub element you can configure the Display mode of the external GUI module. Choose an IFrame if you want a window inside the WebOffice 10.9 R3 client or an pop-up window for a new browser window. Depending on the selected mode, you can either define the window type (iFrame) or window options (pop-up).

You will find an instruction on how to configure a GUI module, that represents news when calling a project in HowTo chapter External GUI Module Representing News.