Overview of Event Bus Events - BloomReach Experience - Open Source CMS
06-12-2019

Overview of Event Bus Events

Below is an overview of common user interactions and system actions that trigger the broadcasting of an event on the Event Bus.

The (inter)actions are grouped by category. For each category, the event class (HippoEvent or a descendant) and the return value of HippoEvent#category are listed. The are the same for all (inter)actions listed under the category. For each (inter)actions, the return value of HippoEvent#action() is listed. Some (inter)actions trigger multiple events with different action values.

Security

  • class: org.onehippo.cms7.event.HippoSecurityEvent
  • category: org.onehippo.cms7.event.HippoEventConstants.CATEGORY_SECURITY
User interaction or system action Event action
User logs in

login

User logs out

logout

User Management

  • class: org.onehippo.cms7.event.HippoEvent
  • category: org.onehippo.cms7.event.HippoEventConstants.CATEGORY_USER_MANAGEMENT
User interaction or system action Event action
Create user

create-user

Delete user

delete-user

Group Management

  • class: org.onehippo.cms7.event.HippoEvent
  • category: org.onehippo.cms7.event.HippoEventConstants.CATEGORY_GROUP_MANAGEMENT
User interaction or system action Event action
Create group

create-group

Add user to group

add-user-to-group

Remove user from group

remove-user-from-group

Delete group

delete-group

Permissions Management

  • class: org.onehippo.cms7.event.HippoEvent
  • category: org.onehippo.cms7.event.HippoEventConstants.CATEGORY_PERMISSIONS_MANAGEMENT
User interaction or system action Event
Grant user or group role in domain

grant-role

Revoke user or group role in domain

revoke-role

Document & Folder Workflow

  • class: org.onehippo.repository.events.HippoWorkflowEvent
  • category: org.onehippo.cms7.event.HippoEventConstants.CATEGORY_WORKFLOW
User interaction or system action Event action(s)
Add new folder or document

add

Rename folder or document (display name)

setDisplayName

Rename folder or document (URL name)

rename

Delete folder or document

delete

Open document in editor

obtainEditableInstance

Save document

commitEditableInstance

Discard changes in document disposeEditableInstance
Move document

moveOver, moveTo, move

Copy document

copyTo, copy

Request publication

requestPublication

Cancel request

cancelRequest

Accept request

acceptRequest

Reject request

rejectRequest

Publish document

publish

Take document offline

depublish

Add document to project *

branch

Remove document from project *

removeBranch

Approve document in project *

com.onehippo.repository.wpm.project.documentworkflow.WpmDocumentWorkflowAction.approve

Publish document in project when campaign started *

publishBranch

Revert document in project when campaign stopped *

depublishBranch

Publish document in project when project merged *

reintegrateBranch

* Only available when the Projects feature is used

See Respond to Workflow Events for a detailed guide.

Channel Workflow

  • class: org.onehippo.cms7.event.HippoEvent
  • category: channel-manager
User interaction or system action Event action
Make change in channel editor

write-changes

Publish channel

publishMount

Discard changes in channel

discardMount

More detailed Experience manager events are available through the Channel Manager Event Listener and the HST Internal Event Bus. See Overview of Experience Manager Events and Response Mechanisms for more information.

Project Workflow

  • class: class: com.onehippo.cms7.services.wpm.wpm.observation.WpmEvent
  • category: hippo-addon-wpm
User interaction or system action Event action
Create project

createProject

Add channel to project

addChannel

Remove channel from project

deleteChannel

Remove document from project

dissociateDocument

Request project review

requestReview

Cancel project review

cancelReview

Approve document

approveDocument

Reject document

rejectDocument

Reopen project in review

restartProject

Start campaign

startCampaign

Stop campaign

stopCampaign

Merge project

reintegrateProject

Delete project

deleteProject

 

 

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?