Use Hyperlinks for providing easy access to image files (e.g. JPG or GIF files) or folders as well as documents (e.g. PDF documents)

 

Hyperlink configuration

Hyperlink configuration

 

Property

Description

Application name

Name of external web application used for display in WebOffice 10.9 R4 client (search result).

Base URL

Full base URL if only the file name of an image or a relative hyperlink is available in the data field.

icon_comment

You may use a UNC path as Base URL as well if the client browser is Internet Explorer (Mozilla Firefox does NOT support opening documents in the browser using UNC paths), e.g. \\myFileServer\myWebOfficeFileShare

Encoding of the URL query string

Encoding of the URL query string, possible options:

•ISO-8859-1

•ISO-8859-2

•ISO-8859-3

•ISO-8859-5

•ISO-8859-6

•US-ASCII

•UTF-8

•UTF-16

Resultcolumn: Name as header

If Yes the configured application name is used as the column header in the result display, not only as tooltip.

Column size

Column size in result page [Units in characters]. Definition is needed if Resultcolumn: Name as header is enabled and has to refer to the length of Application name.

Resolve hyperlink automatically?

If Yes then the hyperlink gets resolved automatically whenever possible for e.g. showing images in the WebOffice 10.9 R4 clients (possible for tool MapTip only). If No then hyperlinks get displayed. The user must then click the hyperlink to get the image respectively multimedia content displayed.

icon_cross-reference

See chapter Hyperlinks for details.

Resolve URL as Image (forced)

If Yes, the hyperlink gets displayed automatically as an image. This is necessary if the link points e.g. to a servlet that serves an image, but because of a missing file ending can not be automatically interpreted as an image.

icon_cross-reference

See chapter Hyperlinks for details.

MapTip: Image width [Pixel]

If the search result is also used in a MapTip and a hyperlink is configured to an image, the image size can be defined.

icon_comment

The definition of a fixed width and height can lead to an image distortion. If only one is defined, then image is to be made smaller or bigger by preserving the proportion.

MapTip: Image height [Pixel]

If the search result is also used in a MapTip and a hyperlink is configured to an image, the image size can be defined.

icon_comment

The definition of a fixed width and height can lead to an image distortion. If only one is defined, then image is to be made smaller or bigger by preserving the proportion.

Postfix

Optionally add a string to the dynamically generated URL, e.g. .jpg or /sizes/o.

icon_comment

The Postfix only gets added if the used URL does not have a query string.

Place the image next to the field name?

Images (when hyperlinking the images) could be placed next to the fieldnames:

•Yes - Place them next to the field names

•No - Place them to the top of the panel (MapTip, search info in the WebOffice flex client)

icon_cross-reference

See chapter Hyperlinks for details.

Popup window width

If using Display Mode pop up for displaying external contents the size of the popup window can be configured.

Popup window height

If using Display Mode pop up for displaying external contents the size of the popup window can be configured.

Buttons available?

Provide a button (Yes) or hyperlink (No) in the WebOffice 10.9 R4 clients.

Icon for application call

In WebOffice 10.9 R4 folder pub/images 10 icons are available (extapp_01.gif, extapp_02.gif to extapp_10.gif). Icon size 16x16 pixels.

Icon for application call (mobile)

In WebOffice 10.9 R4 folder pub/images/mobile 10 sample icons are available (extapp_01.png to extapp_10.png). Icon size 30x30 pixels.

Icon for application call (flex)

In WebOffice 10.9 R4 folder pub/images/flexjs sample icons are available.

Access control ID

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

If an ID is configured here (e.g. LINK_ALKIS_COLORMAP) and WebOffice usermanagement module 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 LINK_ALKIS_COLORMAP). If the necessary application right is not available, the button/link for accessing the external application will not be available in the WebOffice 10.9 R4 search result view.

icon_cross-reference

See the HowTo chapter Create a Restriction on an External Application for an description how to use the access control ID.

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.

Hyperlink properties

 

A Key element needs to be configured for the hyperlink in order to be able to dynamically add the value of the field configured in the key to the resulting URL used if the user clicks the button/hyperlink.

 

icon_comment

E.g. if the Base URL points to your photo upload (virtual) directory http://myserver/WebOfficeUpload and the value of field filename_physical_storage is used as a key, then the selection of a specific uploaded photo point will provide a link to the image file saved in your upload folder.

 

Key configuration

Key configuration

 

Property

Description

Show field name?

Show the field name (Yes) or the field value (No) in the WebOffice 10.9 R4 clients as hyperlink.

Field

Reference to search result field.

Key properties

 

Configuration Options with Hyperlinks

•Define a base URL and add a dynamic parameter from a key field

See the example above. If MapTip is configured then the image file will appear for the corresponding result field.

icon_cross-reference

See chapter MapTip for more details about the configuration in WebOffice author standalone.

 

icon_comment

To better display long attribute values in an external window, there is a custom page provided, which can be integrated by defining internalcode/pub/custom_pages/detailResultTemplate.jsp?value= as Base URL. In this window line breaks, which are added to the attribute field via /n, are effectively displayed as such.

 

•Define no base URL and provide the full URL in the key field

It is also possible to have the complete URL provided by the data field, e.g. a field named Image, containing the URL of the used image. In this case the parameters Base URL and Postfix can be left empty since all the information is provided by the field value. This option allows various types of image and path types as shown in the screenshot below.

 

icon_comment

However, currently only WebOffice flex client can automatically resolve image URLs from an image_gallery. WebOffice html and WebOffice mobile client will display a clickable hyperlink.

 

Field containing full image URLs

Field containing full image URLs

 

Hyperlink configuration for a field with full image URL

Hyperlink configuration for a field with full image URL

 

icon_cross-reference

•See chapter Display Mode for details about the configuration of a specific display mode in WebOffice author standalone.

•See chapter Hyperlinks for details about hyperlinks in the WebOffice html client.