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.xqy module in your own XQuery modules, include the following line in your XQuery prolog:

import module namespace alert = "http://marklogic.com/xdmp/alert" at "/MarkLogic/alert.xqy";

The library uses the alert: namespace, which is not predefined in the server.

60 functions
Function name Description
alert:action-get-description This function returns the description of a given action.
alert:action-get-module This function returns the module of a given action.
alert:action-get-module-db This function returns the module database of a given action.
alert:action-get-module-root This function returns the module root of a given action.
alert:action-get-name This function returns the name of a given action.
alert:action-get-options This function returns the options of a given action.
alert:action-insert This function inserts the specified action into the collection.
alert:action-remove This function removes the named action from the database or throws an exception if the action does not exist.
alert:action-set-description This function returns the action with the description of the action updated.
alert:action-set-module This function returns the action with the module of the action updated.
alert:action-set-module-db This function sets the module database of a given action.
alert:action-set-module-root This function sets the module root of a given action.
alert:action-set-name This function returns the action with the name of the action updated.
alert:action-set-options This function returns the action with the options of the action updated.
alert:config-delete Remove an alerting configuration identified by the specified URI.
alert:config-get Gets the config associated with the specified URI.
alert:config-get-cpf-domain-names This function returns the CPF domain names set in the specified alerting configuration.
alert:config-get-description This function provides returns the description set in the specified alerting configuration.
alert:config-get-id This function returns the ID of the specified alerting configuration.
alert:config-get-name This function returns the name set in the specified an alerting configuration.
alert:config-get-options This function returns the options set in specified alerting configuration.
alert:config-get-trigger-ids This function returns the trigger IDs set in the specified alerting configuration.
alert:config-get-uri This function returns the URI set in the specified alerting configuration.
alert:config-insert Inserts a config into the database.
alert:config-set-cpf-domain-names This function sets the CPF domain names in the specified alerting configuration.
alert:config-set-description This function sets the description within the specified alerting configuration.
alert:config-set-name This function sets the name in the specified alerting configuration.
alert:config-set-options This function sets the options in the specified alerting configuration.
alert:config-set-trigger-ids This function sets the trigger IDs in the specified alerting configuration.
alert:create-triggers Create triggers that invoke the standard alerting trigger module.
alert:find-matching-rules Returns a list of all rules associated with the specified config that match the specified document.
alert:get-actions This function retrieves all the named actions in the specified config URI.
alert:get-all-rules This function returns all rules visible to the current user.
alert:get-my-rules This function returns all rules associated with the current user.
alert:invoke-matching-actions Finds the rules that match the specified document and invokes their associated actions.
alert:make-action This function creates the specified action.
alert:make-config Create an alerting configuration associated with a particular URI.
alert:make-log-action Create a standard logging action named "log".
alert:make-rule This function creates the specified rule.
alert:remove-triggers Remove triggers whose IDs are listed in the config.
alert:rule-action-query This function creates a query to find rules with any of the specified actions.
alert:rule-get-action This function returns the action of a given rule.
alert:rule-get-description This function returns the description of a given rule.
alert:rule-get-id This function returns the ID of a given rule.
alert:rule-get-name This function returns the name of a given rule.
alert:rule-get-options This function returns the options of a given rule.
alert:rule-get-query Get the cts:query corresponding to the rule's query expression.
alert:rule-get-user-id This function returns the user ID of a given rule.
alert:rule-id-query This function creates a query to find rules with any of the specified IDs.
alert:rule-insert This function inserts rule into the database associated with the specified alerting configuration.
alert:rule-name-query This function creates a query to find rules with any of the specified names.
alert:rule-remove This function removes the specified rule from the collection.
alert:rule-set-action This function returns the rule with the action updated.
alert:rule-set-description This function returns the rule with the description of the rule updated.
alert:rule-set-name This function returns the rule with the name of the rule updated.
alert:rule-set-options This function returns the rule with the options of the rule updated.
alert:rule-set-query Set the cts:query corresponding to the rule's query expression.
alert:rule-set-user-id This function returns the rule with the user ID updated.
alert:rule-user-id-query This function creates a query to find rules with any of the specified user IDs.
alert:spawn-matching-actions Finds the rules that match the specified document and spawns their associated actions.