Navigation:  WebOffice APIs >

WebOffice URL Call Interface

Previous pageReturn to chapter overviewNext page

WebOffice 10.8 SP2 supports a set of actions and parameters in its URL call interface. The complete list of actions and parameters is provided in the file pub/url-parameters.info as well.

 

Note: Parameters and values are in general case sensitive. Therefore please check the correct case of your HTTP query string parameters and values.

 

Note: Values with specific characters such as comma, double quotes and various types of brackets (round / square) are filtered out by XSS (Cross Site Scripting) in the externalcall.jsp because certain characters are no longer supported due to security reasons.

Affected special characters, which should be avoided for using in external-ID, are for example: ' " <> ()

 

Note that whenever you want to pass floating point numbers (extents, x/y coordinates etc) in the call interface, then you need to use "." as comma delimiter. WebOffice 10.8 SP2 parses floating point numbers in mathematical, locale independent way.

 

See below for a detailed description off supported actions and parameters.

 

Action/Parameter

Description

Basic information and project start

project

Specifies the ID of the project (Project ID) to be launched by WebOffice 10.8 SP2 client.

E.g. use

project=WebOffice_SampleProject

for starting the WebOffice 10.8 SP2 Sample Project configuration.

client_app_referer

When calling a project with this parameter, a  new entry in the WebOffice 10.8 SP2 statistic file will be done. The value of the parameter will be written into the column APP_REFERER of the statistic file. With this parameter you can get an overview of how many calls to WebOffice from which applications are done.

e.g.: https://<server>/<WebOffice_application>/externalcall.jsp?project=abc&client_app_referer=xyz

Calling this example will write the value 'xyz' into the column APP_REFERER.

Note: When calling a project with 'client_app_referer=...', also an entry in the column REQUEST will be done. There are two different possibilities:

- When calling the project via synserver, PROJECT_START will be written into the column REQUEST.

- When calling the project via externalcall.jsp, EXTERNAL_CALL will be written into the column REQUEST. Please consider, that the externalcall.jsp redirects to synserver, so that there will be two entries in the statistic file; one with EXTERNAL_CALL and one with PROJECT_START. in der Statistikdatei erfolgen; ein Eintrag mit EXTERNAL_CALL und ein Eintrag mit PROJECT_START.

group_id

Holds the ID of the project group whose default project should be started. Project group ID have to be defined in application configuration.

language

Specifies the language to be used in the  WebOffice 10.8 SP2 client.

If you e.g. want to start the WebOffice core client in German language then provide

language=de

Use

language=en

for English.

client

Specifies the client to be used to start the WebOffice 10.8 SP2 application. If the parameter is not used the application will always start with WebOffice core client.

client=core starts with WebOffice core client

client=html starts with WebOffice html client

client=corejs starts with WebOffice core client

client=flex starts with WebOffice flex client

client=mobile starts with WebOffice mobile client

client=auto causes mobile devices to start with WebOffice mobile client, others with the standard desktop client (by default WebOffice core client).

Note: The "client=auto" parameter only works in combination with externalcall.jsp, but not with synserver.

Note: For detailed information how to change the standard desktop client, please see chapter Define the Standard Desktop Client.

Note: If manually changed the standard desktop client has to be configured again, every time a patch or service pack has been installed

skin

Referred only to the FLEX client. Skin to be used in the WebOffice flex client. Possible values are gray, green, brown or blue (that's the default-skin).

E.g. client=flex&skin=green

 

Hinweis: Parameter applies only to the WebOffice flex client.

Hinweis: See chapter Skins for WebOffice flex for more details.

action

The parameter "action=log" is logging the client actions which can be displayed by the user using the CTRL+ALT+L shortcut.

Hinweis: Parameter is only valid for the WebOffice flex Client.

stateID

Loads the saved state specified by stated when launching the WebOffice 10.8 SP2 client. E.g. &stateID=<stateName>

Note: The WebOffice 10.8 SP2 client generates e.g. a state when sending a "placed symbol" or markup to another user via E-Mail.

userprofile

Loads the specified user profile when launching WebOffice 10.8 SP2 client.

"userprofile" is the name of a saved profile on the server.

startmode

Note: Use externalcall.jsp instead of synserver for passing these parameters.

popup: The WebOffice 10.8 SP2 client starts in a new browser window without browser specific navigation buttons

popupfixed: Equal to "startmode=popup", but the browser window is not resizable by the user

winwidth

winheight

The parameters "winwidth" and "winheight" specify the width and the height of the popped up browser window in pixels.

Note: These parameters can only be used in combination with startmode=popup/popupfixed.

ribbon

Use this parameter if you want a specific tab to be opened directly in the WebOffice core Client.

Verwenden Sie diesen Parameter, wenn Sie eine bestimmte Registerkarte im WebOffice core Client direkt geöffnet haben wollen.

Note: To use this parameter, an external id for ribbons have to be configured in Ribbons. If the external id in WebOffice author standalone is e.g. "navigation", then use &ribbon=navigation in the external call.

Note: This configuration parameter is WebOffice core client specific.

maximizemap=true

With the parameter "maximizemap=true" the WebOffice core client will start with a maximized map, i.e. all ribbons and menus will be collapsed.

Note: This parameter is WebOffice core client specific.

time_slider_profile_id

With the parameter "time_slider_profile_id= one" of the defined TimeSlider profiles can be preselect.

Note: This parameter is WebOffice core client specific.

statusbar

If the parameter "statusbar" is passed with false, the WebOffice html client starts without showing the WebOffice statusbar.

Note: This parameter is WebOffice html client specific.

toolbar

If the parameter "toolbar" is passed with false, the WebOffice html client starts without showing the WebOffice toolbar.

Note: This parameter is WebOffice html client specific.

maponly

If the parameter "maponly" is passed with true, the WebOffice html client starts in a special gui mode, where only the map is displayed.

Note: This parameter is WebOffice html client specific.

ct and cd

display

These parameters will be used to display custom data from an external application in WebOffice 10.8 SP2 client and on the print output document. This attribute data can come from a third-party application and can be passed via URL call (http POST). Customtitle "ct" and customdata "cd" are used as a pair of values, it is possible to use several pairs. (ct<1>;cd<1> to ct<n>;cd<n>)

 

ct1=ID; cd1=123; 

ct2=name; cd2=Miller;

ct3=city; cd3=Easton;

 

For positioning the iFrame with the custom data in the WebOffice 10.8 SP2 client, use the parameter "display":

 

topleft

topright

bottomleft

bottomright

floating

hidden

floating_minimized

 

The data will be displayed in the WebOffice 10.8 SP2 client in a table with two columns, the first column with customtitle "ct" and the second one with customdata "cd". For values which are too long a line break will be made.

Note: An automatic line break is only possible, if the given string allows a line break.

A linebreak in the custom data using "\n" will be interpreted accordingly in WebOffice 10.8 SP2 client.

 

Sample:

 

It is also possible to display the custom data on the WebOffice 10.8 SP2 print output document (like address, name of organization) if configured on the print template. See also chapter Custom data display on print template for more information.

Map view and position

view

Sets the initial Map view in the WebOffice 10.8 SP2 client.

Note: The configuration of a map view contains a unique identifier (identifier for external call). 

If e.g. the identifier is configured in the WebOffice author standalone to "citymap", use: view=citymap

basemapview

Sets the initial Basemap view in the WebOffice 10.8 SP2 client.

Note: The configuration of a base view contains a unique identifier (identifier for external call). 

If e.g. the identifier is configured in the WebOffice author standalone to "orthofoto", use:

basemapview=orthofoto

geo_bookmark

Use this parameter if you want to display the map at a certain spatial extent.

Note: To use this parameter at least one Geo bookmark has to be configured. (See chapter Geo Bookmark.)

Hinweis: Um diesen Aufruf zu nutzen, muss zumindest ein Geo-Bookmark konfiguriert sein (Siehe Kapitel Geo-Bookmark). 

If e.g. the identifier  in WebOffice author standalone is configured to "Vienna", use:

geo_bookmark=Vienna

xmin

ymin

xmax

ymax

Use these 4 parameters for specifying the initial map extent

x

Use this parameter to define the center point (X coordinate) for the initialization.

y

Use this parameter to define the center point (Y coordinate) for the initialization.

lat

lon

Starts the application centered at the WGS84 position defined by "lat/lon" (decimal degrees, decimal separator = "."); this works on any project, "lat/lon" are projected from WGS84 to the project coordinate system.

scale

Use this parameter to define the initial scale

Note: This parameter can only be used in combination with the parameters x and y!

rotation

This parameter is used to make an external project call with map rotation. The value is given in degrees (e.g. &rotation=55)

Note: For an external call this parameter is only considered if the function for map rotation in WebOffice author standalone has been configured and rotation is also allowed via a parameter (see Map Rotation).

width

Width (in pixels) of the map image

height

Height (in pixels) of the map image

dpi

Allows the creation of high quality map images for third applications. By default map images are rendered with a resolution of 96dpi. Increase the value to e.g. dpi=192 or dpi=288 for higher resolution.

 

Note: If a map image with &dpi=288 is being requested, then the 288dpi image will nevertheless be displayed in 96 dpi. That is why the image size has to be increased as well. In this case (288dpi is a threefold of 96dpi) the image will be three times the size (width/height).

exclude_north_and_scale=true

With the parameter exclude_north_and_scale=true only a map image will be displayed. North arrow, scale bar and copyright will be suppressed.

geo_tf

Defines a specific geographic transformation (EPSG code; e.g. geo_tf=1618: MGI to WGS84) to be used to transform geographic coordinates.

Note: EPSG codes can be obtained from the Projection and Geotransformation Helper.

Note: A geographic transformation with the command "geo_tf" only works for LAT&LON values. It is not possible to use a different transformation than already configured in the project.

coordmarker_lat_lon

Displays an image (by default "pub\images\meet_x_20_20.png") to mark the spot which was defined by the specified coordinates (in LAT / LON). Separate the coordinates either with a space character or with "%20".

Note: The image can be changed by using the parameter 'coordmarker_id'.

 
Example:

&coordmarker_lat_lon=47.069 15.435

&coordmarker_lat_lon=47.069%2015.435

coordmarker_x_y

Displays an image (by default "pub\images\meet_x_20_20.png") to mark the spot which was defined by the specified coordinates (in X / Y). Separate the coordinates either with a space character or with "%20".

Note: This parameter can also contain several coordinate pairs separated by semicolons.

Note: Only the first two axes are considered per coordinate pair, additional information such as z- or m-values are discarded.

Note: The sequence "X Y" is expected for the specified coordinate pairs.

coordmarker_epsg

Optional parameter that must be specified in connection with the parameter 'coordmarker_x_y' if the initial coordinate system (projection of the marker coordinates to be transferred) differs from the target coordinate system (projection of the main map service in the WebOffice 10.8 SP2 project). Otherwise the default value is always the coordinate system of the main map service.

coordmarker_geo_tf

Specifies a corresponding transformation code, if the markers should be passed in X/Y coordinates and the initial coordinate system (projection of the marker coordinates to be passed) differs from the target coordinate system (projection of the main map service in the WebOffice 10.8 SP2 project).

Note: The transformation code passed in course of this parameter will not be considered, if a corresponding transformation code has already been configured in the WebOffice 10.8 SP2 project configuration.

Note: The default transformation code proposed and used by ArcGIS will be used, if neither the WebOffice 10.8 SP2 project configuration nor the the appropriate WebOffice map widget URL contains a corresponding transformation code.

coordmarker_id

Enter the ID which is configured in WebOffice author standalone in Meeting Points as "External Marker-ID". This image will be displayed on the spot that was defined in the parameter "coordmarker_lat_lon".

marker

If "marker=true" the project starts with a marker at centerpoint when called in combination with x, y, scale or lat, lon, scale.

service_url

service_type

layer_visibility

Dynamically adds a map service at runtime (call shall be directed to externalcall.jsp, but from there may be redirected to synserver).

The parameter "service_url" specifies the URL of the map service to be included.

The parameter "service_type" specifies the type of service to be included (currently WMS for OGC WMS services or AGS for ArcGIS Server Internet Services)

The parameter "layer_visibility" (on|off) defines the state of layers of the added service; if not provided default = off

External queries to WebOffice

query

 

To perform a search in WebOffice 10.8 SP2, this parameter can be passed.

WebOffice 10.8 SP2 then performs the search in the client and displays the results in the search result and on the map.

The parameter "query" identifies a predefined search (see chapter Query).

 

Note: In order to use query, keyname and keyvalue parameters, an external layer ID and a search field are required.

 

 

Search with multiple search fields:

It is possible to search using multiple search fields as well, e.g. if you have address data with fields "STREETNAME" and "HOUSENUMBER" it is possible to search for a specific STREETNAME AND HOUSENUMBER (search for address "Beachstreet, 1") by submitting a URL call like:

http://gisserver/WebOffice/externalcall.jsp?project=WebOffice_SampleProject&client=core&query=address&keyname=STREETNAME&keyvalue=Beachstreet&query1=address&keyname1=HOUSENUMBER&keyvalue1=1

 

 

Using wildcards:

Using the "*" character it is possible to search for keyvalues with a wildcard. E.g. you can search for every customer starting with "M" by typing "keyvalue=M*".

 

 

Multilayer-Suchen:

Multilayer searches can be performed by repeating the parameters "query", "keyname" and "keyvalue" and appending a suffix.

You can use any suffix (numbers, letters, etc.) as long as it is associated with "query", "keyname" and "keyvalue".

Note: Be aware that the WebOffice call using multilayer search is only available in the WebOffice core Client because only there is an object browser available that can display multilayer results.

Note: To trigger a multiple hierarchical search pleas see parameter processing.

 

Sample:

 

 

Geolocator service:

WebOffice 10.8 SP2 also supports Geolocator queries by passing the parameters "query" and "keyvalue". The parameter "query" contains the value that was assigned in the Geolocator query as "External Layer-ID" (see chapter Query), "keyvalue" contains the address for the Geolocator search.

 

Sample:

keyname

 

Name of the search field

Note: For the "keyname", use only the technical field name and not the alias name of the field.

keyvalue

Name of the search value

m_from

m_to

The parameters "m_from" and "m_to" are only used for route segment searches in combination with "query", "keyname" and "keyvalue". Additionally, it is also possible to define a multiquery on "m_from" and "m_to" in order to be able to select multiple sections.

Note: See chapter Layer queries for details.

 

Sample:

separator

The parameter "separator" defines the separation between several search values (keyvalue).

Note: The following separators can be used: @ ; - ! ~ / : =

selection_type

The parameter "selection_type" defines how the selection is executed: "new|add|subtract"

Note: More details about the selection mode in the WebOffice core Client see chapter Select.

gui

The parameter "gui" defines the display of the result gui:

"hideresult" displays the attributive result table, but minimizes it to allow a larger map display;

"maponly" displays the WebOffice GUI in a mode with maximized map display; the attributive result table is minimized, the left and right areas are also minimized

Note: The parameter "maponly" is only available in the WebOffice html client.

mode

The "mode" parameter defines the modes for external query calls.

Possible values are:

zoom_to: no attributive result display, features are displayed selected on the map, map zooms to the extent of the queried features

zoomto_minimized: minimized attributive result display, features are displayed selected on the map, map zoom to the extent of the queried features

Note: The parameter "zoomto_minimized" is only supported in the WebOffice mobile client.

zoom_only: no attributive result display, no selection of queried features on the map, map zooms to extent ob the queried features

result_only: attributive result display only, no selection of queried features on the map, no map update

pan_only: no attributive result display, no selection of queried features on the map, map pans to center of the extent ob the queried features

locate_features: no attributive result display, no selection of queried features on the map, no map update but the position of each feature in the current map extent is displayed for a few seconds using images

clear_selected:clears current selection, removes attributive result display, removes selection displayed on the map

processing

The parameter "processing" defines the processing of several queries, which are identified by "keyname", "keyvalue", ... the following parameters are specified:

combined (Default value): Multiple queries are merged into a minimum number of statements (implicit AND).

separated: A separate statement is created for each URL query (implicit OR). By specifying &processing=separated, multiple hierarchical searches can be triggered and displayed via the URL call interface.

 

Sample:

Note: Values separated  by ";" are connected by OR.

The parameter "&processing=separated" means that query1 is executed before query2(internal):   query1=searchlyr&keyname1=city&keyvalue1=Chicago&keyname1=zone&keyvalue1=890, then:

query2=searchlyr&keyname2=city&keyvalue2=Dallas&keyname2=zone&keyvalue2=890;891

The results will be connected by OR. All conditions with the same number (1,2) will (internal) be connected by AND.

query_preset

Specifies the default layer or query to be used.

Note: Use the "External call ID" of the Query

External filter definition to WebOffice

filter

 

 

Defines the external call ID of the layer

Note: External filter calls are only enabled if a External filter is configured on the specified layer.

 

A combination of multilayer filters is allowed, following the same rules as multilayer queries.

Note: See multilayer queries for details and samples.

 

A combination of query and filter is allowed, following the same rules as multilayer queries.

Sample:

keyname

Name of the search field (database field name, not the configured WebOffice alias)

keyvalue

Name of the search value

query_filtered

The parameter "query_filtered" offers the possibility to combine a query and a filter on a layer with the same parameters.

 

Sample long form:

 

Sample short form:

 

Note: In case of using this parameter please also configure an External Filter and a Filtering search.

resetfilter

Defines the external ID for the layer (resets a set filter to the layers).

Definiert die externe Kennung für den Layer (setzt einen gesetzten Filter auf die Layer zurück)

Starting WebOffice with a predefined active tool

tool

Use the "tool" parameter for setting a specific tool active.

Note: To call a tool using the URL call interface, an external tool ID must be assigned to the corresponding tool in the project configuration.

Note: It is not useful nor possible to activate all of tools using the URL call interface. WebOffice 10.8 SP2  supports  certain tools for calling via the URL call interface.

Note: Besides standard tools, custom tools can also be called directly at project start this way.

 

Below is a list of all tool identifiers that are supported:

EDIT: opens the tool Editing

Note: For more details regarding the parameter "tool=edit" see WebOffice URL Call Interface for Editing.

HELP: opens the tool Help

IDENTIFY_LAYER: opens the tool Identify

IDENTIFY_MAPTIP: opens the tool Identify MapTip

LABEL: opens the tool Label feature

MARKUP: opens the tool Markup

MEASURE_ARCLENGTH: opens the tool Measure Arc/Length

MEASURE_AREA: opens the tool Measure Area

MEASURE_LINE: opens the tool Measure Distance

MEASURE_PERPENDICULAR: opens the tool Measure Perpendicular

MEASURE_POINT: opens the tool Measure Point

PRINT: opens the tool Print

RASTERINFO: opens the tool Raster Info

UPLOAD_GEODATA: opens the tool Add Data

 

Start WebOffice with predefined print tool

tool=print

Opens the tool print on project start up.

Note: Esri Print is not supported in this case.

template_id

This parameter applies only to the print tool "tool=print"

The parameter "template_id" can be used to preselect a specific print template. The external Template-ID has to be used, which is configured directly at the respective print template in  WebOffice author standalone.

 

Sample:

printfields

This parameter applies only to the printing tool "tool=print" and has to be used with the parameters "template_id" and "printfvalues".

You can use the parameter "printfields" to pass the ID of field value/caption of printing fields and Custom function fields (separated by semicolons if several values are used).

 

Sample:

printvalues

This parameter applies only to the printing tool "tool=print" and has to be used with the parameters "template_id" and "printfields".

You can use the parameter "printvalues" to pass the values for Field value and Field caption of printing fields and Custom function fields (separated by semicolons if several values are used)

 

Sample:

WebOffice 10.8 SP2 URL call interface - actions and parameters