FileStorageProvider Section
The "FileStorageProvider" section in the configuration JSON specifies settings for the File System Storage Provider. This provider allows the Event Stream Producer to store blob and slob properties with sizes above a configured threshold value in the local file system. (For details, see "SizeThresholds", later in this topic.)
{ "FileStorageProvider": { "RootDirectory": "<path‑to‑root‑directory>" } }
The RootDirectory parameter is required. It specifies the root directory where the File System Storage Provider will store blob or slob data, and it has a String type; for example:
"D:\\event-egress\\LobData"
For file paths and local configurations, determine values based on your system set up and requirements.
FileStorageProvider Usage
The RootDirectory parameter should point to a directory where the application has read and write permissions. The File System Storage Provider will create subdirectories within this root directory to organize stored data.
Directory Structure
The FileStorageProvider creates a hierarchical structure within the RootDirectory, as follows.
RootDirectory\ ├── YYYY-MM\ │ ├── TransactionID1\ │ │ ├── [EventID1]__PropertyName1.blob │ │ └── [EventID1]__PropertyName2.slob │ └── TransactionID2\ │ ├── [EventID2]__PropertyName1.blob │ └── [EventID2]__PropertyName2.slob └── YYYY-MM\ └── ...
In this structure:
-
YYYY-MM is the year and month of the event timestamp
-
TransactionID is the unique identifier for the transaction
-
EventID is the unique identifier for the event
-
PropertyName is the name of the property associated with the Line of Business (LOB) data
-
The .blob extension is used for binary large object (blob) data
-
The .slob extension is used for string large object (slob) data
Example Configuration
In the following configuration example, the File System Storage Provider will use "D:\event-egress\LobData" as the root directory for storing large object (lob) data.
{ "FileStorageProvider":{ "RootDirectory": "D:\\event-egress\\LobData" } }
Notes
When using the FileStorageProvider section:
-
Ensure that the specified RootDirectory exists, and that the producer has appropriate permissions to create subdirectories and write to this directory.
-
The File System Storage Provider will automatically create the necessary subdirectories within the RootDirectory and will attempt to create RootDirectory if it does not exist.
-
Consider disk space requirements when choosing the RootDirectory location, especially for high‑volume systems.
-
For production environments, it is recommended that you use a dedicated disk or partition for the RootDirectory, to prevent interference with other system operations.