FTPS Node

Section: General

This section contains basic configuration elements required for any FTPS node implementation.

Field

Requirement

Comments

Node Name

Mandatory

Enter a name for this node.

This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.

FTP Address

Mandatory (if Use Device Address unchecked)

Enter the FTP address URL.

FTP User Name

Mandatory

The username to access the FTP folder.

FTP Password

Mandatory

The password to access the FTP folder.

File Format

Mandatory

Select the data structure of the file from a drop-down list:

• JSON (default)
• XML
• String
• CSV
• Bulk compressed XML Zipped
• Bulk compressed CSV
• JSON Array

File Encoding

Mandatory

Select the encoding method for a drop-down list:

• UTF-8 (default)
• UTF-7
• UTF-16 Little Endian
• UTF-16 Big Endian
• UTF-32
• ASCII (7 bit)

Interval Between Devices

Optional

Adds a delay in milliseconds between each device triggered in this node.

Interval Between File Downloads (minutes)

Optional

Sets the delay in minutes between downloading each file.

Download Start Date & Time

Optional

Define the start time for the node (according to selected start time zone). Once set, the node will start to download files from that time at the predefined interval between file downloads.

Download Start Time Zone

Optional

The time zone used in the Download Start Time field. If left blank, UTC time will be used.

Skip if File Same as Previous

Optional

Checkbox option.

Select this to prevent the platform from downloading the same file more than once if there are no new files added to the FTP folder.

Section: Advanced Features

This section contains Advanced configuration elements required for any FTPS node implementation.

Field

Requirement

Comments

Use Device Address

Optional

If checked, the node will use the device IP or URL that has been set for each individual device (in the device management) as the FTP server address.

Call FTP Address for Each Device

Optional

(This is only available when 'Use Device Address' is not checked) 

When checked, the node will call the IP or URL that has been set in the node for each device, if not checked, the node will only call the address once.

Payload File Field Name

Optional

Enter the variable name if the filename is stored as a variable from the flow.

Remove File Name Extension

Optional

Removes the file extension that is added to the JSON as the value of the Data Field Name for the File Name (e.g. 'file.txt' will be changed to 'file').

Remove First N Lines

Optional

Enter an integer value.

This value indicates the number of rows that will be removed from the file during the import process.

Payload Device ID Field Name

Optional

Provide the device ID attribute name in the file that corresponds to the device ID configured in device management.

Filter File

Optional

Will only look at files matching the provided text. 

Node supports use of wildcard (*) at start or end of name to denote a file ending or starting with text, or place at both ends to denote that the name contains the text (e.g. *filename, filename*, *filename*).

SFTP

Optional

Checkbox to define if using Secure File Transfer Protocol method (SSH FTP).

Sender Email

Optional

If users are not able to drop the files in the FTP folder, users can opt to send the file via email to incoming_data@rayven.io.

Enter a sender’s email that the platform is expecting the data to receive from.

Section: Payload Date Settings

This section allows the user to define the field that holds the timestamp of the data.

Field

Requirement

Comments

Date Field Name

Optional

Define the name of the date attribute within the file to be applied to the payload in the Rayven platform. By default, this is set as the server receipt time the payload is processed (in UTC time).

Date Format

Optional

Define the format of the provided date field, for example: dd/MM/yyyy HH:mm:ss. If the date is coming through in 24 hour format, the hours need to be in capital letters, (i.e. HH:mm:ss).

The following specifiers are allowed:

s - Second, 0->59

ss - Second, 00->59

m- Minute, 0->59

mm- Minute, 00->59

h - Hour, 12 hour clock 1->12

hh - Hour, 12 hour clock 01->12

H - Hour, 24 hour clock 1->24

HH - Hour, 24 hour clock 01->24

d - Day, 1->31

dd - Day, 01->31

M - Month, 1-1>2

MM - Month, 01->12

MMM - Month, abbreviated

MMMM - Month, full name

yyyy - Year

Time Zone

Optional

Define from a drop down list, the time zone that the device is recording the data.

Section: Activation

This section contains basic configuration elements required for any Trigger node activation.

Field

Requirement

Comments

Logical Operand

Mandatory

Select the logical operand from the dropdown list to be applied to the selected device filters:

• OR
• AND

Select Device Filter

Mandatory

Select Device Filter configured in Device Management to select the devices that will receive this payload. Additional filters can be added, with the logical operand being applied to devices across filters.