Navigation:  WebOffice author > Edit Menu > WebOffice Category > Project Configuration >

External GUI Module

Previous pageReturn to chapter overviewNext page

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.4 SP2 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

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.

Provide user context?

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

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.

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 usermanagement 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.

Unique identifier:

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

 

Use in the WebOffice flex client

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

Note: This is a WebOffice flex specific parameter.

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).

Note: This is a WebOffice flex 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.4 SP2 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).

 

Display mode IFrame configuration

Display mode IFrame configuration

 

Property

Description

HTML target

Specifies the HTML target to be used. This is useful for accelerating calls to other applications and for controlling in which window a specific web application gets opened.

Window type

Window type

Display mode IFrame properties

 

Note: 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.

Note: See chapter External GUI Module for information about the function in the WebOffice flex client.