Configure triggers

[dmcassel]

Figure out a good way to include triggers in the deploy process and implement it.

[adamfowleruk]

+1 on this too. Many of my demos make extensive use of triggers. Having this would simplify sharing demos and remove misconfiguration issues.

[peetkes]

+1 on this. We have a customer who uses roxy for dev and deploy and they are starting to implement triggers.

[grtjn]

Hmm, interesting. You could mimic at least part by pushing trigger xml docs into the Triggers database, but can imagine that is a bit of a hassle.. ;-)

+1

[dmcassel]

Not yet implemented, but you can do it in deploy/app_specific.rb. Here's an example:

def create_alerting_triggers()
  r = execute_query %Q{
    import module namespace alert = "http://marklogic.com/xdmp/alert" at "/MarkLogic/alert.xqy";
    import module namespace trgr = "http://marklogic.com/xdmp/triggers" at "/MarkLogic/triggers.xqy";

    if (alert:config-get("http://sample.com/audit/alert")) then ()
    else
      let $config :=
        alert:make-config(
          "http://sample.com/audit/alert",
          "Sample Change Alerting",
          "Alerting configuration for Sample",
          <alert:options/>)
      return
        alert:config-insert($config);


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

    if (alert:config-get-trigger-ids(alert:config-get("http://sample.com/audit/alert"))) then ()
    else
      let $uri := "http://sample.com/audit/alert"
      let $trigger-ids :=
          alert:create-triggers(
            $uri,
            trgr:trigger-data-event(
              trgr:directory-scope("/ItemInfo/", "1"),
              trgr:document-content(("modify")),
              trgr:pre-commit()))
      let $config := alert:config-set-trigger-ids(alert:config-get($uri), $trigger-ids)
      return
        alert:config-insert($config);

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

    if (alert:get-actions("http://sample.com/audit/alert", ("*"))) then ()
    else
      let $uri := "http://sample.com/audit/alert"
      let $action-add-mailfile :=
        alert:make-action(
          "add-to-inbox",
          "Add Audit Event to the User Inbox",
          xdmp:modules-database(),
          xdmp:modules-root(),
          "/lib/add-to-inbox.xqy",
          <alert:options/>
        )
      return
        alert:action-insert($uri, $action-add-mailfile)
  },
  { :app_name => @properties["ml.app-name"] }
end

[grtjn]

Here an example for plain triggers:

class ServerConfig
  alias_method :original_deploy_modules, :deploy_modules
  def deploy_modules()
    original_deploy_modules

    r = execute_query(%Q{
        xquery version "1.0-ml";

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

        xdmp:log("Installing triggers.."),

        try {
          trgr:remove-trigger("CreateTrigger"),
          trgr:remove-trigger("ModifyTrigger")
        } catch ($ignore) {
        };


        xquery version "1.0-ml";

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

        trgr:create-trigger("CreateTrigger", "Trigger to enrich XML ingested via MLCP", 
          trgr:trigger-data-event(
            trgr:directory-scope("/ingest/", "1"),
            trgr:document-content("create"),
            trgr:pre-commit()
          ),
          trgr:trigger-module(xdmp:modules-database(), "/", "/triggers/enrich-xml.xqy"),
          fn:true(),
          xdmp:default-permissions(),
          fn:false()
        ),

        trgr:create-trigger("ModifyTrigger", "Trigger to enrich XML ingested via MLCP", 
          trgr:trigger-data-event(
            trgr:directory-scope("/ingest/", "1"),
            trgr:document-content("modify"),
            trgr:pre-commit()
          ),
          trgr:trigger-module(xdmp:modules-database(), "/", "/triggers/enrich-xml.xqy"),
          fn:true(),
          xdmp:default-permissions(),
          fn:false()
        )
      },
      :app_name => @properties["ml.app-name"]
    )
  end
end

[dmcassel]

I just added both of these samples to the Adding Custom Build Steps wiki.

[eouthwaite]

Could Richard's method be implemented as standard ?
https://rclayton.silvrback.com/writing-and-deploying-triggers-in-marklogic-roxy

[grtjn]

I would prefer going even a step further, and taking deployment of CPF as example:

ml local deploy triggers
ml local clean triggers

and while at it:

ml local deploy alerts
ml local clean alerts

The idea would be to record essential settings in some XML config, and have that interpreted and executed. The syntax could be close to the real XML syntax of triggers/alerts inside the database. I expect that to be less error prone..

A bit more involved, but will add it to the wishlist of release 1.7.3

[dmcassel]

+1 on adding commands for triggers and alerts

[peetkes]

At last!!! +1!

[grtjn]

Sorry guys, pushing away for the time being..

[dmcassel]

@adamfowleruk @peetkes @eouthwaite I implemented deploying and removing (cleaning) triggers. Testers welcome.

[dmcassel]

If this approach looks good, alerts could be added to the same file (triggers-config.xml) or to a file that is specific to alerts.

[dmcassel]

Added a wiki describing the new feature (currently in a PR).

[dmcassel]

fixed in dev