Introduction

(Since 2024.01)

Log displays can be configured in the LogDisplays.xml. The LogDisplays.xml can contain multiple displays. A log display can contain both system logging as well as manual logging.

SystemLog


Data Selection 
		<systemLog enabled="true">
			<logLevel>INFO</logLevel>
		</systemLog>


ManualLog

Manual logging can be added to a logDisplay. In this way users of the Web OC can drop messages/notes for all other to see. These messages can be edited and deleted (only by user that send them), acknowledged and disseminated (if configured). 

The manual log functionality is based on the NoteGroup as configured in the ForecasterNotesDisplay.xml, see documentation or the configuration example below. 


ManualLog 
		<manualLog enabled="true">
			<noteGroupId>operator_log</noteGroupId>
			<createPermission>operator</createPermission>
		</manualLog>
Example of NoteGroup Configuration 
<forecasterNotesDisplay>
	<title>Forecaster Notes</title>
	<msgTemplate id="Default">
		<message/>
	</msgTemplate>
	<eventCode id="event.operator.log"/>
	<multipleForecasterNotesMaker>
		<noteGroup name="Operator Log" id="operator_log">
			<note>
				<eventCodeId>event.operator.log</eventCodeId>
				<messageTemplateId>default</messageTemplateId>
				<maxNumberOfLines>10</maxNumberOfLines>
				<maxNumberOfCharactersInLine>1000</maxNumberOfCharactersInLine>
			</note>
			<viewPermission>operator</viewPermission>
			<createPermission>operator</createPermission>
		</noteGroup>
	</multipleForecasterNotesMaker>
</forecasterNotesDisplay>


Log Dissemination

The log messages (both system as manual) can be disseminated through a SystemAlerter tasks. The eventCode that is configured for a dissemination action should be coupled through event - action configuration with an MCSystemAlerter task. Multiple disseminationActions can be configured (for example to send Email, SMS or Signal message.) 



Log Dissemination Example 
<logDissemination enabled="true">
	<disseminationActions>
		<action id="sms">
			<description>Send this log message as SMS.</description>
			<iconId>mdi-message-alert</iconId>
			<eventCode>sent.sms</eventCode>
			<manualLog>true</manualLog>
			<systemLog>true</systemLog>
			<permission>dissemination</permission>
		</action>
	</disseminationActions>
</logDissemination>




  • No labels

Disclaimer