ATG Personalization Programming Guide

Class name

atg.process.dms.ProcessEndMessage

JMS name

atg.dss.ScenarioEnd

Display name

Scenario Ends

Message scope

Global

Message source

Component: /atg/scenario/DSSMessageSource

Class: atg.scenario.dms.DSSMessageSource

Component that calls the message source

/atg/process/ScenarioUpdateTrigger (class atg.process.ProcessUpdateTrigger)

How this event is triggered

The Scenario Manager generates and sends a ProcessUpdateEvent to any configured ProcessUpdateListeners, including the ScenarioUpdateTrigger component. When it receives the event, the ScenarioUpdateTrigger component determines whether the event indicates that a scenario has been terminated, and if so, it generates and sends the corresponding JMS message of the type specified by its ProcessEndMessageType property (by default, atg.dss.ScenarioEnd).

Note that only the ScenarioUpateTrigger component located on the process editor server performs these steps. The components on other servers receive the event but do not send the JMS message.

How to turn this event off

Set to true the sendProcessEndMessages property in the /atg/process/ScenarioUpdateTrigger component.

endType

int

endType

Indicates the way the scenario was terminated. The value can be REMOVE (indicating the scenario was deleted by an ACC user), DISABLE (disabled by an ACC user), or DISABLE_SELF (disabled as a result of a DisableScenario action)

processName

java.lang.String

processName

The name of the scenario that was terminated.