Skip to content
Art2link ESB HomeDocumentationBlogContact
Updated July 9, 2026
Adapters/File Share adapter
Adapter

File Share adapter

Bidirectional integration with SMB / Azure Files. Listener picks up files matching a glob; Caller writes files with templated paths and atomic rename.

ADAPTER · RECEIVE · SEND File Share SMB / Azure Files, pick up files or drop files on a network share DIRECTION ↓ ↑ Receive & Send MODES One-way · Two-way AUTHENTICATION File Share Authentication PORT Receive or Send

The File Share adapter mounts an SMB share (a UNC path on a Windows file server, or an Azure Files share) and works with files on it. The same adapter binds to either a receive port (pick up) or a send port (drop off); the underlying share is referenced by an Authentication that owns the credentials.

The adapter speaks SMB only. That is the single transport it implements today, and it covers both targets you would reach with this adapter: UNC paths on Windows file servers and Azure Files shares, which are themselves SMB endpoints. There is no NFS, FTP, or WebDAV support at present.

Roadmap. Additional protocols may be added in a future release. None beyond SMB is available at this time, so plan integrations around an SMB-reachable share.

On a receive port, the adapter watches a directory on the share for files matching a configurable glob pattern. The watch is poll-based by default with a configurable interval; on platforms that support SMB change notifications, the runtime can switch to event-driven mode.

WATCHED DIRECTORY \\\\share\\inbound\\ glob: *.xml order-7831.xml order-7832.xml poll or SMB notify read FILE LISTENER body => message filename promoted as property publish Bus post-publish: move / delete the file

On successful publish, the file is removed from the watched directory according to the configured Post-Publish Action: Delete, Move to subdirectory (e.g. ./processed/), or Rename in place (e.g. add a .done suffix). A failure leaves the file alone for the next poll.

On a send port, the adapter writes the message body to a file on the share. Path and filename templating works the same way as on other file-shaped Callers; atomic write (temp filename + rename) is on by default so downstream watchers never see a half-written file.

The File Share adapter pairs with a File Share Authentication. The Authentication carries the connection target (the UNC root for an SMB file server, or the Azure Files endpoint) plus one credential, and the port never stores credentials itself. Two methods are supported.

NTLM. A username and password validated over SMB against the file server or its domain. This is the method for on-premises Windows shares and domain-joined file servers. The account you supply needs read and write on the target directory, and on the Listener side, permission to move, rename, or delete files so the Post-Publish Action can run. Give the credential in DOMAIN\\user (or user@domain) form.

Azure Storage Account Key. The access key of the storage account that backs an Azure Files share. The runtime mounts the share over SMB using the storage account name and its key, so no domain or user account is involved. Use this when the share is an Azure Files endpoint rather than a classic Windows file server. Rotate the key on the Authentication when you cycle it in Azure; either the primary or secondary key works.

Placeholder field set, verify against the running product.

Path, required; relative or absolute path under the share root. Templatable on Caller; static on Listener.
File Pattern, required on Listener; glob (e.g. *.xml, order-*.csv).
Filename, required on Caller; templatable.
Poll Interval, required on Listener when SMB notify is unavailable; how often the directory is scanned.
Use SMB Notify, optional on Listener; defaults to on where supported.
Post-Publish Action, required on Listener; Delete, Move, or Rename.
Move Target / Rename Suffix, required when Post-Publish Action is Move or Rename.
Overwrite Policy, required on Caller; Fail if exists, Overwrite, or Append suffix.
Atomic Write, optional toggle on Caller; default on. Writes .tmp and renames.
Content Encoding, optional; UTF-8 / ASCII / Binary.
Authentication, required; picker filtered to File Share Authentication objects in the same Application.

That is the File Share adapter

SMB / Azure Files. Pick up via glob, drop off with templated paths and atomic write. Back to Adapters.