Initial settings for Agent by editing a default settings file (defaultsettings.ini)

[Revised contents from the ninth edition]

Date of Issue	Description
April 05, 2022	The description of "#" is changed from "hash mark" to "number sign". The description of "#" is changed from "hashtag" to "number sign".

If Agent has never been activated, Agent loads a default settings file (defaultsettings.ini) only once when Agent starts. By editing the default settings file, you can do the following:

Setting up an Agent operation by setting initial values for each item on the Agent Operation Settings screen
Allocating a Unit and a Profile to Agent when Agent activates

If you replace the default settings file with the file that was edited in advance, you can set the same initial values for the multiple Agent instances.

Note

If you prescribed the settings values for the Agent Operation Settings screen by using a lockdown.conf file, you cannot change these values by using the defaultsettings.ini file. The settings in the lockdown.conf file are valid.

For details about the lockdown.conf file, see the "User's Guide".

(1) When you edit the default settings file

There are two times when you can edit the default settings file.

When you create the default settings file at the working directory for installation of Agent by deploying the compressed installation modules file

If you edit the default settings file at this time, the edited file is deployed to the installation directory after Agent installation.

When you deploy the default settings file to the installation directory of Agent by installing Agent

If it is before the first activation of Agent, you can change the settings by editing the contents of the default settings file in the installation directory.

(2) Format of the default settings file

The description format of the default settings file is as follows:

Format of defaultsettings.ini file

The-parameter-name = [Setting-value]

Delete a number sign (#) from the line to be specified, set the value.

If you specified the value that cannot be specified, Agent will be activated, however, the settings value is not applied as an initial value for the Agent Operation Settings screen.

If the item name is incorrect, the line is ignored.

(3) Setting up an Agent operation by setting initial values for the Agent Operation Settings screen

Items to set initial values for the Agent Operation Settings screen are as follows:

Table 3.2 Items to set initial values for the Agent Operation Settings screen

Item Parameter Field name in the Agent Operation Settings screen Description Specifiable values Default values Unit

Agent - Manager Communications polling_interval Polling Interval Specify the interval at which Agent polls Manager. 1 to 5097600 60 Seconds ^*1

rcvque_polling_interval Receive Queue Polling Interval Specify the interval at which Agent polls the Receive Task Queue. 1 to 5097600 60 Seconds ^*1

communication_time_limit_enabled Communication Time Limit
Specify whether the time period when Agent communicates with Manager is restricted.

If you restrict the time period for Agent to communicate with Manager, specify Start Time and End Time, too.

0: Do not restrict the communication hours

1: Restrict the communication hours
0 -

start_communication_time Start Time
Specify the time of day when Agent can start to communicate with Manager if you limit the time when Agent can communicate with Manager.

Specify the value with "End Time".
0 to 23 --- o'clock

end_communication_time End Time
Specify the time of day when Agent ends the communication with Manager if you limit the time when Agent can communicate with Manager.

Specify the value with "Start Time".
0 to 23 --- o'clock

Connecting connection_retry_count Connection Retry Count Specify the number of times to retry a connection when Agent fails to connect to HULFT. 0 to 9999 8640 Times

connection_retry_interval Connection Retry Interval Specify the amount of time to wait before Agent retries a connection when Agent fails to connect to HULFT. 0 to 9999 10 Seconds

socket_timeout Socket Read Timeout
Specify the time until a timeout of Agent occurs when Agent does not receive a response from HULFT during a socket communication between Agent and HULFT.

If a timeout occurs, Agent regards the state as a communication error and disconnects the communication.
10 to 259200 30 Seconds

request_timeout Request Timeout
Specify the time until a timeout of Agent occurs when Agent does not receive a response from Manager during any communications between Agent and Manager.

If a timeout occurs, Agent regards the state as a communication error and disconnects the communication.
10 to 259200 3600 Seconds

socket_buffer_size Socket Buffer Size
Specify the socket buffer size that is applied to socket communication from Agent to HULFT.

If 0 is specified, the system value is used.
0, 4096 to 2147483647 0 Bytes

Resending auto_retry_count Auto Resend Retry Count Specify the number of times that Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT. 0 to 255 60 Times

auto_retry_interval Auto Resend Retry Interval Specify the amount of time to wait before Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT. 0 to 9999 60 Seconds

send_multiplex_level Send Process Multiplex Level
Specify the maximum number of send processes (huliotsend) that Agent can start at the same time.

If the number of transfer files in an instance of Agent exceeds the maximum number of send processes, Agent delays transferring the extra files until the next trigger fire after the time of the monitoring interval that is specified on the Transfer Settings screen elapsed.
1 to 99 10 Processes

Receiving ^*2 Size of Receive Task Queue
Specify the maximum number of Receive Tasks that can be registered in the Receive Task Queue for the file distribution function.

If the number of tasks exceeds the maximum, the new task will not be added to the queue.
1 to 9999 10 Tasks

Jobs job_timeout Job Timeout
Specify the amount of time to wait before generating an error when the result of a job for a file transfer or file distribution is not returned.

If 0 is specified, Agent keeps waiting for a result without timing out.
0, 10 to 86400 0 Seconds

Logs log_output_mode Log Output Mode
Specify whether to have Agent always output Send Logs or whether to have Agent output Send Logs only when an error occurs.

If 0 is specified, logs are output only when an error occurred.

If 1 is specified, logs are always output.
0 or 1 1 -

send_log_pool_size Send Log Pool Size
Specify the size of Send Logs that are kept in Agent.
1048576 to 1073741824 5242880 Bytes ^*3

trace_log_pool_size Trace Log Pool Size
Specify the size of Trace Logs that are kept in Agent
1048576 to 1073741824 5242880 Bytes ^*3

Table 3.2 Items to set initial values for the Agent Operation Settings screen
Item	Parameter	Field name in the Agent Operation Settings screen	Description	Specifiable values	Default values	Unit
Agent - Manager Communications	polling_interval	Polling Interval	Specify the interval at which Agent polls Manager.	1 to 5097600	60	Seconds ^*1
rcvque_polling_interval	Receive Queue Polling Interval	Specify the interval at which Agent polls the Receive Task Queue.	1 to 5097600	60	Seconds ^*1
communication_time_limit_enabled	Communication Time Limit	Specify whether the time period when Agent communicates with Manager is restricted. If you restrict the time period for Agent to communicate with Manager, specify Start Time and End Time, too.	0: Do not restrict the communication hours 1: Restrict the communication hours	0	-
start_communication_time	Start Time	Specify the time of day when Agent can start to communicate with Manager if you limit the time when Agent can communicate with Manager. Specify the value with "End Time".	0 to 23	---	o'clock
end_communication_time	End Time	Specify the time of day when Agent ends the communication with Manager if you limit the time when Agent can communicate with Manager. Specify the value with "Start Time".	0 to 23	---	o'clock
Connecting	connection_retry_count	Connection Retry Count	Specify the number of times to retry a connection when Agent fails to connect to HULFT.	0 to 9999	8640	Times
connection_retry_interval	Connection Retry Interval	Specify the amount of time to wait before Agent retries a connection when Agent fails to connect to HULFT.	0 to 9999	10	Seconds
socket_timeout	Socket Read Timeout	Specify the time until a timeout of Agent occurs when Agent does not receive a response from HULFT during a socket communication between Agent and HULFT. If a timeout occurs, Agent regards the state as a communication error and disconnects the communication.	10 to 259200	30	Seconds
request_timeout	Request Timeout	Specify the time until a timeout of Agent occurs when Agent does not receive a response from Manager during any communications between Agent and Manager. If a timeout occurs, Agent regards the state as a communication error and disconnects the communication.	10 to 259200	3600	Seconds
socket_buffer_size	Socket Buffer Size	Specify the socket buffer size that is applied to socket communication from Agent to HULFT. If 0 is specified, the system value is used.	0, 4096 to 2147483647	0	Bytes
Resending	auto_retry_count	Auto Resend Retry Count	Specify the number of times that Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT.	0 to 255	60	Times
auto_retry_interval	Auto Resend Retry Interval	Specify the amount of time to wait before Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT.	0 to 9999	60	Seconds
send_multiplex_level	Send Process Multiplex Level	Specify the maximum number of send processes (huliotsend) that Agent can start at the same time. If the number of transfer files in an instance of Agent exceeds the maximum number of send processes, Agent delays transferring the extra files until the next trigger fire after the time of the monitoring interval that is specified on the Transfer Settings screen elapsed.	1 to 99	10	Processes
Receiving	^*2	Size of Receive Task Queue	Specify the maximum number of Receive Tasks that can be registered in the Receive Task Queue for the file distribution function. If the number of tasks exceeds the maximum, the new task will not be added to the queue.	1 to 9999	10	Tasks
Jobs	job_timeout	Job Timeout	Specify the amount of time to wait before generating an error when the result of a job for a file transfer or file distribution is not returned. If 0 is specified, Agent keeps waiting for a result without timing out.	0, 10 to 86400	0	Seconds
Logs	log_output_mode	Log Output Mode	Specify whether to have Agent always output Send Logs or whether to have Agent output Send Logs only when an error occurs. If 0 is specified, logs are output only when an error occurred. If 1 is specified, logs are always output.	0 or 1	1	-
send_log_pool_size	Send Log Pool Size	Specify the size of Send Logs that are kept in Agent.	1048576 to 1073741824	5242880	Bytes ^*3
trace_log_pool_size	Trace Log Pool Size	Specify the size of Trace Logs that are kept in Agent	1048576 to 1073741824	5242880	Bytes ^*3

*1

:

Specify Polling Interval and Receive Queue Polling Interval as follows:

Interval that you can set
Specifiable values

(in seconds)
Description

1 second to 59 seconds　(in seconds)
1 to 59 Specify from 1 to 59.

1 minute to 59 minutes (in minutes)
60 to 3540
Specify a multiple of 60.

Example) 3 minutes: 180, 15 minutes: 900

1 hour to 23 hours　(in hours)
3600 to 82800
Specify a multiple of 3600.

Example) 3 hours: 10800, 15 hours: 54000

1 day to 59 days (in days)
86400 to 5097600
Specify a multiple of 86400.

Example) 3 days: 259200, 15 days: 1296000

Interval that you can set	Specifiable values (in seconds)	Description
1 second to 59 seconds　(in seconds)	1 to 59	Specify from 1 to 59.
1 minute to 59 minutes (in minutes)	60 to 3540	Specify a multiple of 60. Example) 3 minutes: 180, 15 minutes: 900
1 hour to 23 hours　(in hours)	3600 to 82800	Specify a multiple of 3600. Example) 3 hours: 10800, 15 hours: 54000
1 day to 59 days (in days)	86400 to 5097600	Specify a multiple of 86400. Example) 3 days: 259200, 15 days: 1296000

*2

:

Size of Receive Task Queue is not specifiable.

*3

:

Specify Send Log Pool Size and Trace Log Pool Size as follows:

Size that you can set
Specifiable values

(in bytes)
Description

1 MB to 1024 MB　(in megabytes)
1048576 to 1073741824
Specify a multiple of 1048576.

Example) 100 MB: 104857600, 500 MB: 524288000

Size that you can set	Specifiable values (in bytes)	Description
1 MB to 1024 MB　(in megabytes)	1048576 to 1073741824	Specify a multiple of 1048576. Example) 100 MB: 104857600, 500 MB: 524288000

Example description for the defaultsettings.ini file

The following example shows the defaultsettings.ini file when you set 2 minutes as the initial value for Polling Interval.

If the line top is a number sign (#), the line is to be seemed as a comment line.

polling_interval = 120

# rcvque_polling_interval =

# communication_time_enabled =

# start_communication_time =

# end_communication_time =

# connection_retry_count =

# connection_retry_interval =

# socket_timeout =

# request_timeout =

# socket_buffer_size =

# auto_retry_count =

# auto_retry_interval =

# send_multiplex_level =

# job_timeout =

# log_output_mode =

# send_log_pool_size =

# trace_log_pool_size =

# profile_id =

(4) Allocating a Unit and a Profile to Agent when Agent activates

An item for allocating a Unit and a Profile to Agent is as follows:

Table 3.3 Item for allocating a Unit and a Profile to Agent

Item Parameter Description

Profile profile_id
Specify a profile ID that is registered in Manager.

The specified profile and the unit to which the profile belongs are allocated to the Agent instance when Agent activates.

Example description for defaultsettings.ini file

profile_id = 1234567c-1abc-1ab2-a1bc-1a23bc4d5e675