JavaScript admin.groupScheduledTaskSetEnabled

MarkLogic 10 Product Documentation
admin:group-scheduled-task-set-enabled

admin:group-scheduled-task-set-enabled(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $task-id as xs:unsignedLong,
   $enabled as xs: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



xquery version "1.0-ml";

import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

let $config := admin:get-configuration()
let $group-id := admin:get-group-id($config, "myGrouop")
let $task-id := admin:group-get-scheduled-task($config,
      admin:group-get-id($config,"Default"), ())
return
admin:group-scheduled-task-set-enabled($config, $grup-id, $task-id, fn:true())

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)

MarkLogic 10 Product Documentationadmin:group-scheduled-task-set-enabled

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:group-scheduled-task-set-enabled