- 0 minutes to read
</i> Configure Nodinite Pickup Service Logging Agent for File Folder (SMB) Integration">

Release Notes

File Folder Configuration Example

Unlock seamless integration by configuring the Nodinite Pickup Logging Service to fetch JSON Log Events directly from your Windows File Folders or SMB network shares. This guide empowers you to set up secure, scalable, and reliable log event collection for your enterprise systems.

✅ Effortless integration with Windows File Folders and SMB shares
✅ Secure and reliable log event collection
✅ Scalable setup for enterprise environments
✅ Long-term storage and compliance-ready

graph TD subgraph "Folder" roS(fal:fa-folder-open Folder) roBO(fal:fa-trash-can Backout folder) end subgraph "Nodinite instance" roPS(fal:fa-truck-pickup Pickup Service) roPS -.->|Bad/invalid messages| roBO roS --> roPS roPS --> |Long term storage|roDB(fal:fa-database Log Database) end

The diagram above illustrates how the Pickup Service interacts with file folders, processes messages, and stores them in the Nodinite Log Database. Invalid files are routed to the Backout folder for further review.

Folder

The Folders section lets you manage all file folder sources (Windows File Folders and SMB shares) for your log events.

You configure these sources in the Settings.json file, which uses JSON format. The default path is:

C:\Program Files\Nodinite\Logging Agent - Pickup Service\Settings.json

{
  ...
  "Folders": [
    {
      "Enabled": true,
      "LogApi": "https://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": null,
      "Folder": "C:\\Temp\\Nodinite.LogAgent.PickupService.Test",
      "BackoutFolder": "C:\\Temp\\BackoutFiles",
      "RemoveEmptyFiles": true,
      "Filter": "*.json",
      "IncludeChildFolders": false,
      "ExcludeChildFolders": [
        {
          "Name": "C:\\Temp\\Nodinite.LogAgent.PickupService.Test\\NotMe"
        }
      ],
      "ReplaceRules": [
        {
          "Name": "Fix Endpoint real customer id to {customerId}",
          "ReplaceName": false,
          "ReplaceUri": true,
          "Pattern": "/([0-9]{4,})$",
          "Group1Value": "{customerId}"
        }
      ]
    }
  ]
  ...                      
}

Folders is an array of Folder configurations. Each entry defines how the Log Agent connects to and processes messages from a specific folder. This setup ensures your Nodinite JSON Log Events are reliably collected and managed.

Property Description Value Example Comment
Folder The folder to look for log files For a network share, use \\server\share in the JSON configuration Use \\ to escape \ in JSON
BackoutFolder The folder for invalid log files For a network share, use \\server\theothershare Do not use a child folder if IncludeChildFolders is enabled unless you have a proper exclude configuration
RemoveEmptyFiles When true, the system removes empty files true, false Empty files should not exist
Filter A file filter to match files *.log or *.json Can use wildcards (* and ?)
IncludeChildFolders Search for JSON Log Event in subfolders true or false
ExcludeChildFolders Array of child folders to exclude if IncludeChildFolders is true Provide the full path
Enabled See the Shared Configuration section for more info
LogAPI See the Shared Configuration section for more info
UseConfigurationDatabase See the Shared Configuration section for more info
ConfigurationDatabaseConnectionString See the Shared Configuration section for more info
ReplaceRules See the shared Replace Rules section for more info

Important

You must restart the Nodinite Pickup Log Events Logging Service for configuration changes to take effect.

Next Step

Configure