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

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.

Folders

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

In the Remote Configuration GUI, navigate to the Folders tab. Here, you can add, edit, or remove folder configurations. Each configuration defines how the Nodinite Pickup Log Events Logging Service connects to and processes messages from a specific folder or SMB share.

Example of the Folders configuration tab in the Remote Configuration GUI.

Click the Add button to create a new folder configuration. Fill in the required fields, such as folder path, backout folder location, and file filter pattern. You can also configure options for processing child folders and handling empty files.

Example of a Folder configuration accordion in the Remote Configuration GUI.

Expand the accordion for each folder configuration to access advanced settings, including Replace Rules for message processing. These rules allow you to modify message content before it's stored in Nodinite, ensuring consistency and compliance with your logging standards.

Important

Ensure that the folder path (local or SMB share) is accessible from the server where the Pickup Service runs. Verify permissions and network connectivity before enabling a configuration.

General tab

The General tab provides the fundamental settings for your folder configuration within the Remote Configuration GUI.

The General tab allows you to enable/disable the configuration and provide a display name and description.

The following key fields are required:

Follow these guidelines when configuring the General tab:

• Use descriptive names that clearly indicate the folder path and purpose (e.g., "Production Logs - Order Events")
• In the Description field, note important details such as the folder's business purpose, owner contact, or any special processing notes
• The Display Name appears throughout the Nodinite interface, so keep it concise yet meaningful
• Leave the configuration disabled during initial setup if you're not ready to start collecting files

Source tab

The Source tab contains the folder path configuration and file processing settings.

The Source tab contains settings for connecting to the folder and configuring file handling options.

The following key fields must be configured for folder connectivity:

Follow these guidelines when setting up the Source tab:

• Ensure the folder path is accessible from the server running the Pickup Service (test connectivity before enabling)
• For network shares, verify SMB/CIFS permissions and ensure the service account has read access
• Use a descriptive Filter pattern that matches your log file naming convention (e.g., app-*.json)
• Always configure a Backout Folder separate from your source folder to prevent infinite reprocessing loops
• Enable Include Child Folders only if you have subfolders containing log events
• If using Include Child Folders, carefully configure Exclude Child Folders to skip temporary, cache, or backup directories
• For large folder structures, test with a single folder before scaling to multiple sources

To exclude specific child folders, click the Add Exclude Folder button and provide the full path of each folder to skip.

Example of configuring excluded child folders in the Source tab.

Destination tab

The Destination tab configures where processed log events are stored. By default, events are sent to the Nodinite Log API where they are written to the Log Database for long-term storage and analysis.

The Destination tab contains settings for connecting to the Log API and authentication options.

The following key fields are required for destination configuration:

Follow these guidelines for the Destination tab:

• Always ensure Use Log API is checked to maintain proper log event storage
• For local/development environments, use unprotected Log API URLs (e.g., http://localhost:40002/LogAPI/)
• For production environments with authentication, check the Protected checkbox and provide valid OAuth 2.0 credentials
• When using Protected authentication, ensure your Client ID, Client Secret, and Scope are correctly configured with your identity provider (IDP)
• The IDP Token Endpoint must be accessible from the Pickup Service instance
• Keep Client Secret values secure and never commit them to version control

Replace Rules

Read about Replace Rules in the shared configuration section. Replace Rules allow you to modify message content before it's stored in Nodinite, ensuring consistency and compliance with your logging standards.
The Replace Rules tab allows you to configure rules for modifying message content.

Configuration file

Note

This section applies for older versions (<7.1.x) of the Nodinite Pickup Log Events Logging Service.

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.

Important

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

Next Step

• Configure - Set up your folder integration
• Remote Configuration Guide - Learn the GUI setup process

Related Topics

• JSON Log Event - Message format specification
• Replace Rules - Transform message content
• Log Databases - Where log events are stored
• Log API - REST endpoint for log events
• Pickup Service Overview - Feature overview
• Shared Configuration - Common settings guide