Official | HULFT IoT EdgeStreaming Adapter Reference First Edition: July 1, 2021

Writing

This operation writes the input data to a text file.

By configuring the settings for the writing operation, you can periodically output input data, or specify a full path or a relative path to output to an appropriate location.

When you write to a file in a network, the FTP adapter is used to output the data.

For details on the FTP adapter, refer to FTP.

You can display the writing 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 > File > Basic > Writing

Note

The file adapter has specific functional restrictions.

For details on the functional restrictions, refer to Functional restrictions specific to file adapter.

 

Figure 4.1 Writing operation screen

(1) Field list

This is a list of the fields to configure for the writing operation.

Table 4.1 Field list

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

 

File name

 

 

-

 

File size to rotate

104857600

From 0 to 999999999

-

Unit: bytes

Set as integer

Maximum number of retained generations

999

From 0 to 1000

-

Set as integer

Maximum number of days retained

10

From 0 to 365

-

Set as integer

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 writing operation.

After changing these settings, click Finish to save the settings.

Click Cancel to discard the changes.

Name

Name of the writing 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 that you want to write

From the input data component names displayed in the list, select the component name of the input data that you want to write.

Required settings

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 for writing is stored based on the following path according to the execution location:

  • For Windows

    Table 4.2 File path for writing

    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 4.3 File path for writing

    Execution Location

    Starting Point of the Path

    Remote device execution

    The same level as EdgeStreaming Runtime (es-agent)

     

File size to rotate

File size to rotate files for writing (bytes)

Specify a number from "0" through "2147483646" for the file size to rotate files for writing.

If you set the rotated file size to "0", you can continue writing to the same file without performing file rotation.

If you omit this setting, "104857600" is specified.

Maximum number of retained generations

Maximum number of retained generations of files for writing

Specify a number from "0" through "1000" for the amount of retained backup data of files for writing.

If the specified maximum number of generations is exceeded, the files are deleted from the oldest one.

If you set the maximum number of retained generations to "0", all files are retained.

However, if the specified maximum number of days retained is exceeded, the file that exceeded the specified number of days is deleted.

If you omit this setting, "999" is specified.

Maximum number of days retained

Maximum number of days that files for writing are retained

Specify a number from "0" through "365" for the maximum number of days that files for writing are retained.

The file that exceeds the specified maximum number of days retained is deleted.

If you set the maximum number of days retained to "0", all files are retained.

However, if the value specified for maximum number of generations is exceeded, the files are deleted from the oldest one.

If you omit this setting, "10" is specified.

Comment

Comment

Comment regarding the writing operation

You can enter a comment.

 

(c) Saison Information Systems Co., Ltd. 2016

 

Official | HULFT IoT EdgeStreaming Adapter Reference First Edition: July 1, 2021