Navigation:  Administration > WebOffice Project's Monitoring

The WebOffice 10.4 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.4 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.4 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.4 SP2 project level has a significant advantage:

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

 

Synmonitor call interface

WebOffice 10.4 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>/<WebOfficeApplication>/synmonitor?project=<project>&action= the single requests can be called.

 

•&action=get_project_status (or without the &action parameter)

returns the status of the project called

Example:

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>

Response:

OK (project is initialized and available)

FAILED (project is not available)

Monitoring a WebOffice 10.4 SP2 project by using the synmonitor call interface - OK

 

Monitoring a WebOffice 10.4 SP2 project by using the synmonitor call interface – FAILED

 

Note: It is not necessary to use this parameter in production systems. Usually it will not be needed in production scenarios, because projects stay initialized by user interactions.

 

WebOffice 10.4 SP2 provides an additional, invasive parameter called &mode=. This parameter is used for:

•&action=get_project_status&mode= (or without the &mode parameter)

returns the status, if a project has been initialized

Example:

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>

Response:

OK (project is not unloaded)

FAILED (project is unloaded)

 

Note: The synmonitor gets the result "OK" if the main map service and all map services with the option "Must be available: Yes" are initialized. If another service is not initialized does not change the response of the synmonitor request.

 

•&action=get_project_status&mode=OK_if_unloaded

returns the status, if a project is unloaded (project will not be reloaded)

Example:

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&mode=OK_if_unloaded

Response:

OK (project is unloaded)

FAILED (project is not unloaded)

 

Note: The synmonitor gets the result "OK" if the main map service and all map services with the option "Must be available: Yes" are initialized. If another service is not initialized does not change the response of the synmonitor request.

 

•&action=get_project_status&mode=reinit_if_unloaded

allows to initialize unloaded projects

Example:

http://<server>:<port>/<WebOfficeApplication>/synmonitor?project=<project>&mode=reinit_if_unloaded

Response:

OK (the project is initialized and available)

FAILED (the project is not available)

 

Note: The synmonitor gets the result "OK" if the main map service and all map services with the option "Must be available: Yes" are initialized. If another service is not initialized does not change the response of the synmonitor request.

 

•&action=get_service_status

returns the status of all services of your WebOffice 10.4 SP2 projects

Example:

http://<server>:<port>/<WebOfficeApplication>/synmonitor?action=get_service_status

Response:

OK (service is initialized and available)

FAILED (service is not available)

 

Example of a response of synmonitor by using the parameter &action=get_service_status

 

 

•&action=get_service_status&service=...

returns the status of a certain service in your WebOffice 10.4 SP2 project

Example:

http://<server>:<port>/<WebOffice application>/synmonitor?action=get_service_status&service=<service-user>@http://<server>:<port>/arcgis/<folder>/<service>/<service type>

Response:

OK (service is initialized and available)

FAILED (service is not available)

 

Note: The response of the call always is a string, there will not be returned any html documents.

Note: Please also consider chapter Batch Administration Request to administrate your WebOffice 10.4 SP2 application.