<< Click here to display Table of Contents >> Navigation: Install, Configure and Administer GN4 > Back4 > Monitoring Back4 activities:

HTTP interface

Build 1501 on 14/Nov/2017 This topic last edited on: 26/Aug/2014, at 12:02

Contents

There is an http interface to the Back4 service that can be used to monitor Back4 activities. It works by listening for requests at a specific address, configured in the WebUrlPrefix parameter in the Back4 configuration.

NOTE: The Back4 service must be running for these commands to be available.

Command	Description
QUERY_TASKS	Returns an xml containing the list of all current tasks at the service (both pending or in execution).
QUERY_PEND_TASKS	Returns an xml containing the list of all pending tasks at the service.
QUERY_EXEC_TASKS	Returns an xml containing the list of all tasks currently in execution at the service.
QUERY_LOG	Returns an xml containing the ordered list of executed tasks. It accepts the following parameters: - FROM: The date/time from which to list the tasks. - TO: The date/time until which to list the tasks. - MAX: The maximum number of tasks to show. - PRIORITY-FROM: Retrieve only tasks log entries with this or greater priority. - PRIORITY-TO: Retrieve only tasks log entries with this or lower priority. - EXEC_PROC: Retrieve only tasks log entries executed by the specified process. - RESULT: Retrieve only tasks log entries with this result. Possible values: Error, Success, Warning. - TYPES: Retrieve only the tasks of these types. Empty to retrieve tasks of all types. Possible values: ObjsWF, Publish, FileWatcher.
PAUSE	Directs the service to stop processing tasks and to stop polling the database for new tasks. Note, this command does not stop the Back4 Service.
RESUME	Resumes the service after a pause.
FORCE_POLLING	Forces the service to m poll the database for new tasks. Particularly useful when the service is paused.
GET_CONFIG	Returns the current Back4 service configuration in xml. This command requires ManageTasks privileges.
RETRY_TASKS	Re-schedule tasks from the database executed task log entries. It accepts the following parameters: - IDS: List of comma separated database ids of the task log entries (required). - AT: The date/time at which the tasks will be scheduled (optional, default = immediate execution). NOTE: Only tasks of type DBTask (Publish and ObjsWF) can be re-scheduled.

NOTE

Task Log queries are returned in descending date and time order, so when used together with the MAX parameter it will return the most recent entries up to the Max value.

Examples:

http://localhost:7373/PAUSE

http://localhost:7373/QUERY_LOG?FROM=2008-09-24T14:31:13.220Z&MAX=50

http://localhost:7373/RETRY_TASKS?Ids=73,128,157