Explanation of Each Field
Agent Information Settings
agent.id
The ID that identifies Agent
You can set any value for this field. When same Connection ID is used by the multiple Agents, you must specify different Agent IDs for each Agent.
This field is mandatory and case-sensitive.
If you intend to connect to HULFT8 for IBMi, do not use lowercase characters for agent.id for the following reasons:
-
This setting value is used for Host Name in the Host Information on HULFT.
-
In HULFT8 for IBMi, you cannot use lowercase characters in the management information settings.
agent.sender.port
The receiving port of Agent on the sending side
This port receives the data sent from HULFT. Specify a value for this field that is appropriate for the operating environment.
Make sure this port number does not overlap with the port number reserved by the operating system or used by other application programs.
This field is mandatory.
agent.command.port
The port for internal communications when executing commands
Specify a value for this field that is appropriate for the operating environment.
Make sure this port number does not overlap with the port number reserved by the operating system or used by other application programs.
If nothing is specified, the default value is '1099'.
Connection Information Settings
connection.keystore.filepath
Specify the path of the Connection ID Authentication Settings File.
Enter a relative path from the Agent configuration file or the absolute path.
This field is mandatory.
service.accesspoint
The access point to the HULFT-WebConnect service
Do not modify the value of this field.
Proxy Information Settings
proxy.host
The host name or domain name (IP address) of the proxy server
This field is considered as a comment and disabled upon installation.
To enable the field, delete a single byte number sign (#) exists at the beginning of the line, and then specify the value for the field.
The field is not case-sensitive.
proxy.port
The port number for the proxy server
This field is considered as a comment and disabled upon installation.
To enable the field, delete a single byte number sign (#) exists at the beginning of the line, and then specify the value for the field.
proxy.username
The user name for the proxy server that requires user authentication
This field is considered as a comment and disabled upon installation.
To enable the field, delete a single byte number sign (#) exists at the beginning of the line, and then specify the value for the field.
The field is case-sensitive.
proxy.password
The password for the proxy server that requires user authentication
This field is considered as a comment and disabled upon installation.
To enable the field, delete a single byte number sign (#) exists at the beginning of the line, and then specify the value for the field.
The field is case-sensitive.
Windows Service Startup Settings
windows.service.startup.sender
The startup setting for using Agent on the sending side as a Windows service
Specify 'on' or 'off' for this field. The field is case-sensitive.
When 'on' is specified, Agent on the sending side will be started at the same time as Windows services.
windows.service.startup.receiver
The startup setting for using Agent on the receiving side as a Windows service
Specify 'on' or 'off' for this field. The field is case-sensitive.
When 'on' is specified, Agent on the receiving side will be started at the same time as Windows services.
For Linux, the contents of the 'Windows Service Startup Settings' are not used.
Agent Update Settings
update.action
The settings for the update notification to be displayed on Agent startup
Specify 'alert' or 'none' for this field. The field is case-sensitive.
When 'alert' is specified, Agent will notify you whether there is an update or not. You must update Agent manually.
Example: Update Available
I600029 - The update check succeeded. Message:[You can update to latest version X.X.X from Y.Y.Y.]
Example: No Available Update
I600029 - The update check succeeded. Message:[You do not have to update: latest version X.X.X.]
update.action.onError
The settings for the Agent startup process when the update notification fails Only when 'update.action' is set to 'alert', the setting value of this field is valid.
'continue' is set for this field to continue the Agent startup process when the update notification has failed.
Do not modify the value of this field.
System Operation Settings
session.keepalive.interval
The interval at which keepalive packets are sent to maintain a session between Agent and HULFT-WebConnect
When Agent connects to HULFT-WebConnect via the proxy server, the session time-out may occur because of the non communication time-out settings on the proxy server.
To avoid unexpected session time-outs, change the value to correspond to the environment in which Agent is installed.
Specify the value from '0' to '3600000' (Unit: milliseconds).
When '0' is specified, keepalive packets are not sent.
session.management.reconnect.times
The number of attempts to reconnect the management session to HULFT-WebConnect when a network error occurs while Agent is running and Agent is disconnected from HULFT-WebConnect
Specify the value from '0' to '360'.
When '0' is specified, reconnection is not attempted.
If the number of failed reconnection attempts exceeds the specified count, Agent will stop.
session.management.reconnect.interval
The reconnection interval
Specify the value from '0' to '60' (Unit: seconds).
When '0' is specified, reconnection is attempted immediately.
jvm.options
The startup options for Java to be used when executing Agent
To specify multiple options, separate the options by using half-width spaces.
The field is case-sensitive.
Example: Allocation of Memory
jvm.options=-Xms64M -Xmx256M
Example: Language Settings
# Set to English. jvm.options=-Duser.language=en # Set to Japanese. jvm.options=-Duser.language=ja
Example: Time Zone Settings
# Set to Tokyo. jvm.options=-Duser.timezone=Asia/Tokyo # Set to Los Angeles. jvm.options=-Duser.timezone=America/Los_Angeles # Set to UTC +9. jvm.options=-Duser.timezone=UTC+9
The available format and values that can be specified might vary depending on the version of Java.
For details, refer to https://www.oracle.com/technetwork/java/index.html.
Configuration File Version Settings
configuration.version
The version of the Agent configuration file
Do not modify the value of this field.
No |
Key Name |
Explanation |
Default Value |
Value When Omitted |
Mandatory |
Setting Value |
Remarks |
---|---|---|---|---|---|---|---|
1 |
agent.id |
Agent ID |
|
|
✔ |
Alphanumeric characters Particular symbols |
Within 25 bytes Case-sensitive |
2 |
agent.sender.port |
Sending-side Agent receiving port |
46000 |
|
✔ |
From 1 to 65535 |
|
3 |
agent.command.port |
Port for internal command communications |
1099 |
1099 |
|
From 1 to 65535 |
|
4 |
connection.keystore.filepath |
Path of the Connection ID authentication settings file |
./connection.keystore |
|
✔ |
|
|
5 |
service.accesspoint |
Service access point |
service-ap.tokyo.webconnect.hulft.com |
|
✔ |
|
Cannot be modified |
6 |
proxy.host |
Proxy server host name |
|
|
|
Alphanumeric characters Particular symbols |
Within 255 bytes Case-insensitive |
7 |
proxy.port |
Proxy server port number |
|
|
|
From 1 to 65535 |
|
8 |
proxy.username |
Proxy server user name |
|
|
|
Half width characters |
Within 256 bytes Case-sensitive |
9 |
proxy.password |
Proxy server password |
|
|
|
Half width characters |
Within 256 bytes Case-sensitive |
10 |
windows.service.startup.sender |
Windows service startup settings (Sending-side Agent) |
on |
on |
|
on, off |
Case-sensitive |
11 |
windows.service.startup.receiver |
Windows service startup settings (Receiving-side Agent) |
on |
on |
|
on, off |
Case-sensitive |
12 |
update.action |
Agent update notification settings |
alert |
alert |
|
alert, none |
Case-sensitive |
13 |
update.action.onError |
Agent startup settings on the update failure |
continue |
continue |
|
continue |
Cannot be modified |
14 |
session.keepalive.interval |
Interval at which keepalive packets are sent (Unit: milliseconds) |
60000 |
60000 |
|
From 0 |
|
15 |
session.management.reconnect.times |
Number of times to attempt reconnections |
360 |
360 |
|
From 0 to 360 |
|
16 |
session.management.reconnect.interval |
Interval at which to attempt reconnections (Unit: seconds) |
30 |
30 |
|
From 0 to 60 |
|
17 |
jvm.options |
Java startup options |
-Xms64M -Xmx256M |
|
|
Half width characters |
Case-sensitive |
18 |
configuration.version |
Configuration file version settings |
|
|
✔ |
|
Cannot be modified |
The specifiable symbols for 'agent.id' and 'proxy.host' are hyphens (-) and periods (.).