Start/notes.ini Parameters/SwapPath

SwapPath

Parameter: SwapPath
Short description: Specifies the directory in which Notes/Domino stores temporary swap files (.tmp / VBS files). Used on systems where the system temp directory is unsuitable (separate volume for performance, anti-virus exclusion paths, separation between user and server temp areas). Default: system temp directory (e.g. %TEMP% on Windows, /tmp on Linux/AIX).

Profile

Parameter
SwapPath
Component
Server, Client, Designer, Admin Client
Category
Performance / Storage
Available since
at least Notes/Domino 7 (continuously through 14.5.1)
Default
System temp directory of the OS (%TEMP% on Windows, /tmp on Linux/AIX, /usr/tmp on Solaris)
Value format
Absolute path to an existing, writable directory

Description

Notes and Domino create various temporary work files during normal operation:
  • .vbs files (VBuf swap, see HCL Notes and Domino Wiki) for buffer overflow when transactional logging or large mail handling fills the configured memory.
  • .tmp files for view rebuilds, agent execution, MIME conversions, mail rules, full-text indexing.
  • Temporary attachment files when opening mails with embedded objects.
Without a SwapPath setting, Notes/Domino stores these files in the operating system's standard temp directory:
  • Windows server: %LOCALAPPDATA%\Temp (Windows service accounts) or %TEMP%
  • Windows client: %USERPROFILE%\AppData\Local\Temp
  • Linux/AIX: /tmp
  • Solaris: /usr/tmp
With SwapPath=<directory>, this storage location is moved to a custom path. Typical reasons:
  • Performance: Temp directory on a fast SSD volume separated from data and program directory.
  • Quota / disk space: System temp directory has no space; relocate to a volume with sufficient free space.
  • Anti-virus exclusions: Many AV products scan the system %TEMP% aggressively. With your own SwapPath, an explicit exclusion path can be defined that only contains Notes/Domino temporary files.
  • Forensics / cleanup: Separation between OS-level temporary files and Notes-specific files, e.g. for diagnostic snapshots.
  • Server hardening: Server temp directory may not be writable by other applications.

Examples

Windows server (Daniel Nashed deployment best practice):
SwapPath=C:\Domino\temp
Linux server with separate volume:
SwapPath=/var/notesdata/temp
Windows Notes client:
SwapPath=C:\Notes\Data\temp
Domino server in container/AKS (per HCL Wiki article):
SwapPath=/local/notesdata/temp

Notes

  • Directory must exist beforehand – Notes/Domino does not create the directory; if missing, the value is silently ignored and the system temp directory is used.
  • Permissions – The directory must be writable by the Notes user. On Windows server: write permission for the service user; on Linux: read/write/execute for the notes user.
  • No NFS / network drive – The HCL Notes and Domino Wiki advises against placing SwapPath on a network drive, since file locking and performance there are less reliable than on local disks.
  • Activation – Effective only after restart of the affected program (Notes Client, Admin Client, Designer, Domino Server). At runtime, the path is not reread.
  • Must not point to the data directory – The temp area should be separate from the Domino data directory so that backups, anti-virus, and full-text scans can deal with it appropriately.
  • Cleanup – Notes/Domino does not automatically delete .vbs and .tmp files. After crashes or unclean shutdowns, leftovers may remain that should be removed periodically.
  • Diagnostic – The Tell HTTP Show Path (server) or the View File Locations dialog (client) shows the active swap path.

Sources (HCL Product Documentation)

  • HCL Notes and Domino Wiki – "SwapPath" (Notes.inis T-U-V-W-X-Y-Z) with the entry: "For an explanation of NOTES.INI variables and how they are set, refer to the topic Setting NOTES.INI variables in the IBM® Lotus Domino® Administrator's online Help.": ds_infolib.hcltechsw.com/ldd/dominowiki.nsf/dx/SwapPath