Skip to content
Art2link ESB v2.02 LTS HomeDocumentationBlogContact
Core concepts/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 Beta DIRECTION ↓ ↑ Receive & Send MODES One-way · Two-way AUTHENTICATION File Share Authentication PORT Receive or Send Beta

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.

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 UNC root or Azure Files endpoint, plus a credential. Three shapes are supported: Username + password, Storage account key (Azure Files), and Managed Identity (Azure Files with the runtime's Entra identity granted RBAC on the storage account).

Placeholder field set — verify against the running product. Beta details may change before GA.

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. Beta until GA. Back to Adapters.