JSON formatted Log Event

Unlock robust, end-to-end integration logging with Nodinite by using JSON formatted Log Events. This guide provides technical details, field definitions, and best practices to help developers and integration experts create, validate, and leverage Log Events for maximum business value.

What you'll find on this page:

✅ JSON Log Event structure and required fields
✅ How to include payloads and context properties
✅ Examples for both minimal and full Log Events
✅ Best practices for asynchronous, decoupled logging
✅ Tips for self-service analytics and repository mapping

This article provides examples and technical guidance for creating JSON formatted Log Events in your custom logging solutions.

You can send JSON formatted Log Events directly to the LogAPI or to a queue/folder for asynchronous pickup by the Pickup Log Events Service Logging Agent (recommended approach).

A Log Event consists of three main parts:

1. Event details (also called Additional field values in Nodinite)
   • Includes the critical OriginalMessageTypeName field that determines which Search Field Expressions are evaluated
   • Use the field function in the Formula plugin to extract values from event details
2. Payload (Body, 0 or more)
   • The actual message data (XML, JSON, EDI, flat file, etc.)
   • Search Field Expressions extract business values from this payload based on the Message Type
   • Use the body function in the Formula plugin to extract values from any payload
3. Context properties (Key/Value)
   • Custom key-value pairs for metadata and business data
   • Search Field Expressions can extract from these properties too
   • Use the context function in the Formula plugin to extract values from the key/value collection

How it connects: The OriginalMessageTypeName field you provide in the JSON determines which Search Field Expressions run during processing. Getting this right ensures your business data is extracted and searchable. Learn more about the processing pipeline.

Illustration: JSON Log Event structure with details, payload, and context properties in Nodinite.

1. Details

The first 7 event fields are mandatory; the rest are optional (set value to null or omit the field). Providing more details improves the Nodinite end-user experience.

LogDateTime – Provide timezone data (e.g. -01:00, +02:00, or Z). If not provided, UTC is used. Nodinite always stores LogDateTime as UTC and presents the correct time for end-users regardless of timezone.

Example: 2017-04-10T08:44:22.309+02:00 (+02:00 against UTC)

Value for the guid data type is sent without brackets or null.

Example: "064205E2-F7CF-43A6-B514-4B55536C2B67"

2. Payload

The payload is optional and can be a single message (default) or multiple payloads (e.g., email attachments).

Body

The payload/body is a base64 encoded string/file or null. Omit the "Body" field if you have no payload to log.

Bodies

If you have multiple payloads, use the Bodies element instead of the Body element.

3. Context Properties

Context properties are a collection of key/value pairs. Send whatever you need to create powerful self-service Log Views for your business.

Omit the "Context" field if you have no context properties to log.

...
"Context": {
    "CorrelationId": "064205E2-F7CF-43A6-B514-4B55536C2B67",
    "FileName": "\\server\\share\\NodiniteHappyCustomerList.txt"
}

Repository

By providing additional details in the Context, the Repository Model may be populated with that information when processed by the Logging Service. Read more in the Context Options documentation.

Full Example

Complete Log Event with all available fields set (optional and mandatory):

{
  "LogAgentValueId": 42,
  "EndPointName": "INT101: Receive Hello World Log Events",
  "EndPointUri": "C:\\temp\\in",
  "EndPointDirection": 0,
  "EndPointTypeId": 60,
  "OriginalMessageTypeName": "Hello.World.File/1.0",
  "LogDateTime": "2017-11-22T08:44:22.309Z",
  "EventDirection": "17",
  "ProcessingUser": "DOMAIN\\user",
  "SequenceNo": 0,
  "EventNumber": 0,
  "LogText": "File OK",
  "ApplicationInterchangeId": "",
  "LocalInterchangeId": null,
  "LogStatus": 0,
  "ProcessName": "My Process",
  "ProcessingMachineName": "localhost",
  "ProcessingModuleName": "INT101-HelloWorld-Application",
  "ProcessingModuleType": "FilePickup",
  "ServiceInstanceActivityId": null,
  "ProcessingTime": 80,
  "Body": "SGVsbG8gV29ybGQ=",
  "Context": {
      "CorrelationId": "064205E2-F7CF-43A6-B514-4B55536C2B67",
      "FileName": "Hello.txt"
  }
}

Minimal Example

Minimal incoming Log Event with mandatory fields (endpoint is file-based in this example):

{
  "LogAgentValueId": 42,
  "EndPointName": "INT101: Receive Hello World Log Events",
  "EndPointUri": "C:\\temp\\in",
  "EndPointDirection": 0,
  "EndPointTypeId": 60,
  "OriginalMessageTypeName": "Hello.World.File/1.0",
  "LogDateTime": "2017-11-22T08:44:22.309Z"  
}

Next Step

• Log Api – Log from code (C# and Java)
• Log Event
  • Context Options
  • Log Status Codes
  • Event Directions
• Endpoints
  • Endpoint Types
  • Endpoint Directions

Related Topics

• Message Types
• Log Agents – Events and messages
• Logging Service – Processes (indexing) the messages
• Log Views – Manage User access to events and messages across platform
• Log Databases – Keep as much data as you like
• Repository Model