High Level Messages
High level messages request information or change the behavior of a running NMS service without changing its startup command. This section covers common Service messages and service-specific handlers. Check the stated applicability and prerequisites before sending a request. DBService and ODService use their own handlers; adapter-specific messages are documented in the Adapters Guide, and DMSService messages are documented with the Power Flow Services reference.
Send a request to the running service with:
Action any.<service name> <command> [arguments]
The service target can contain a wildcard; select the intended service when changing state. Command names are normalized to lowercase; argument case follows the individual command. Output normally appears in the target service log. Forwarded publisher diagnostics appear in the WebLogic log. An acknowledgement can precede completion of the requested operation.
In the syntax below, angle brackets identify required values, square brackets identify optional values, and an ellipsis permits repetition. Enter values without the brackets and preserve the spelling and case shown.
Caution: Consult Oracle Support before first using diagnostic or maintenance commands, particularly in production. Commands can modify data, interrupt processing, or generate substantial output. Use sms-stop for routine service shutdown rather than the deprecated stop message.
Common Service Messages
These entries apply to SMService, DDService, JMService, MBService, MTService, SwService, TSService, corbagateway, publisher, mycentricity, RTAdapter, CalcAdapter, IccpAdapter, IVRAdapter, mdsgateway, DMSService. DBService and ODService use separate parsers and handlers; use their own sections. A service-specific entry takes precedence over a common entry. The publisher process uses the corbagateway handler.
debug [<level> | <facility> <level> ...]
Toggle global debugging when no argument is supplied; otherwise set the global level or individual facility levels.
Notes: With debug_bitwise on, several levels can follow each facility. Set debug 0 to turn down global debugging, or set each enabled facility to 0.
Example:
Action any.DDService debug EXPACT 2 SCADA 2 MESSAGES 2
debug_bitwise <on|off>
Enable independent debug-level selection with on; any other value disables it. Changing the mode resets all facility levels to zero.
debug_device <device>
Select a device for device-specific diagnostics.
Aliases: debugdevice, device_debug, devicedebug.
debug_thread <disable|enable|dump> [thread_name ...]
Disable or enable debug output for threads matching the supplied name fragments. Use enable without names to reset all thread filters. Each command prints the resulting disabled-thread list.
disconnect
Disconnect the process from the message bus.
Use: Oracle Support diagnostics.
Caution: Interrupts service communication.
displaymessage <message ...>
Write a message to the service log to correlate operator actions with diagnostic output.
dump [resource]
Print service-specific diagnostic state. Supported resources and the no-argument behavior are defined by the target service.
Use: Oracle Support diagnostics.
functiontrace <dump|clear|reset|trace>
Print function call counts (dump), clear counts (clear), dump then clear (reset), or print current stack traces (trace).
Use: Oracle Support diagnostics.
Prerequisites: The OMS_FUNCTION_TRACE function-tracing debug facility must be configured before process startup through the OMS_FUNCTION_TRACE environment variable: level 1 enables call counts, level 2 also enables stack traces, and level 3 also enables timing statistics.
getrusage
Write operating-system resource usage statistics to the service log.
Use: Oracle Support diagnostics.
hot
Message sent by SMService to activate a managed warm service instance. It promotes the instance to active operation and updates SMService status; it has no effect if already active.
Use: Oracle Support diagnostics.
Caution: Do not call this message explicitly on a managed service. SMService coordinates activation through the configured failover procedure.
Notes: To activate the complete managed warm service set, the hot message is handled by SMService as described in its own entry.
isisdump
Generate a message-bus diagnostic dump.
Use: Oracle Support diagnostics.
pgtiming <on|off|start|stop|0|1> | pgtiming stats <on|off|start|stop|dump|print|clear|reset>
Control process-group timing output or separately collect accumulated process-group statistics.
Use: Oracle Support diagnostics.
Notes: Timing and statistics collection are separate controls. Arguments are lowercase as shown. Missing or unrecognized arguments leave the corresponding setting unchanged. Output appears in the target service log; these diagnostic settings are local to the process and do not update system.dat.
• on or start: enable timing output; off or stop: disable it. Numeric 0 disables timing and a positive integer enables it.
• stats on or stats start: begin collecting statistics. stats off or stats stop: print the accumulated statistics and stop collection.
• stats dump or stats print: print accumulated statistics without clearing them or stopping collection.
• stats clear: clear accumulated statistics without printing their previous values. stats reset: print the accumulated statistics, then clear them. Neither changes whether collection is enabled.
Example:
Action any.MTService pgtiming stats on
Action any.MTService pgtiming stats dump
Action any.MTService pgtiming stats off
relog
Archive the current service log and open a new one.
report
Acknowledge a service-status probe. Action reports the number of matching responding processes; an initializing service can defer its acknowledgement.
restart
Exit and request immediate restart by SMService.
Use: Oracle Support diagnostics.
Caution: Interrupts service processing.
stop
Stop the target process.
Status: Deprecated.
Caution: Use sms-stop for routine shutdown. Action requires -force for protected STOP requests.
what <handle|alias>
Print service-specific information for a device. Handles and aliases are resolved before the service-specific report is generated.
Network Service Messages
These messages apply to MTService and DMSService, in addition to the common service messages. Service-specific messages take precedence.
dump_caches [filename]
Write network caches to a diagnostic file.
Use: Oracle Support diagnostics.
dump_network force
Print the entire real-time electrical network.
Use: Oracle Support diagnostics.
Caution: The model is locked during output. Processing can be unavailable for many minutes; force is required.
study_what [session] <handle|alias> [handle|alias ...]
Print topology information in the selected study session. With one device argument, use the tracking session. Invalid or unknown session IDs fall back to tracking.
what <handle|alias> [handle|alias ...]
Print real-time topology information for the listed devices.
SMService
The common service entries also apply, except where overridden below.
check
Check managed process-group status.
hot
When SMService is warm, activate SMService and all warm services it manages by sending them the hot message.
Caution: Promotes the managed warm service set. Use only through the configured failover procedure; do not send hot directly to individual managed services.
reset_instances
Reset restart counters for blocked managed instances so they can be considered for restart.
restart [system_dat_file]
Reconfigure the managed service set, optionally loading another system.dat file. This overrides the generic restart behavior: it does not simply exit SMService.
Notes: With a file, reread configuration, retain runtime state, and poll running processes before continuing startup. Without a file, restart processing of the current configuration.
DBService
clear
Reset the DBService transaction metrics.
cursql
Print the currently executing SQL statement, or report that none is executing.
debug [level] | debug <facility> <level>
Set the default or named facility debug level. No arguments reset the default facility to zero; this differs from the shared service toggle.
dump
Print DBService diagnostic state.
hot
Message sent by SMService to activate a managed warm service instance. It promotes the instance to active operation and updates SMService status; it has no effect if already active.
Caution: Do not call this message explicitly on a managed service. SMService coordinates activation through the configured failover procedure.
Notes: To activate the complete managed warm service set, the hot message is handled by SMService as described in its own entry.
queryout [0|1]
Set query logging to standard output. With no argument, toggle the current setting.
relog
Open a new service log and send the new log file to all dbrdwr processes.
report
Acknowledge a status probe after DBService initialization.
sqlout [0|1]
Set SQL-update logging to standard output. With no argument, toggle the current setting.
sqltiming <milliseconds>
Set SQL timing logging: 0 disables it, 1 logs all statements, larger values select statements exceeding that number of milliseconds.
stop
Stop DBService.
Status: Deprecated.
Caution: Use sms-stop for routine shutdown.
DDService
The common service entries also apply, except where overridden below.
chk_abnormal
Audit and update the Abnormal Device Summary.
delete_condition <handle>
Delete a real-time condition, clearing its status first if necessary.
Use: Oracle Support diagnostics.
Caution: Directly changes real-time condition data; use only under Oracle Support direction.
dump <resource>
Print the selected Dynamic Data Service structure or measurement.
Notes: Use dump help for the resource list. The current implementation does not dump all structures when no resource is supplied.
• help or ?: list resources.
• analogs, digitals, measures, controls, conditions: measurements, controls, or conditions.
• ctrl_zone, dcz, rt_switch, session, alarm, limits, momentary: corresponding managers.
• alt_view: alternate views and diagrams.
• rules, messages, memstats: rules, message mappings, or memory statistics.
• \<class.index.attribute\>: digital or analog measurement for a device attribute.
dump_caches [filename]
Write DDService caches to a diagnostic file.
Use: Oracle Support diagnostics.
purge_history
Run PURGE_HISTORY_TABLES to purge history using the RETAIN_HISTORY_RECORDS configuration.
Caution: Deletes history rows according to the configured retention policy.
Notes: The database procedure is customizable. Product tables include PF_DERMS_FORECAST_HISTORY, FLM_FDR_LOAD_HISTORY, FLM_FDR_LOAD_DETAILS_HISTORY, FLM_DEV_VIOLATIONS_HISTORY, and SCADA_ANALOG_HISTORY.
recache_alarm_rules
Reload the active alarm manager configuration.
reload_rules
Reload SRS configuration rules and update dependent DDService settings.
reloadanalog
This command is deprecated and returns no successful reply. Use UpdateDDS -recacheMeasures.
Status: Deprecated.
reloaddigital
This command is deprecated and returns no successful reply. Use UpdateDDS -recacheMeasures.
Status: Deprecated.
JMService
The common service entries also apply, except where overridden below.
clear_old_callbacks <minutes> [username]
Expire restored-event callbacks after the specified positive timeout in minutes. The optional username is currently unused.
Notes: Rejected by warm instances.
dump [resource ...]
Print JMService internal state. Several resources can be supplied.
Default: rules queues feeders completed crews upstream_cache statistics allcalls.
• active, events, alarms, completed, feeders, crews: event and crew state.
• queues, alarmqueue: grouping and timed-alarm queues.
• allcalls (alias allincs): include all calls with feeder output.
• rules, autoert, tcode: rules, automatic ERT, or trouble-code configuration.
• jobs_by_device, jobs_by_sheet: job lookup caches.
• avl, cb, amr, stormman: subsystem state.
• caches, snodes (alias supplynodes), scache, upstream_cache (alias upcache): internal caches.
• statemgr, statecb: transition-engine state and callbacks.
• statistics (alias stats), memstats, tfsummary: statistics and trouble-feeder summary.
• \<handle|device alias\>: report the selected event, feeder, device, or call.
dump_caches [filename]
Write JMService caches to a diagnostic file.
Use: Oracle Support diagnostics.
fix_duplicates <event_handle>
Repair duplicate non-NFY event numbers.
Use: Oracle Support diagnostics.
Caution: Consult Oracle Support before use. Rejected by warm instances.
grouping_param <name=value> [name=value ...]
Change the grouping scheduler parameters described under -groupingParam.
Notes: Rejected by warm instances.
isis_prm <parameter> [integer]
Report a named message-bus system parameter, or change it to an integer value. This command does not select a parameter file.
Use: Oracle Support diagnostics.
Notes: Warm instances permit queries, but reject changes.
reload [-wait] <resource> [resource ...]
Reload selected configuration structures. Place -wait before the first resource to delay acknowledgement until reload completes.
Notes: Without -wait, acknowledgement precedes the first reload. Rejected by warm instances.
• crew_members, crew_vehicles, crews, crew_columns, crew_config: crew configuration.
• rules: job-management rules.
• statemgr, statecb: transition-engine state or callbacks.
• trouble_codes, dispatch_groups: trouble-code and referral-group configuration.
• stormman, autoert: Storm Management or automatic ERT configuration.
reload_rules
Reload all JMService rule sets.
Notes: Rejected by warm instances.
simulation ["date time"]
Set a fixed Storm Management simulation time; omit the value to return to the current time. Quote a date/time containing spaces. Parsing uses NMS_SYSDATE; an invalid value clears the fixed time.
Prerequisites: An initialized Storm Management subsystem.
Notes: Rejected by warm instances.
validate <resource>
Validate JMService memory and database consistency; write errors and warnings to the service log.
• jobs, snodes, calls: validate corresponding memory structures.
• jobs_in_db, snodes_in_db, calls_in_db: compare memory against the corresponding database tables.
• alarmqueue: validate the timed-alarm queue.
• all: validate jobs, calls, and supply nodes in memory and against the database; alarmqueue is separate.
MBService
The common service entries also apply, except where overridden below.
checkpatchesnnotify
Check model patches and notify services of pending changes.
Use: Oracle Support diagnostics.
getstatus
Report current model-build status.
Use: Oracle Support diagnostics.
haltbuild
Suspend new model-build processing after currently running patches finish.
Use: Oracle Support diagnostics.
refresh
Refresh the model-build configuration and cached model data.
Use: Oracle Support diagnostics.
regenerategeojson <map-prefix>
Regenerate GeoJSON output for the required map filename prefix.
Use: Oracle Support diagnostics.
resumebuild
Resume suspended model-build processing.
Use: Oracle Support diagnostics.
validate <PATCHES/ALTERNATE_VIEWS/ALL>
Validate model-edit patches, alternate views, or both; write results to the service log.
Use: Oracle Support diagnostics.
MTService
The common service entries also apply, except where overridden below.
check_backfeeds
Start checking backfeedable devices.
Use: Oracle Support diagnostics.
check_rt_tracking
Compare real-time and tracking topology state.
Use: Oracle Support diagnostics.
colors
Reload feeder-color definitions and notify clients if they changed.
dump <memstats|colors|ids>
Print memory statistics, feeder colors, or real-time mother-ID information.
dump_colors
Print all configured feeder colors.
print_mother_ids
Print real-time mother IDs.
Use: Oracle Support diagnostics.
print_tracking_mother_ids
Print tracking-session mother IDs.
Use: Oracle Support diagnostics.
reload
Reload topology configuration rules and recheck backfeedable devices if that rule changed.
Aliases: reload_rules.
report
Acknowledge a service probe only after initialization completes.
resolve
Resolve the real-time, tracking, and nominal topology sessions, then request a publisher refresh.
Caution: Use only for diagnosed topology inconsistencies. Depending on the original issue, clients or the managed server may also need restarting.
validate
Validate the real-time topology cache.
Use: Oracle Support diagnostics.
ODService
debug [level] | debug <facility> <level>
Set the default or named facility debug level. With no arguments, toggle legacy application debugging and reset the default facility level to zero.
dump
Print cached object-directory information for diagnostics.
dump_caches [filename]
Write object-directory caches to a diagnostic file. The spelling is dump_caches, not dump_cache.
hot
Message sent by SMService to activate a managed warm service instance. It promotes the instance to active operation and updates SMService status; it has no effect if already active.
Caution: Do not call this message explicitly on a managed service. SMService coordinates activation through the configured failover procedure.
Notes: To activate the complete managed warm service set, the hot message is handled by SMService as described in its own entry.
metrics
Print alias-cache and MRU utilization metrics.
recache
Reload object-directory caches.
relog
Archive the current log and open a new one.
report
Acknowledge a service-status probe.
restart
Exit and request service restart.
stop
Stop ODService.
Status: Deprecated.
Caution: Use sms-stop for routine shutdown.
SwService
The common service entries also apply, except where overridden below.
dump
Print cached switching plans.
Use: Oracle Support diagnostics.
execute_next_scheduled_steps <sheet_id>
Execute the next scheduled steps on the specified DERMS Optimization switching sheet. The sheet ID must be a positive integer.
Use: Oracle Support diagnostics.
Caution: Can execute switching steps; use only for the intended DERMS workflow.
reload
Reload switching power-flow rule definitions.
Aliases: reload_rules.
relock [plan_handle]
Release the selected switching-plan lock, or all switching locks if no valid handle is supplied, then notify switching clients.
Use: Oracle Support diagnostics.
Caution: Changes plan locking; use only to recover diagnosed lock problems.
TSService
The common service entries also apply, except where overridden below.
recalc
Recalculate Trouble Summary information and notify the publisher of the resulting snapshot.
Notes: No calculation is performed while the service is warm, an update is already in progress, or -noTroubleSum is configured.
corbagateway / publisher
The common service entries also apply, except where overridden below.
dump_rules
Print gateway configuration rules.
Use: Oracle Support diagnostics.
dump_stats
Print publisher statistics.
Use: Oracle Support diagnostics.
ejb dump [resource]
Forward a diagnostic dump request to WebLogic Java services. Output is written to the WebLogic log.
Notes: The gateway acknowledges forwarding, not completion of Java-side processing. Resource spellings follow the Java handler.
• zones: configured zone hierarchy.
• crews: configured crews.
• events: current events.
• conditions: cached conditions.
• measures \[class.index\[.attribute\]\]: all measurements, a device, or one device attribute.
• users: active users.
• cache: defined cache sizes.
• cache memory: cache sizes including memory consumption; background processing can delay output.
• message: queued messages.
• all or no resource: all standard dumps.
Example:
Action any.publisher ejb dump cache memory
orb_debug_level [level]
Report or set the TAO CORBA debug level.
Use: Oracle Support diagnostics.
pub_interval <iterations>
Change the positive number of periodic event-processing iterations between publisher heartbeat messages and consumer backlog checks. The value is an iteration count, not a duration.
Use: Oracle Support diagnostics.
Default: 13 iterations unless changed by startup configuration or an earlier message.
Prerequisites: The target corbagateway instance must have a publisher enabled with -publisher.
Notes: The existing iteration counter is not reset by this message. Heartbeat timing depends on pub_timeout plus event-processing time, rather than a fixed number of seconds. Invalid nonpositive values are logged and leave the previous value unchanged. An acknowledgement precedes validation; confirm acceptance in the target log. Use -pub_interval in system.dat to retain the setting after restart. Restore the original value to undo the change.
Example:
Action any.publisher pub_interval 13
pub_timeout <milliseconds>
Change the positive delay, in milliseconds, used to reschedule periodic publisher event processing after the current iteration finishes. This is not a CORBA request timeout.
Use: Oracle Support diagnostics.
Default: 800 milliseconds unless changed by startup configuration or an earlier message.
Prerequisites: The target corbagateway instance must have a publisher enabled with -publisher.
Notes: The new value is used when the processing task next reschedules. Processing time is additional to the delay, so it is not a guaranteed update period. Invalid nonpositive values are logged and leave the previous value unchanged. An acknowledgement precedes validation and does not prove that the value was accepted. Confirm the change in the target log. Changes are process-local; use -pub_timeout in system.dat to retain a value after restart. Restore the original value to undo the change.
Example:
Action any.publisher pub_timeout 800
reload_crews
Reload crew information in the gateway.
reload_rules
Reload gateway configuration and forward the reload to Java services.
mycentricity (Service Alert)
The common service entries also apply, except where overridden below.
reload_rules
Reload configuration rules used by the Service Alert process.
Notes: Send Action to the configured service/process name, commonly service_alert; mycentricity is the executable.