Integration (Call FROM WebOffice)

<< Click to show table of contents >>

Use Integration (Call FROM WebOffice) for passing parameters (objects keys etc.) to other web applications using HTTP GET query string or HTTP POST. This way user can easily switch/jump from WebOffice 10.9 R4 clients to another web application passing over a specific selected object or a list of objects.

Integration (call FROM WebOffice) configuration

Property

Description

Application name

Name of external web application used for display in WebOffice 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.

	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.
	If a number sign '#' is used in the base URL, you need to use a new intermediate page which can be found under 'pub/custom_pages/forward_sample_03.jsp'.

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

Use

Specify whether to pass single objects (Single Hit) or multiple objects (Multiple Hit) or both (Single and Multiple Hit).

If Multiple Hit or Single and Multiple Hit is configured and an Icon for application call is specified, this icon will be shown instead of the default icon (flash). Prerequisite is, that this is the only multi hit supporting external application configured for this search result.

The additional option External permits to replace the WebOffice 10.9 R4 search result window by a search result window of the external application.

If you use option External you can neither use multiple search result views nor call multiple external applications.

Call Multihit automatically?

Configure Yes to execute the multiple hit application call automatically with every new result

The parameter Use has to be set to Multiple Hit.

Use HTTP Get?

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

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.

Delimiter

Delimiter used for concatenating multiple values.

The delimiter | is not supported.

Final Delimiter

Set to true (Yes) if the key list should end with delimiter character. Set to false (No) if no delimiter should be used at the end of the key list.

For example:

•Yes: 123;456;789;

•No: 123;456;789

Provide coordinates?

Specifies whether to additionally pass (Yes) or not pass (No) coordinates

•If Identify/Info tool was used and no objects have been found then the click point gets passed

•If a result with one or multiple objects has been found then for each single object the label point is passed

WebOffice 10.9 R4 supports to pass m-values to an external application if parameter Provide coordinates? is set true and feature geometry is of type line.

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

Used for projects that are secured with WebOffice usermanagement. Specifies if the user context of the user logged on to WebOffice 10.9 R4 will get passed in the HTTP header.

The external application gets the following information:

x-syn-login = <username>

x-syn-application-roles = <list of application roles>

x-syn-group = <group name>

If providing a user context to an external application the URL will be redirected (URL changes from http://extserver/extpage.htm?...to http://webofficeserver/webofficeapplication/synredirect?...) Therefore all paths used in the external Application have to be fully qualified!

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.

Popup window width

If using popup windows for displaying external contents the size of the popup window can be configured.

Popup window height

If using popup windows 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 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 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.

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.

Integration (call FROM WebOffice) properties

Key Sets

A Key set element needs to be configured for the integrating an external application, so it is possible to pass parameters from WebOffice 10.9 R4 to the external application. It is possible to choose from:

•Concatenated Parameter

•Separated Parameters

Concatenated Parameter

Use a concatenated parameter if you want to concatenate values from various key fields passing them over as one single parameter.

Key set - concatenated parameter configuration

Property

Description

HTTP Parameter name

HTTP parameter name to be used for parametrized calls to external applications. If no parameter name is specified, the field name is taken as parameter name.

Show field name?

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

Delimiter

Delimiter used for concatenating multiple values.

The delimiter | is not supported.

Key set - concatenated parameter properties

You have to configure at least on Key element that points to a configured field in the Search Result View.

Key - concatenated parameter configuration

Property

Description

Field

Reference to a configured search result field.

Field value prefix

Optionally add a character or a string as prefix directly before the field value to the resulting URL.

E.g. quotation marks (") may be required to indicate that the value shall be interpreted as a string rather than a numeric value.

Field value postfix

Optionally add a character or a string as postfix directly after the field value to the resulting URL.

E.g. quotation marks (") may be required to indicate that the value shall be interpreted as a string rather than a numeric value.

Key - concatenated parameter properties

Separated Parameters

Use separated parameters if you want to pass separated values from various fields but each of them as one specific parameter.

Key set - separated parameters configuration

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

Key set - separated parameters properties

You have to configure at least on Key element that points to a configured field in the Search Result View.

Key - separated parameters configuration

Property	Description
Field	Reference to a configured search result field.
HTTP Parameter name	HTTP parameter name to be used for parametrized calls to external applications. Do not provide a parameter name at all if you want to provide access to multimedia content (e.g. documents, images etc.).
Field value prefix	Optionally add a character or a string as prefix directly before the field value to the resulting URL. E.g. quotation marks (") may be required to indicate that the value shall be interpreted as a string rather than a numeric value.
Field value postfix	Optionally add a character or a string as postfix directly after the field value to the resulting URL. E.g. quotation marks (") may be required to indicate that the value shall be interpreted as a string rather than a numeric value.

Key - separated parameters properties

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