Configure the Geoprocessing tool to give users the option to use geoprocessing tasks within your WebOffice 10.9 R3 project. Geoprocessing tasks are part of geoprocessing services that can be shared from your results in ArcMap. If you execute a task in a geoprocessing service, it executes this task on the server computer using resources of the server computer. Configure one geoprocessing tool for each geoprocessing task you want to provide with you WebOffice 10.9 R3 project (even if the geoprocessing service you are using includes multiple geoprocessing tasks).

 

icon_cross-reference

This chapter only refers to the configuration of the Geoprocessing tool in WebOffice author standalone. For more information about preconditions, first go through the HowTo chapter Prepare a Geoprocessing Service as well as the ArcGIS Resources - What is a geoprocessing service?.

icon_comment

A geoprocessing tool that requires input parameters not supported by WebOffice 10.9 R3 will be ignored.

 

Geoprocessing tool configuration

Geoprocessing tool configuration

 

Property

Description

Tool tip

Specifies the tool name that will be displayed in the WebOffice 10.9 R3 client. If no specific tool name is entered here, the name of the Geoprocessing task will be used instead.

Tool description

Provide an optional tool description that will be displayed in the tool dialog.

Tool icon

Reference to the icon that will be used in the WebOffice 10.9 R3 client. If a custom icon is to be used, save it in a folder in the pub Directory.

Access control ID

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

If an ID is configured here (e.g. GP_DELETE_FEATURES) and WebOffice usermanagement module is used then the user role is checked whether it provides the necessary application right or not (according to the example the application right would be GP_DELETE_FEATURES). If the necessary application right is not available then the geoprocessing tool will not be available in WebOffice 10.9 R3. Must not begin with a prefix TOOL_!

Visible in Toolbar?

Specifies whether the tool will be available in the toolbar (true, default) or not (false). Choose the latter option if you do not want to show the tool in the toolbar but use it in combination with the scriptAPI.setTool method or if you want to provide geoprocessing functionality only via search results.

Always show task messages?

Defines if the messages of the geoprocessing task are pop-up in an iFrame always (true) or only if an error occurred (false, default). Otherwise they are available when clicking the respective button.

icon_comment

Geoprocessing messages can only be provided with synchronous geoprocessing services.

External ID

External ID used for identifying the geoprocessing tool in parametrized calls to WebOffice.

icon_comment

External IDs may not contain spaces or special characters. Only combinations of the following letters and numbers are permitted or are intended to be used:

A to Z (uppercase letters)

A to z (lowercase letters)

0 to 9 (numeric characters)

Use tool?

Specifies whether the tool should be used or not

 

Geoprocessing tool properties

 

The Geoprocessing tool has an important sub element that has to be configured in order to work properly.

ArcGIS Server Geoprocessing Service

 

Configure a separate geoprocessing tool whenever you have

multiple geoprocessing tasks within one geoprocessing service

multiple geoprocessing services

 

icon_cross-reference

See chapter ArcGIS Server Geoprocessing Service for details about the configuration of the ArcGIS Server Geoprocessing Service in WebOffice author standalone.

See chapter Geoprocessing Input Parameter for details about the configuration of geoprocessing input parameters in WebOffice author standalone.

See chapter Activate Geoprocessing for details about the configuration of geoprocessing for the WebOffice Sample Project.

With WebOffice 10.9 R3 it is possible to pass parameters dynamically to the geoprocessing tool. See HowTo chapter Integrate Geoprocessing for details.

See chapter Geoprocessing for details about the tool appearance in the WebOffice core client.