Loading TOC...
JavaScript admin.groupAddScheduledTask

admin:group-add-scheduled-task

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


  xquery version "1.0-ml";
  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()

  let $task := admin:group-hourly-scheduled-task(
      "/Scheduler_test.xqy",
      "/Docs",
      2,
      30,
      xdmp:database("Documents"),
      0,
      xdmp:user("Jim"),
      0)

  let $addTask := admin:group-add-scheduled-task($config,
      admin:group-get-id($config, "Default"), $task)

  return
      admin:save-configuration($addTask)

  (: Creates an hourly scheduled task and adds it to the "Default" group.
     Use admin:save-configuration 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.