Loading TOC...

admin.groupScheduledTaskSetEnabled

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

Summary

This function enables one or more scheduled tasks for a group based on the group ID and task ID.

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.
$enabled Enables group scheduled task to occur. The default is true, which means the scheduled group task will occur.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

http://marklogic.com/xdmp/privileges/admin/group/scheduled-task

http://marklogic.com/xdmp/privileges/admin/group/scheduled-task/{id}

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"), ())
admin.groupScheduledTaskSetEnabled(config, grupId, taskId, fn.true())

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.  
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.