Administration > WebOffice Project's Monitoring

The WebOffice 10.5 SP2 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.5 SP2 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.5 SP2 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 on WebOffice 10.5 SP2 project level has a significant advantage:

It is far more reliable then just monitoring the server/host, the middle ware of the GIS Server (ArcGIS Server 10.5.1), because the test on WebOffice 10.5 SP2 project level will be positive/successful only, if all involved system components (hardware/software) are available and online.

Synmonitor call interface

WebOffice 10.5 SP2 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.

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.

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&user=batchadmin&password=<batchadmin password - encrypted>

Specifies the status of the availability of the respective project

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. Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "OK" will be delivered.
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. Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "OK" will be delivered.
FAILED	The project is not available
FAILED: INITIALIZING	The project is available and is currently being initialized Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "FAILED" will be delivered.
FAILED: NOT_FOUND	The project name does not exist in the application Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "FAILED" will be delivered.
FAILED: Unauthorized	The batchadmin user was not specified Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "FAILED" will be delivered.
FAILED: Forbidden	Incorrect batchadmin password was entered Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "FAILED" will be delivered.

Possible responses to a Synmonitor call "get_project_status"

admin_monitoring1

Monitoring a WebOffice 10.5 SP2 project with the Synmonitor Call interface - OK

admin_monitoring2

Monitoring a WebOffice 10.5 SP2 Project with the Synmonitor Call Interface - FAILED UNLOADED

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

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&user=batchadmin&password=<batchadmin password - encrypted>

Returns the status whether a project is initialized

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&user=batchadmin&password=<batchadmin password - encrypted>&action=get_project_status&mode=OK_if_unloaded

Returns the status whether the project is unloaded (project is not reloaded)

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&user=batchadmin&password=<batchadmin password - encrypted>&action=get_project_status&mode=reinit_if_unloaded

Allows you to reinitialize your unloaded projects

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.

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

indicates the status of all services in your WebOffice 10.5 SP2 projects

Response	Description
OK	The service is available
FAILED	The service is not available
FAILED: NOT_FOUND	The service doesn't exist Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "FAILED" will be delivered.
FAILED: No Content	There are no services available in the project Note: This answer will only be available from the patch release of 13.4.2018 - before that, the general answer "FAILED" will be delivered.

Possible responses to a Synmonitor call "get_service_status"

admin_monitoring3

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

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&user=batchadmin&password=<batchadmin password - encrypted>&action=get_service_status&service=

<service user>@http://<server>:<port>/arcgis/<directory>/<service>/<service type>

Indicates the status of a particular service in your WebOffice 10.5 SP2 projects

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.5 SP2 application.