MarkLogic Server 11.0 Product Documentationalert 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:
const alert = require("/MarkLogic/alert");
60 functions
| Function name | Description |
|---|---|
| alert.actionGetDescription | This function returns the description of a given action. |
| alert.actionGetModule | This function returns the module of a given action. |
| alert.actionGetModuleDb | This function returns the module database of a given action. |
| alert.actionGetModuleRoot | This function returns the module root of a given action. |
| alert.actionGetName | This function returns the name of a given action. |
| alert.actionGetOptions | This function returns the options of a given action. |
| alert.actionInsert | This function inserts the specified action into the collection. |
| alert.actionRemove | This function removes the named action from the database or throws an exception if the action does not exist. |
| alert.actionSetDescription | This function returns the action with the description of the action updated. |
| alert.actionSetModule | This function returns the action with the module of the action updated. |
| alert.actionSetModuleDb | This function sets the module database of a given action. |
| alert.actionSetModuleRoot | This function sets the module root of a given action. |
| alert.actionSetName | This function returns the action with the name of the action updated. |
| alert.actionSetOptions | This function returns the action with the options of the action updated. |
| alert.configDelete | Remove an alerting configuration identified by the specified URI. |
| alert.configGet | Gets the config associated with the specified URI. |
| alert.configGetCpfDomainNames | This function returns the CPF domain names set in the specified alerting configuration. |
| alert.configGetDescription | This function provides returns the description set in the specified alerting configuration. |
| alert.configGetId | This function returns the ID of the specified alerting configuration. |
| alert.configGetName | This function returns the name set in the specified an alerting configuration. |
| alert.configGetOptions | This function returns the options set in specified alerting configuration. |
| alert.configGetTriggerIds | This function returns the trigger IDs set in the specified alerting configuration. |
| alert.configGetUri | This function returns the URI set in the specified alerting configuration. |
| alert.configInsert | Inserts a config into the database. |
| alert.configSetCpfDomainNames | This function sets the CPF domain names in the specified alerting configuration. |
| alert.configSetDescription | This function sets the description within the specified alerting configuration. |
| alert.configSetName | This function sets the name in the specified alerting configuration. |
| alert.configSetOptions | This function sets the options in the specified alerting configuration. |
| alert.configSetTriggerIds | This function sets the trigger IDs in the specified alerting configuration. |
| alert.createTriggers | Create triggers that invoke the standard alerting trigger module. |
| alert.findMatchingRules | Returns a list of all rules associated with the specified config that match the specified document. |
| alert.getActions | This function retrieves all the named actions in the specified config URI. |
| alert.getAllRules | This function returns all rules visible to the current user. |
| alert.getMyRules | This function returns all rules associated with the current user. |
| alert.invokeMatchingActions | Finds the rules that match the specified document and invokes their associated actions. |
| alert.makeAction | This function creates the specified action. |
| alert.makeConfig | Create an alerting configuration associated with a particular URI. |
| alert.makeLogAction | Create a standard logging action named "log". |
| alert.makeRule | This function creates the specified rule. |
| alert.removeTriggers | Remove triggers whose IDs are listed in the config. |
| alert.ruleActionQuery | This function creates a query to find rules with any of the specified actions. |
| alert.ruleGetAction | This function returns the action of a given rule. |
| alert.ruleGetDescription | This function returns the description of a given rule. |
| alert.ruleGetId | This function returns the ID of a given rule. |
| alert.ruleGetName | This function returns the name of a given rule. |
| alert.ruleGetOptions | This function returns the options of a given rule. |
| alert.ruleGetQuery | Get the cts.query corresponding to the rule's query expression. |
| alert.ruleGetUserId | This function returns the user ID of a given rule. |
| alert.ruleIdQuery | This function creates a query to find rules with any of the specified IDs. |
| alert.ruleInsert | This function inserts rule into the database associated with the specified alerting configuration. |
| alert.ruleNameQuery | This function creates a query to find rules with any of the specified names. |
| alert.ruleRemove | This function removes the specified rule from the collection. |
| alert.ruleSetAction | This function returns the rule with the action updated. |
| alert.ruleSetDescription | This function returns the rule with the description of the rule updated. |
| alert.ruleSetName | This function returns the rule with the name of the rule updated. |
| alert.ruleSetOptions | This function returns the rule with the options of the rule updated. |
| alert.ruleSetQuery | Set the cts:query corresponding to the rule's query expression. |
| alert.ruleSetUserId | This function returns the rule with the user ID updated. |
| alert.ruleUserIdQuery | This function creates a query to find rules with any of the specified user IDs. |
| alert.spawnMatchingActions | Finds the rules that match the specified document and spawns their associated actions. |