Contents x
    FTP Node
        Contents

        FTP Node

            Article summary

            FTP Node

            The FTP node enables simple, rapid transmission of a file across a network supporting TCP/IP. Generally, this network will be the Internet or a local network. It extracts files from an FTP folder and parses them as JSON payloads for onward processing. 

            Output payloads will contain keys from file header columns. Each row in the file will be sent as one payload.

            Adding an FTP node to your workflow

            1. First, select your desired solution and navigate to Rayven Workflow.
            2. Select ‘Inputs’ from the left-hand panel.
            3. Find the FTP node and drag it onto the canvas.
            4. Provide input to the FTP node by connecting it to another node.
            5. Double click on the FTP node to open its configuration window.

            Configuring your FTP node

            1. Give your node a name. Choose something simple that clearly explains its purpose. You must pick a name that has three or more characters.
            2. If Use Device Address is left unchecked, enter the FTP address.
            3. Enter the username and password needed to access the FTP folder.
            4. Select the File Format from the drop-down menu: 
              • JSON,
              • XML,
              • String,
              • CSV,
              • Bulk compressed XML Zipped,
              • Bulk compressed CSV,
              • JSON Array.
            5. Select the method for encoding the file from the drop-down menu: 
              • UTF-8,
              • UTF-7,
              • UTF-16 Little Endian,
              • UTF-16 Big Endian,
              • UTF-32,
              • ASCII (7 bit).
            6. Under 'Activate by Filter Device', input the relevant device filters. See Section 3.3: Device Filters for more information.
            7. It's possible to add a delay between each device triggered in the node using Interval Between Devices. The measurement is milliseconds. 
            8. You can add a delay between downloading each file under Interval Between File Downloads. The measurement is minutes.
            9. Define the start time (in UTC) for your node. Once set, your node will begin downloading files from that time at the interval specified. 
            10. Alternatively, select a time for the node to start downloading files.
            11. Specify the Download Start Time Format if you have entered a Download Start Time.
            12. Enter the time zone for the Download Start Time. 
            13. Selecting Skip if File Same as Previous will ensure that if two files exist with the same name the node will take the last file saved.


            Advanced features

            1. Checking Use Device Address will ensure the node uses the preset device IP or URL as the FTP server address. You can configure these for individual devices under device management. For more information, see Section 3.3.
            2. If 'Use Device Address is unchecked, you can 'Call FTP Address for Each Device'. When checked, your node will call the IP or URL set in the node for each device. If not checked, the node will only call the address once.
            3. Under 'Payload File Field Name', you can enter a variable name if this is how your filename is stored.
            4. 'Remove File Name Extension' will remove the extension added to the JSON when taking the value of the Data Field Name For File Name. For example, 'file.txt' would be changed to 'file'.
            5. Entering a number under Remove First N Lines will remove the first lines in the CSV until this number during the import. 
            6. Enter the Device ID Field Name for the file, i.e. 'Device_ID' or 'Device_Name'.
            7. Filter Files by entering specific text. The Rayven FTP Node supports wildcards - use a * at the start or end of a name to denote a file ending or starting with text (e.g. *filename, filename*, *filename*). 
            8. Run Server Script will change to drop-down only with projects running a dedicated script. Dedicated scripts are custom logic defining how to handle the files on the FTP. 
            9. Check Use Secure FTP if you are using the Secure File Transfer Protocol method. 

             


             


            Configuring Payload Date Settings

            It's possible to define the field that holds the timestamp of the data. To do so:

            • Enter the name of the date field as it arrives from your device.
            • Define the date format of the data. For example, dd/MM/yyyy or HH:mm:ss. If the date format is 24 hours, this needs to be indicated using capital letters (e.g. HH/mm/ss).  
            • Choose the time zone for the device that is recording the data from the drop-down menu.


             

            See Also: Adding devices
            As of Release: 17.11.2021

            What's Next