[DOCU-167] Document the example listener in Observation module Created: 01/Jul/11  Updated: 03/Nov/15

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Antti Hietala
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

In the Observation module document, explain the following points:

  • Observation module is NOT installed by default. The current text is incorrect.
  • Make it clear that even though the /modules/observation folder is present in a typical bundle installation it doesn't mean the Observation module is actually installed. Common stumbling block. How to check if a module is installed?
  • Some other modules bootstrap their own listener configurations which causes the /modules/observation folder to be created. Explain what modules included in the EE bundle do this and describe the listeners they bootstrap. Verify that the modules' own articles also mention the listeners.
  • Install the Observation module and describe the example listener it bootstraps. It's a commonly requested listener, search the mailing list. Explain how to customize it for example to listen to the dms workspace.
  • Link to the Commands chapter in Technical Guide from relevant places because it is more common to specify a command to be executed than it is to write your own event listener.
  • Did anyone write their own event listener? Search the mailing list. What problems did they solve?


 Comments   
Comment by Ruth Stocks [ 23/Jul/11 ]

Updated page at - http://docuauthor.magnolia-cms.com/modules/observation.html.

Installation of the Observation module causes in the configurations installed by the Commenting and Categorization modules to disappear. They are not recreated on subsequent startups. This doesn’t seem to be intended behavior.In the Commenting module the XML file for sendMailOnPageComments resides at /mgnl-bootstrap/commenting/setup/observation. I can’t find a corresponding XML bootstrap file for generateCateogires in the Categorization module.

Comment by Antti Hietala [ 13/Jan/12 ]

Resolved. Unwanted deletion of sample listener configs reported in MGNLOBS-13.

Generated at Mon Feb 12 01:06:34 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.