To help you monitor scenarios and debug them if necessary, enable the loggingDebug
property in the /atg/scenario/ScenarioManager
component (set to false
by default). If you set it to true
, the system logs information such as the events each scenario is capturing, the condition elements that are being satisfied, and the action elements that are triggered. The information is stored in the debug.log
file and it also appears in the Oracle Commerce Platform console window.
Note that you might not want to keep this setting enabled for long periods of time, especially for live sites, because tracking information on each scenario can affect performance.
The ScenarioManager
component contains additional properties you can use for different levels of scenario debugging as described below:
debugProcessNames
Allows you to debug specific scenarios rather than all of them. Set this property to the folder path of the scenario or scenarios that you want to debug, minus the part of the registry where all scenarios are located. You can specify individual scenarios or all scenarios in a given folder. For example:
debugProcessNames=/DSSDemo/InvestorRelations/MyScenario
logs information for the specified scenario. Note that the path comes from the location of this scenario’s SDL file under the
/atg/registry/data/scenarios
directory. You can determine the path by looking for the scenario in the ACC using the By Folders view.debugProcessNames=/scenario1, /scenario2
logs information only for scenarios called
scenario1.sdl
andscenario2.sdl
debugProcessNames=/recorders/*,/scenario1
logs information for all scenarios in folder
/recorders/
, plus/scenario1.sdl
.The default setting is
*
, which logs information on all scenarios. Note that this property is available only if bothloggingDebug
andloggingDebugProcesses
are enabled.loggingDebugMessages
Includes in the debug log file information about the Java Message Service (JMS) messages sent and received by the Scenario Manager.
The default setting is
true
.loggingDebugProcesses
Includes additional scenario information in the debug log file such as the time that individual instances are created, transitions between states, and filter checking.
The default setting is
false
.loggingDebugUpdates
Includes information about scenario updates in the debug log file.
The default setting is
true
.loudMissingElementMessages
In some circumstances, a server may read scenario definitions generated by another server, attempt to run them, and be unable to do so because the required elements do not exist in its configuration path. In this case, a long series of errors about unknown elements is sent to the console when the agent server is started.
Setting the
loudMissingElementMessages
property to false displays an informative message rather than the errors. Note that it is set to false in the DSSliveconfig
layer.
For more information on configuring the ScenarioManager
component, see Configuring Scenarios.
As an alternative to editing the ScenarioManager
component directly, you can enable many of these debugging properties through the Configure Server Debugging dialog box in the ACC. To access this dialog box, display the Scenarios > Scenarios window, and then select Tools > Configure Server Debugging. This dialog box contains the following options:
Include debugging information in server log: Enables the
loggingDebug
property.Log JMS messages received by process manager: Enables the
loggingDebugMessages
property.Log information related to process updates: Enables the
loggingDebugUpdates
property.Enable logging of information about individual processes: Enables the
loggingDebugProcesses
property.