File Writer
The File Writer North Connector writes files and data to a specified output folder on disk. This connector is useful for local storage, data processing pipelines, or integration with file-based systems.
Specific Settings
| Setting | Description | Example Value |
|---|---|---|
| Output folder | Directory where files will be stored. Relative paths are resolved based on the Data folder (see About section). | /data/oibus-out |
Network Share Authentication (Windows only)
To write to a Windows network share, set Output folder to a UNC path (\\server\share\...) and provide credentials
for it:
| Setting | Description | Example Value |
|---|---|---|
| SMB username | Username used to authenticate against the network share. | svc_oibus |
| SMB password | Password for the SMB username. | •••••••• |
| SMB domain | Domain for the SMB username (optional, e.g. for Active Directory). | CORP |
These fields only appear when OIBus runs on Windows. OIBus authenticates an SMB session against the server (net use)
before writing, and removes it when the connector disconnects. This does not go through the Windows Credential Manager,
so it also works when OIBus runs as a Windows service, where the interactive-session-only Credential Manager is
unreliable even under an account that otherwise has access to the share.
File Naming Options
| Setting | Description | Example Value |
|---|---|---|
| Prefix | Text to prepend to the filename. Supports internal variables like @ConnectorName. | @ConnectorName- |
| Suffix | Text to append to the filename (before the extension). Supports internal variables like @CurrentDate. | -@CurrentDate |
Use internal variables to create dynamic filenames:
@ConnectorName: Inserts the name of the connector.@CurrentDate: Inserts the current timestamp inyyyy_MM_dd_HH_mm_ss_SSSformat.
Example:
With prefix @ConnectorName- and suffix -@CurrentDate, a file named example.file becomes:
<ConnectorName>-example-<CurrentDate>.file
Best Practices
- Use absolute paths for the output folder to avoid ambiguity.
- Create a dedicated directory for each connector to keep files organized.
- Combine with transformers to:
- Convert data to other formats (e.g., JSON, CSV).
- Filter or enrich data before writing.
- Monitor disk space usage, especially when processing large volumes of data.