Documentation Center

prepare_allowed

Tests whether prepare is allowed to run.

Description

The prepare_allowed function checks to see if a prepare can run within the Legacy Content Delivery application.

Parameters

action
prepare_allowed
timer
The number of minutes until processes that are scheduled will prevent prepare from running (default=60).

Example URL

http://<host>:<port>/<context>/web/pub.xql?action=prepare_allowed&timer=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure. If the prepare can run.

Failed Result

If prepare cannot run, this function returns a standard API result element with a statusCode equal to 1052.