Start/notes.ini Parameters/FT_USE_MY_ATTACHMENT_WHITE_LIST

FT_USE_MY_ATTACHMENT_WHITE_LIST

Parameter: FT_USE_MY_ATTACHMENT_WHITE_LIST
Short description: Discards the default whitelist when full-text indexing attachments and forces exclusively the file extensions defined in FT_INDEX_FILTER_ATTACHMENT_TYPES.

Profile

Parameter
FT_USE_MY_ATTACHMENT_WHITE_LIST
Category
Performance / Memory
Component
Server, Client
Available since
9.0.1
Supported versions
9.0.1, 10.0, 11.0, 12.0, 14.0, 14.5, 14.5.1
GUI equivalent
Configuration document (NOTES.INI tab) or Desktop Settings Policy → Custom Settings → notes.ini
Possible values
0 = default whitelist (default), 1 = use exclusively the custom list defined in FT_INDEX_FILTER_ATTACHMENT_TYPES

Description

FT_USE_MY_ATTACHMENT_WHITE_LIST controls the whitelist behavior when full-text indexing file attachments through the Apache Tika conversion filter. When set to 1, Domino discards the shipped default whitelist (all formats supported by Tika minus the default ignore list) completely and indexes exclusively the file extensions listed in FT_INDEX_FILTER_ATTACHMENT_TYPES.
The parameter is the strict variant of whitelisting:
  • FT_USE_ATTACHMENT_WHITE_LIST=1 additionally activates the default whitelist (extendable via FT_INDEX_FILTER_ATTACHMENT_TYPES).
  • FT_USE_MY_ATTACHMENT_WHITE_LIST=1 replaces the default whitelist and works exclusively with the admin-defined list.
Typical use: strictly regulated environments (banks, government agencies, GxP, public sector) where it must be precisely defined which attachment types pass through the Tika conversion filter and into the full-text index.

Example configuration

FT_USE_MY_ATTACHMENT_WHITE_LIST=1
FT_INDEX_FILTER_ATTACHMENT_TYPES=*.pdf,*.docx,*.xlsx,*.pptx,*.txt
Runtime variant (server console):
set config FT_USE_MY_ATTACHMENT_WHITE_LIST=1

Notes & pitfalls

  • Caution, pitfall (HCL-documented): if FT_USE_MY_ATTACHMENT_WHITE_LIST=1 is set without defining FT_INDEX_FILTER_ATTACHMENT_TYPES, no attachments at all will be indexed — server-wide across all databases.
  • Only effective in combination with the Apache Tika conversion filter; databases whose FT index is built without the conversion filter ("brute force text-stripping") are not controlled by this whitelist.
  • Whitelist changes only take effect after a rebuild of the FT index of the affected databases (load updall -f).
  • Easiest deployment across many servers via configuration document → NOTES.INI tab; on Notes clients via Desktop Settings Policy (Custom Settings → notes.ini).

Sources (HCL Product Documentation)