MarkLogic Server 11.0 Product Documentation
admin.groupAddScheduledTask

admin.groupAddScheduledTask(
   config as element(configuration),
   group-id as (Number|String),
   scheduled-tasks as element(gr.scheduledTask)[]
) as element(configuration)

Summary

This function adds one or more scheduled tasks to the specified group.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
group-id	The ID of the group on which the scheduled tasks are configured. Typically, this is the result of an `admin:group-get-id` call.
scheduled-tasks	One or more scheduled tasks, such as those created by the task-create functions.

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');
  const config = admin.getConfiguration()
  const task = admin.groupHourlyScheduledTask(
      "/Scheduler_test.xqy",
      "/Docs",
      2,
      30,
      xdmp.database("Documents"),
      0,
      xdmp.user("Jim"),
      0)
  const addTask = admin.groupAddScheduledTask(config,
      admin.groupGetId(config, "Default"), task)
      admin.saveConfiguration(addTask)

   //Creates an hourly scheduled task and adds it to the "Default" group.
   //Use admin.saveConfiguration to save the changes to the configuration
   //or pass the configuration to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.groupAddScheduledTask

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.groupAddScheduledTask