JavaScript admin.groupHourlyScheduledTask

MarkLogic 12 EA 1 Product Documentation
admin:group-hourly-scheduled-task

admin:group-hourly-scheduled-task(
   $task-path as xs:string,
   $task-root as xs:string,
   $task-period as xs:positiveInteger,
   $task-minute as xs:nonNegativeInteger,
   $task-database as xs:unsignedLong,
   $task-modules as xs:unsignedLong,
   $task-user as xs:unsignedLong,
   $task-host as xs:unsignedLong?,
   [$task-priority as xs:string?]
) as element(gr:scheduled-task)

Summary

This function constructs a task to be invoked at hourly intervals. You can call admin:group-add-scheduled-task to add the task.

Parameters
task-path	The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
task-root	The root directory (filesystem) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
task-period	The number of hours to elapse between each invocation of the module.
task-minute	The number of minutes after the hour to invoke the module. This value must be 59 or less. Note that this setting does not add to the task-period value.
task-database	The ID of the database on which the module is to be invoked.
task-modules	The ID of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
task-user	The ID of the user with permission to invoke the module. For example, xdmp:user("Jim").
task-host	The ID of the host on which to invoke the module. Leave empty, (), to specify all hosts.
task-priority	The priority of the task. Either "normal" or "higher".

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
     admin:group-hourly-scheduled-task(
         "/Scheduler_test.xqy",
         "/Docs",
         2,
         30,
         xdmp:database("Documents"),
         0,
         xdmp:user("Jim"),
         0,
        "normal")

    (: returns an hourly scheduled task. :)

MarkLogic 12 EA 1 Product Documentationadmin:group-hourly-scheduled-task

Summary

Example

MarkLogic 12 EA 1 Product Documentation
admin:group-hourly-scheduled-task