- 4 minutes to read

Add or manage Message Type

This guide teaches how to manage Nodinite Message Types.

Add a new Message Type, Edit or Delete an existing one from the list in the overview.

A Message Type can have the following relationships:

In addition, the Search Field Expressions from user-defined Search Fields are present in the display in read-only mode.

Manage Message Type Example managing the Message Type.

Basic data fields

  • A unique Name is required to create the Message Type.
  • Description: A user-friendly optional description.
  • Web Site: You can provide an optional quick link for end-users working with and viewing the Message Type. This link usually points to a WIKI/Sharepoint site with additional documentation.

Removal of old messages based on Message Type (Days to keep)

The Logging Service periodically removes old Events, Context, and Bodies.

  • The retention period is user-defined per Message Type.
  • To qualify for removal, the logged events must be in the processed state.

Manage Retention
Manage retention for Message Types.

Days to keep Events

The number of days to keep events of a given Messages Type. If you set the value to zero (0), the events are removed on the next cleanup run.

The 'Never remove Events' option means that data in Nodinite stays forever.

When Log Events are removed, the comments are also lost.

Days to keep Context

The number of days to keep the Context data for Log Events of a given Messages Type. If you set the value to zero (0), the events are removed on the next cleanup run.
The 'Never remove Context' option means that data in Nodinite stays forever.

This value can not be higher than the 'Days to keep Events'.

Days to keep Bodies

The number of days to keep the Bodies for events of a given Messages Type. If you set the value to zero (0), the bodies are removed on the next cleanup run.
The 'Never remove Bodies' option means that data in Nodinite stays forever.

This value can not be higher than the 'Days to keep Events'.

Visualization of the days to keep for events

graph TD subgraph "fal:fa-envelope-open-text Days to keep Events" baseInformation(Information about<br>the Event itself) searchFieldValues(Search Field Values) comments(Comments) subgraph "far:fa-key Days to keep Context" conntextValues(&nbsp &nbsp &nbsp Context &nbsp &nbsp &nbsp) end subgraph "fal:fa-file-code Days to keep Bodies" Bodies(&nbsp &nbsp &nbsp Body &nbsp &nbsp &nbsp) end end

The default values for a new Message Type are based on a System Parameter from the SystemParameters table in the configuration database:

  • DaysToKeepMessageEventsDefault: The default number of days to keep events. Deleting an event will also delete its data/body message. This value will be assigned to new message types as its default. The Logging Service must be restarted if this value is changed.

  • DaysToKeepMessageContextDefault: New 5.3 The default number of days to keep context for an event. This value will be assigned to new message types as its default. The Logging Service must be restarted if this value is changed.

  • DaysToKeepMessageDataDefault: The default number of days to keep data in an event. This value will be assigned to new message types as its default. The Logging Service must be restarted if this value is changed.

If too many Messages or Events are logged, searching for data may be significantly slower than with less data.

TIP: Tune these settings according for your business needs. Do not save more data than needed.

Custom Fields

As part of the Repository Model model, You can also add Custom Field values to provide additional documentation about your Message Type.
Custom Fields Example with an assigned value from a Custom Field.

Services

Services associated with the Message Type are listed.

You can navigate further to the associated Service by clicking the provided link.

Search Field Expressions

Search Field Expressions associated with the Message Type are listed. You can Add or manage Search Field in the Log Administration.

Search Field
Example of Search Fields in use with the Message Type.

You can navigate to the associated Search Fields by clicking the provided link.

Learn how to manage Search Field Expressions in the 'Configure Search Field Expression' user guide.

Custom Metadata

As part of the Repository Model model, You can also add Custom Metadata to provide well-structured additional documentation about the Message Type.

Statistics

Use the perpetual Statistics to analyze traffic patterns for the selected Message Type. Also, the statistics show a list of tracked Endpoints on the Message Type chosen. Message Type Statistics
Example of the recorded traffic pattern and its known Endpoints on the selected Message Type.

Next Step

Add or manage Search Field
Add or manage Service
Add or manage System

Message Types
Repository Model
Search Fields
Services
System
Endpoints
Log Views