Keep directory configuration

A keep directory stores source-event files after a map successfully processes them. A keep directory is always available when cooperative file listening is enabled in the config.yaml file. When cooperative file listening is not enabled, a keep directory is available if you explicitly configure its directory path in the Launcher settings. The OnSuccess setting of the input card must be Keep or KeepOnContent to save source-event files in a keep directory.

Configure the keep directory path in the Input(s) > card_name > SourceEvent > KeepDirectory field of the Launcher settings. You can specify the keep directory as an absolute file path, a relative file path, or an alias that is defined in the Resource Registry. If the fully qualified path to the Keep directory exceeds 260 bytes, the Launcher does not start.

If you enable cooperative file listening but do not specify a keep directory in the Launcher settings, the File adapter saves the source-event files in the default WTX_KEEPDOCS subdirectory of the trigger directory.

The following table illustrates how the keep directory paths resolve, relative to the C:\myInput trigger directory.

Table 1. Resolution of keep subdirectory paths in C:\myInput
Specified path in ErrorDirectory field Fully qualified path
backup C:\myInput\backup
C:\backup C:\backup
..\myBackup C:\myInput\..\myBackup
No directory specified C:\myInput\WTX_KEEPDOCS

To use a keep directory when cooperative file listening is disabled, specify a keep directory in the Launcher settings and set OnSuccess to Keep or KeepOnContent. When the setting is Keep, the File adapter saves the source-event file when the map succeeds. When the setting is KeepOnContent, the File adapter saves the source-event file when the map succeeds and the source-event file is not empty.