Node-RED package to perform common file system related tasks

This files and folders package contains nodes to perform common file system related tasks like triggering a flow when a new file arrives or list the files in a specific folder.

Features

• The folder capture node watches a directory for file creation and update events.
• The folder listing node lists the files present in a user specified folder.
• The file operations node can copy, move and delete files.
• The folder operations node allows user specified folders to be created or removed.

Installation

Use the Manage Palette option from the Node-RED-menu, or run the following command in your Node-RED user directory - typically ~/.node-red

npm install @objectif-lune/node-red-contrib-files-and-folders

Usage

Use the folder capture node as the trigger (input) for file based flows. The node returns information about the file path, basename, size and file extension of any matched file and triggers the flow one file at a time. The node does NOT read the actual file data, for this you should utilize the read file node or pass the path to OL Connect nodes like data mapping, document mapping, file store upload for further processing on the OL Connect Server. However to its benefit the node waits for write operations to finish before triggering the flow.

The folder listing node allows for the filtering of file names using a regular expression or star-based file masks such as *.xml. It also, if requested, will list files in sub folders.

With the file operations node it is possible to define both source and target files. The node has the added advantage of knowing when a file is being used by another process and will terminate the operation if this is the case.

Take CARE when using the folder operations node. It permanently deletes content. Time has been taken to ensure that in case of a user input error the node protects as many essential system and user folders as is humanly possible. This is for both Windows and Linux OS.

A word of caution

This node is part of the OL Connect Automate stack. It is intended for use by current users of OL Connect who want to experiment with automating server operations through Node-RED. The OL Connect Automate stack is a technology preview.

Support

At this early stage, the OL Connect Automate stack is not supported through the OL Care program. Feel free to visit the OL Connect Automate stack forum to post questions, comments and suggestions.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.