Official | HULFT IoT EdgeStreaming Adapter Reference First Edition: July 1, 2021
Send file of specified size
This operation accumulates input data in a file and sends it to the FTP server when it reaches the specified number of bytes.
The FTP adapter has specific functional restrictions.
For details on functional restrictions, refer to Functional restrictions specific to FTP adapter.
You can display the send file of specified size operation screen by displaying the script canvas on the Designer screen, clicking the following items in the following order, and then dragging and dropping the component icon onto the script canvas:
-
Tool palette > Generic protocol > FTP > Send file of specified size
Figure 7.3 Send file of specified size operation screen
(1) Field list
This is a list of the fields to configure for the send file of specified size operation.
|
Field Name |
Initial Value |
Setting Value |
Omission |
Notes |
|
|---|---|---|---|---|---|
|
Name |
|
Single-byte alphanumeric characters and certain symbols (*1) |
- |
A value that begins with a single-byte alphabetic character |
|
|
Input data |
(No input data) |
Name of the input data component |
- |
Select from list (*2) |
|
|
Required settings |
|||||
|
|
Destination |
|
|
- |
|
|
File name |
|
|
- |
|
|
|
Sending size |
|
From 1 to 2147483646 |
- |
Unit: bytes Set as integer |
|
|
Write settings |
|||||
|
|
Append |
|
|
✓ |
|
|
Header |
|
|
✓ |
|
|
|
Retry settings |
|||||
|
|
Number of retries |
15 |
From 0 to 9999 |
✓ |
Set as integer |
|
Number of buffering items |
86400 |
From 0 to 1073741824 |
✓ |
|
|
|
Buffer type |
Memory buffer |
|
✓ |
Select from list |
|
|
Comment |
|||||
|
|
Comment |
|
Characters |
✓ |
|
|
✓ |
: |
Possible to omit |
|
- |
: |
Impossible to omit |
|
*1 |
: |
Only "_" (underscore) can be specified. |
|
*2 |
: |
When component icons for input or conversion are placed on the script canvas, the options are displayed in the list. |
(2) Description of each field
This section explains each of the fields to configure for the send file of specified size operation.
After changing these settings, click Finish to save the settings.
Click Cancel to discard the changes.
- Name
-
Name of the send file of specified size operation component
Single-byte alphanumeric characters and "_" (underscore) can be used.
Use a value that begins with a single-byte alphabetic character.
- Input data
-
Selection of the component name of the input data for the send file of specified size operation
From the input data component names displayed in the list, select the component name for the send file of specified size operation.
Required settings
- Destination
-
FTP destination
Select the FTP connection destination for the send file of specified size operation.
When you click Add, the FTP connection settings screen appears.
For details on the FTP connection settings screen, refer to FTP connection settings.
When you click Edit list..., the editing screen for the resource list appears.
For details on the editing screen for the resource list, refer to Edit resource list.
- File name
-
File name for writing
Specify the file name as the full path or relative path.
If you use a relative path, the file to be written is stored under the following paths according to the execution location:
-
For Windows
Table 7.4 Path for write file
Execution Location
Starting Point of the Path
Studio execution
$EDGESTREAMING_HOME\client\es-agent\projectname\scriptname
Remote device execution
The same level as EdgeStreaming Runtime (es-agent.exe)
-
For Linux
Table 7.5 Path for write file
Execution Location
Starting Point of the Path
Remote device execution
The same level as EdgeStreaming Runtime (es-agent)
-
- Sending size
-
The sending size when performing FTP transfer (bytes)
Specify the sending size when performing FTP transfer as a numerical value between "1" and "2147483646".
Write settings
- Append
-
Selection of appending
Select this check box to write data to a file that already exists at the time of FTP transfer.
- Header
-
Header
Describe the contents to be entered into the header of the write file.
Retry settings
- Number of retries
-
Number of retries when trying to send to the FTP server
Specify a number from "0" through "9999" for the number of retries when trying to send to the FTP server.
- Number of buffering items
-
Number of buffering items when sending to the FTP server
Specify a number from "0" through "1073741824" for the number of buffering items when sending to the FTP server.
- Buffer type
-
Buffer type
Select a buffering type.
-
Memory buffer
-
Comment
- Comment
-
Comment regarding the send file of specified size operation
You can enter a comment.
Official | HULFT IoT EdgeStreaming Adapter Reference First Edition: July 1, 2021