Administration > WebOffice Project's Monitoring

The WebOffice 10.7 SP1 application provides a call interface for monitoring specific projects. By using this call interface, it is easy to determine, whether at a certain point of time a WebOffice 10.7 SP1 project is valid or not.

Monitoring the availability of projects is important for implementing

•load balancing and/or

•fail over systems.

Being able to monitor a WebOffice 10.7 SP1 project it is easy to precisely provide information on availability and to implement monitoring systems, which may escalate a problem by notifying technical staff, if the availability check was negative/not successful.

Monitoring at WebOffice 10.7 SP1 project level has a significant advantage: It is far more reliable than simply monitoring the server, the middleware or the GIS server (ArcGIS Server), since a test at WebOffice 10.7 SP1 project level will only be positive or successful if all system components involved (hardware/software) are available and online.

Synmonitor call interface

WebOffice 10.7 SP1 provides a HTTP request to check the availability of a project by using the synmonitor call interface.

So by using the parameter &action= in the URL http://<server>:<port>/<Application>/synmonitor?project=<projekt>&user=batchadmin&password=<batchadmin password encrypted>&action= the single requests can be called.

Value for parameter "action"	Description
-	If no action parameter is specified, the default option "get_project_status" is selected, i.e. the call returns the status of projects.
get_project_status	Returns the status of a project
get_service_status	Returns the status of a service
validate_session	Describes the validation status of the session

Note: Users from UserManagement cannot be used for synmonitor calls.

Note: The encrypted password of the batchadmin user can be copied directly from the application configuration under <Application>\WEB-INF\classes\configuration\application_config.xml.

action=get_project_status

With the parameter "action=get_project_status" (or without action parameter) the following answers about the status of the project can be provided:

Response	Description
OK	The project is initialized and available Note: The Synmonitor provides as result for the project "OK", if the main map service and all map services with the map service property "Must be available: Yes" and the encrypted batchadmin password is correct. It does not matter whether other services are not initialized.
OK: but uses service which requires global SOE functionality and this service is not SOE core enabled	The project is initialized and available, but the output service has not activated the SOE functionality.
OK: but uses service which requires global SOE functionality and this service is not alive	The project is initialized and available, but the output service with activated SOE functionality is not available.
FAILED	The project is not available
FAILED: INITIALIZING	The project is available and is currently being initialized
FAILED: NOT_FOUND	The project name does not exist in the application
FAILED: Unauthorized	The batchadmin user was not specified
FAILED: Forbidden	Incorrect batchadmin password was entered

Possible responses to a Synmonitor call "get_project_status"

admin_monitoring1

Monitoring a WebOffice 10.7 SP1 project with the Synmonitor Call interface - OK

admin_monitoring2

Monitoring a WebOffice 10.7 SP1 Project with the Synmonitor Call Interface - FAILED UNLOADED

With WebOffice 10.7 SP1 an additional invasive synmonitor parameter named &mode= is provided. This offers the following possibilities:

Value for parameter "mode"	Description
-	returns the status if a project is initialized
OK_if_unloaded	returns the status whether the project is unloaded (project is not reloaded)
reinit_if_unloaded	returns the status whether the project is unloaded, and if so, it is initialized

Example of a project status call with reinitialization:

http://<server>:<port>/<WebOfficeApplikation>/synmonitor?project=<Projekt>&user=batchadmin&password=<batchadmin-Passwort - verschlüsselt>&action=get_project_status&mode=reinit_if_unloaded

Note: It is not necessary to use this parameter in the production system. Normally, it is not used in production scenarios, since the project is actually initialized by user interaction.

action=get_service_status

The call specifies the status of all services in your WebOffice 10.7 SP1 projects without specifying a special service:

http://<server>:<port>/<WebOffice application>/synmonitor?user=batchadmin&password=<batchadmin password - encrypted>&action=get_service_status

If a special service is specified, the call specifies the status of this service:

http://<server>:<port>/<WebOffice application>/synmonitor?user=batchadmin&password=<batchadmin password - encrypted>&action=get_service_status&service=http://<server>:<port>/arcgis/<directory>/<service>/<service type>

Note: The ArcGIS Server Publisher is no longer part of the service identifier. It is therefore not necessary to specify the service user in the request.

Response	Description
OK	The service is available
FAILED	The service is not available
FAILED: NOT_FOUND	The service doesn't exist
FAILED: No Content	There are no services available in the project

Possible responses to a Synmonitor call "get_service_status"

admin_monitoring3

Example of the SynMonitor result response with the parameter &action=get_service_status

action=validate_session&synergis_jsessionid=...&user=...

Used to validate sessions.

Antwort

Beschreibung

A session with the specified synergis_jsessionid exists and belongs to the specified user. If no user management is used, only the parameter 'synergis_jsessionid' has to be used without specifying a 'user'.

FAILED

a] no session exists with the specified session ID, or

b] the session exists, but does not belong to the specified user

Note: The response of the URL request consists of a STRING, no HTML document is returned.

Note: Please also refer to the chapter Batch Administration Request for administration of your WebOffice 10.7 SP1 application.