MarkLogic 9 Product Documentation
admin.groupScheduledTaskGetEnabled

admin.groupScheduledTaskGetEnabled(
   config as element(configuration),
   group-id as (Number|String),
   task-id as (Number|String)
) as Boolean

Summary

This function returns true or false to indicate whether a scheduled task for a group is enabled.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
task-id The ID of the task, the result of an admin:group-get-scheduled-task call.

Example

const admin = require('/MarkLogic/admin.xqy');
var config = admin.getConfiguration()
var groupId = admin.getGroupId(config, "myGrouop")
var taskId = admin.groupGetScheduledTask(config,
      admin.groupGetId(config,"Default"), null)
admin.groupScheduledTaskGetEnabled(config, grupId, taskId)

     //returns the backup enabled setting for the group's scheduled task - true or false 
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy