External GUI Module

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.

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

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

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

Pass user context (base 64 Authorization header field)?

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.

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

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.

Note: 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 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. However, this process also deletes the rest of the profile information.

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

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

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

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