consistency_check

Manually run consistency check.

Description

This functions allow "Manage Application" users to manually run consistency check and optionally perform a backup.

Parameters

action
consistency_check
zip
If backup=yes, write as a zip file (default="yes")
zip_max
If backup=yes, this is the number of previous backups to keep (default=5).
backup
In addition to validating the database, perform a backup if set to "yes" (default="no")

Example URL

http://<host>:<port>/<context>/web/admin.xql?action=consistency_check&zip=<value>&zip_max=<value>&backup=<value>

Successful Result

After successful execution of this function, it will generates a report in the 'data/export' folder and a backup zip file if backup option is given.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available.