Distributing a file from Manager to Agent
To distribute files to an instance of Agent, you must create reception settings at the profile that is assigned to the instance of Agent.
1. Display the operation screen of Manager
Display the operation screen of Manager.
2. Create a profile
To use an existing profile, continue to step 3. Create reception settings for the profile.
-
On the operation screen of Manager, select [Profile].
Information about existing profiles is displayed on the Profile List screen.
-
Click [Add].
-
On the Create Profile screen, select a unit, and then enter a profile name.
-
Click [Create Profile].
The created profile appears on the Profile List screen.
3. Create reception settings for the profile
On the operation screen of Manager, specify reception settings.
-
On the operation screen of Manager, select [Profile].
-
Click the line of the profile whose reception settings you want to specify.
-
Under [Reception Settings] on the [Basic Settings] tab of the Profile Details screen, click [Add].
-
On the Reception Settings screen, enter the following items.
Table 3.10 Reception settings
Field name
Description
Specifiable values
Settings Name Enter a name to distinguish the reception settings.
Maximum 64 characters
File Name at Send Destination Specify the file name to use when Agent receives the file on the IoT equipment, by using the full path of the file storage location on the IoT equipment.
256 bytes
-
If you want to execute a job after the file is received successfully, also enter the following items.
Table 3.11 Job settings for the reception settings
Field name
Description
Specifiable values
Default value
Job Execution mode Specify whether jobs that are executed after a distribution file is received successfully are executed at the level of scripts or steps.
[Script Execution] or [Step Execution]
[Script Execution]
Job Describe jobs that are executed after a distribution file is received successfully.
ASCII characters (alphanumeric characters and symbols)
Maximum 2048 characters
None
- Available environment variables
- The following table shows the environment variables which can be used in Jobs. For details about the example of usage, see (4) Usage of environment variables.
-
Table 3.12 Available environment variables
Variable Name
Conversion Rule
FILENM Converts to the file name at send destination.
-
On the Reception Settings screen, click [Save].
4. Uploading the file to be distributed
On the Upload File screen that is displayed from [Reception Settings] for the profile, upload the file to be distributed.
The size of a file that you can upload it depends on the settings of distribution file size (spring.servlet.multipart.max-file-size and spring.servlet.multipart.max-request-size) in the environment settings file (application.properties). For details about the environment settings file, see (2) Contents of the environment settings file.
-
On the operation screen of Manager, select [Profile].
-
Click the line of the profile whose reception settings has been specified.
-
Select the check box of the reception settings in which the file to be distributed is defined.
-
In [Reception Settings] on the [Basic Settings] tab of the Profile screen, from the [Action] menu, click [Upload].
-
On the Upload File screen, choose the distribution file.
-
On the Upload File screen, click [Upload].
After the file is uploaded, Agent confirms the task at the frequency specified by [Receive Queue Polling Interval], and then receives the file.
5. Confirming the Receive Task Queue
On the operation screen of Manager, confirm tasks that have not yet been executed.
-
On the operation screen of Manager, click [Agent].
The Agent List screen appears.
- On the Agent List screen, click the check button of the Agent instance for which you want to display tasks, and then click [Action].
-
Click [Manage Receive Task Queue].
Tasks to be executed are displayed on the Manage the Receive Task Queue screen.
If Agent fails to receive a file, the task is deleted from the Receive Task Queue.