Save to File Node

The Save to File node exports the current message payload to a designated local folder on the server.

General Settings

Destination Folder: the full path to a local directory (on the server) to watch for files.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the operating system of the server.

Create Parent Directories: When checked, if the target path does not exist then it will be created. Otherwise an error will be thrown.

File Name: Set the name of the file when writing out the message payload.

Note: At RUNTIME if PAS attempts to write out a file or create a directory it checks to make sure it does not contain any invalid characters (i.e. |?:* etc...). If it does all invalid characters will be replaced with an underscore "_"

Options

Write Mode: Determines whether a create new file or append to an existing file such as updating a .csv record.

Create new file: Always create a new file in the directory.
Append: If the file name already exists, add the message content to the end of the existing file. This should only be used for example when adding to simple files such as adding additional rows to a log or csv file. Complex files such as PDFs can not simply be appended in this way.

Name Collision Logic: When a prepared output file has the same name as an existing file the existing file could be overwritten. You may choose to have an unused name created by appending a numeric or alphabetic counter to the end of the file name. Be careful when using the overwrite option.

Add unique numeric suffix: appends a unique number to the end of the file that will increment by 1 for each occurrence (i.e. _1, _2, etc...)
Add unique alphabetic suffix: appends a unique number to the end of the file that will increment by 1 for each occurrence (i.e. _a, _b, etc...)
Overwrite Files: Overwrites the existing file in the original storage location that contains the exact same name
Fail: Sends the message payload to trouble handling