- 0 minutes to read

Manage Message Types

Message Types tie each message format to the Search Field Expressions that extract business values from it. When you add or change Search Fields, or clean up formats that are no longer logged, this page shows how to keep the Message Type list correct and how to apply new Search Fields to messages that are already logged.

  • ✅ Add and edit Message Types
  • ✅ Edit retention, re-index, tag, and delete many Message Types at once with With Selected
  • ✅ Re-index historical data after you add or change Search Field Expressions

On this page, an administrator, or a user whose Role may modify Message Types, learns to manage the Message Type list. Business users who only look up Message Types start with the Message Types Overview instead.

Understanding delete and restore

Delete in Nodinite is a soft delete: the Message Type is flagged as deleted and hidden from the list, but it stays in the database, so you can restore it. See Show deleted records for how this works across Nodinite.

flowchart LR Active["fa:fa-file Message Type"] Deleted["fa:fa-trash-can Deleted
soft delete"] Gone["fa:fa-trash-xmark Permanently deleted"] Active -->|"Delete"| Deleted Deleted -->|"Restore"| Active Deleted -->|"Permanently Delete
Administrator only"| Gone style Active fill:#93d16d style Deleted fill:#FFD525 style Gone fill:#c33d34,color:#fff

A Message Type's life after Delete. Green: active. Yellow: deleted, and anyone who may modify Message Types can restore it. Red: permanently deleted, which only an Administrator can do and nobody can undo. See Show deleted records.

Who can do what

Action Who can do it Can you undo it?
Add a Message Type Create on Message Types in the Role ✅ Yes, delete it
Edit a Message Type Modify on Message Types (Permission Set for the Repository Model) ⚠️ No version history; change it back by hand
Delete, one or many Modify on Message Types ✅ Yes, restore it
Restore, one or many Modify on Message Types ✅ Yes, delete it again
Permanently Delete, one or many The built-in Administrator Role only, on deleted Message Types ❌ No

Add, edit, delete, and restore also work from the Repository menu for users whose Role allows it; the Administration menu needs the built-in Administrator Role.

Every right is set per Role on its Repository Permissions tab. Users first need the global Access right on Repository (Repository Access), then Access on the Message Types row; Create and Modify sit on the Message Types Permissions for all row. A Deny in any of the user's Roles always wins.

Find the Message Types list

Open Administration > Repo Management > Message Types, or Repository > Message Types. From Administration, clicking a Message Type opens it for editing; from Repository, it opens it for viewing. Type in the filter box to narrow a long list, filter by Component Type or by Tag (the Tags column shows each Message Type's Tags), and check Include deleted to list deleted Message Types too. The list also shows the encoding, the Days to keep for Events, Context, and Bodies, the body sizes, and the first and last logged event.

Message Types list filtered on contoso.com, with the Component Type and Tag filters, Include deleted, the Encoding, Days to keep, size, and event columns, and With Selected (7.12)
Use the filters and Include deleted to find the Message Type you want to manage.

Add a Message Type

Click Add Message Type to open the editor. See Add or manage Message Type for every field, including encoding and how long Nodinite keeps the messages.
Add Message Type button (7.12)
The Add Message Type button opens the Message Type editor.

Add the Message Type https://contoso.com/schemas/stock/1.0#StockLevel with a description and the Tag Contoso: Critical, animated walkthrough (7.12)
Animated walkthrough: a new Message Type with its Tag, ready in the list.

  1. Click Add Message Type.
  2. Fill in Name the way the schema names it, namespace and root: https://contoso.com/schemas/stock/1.0#StockLevel.
  3. Add a Description, and the Tag Contoso: Critical.
  4. Click Save and close. The new Message Type is in the list, with its Tag.

Tip

You can also manage Message Types from DevOps pipelines with the Nodinite Web API.

Edit a Message Type

Click the Message Type's Name in the Administration list, or choose Edit from its Action menu. See Add or manage Message Type.

The Action menu

Click Action on a row to open the Action menu for that Message Type:

  • The Integrations, Systems, Services, Contracts, and Endpoints submenus jump to what uses the Message Type.
  • View opens the Message Type read-only, and Edit opens it in the editor.
  • Edit Retention changes how long Nodinite keeps its messages.
  • Reindex applies the Message Type's Search Field Expressions to messages that are already logged. Only Administrators see it, on active Message Types.
  • Show in Mapify and Show in Mermaid draw the Message Type and what uses it in Mapify or as a Mermaid diagram.
  • Delete on an active Message Type; Restore on a deleted one, and Permanently Delete for Administrators.

Message Types have no Duplicate.

Action menu of an active Contoso Message Type with the related-entity submenus, View, Edit, Edit Retention, Reindex, Show in Mapify, Show in Mermaid, and Delete (7.12)
The Action menu of an active Message Type. The items you see depend on your Role and on whether the Message Type is deleted.

Delete a Message Type

Choose Delete from the Message Type's Action menu and confirm with Yes. The Message Type disappears from the list, and you can restore it later.

Delete the Message Type https://contoso.com/schemas/stock/1.0#StockLevel and restore it, animated walkthrough (7.12)
Animated walkthrough: a delete you can take back, from the Action menu.

  1. Find https://contoso.com/schemas/stock/1.0#StockLevel in the list.
  2. Open its Action menu, choose Delete, and confirm with Yes. The Message Type is gone from the list.
  3. Check Include deleted. The Message Type is back in the list, marked Deleted.
  4. Open its Action menu, choose Restore, and confirm with Yes.
  5. Uncheck Include deleted. The Message Type is in the list again.

Restore deleted Message Types

  1. Check Include deleted to list deleted Message Types.
  2. Open the Action menu of the deleted Message Type, choose Restore, and confirm with Yes.

Permanently Delete Message Types

New 7.12

Important

Permanently Delete needs the built-in Administrator Role, and it can't be undone.

Permanently delete a deleted Message Type that has log events, walking the Impact and Views tabs, animated walkthrough (7.12)
Animated walkthrough: the counts before it is too late, and the Message Type is gone even with Include deleted on.

Permanently Delete is offered only for Message Types that are already deleted. Check Include deleted, tick the deleted Message Types, and choose With Selected > Permanently Delete (n), or choose Permanently Delete from a deleted Message Type's Action menu. Both open the same review dialog as the other Repository lists:

  1. On the Impact tab, check what the purge removes, counted on the live data: Log and Monitor View filter rows, Log Points, Metrics and their Metric Values, and Transport Contract links. Contracts that go with an emptied Transport Contract are listed by name.
    Permanently Delete Message Types review dialog for one deleted Message Type, with the This cannot be undone box, the Impact tab listing the Contract removed with its emptied Transport Contract, and the counts (7.12)
    The Impact tab shows what goes with the Message Type before anything happens.
  2. On the Views tab, check the Log Views that lose a filter. One that filtered only on these Message Types is no longer restricted by them and shows more events.
    Views tab of the review dialog listing a Log View that loses its Message Types filter and is marked Shows more events (7.12)
    Adjust the scope of a Log View marked Shows more events before or after the purge.
  3. Tick I understand that this cannot be undone, then click Permanently Delete, or Cancel to keep the Message Types.
  4. The result names what was purged, and the details go to the Log Audits.
    Result message 1 Message Type permanently deleted, gone with everything listed in the review, details written to the Log Audits (7.12)
    The result confirms the purge.
  5. Click Close. The Message Type is gone, even with Include deleted on.

The default Message Type is never permanently deleted; the dialog lists it as refused. There's no BPMs tab, because no BPM uses a Message Type.

What is removed, and what is kept

Removed together with each Message Type:

Changed: Endpoints that used it as their default Message Type keep running without one.

Kept: the Log Events already logged; they stay until the retention for events without a Message Type removes them.

Act on many Message Types at once

New 7.12

Tick the checkbox on each Message Type, or the checkbox next to With Selected to tick every Message Type on this page of the list (unticking it clears the whole selection, on every page), then open With Selected. The number in each item shows how many of the selected Message Types it applies to.

Give two Contoso Message Types the Tag Contoso: Finance with With Selected and Manage Tags, animated walkthrough (7.12)
Animated walkthrough: one Tag on two Message Types in one go.

  1. Filter the list on contoso.com/schemas/ and tick the Order and Invoice schemas.
  2. Click With Selected and choose Manage Tags.
  3. In Add a Tag to all, pick Contoso: Finance, then click Save and close. The Tags column shows it on both.
  • Delete (n) deletes the selected Message Types. You can restore them later.
  • Restore (n) and Permanently Delete (n) count the deleted Message Types in the selection (check Include deleted first), next to Delete (n) for the active ones. Permanently Delete needs the built-in Administrator Role, and it can't be undone.
  • Edit Retention changes how long Nodinite keeps the messages of every selected Message Type, the Days to keep columns in the list; see Add or manage Message Type.
  • Reindex re-indexes every selected Message Type; the considerations below apply to each of them. It needs the built-in Administrator Role.

As in every list, Manage Tags comes first and the list's own items, Edit Retention and Reindex, come last.

With Selected menu on the Message Types list with Manage Tags, Delete (2), Edit Retention, and Reindex for two selected Message Types (7.12)
Two Message Types ticked. The list's Days to keep columns show the retention for Events, Context, and Bodies.

Reindex a Message Type

Re-indexing applies Search Field Expressions to historical messages and extracts their values retroactively. You need it when you add new Search Fields or change existing expressions. Re-indexing needs the built-in Administrator Role, from the row, the edit page, or With Selected.

When to re-index

  • You added a new Search Field and want to search historical data
  • You changed a Search Field Expression and need to recalculate existing values
  • You prepare for a compliance audit that needs retroactive search

Warning

Most Search Field plugins load the entire message into RAM. Use this function only for small messages, or be prepared for high memory usage.

Start a re-index

Reindex the Message Type O2C.Order.Received/1.0 from its Action menu, animated walkthrough (7.12)
Animated walkthrough: the result message says how many events will be reprocessed.

  1. Click Action on the Message Type's row.
  2. Choose Reindex.
    Action menu of a Contoso Message Type with Reindex highlighted (7.12)
    The Reindex item starts a re-index for this Message Type only.
  3. Reindex Message Types lists the selected Message Types with their Days to keep; tick or untick them. There is no period to set: the re-index covers the events still within retention. Click Reindex to confirm.
    Reindex Message Types dialog with the resource warning, one ticked Contoso Message Type with its Days to keep, and the Reindex button (7.12)
    Click Reindex to start the re-index for the ticked Message Types.
  4. The message Reindex operation started gives the number of events to reprocess. The re-index then runs in the background.

Important considerations

  • Resource-intensive: Re-indexing can be very CPU- and memory-intensive and may slow the processing of new events.
  • Batch your changes: Re-index only once, after you finish editing several Search Field Expressions.
  • Cannot abort: Once started, the re-index runs to completion. There is no way to stop it.
  • Processing order: Nodinite processes messages by ascending date and time (oldest first).
  • Message Type-specific: Only the Search Field Expressions assigned to this Message Type are evaluated again.

Tip

For large Message Types (millions of messages), schedule the re-index during low-traffic periods and watch the performance of the Logging Service.

How a re-index runs explains batching, where to find the result, and how to follow progress.

Copy API URL

Click Copy API URL to see the underlying REST call to the Web API and copy the query string. Use it in custom Reports, automation scripts, or DevOps pipelines.

Frequently asked questions / Troubleshooting

I deleted a Message Type by mistake. Can I get it back?

Yes. Check Include deleted, then restore it.

My new Search Field finds nothing in older messages

New and changed Search Field Expressions apply only to messages logged after you save them. Re-index the Message Types that need the values in older messages.

Next Steps

Add or manage Message Type
Add or manage Search Field
Show deleted records
Manage the Repository

Message Types - What a Message Type is
Message Types Overview - Find and view Message Types
Permission Set for the Repository Model
Search Fields
Log Views
What is a Tag?