Loading TOC...

alert functions

The table below lists all the alert built-in functions (in this namespace: http://marklogic.com/xdmp/alert).

The Alerting API function module is used to create alerting applications. The Alerting API abstracts the security considerations and the reverse search functionality from the developer. The Alerting API is installed as the following file:

  • install_dir/Modules/MarkLogic/alert.xqy

where install_dir is the directory in which MarkLogic Server is installed.

To use the alert module in your own Server-Side JavaScript modules, include the following line in your JavaScript program:

var alert = require("/MarkLogic/alert");

The Alerting API requires a valid alerting license key. Without a valid license key, the functions in the Alerting API will throw an exception. Additionally, a valid alerting license key is required to use the reverse index.

60 functions
Function nameDescription
alert.actionGetDescriptionThis function returns the description of a given action.
alert.actionGetModuleThis function returns the module of a given action.
alert.actionGetModuleDbThis function returns the module database of a given action.
alert.actionGetModuleRootThis function returns the module root of a given action.
alert.actionGetNameThis function returns the name of a given action.
alert.actionGetOptionsThis function returns the options of a given action.
alert.actionInsertThis function inserts the specified action into the collection.
alert.actionRemoveThis function removes the named action from the database or throws an exception if the action does not exist.
alert.actionSetDescriptionThis function returns the action with the description of the action updated.
alert.actionSetModuleThis function returns the action with the module of the action updated.
alert.actionSetModuleDbThis function sets the module database of a given action.
alert.actionSetModuleRootThis function sets the module root of a given action.
alert.actionSetNameThis function returns the action with the name of the action updated.
alert.actionSetOptionsThis function returns the action with the options of the action updated.
alert.configDeleteRemove an alerting configuration identified by the specified URI.
alert.configGetGets the config associated with the specified URI.
alert.configGetCpfDomainNamesThis function returns the CPF domain names set in the specified alerting configuration.
alert.configGetDescriptionThis function provides returns the description set in the specified alerting configuration.
alert.configGetIdThis function returns the ID of the specified alerting configuration.
alert.configGetNameThis function returns the name set in the specified an alerting configuration.
alert.configGetOptionsThis function returns the options set in specified alerting configuration.
alert.configGetTriggerIdsThis function returns the trigger IDs set in the specified alerting configuration.
alert.configGetUriThis function returns the URI set in the specified alerting configuration.
alert.configInsertInserts a config into the database.
alert.configSetCpfDomainNamesThis function sets the CPF domain names in the specified alerting configuration.
alert.configSetDescriptionThis function sets the description within the specified alerting configuration.
alert.configSetNameThis function sets the name in the specified alerting configuration.
alert.configSetOptionsThis function sets the options in the specified alerting configuration.
alert.configSetTriggerIdsThis function sets the trigger IDs in the specified alerting configuration.
alert.createTriggersCreate triggers that invoke the standard alerting trigger module.
alert.findMatchingRulesReturns a list of all rules associated with the specified config that match the specified document.
alert.getActionsThis function retrieves all the named actions in the specified config URI.
alert.getAllRulesThis function returns all rules visible to the current user.
alert.getMyRulesThis function returns all rules associated with the current user.
alert.invokeMatchingActionsFinds the rules that match the specified document and invokes their associated actions.
alert.makeActionThis function creates the specified action.
alert.makeConfigCreate an alerting configuration associated with a particular URI.
alert.makeLogActionCreate a standard logging action named "log".
alert.makeRuleThis function creates the specified rule.
alert.removeTriggersRemove triggers whose IDs are listed in the config.
alert.ruleActionQueryThis function creates a query to find rules with any of the specified actions.
alert.ruleGetActionThis function returns the action of a given rule.
alert.ruleGetDescriptionThis function returns the description of a given rule.
alert.ruleGetIdThis function returns the ID of a given rule.
alert.ruleGetNameThis function returns the name of a given rule.
alert.ruleGetOptionsThis function returns the options of a given rule.
alert.ruleGetQueryGet the cts.query corresponding to the rule's query expression.
alert.ruleGetUserIdThis function returns the user ID of a given rule.
alert.ruleIdQueryThis function creates a query to find rules with any of the specified IDs.
alert.ruleInsertThis function inserts rule into the database associated with the specified alerting configuration.
alert.ruleNameQueryThis function creates a query to find rules with any of the specified names.
alert.ruleRemoveThis function removes the specified rule from the collection.
alert.ruleSetActionThis function returns the rule with the action updated.
alert.ruleSetDescriptionThis function returns the rule with the description of the rule updated.
alert.ruleSetNameThis function returns the rule with the name of the rule updated.
alert.ruleSetOptionsThis function returns the rule with the options of the rule updated.
alert.ruleSetQuerySet the cts:query corresponding to the rule's query expression.
alert.ruleSetUserIdThis function returns the rule with the user ID updated.
alert.ruleUserIdQueryThis function creates a query to find rules with any of the specified user IDs.
alert.spawnMatchingActionsFinds the rules that match the specified document and spawns their associated actions.
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy