Configuring the Manager environment

To set up the Manager environment, you must edit the environment settings file (application.properties).

This file is stored in the installation directory of Manager.

(1) Editing the environment settings file

After installing Manager, you can edit the values in the environment settings file that you want to change from the initial settings. Use a text editor to edit the file.

We recommend backing up the environment settings file before making any changes.

Note

Whenever you edit the environment settings file (application.properties), restart Manager to apply the changes.

(2) Contents of the environment settings file

Port number of Manager
server.port=8765
server.port

Specify the port number for Manager.

The initial value of the server port after installation is 8765.

Distribution file size
# spring.servlet.multipart.max-file-size=10MB
# spring.servlet.multipart.max-request-size=15MB

These lines are commented out (the lines begin with a number sign [#]) after installation.

These are the values that are used after Manager is installed. If you want to change these values, delete the number signs and change the appropriate values.

spring.servlet.multipart.max-file-size

Define the maximum size of a distribution file that Manager can upload, by specifying both a value and a unit.

  • Range of value: From 1 to 2147483647

  • Unit: MB or KB

The actual ability to upload a file is dependent on the resources in the environment in which Manager is running.

* The maximum value of the file size that the user can distribute is 2147483647 Byte (2G Byte - 1 Byte).

spring.servlet.multipart.max-request-size

Define the maximum size of an HTTP request to Manager, by specifying both a value and a unit.

  • Range of value: From 1 to 9223372036854775807

  • Unit: MB or KB

The actual ability to execute a request is dependent on the resources in the environment in which Manager is running.

Note

For the HTTP request size, specify the sum of the distribution file size and the size of the HTTP header information and other data. If the values specified for spring.servlet.multipart.max-file-size and spring.servlet.multipart.max-request-size are not appropriate, you might not be able to upload distribution files whose size is equal to the specified maximum.

Example settings that will prevent the uploading of a 10 MB file

spring.servlet.multipart.max-file-size=10MB

spring.servlet.multipart.max-request-size=10MB

Example settings that will allow the uploading of a 10 MB file

spring.servlet.multipart.max-file-size=10MB

spring.servlet.multipart.max-request-size=15MB

Truncation of logs
device.access.log.truncation.cron=0 0 2 * * *
transfer.log.truncation.cron=0 0 2 * * *
receiving.log.truncation.cron=0 0 2 * * *
trace.log.truncation.cron=0 0 2 * * *

device.access.log.truncation.cron

Specify the value to use when truncating Access Logs.

transfer.log.truncation.cron

Specify the value to use when truncating Transfer Logs.

receiving.log.truncation.cron

Specify the value to use when truncating Receive Logs.

trace.log.truncation.cron

Specify the value to use when truncating Trace Logs.

Specification method

  • Default: 0 0 2 * * * (truncate the log at 2 a.m. every day)

  • Format: second minute hour day month day-of-week
    Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Example

If you want to truncate logs every hour between 10:00 a.m. and 6:00 p.m. from Monday to Friday, specify the values as follows:

0 0 10-18 * * MON-FRI

If you specify the values shown in the following example, every day at 2 a.m., Manager retains the logs from the past 30 days and truncates any other logs.

- Schedule: 0 0 2 * * *

- Truncation Mode: Date

- Threshold: 30 days

To enable truncation settings, configure them on the Manager screen.

For details about these settings, see Setting conditions for the deletion of logs.

Operational environment of the database
# DataSource
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://127.0.0.1:5432/hulftiot
spring.datasource.username=postgres
spring.datasource.password=postgres

The environment is set as shown above just after installation.

When the user changes the password for PostgreSQL, see the "Installation Guide".

Environment for web connections
# server.ssl.enabled=true
# server.ssl.key-store=${hulftiot.manager.home}/.keystore
# server.ssl.key-password=changeit
# server.ssl.key-store-password=changeit
# server.ssl.key-alias=iot

These lines are commented out (the lines begin with a number sign [#]) after installation.

The specified values are samples. If you want to change these values, delete the number signs and change the appropriate values.

server.ssl.enabled

Specify whether to enable HTTPS by using the web server functionality included with HULFT IoT Manager.

  • true: Enable HTTPS.

    If you use HULFT over TLS for file transfer from Agent to HULFT, set true.

  • false: Disable HTTPS.

When you enable HTTPS (server.ssl.enabled=true), you must specify the following 4 items.

server.ssl.key-store

Specify the path of the certificate store.

server.ssl.key-password

Specify a password for the key that is stored in the certificate store.

server.ssl.key-store-password

Specify a password for the certificate store.

server.ssl.key-alias

Specify an alias name for the key that is stored in the certificate store.

Timeout for user sessions
hulft.login.session.timeout.polling=60
hulft.login.session.timeout=3600

The environment is set as shown above just after installation.

hulft.login.session.timeout.polling

Specify a polling interval (in seconds) for confirmation of whether a session between Manager and a user has timed out. Specify only the value (do not specify the unit).

  • Range of value: From 1 to 2592000

hulft.login.session.timeout

Specify the time (in seconds) after which a session between Manager and a user times out. Specify only the value (do not specify the unit).

  • Range of value: From 1 to 2592000
Timeout for Agent sessions
hulft.agent.session.timeout=259200

The environment is set as shown above just after installation.

hulft.agent.session.timeout

Specify the time (in seconds) after which a session between Manager and Agent times out. Specify only the value (do not specify the unit).

  • Range of value: From 1 to 2592000
Specification of the compatibility mode and the compatibility version
hulft.api.compatibility.mode=on
hulft.api.compatibility.version=V01L00R00P00

The environment is set as shown above just after installation.

hulft.api.compatibility.mode

Specify whether Manager manages old version Agent.

  • on: Manager manages old version Agent.
  • off: Manager does not manage old version Agent.

hulft.api.compatibility.version

If "on" is specified for hulft.api.compatibility.mode, specify the version of Agent from which Manager manages Agent.

Specification method

  • Format: VversionLlevelRrevisionPminor-revision

Example

When the current Manager manages the Agent version 1.1.0A and later, specify the value as follows:

V01L01R00P0A

Agent compatibility mode via an SSL accelerator
server.compatibility.v1.ssl.accelerator=false

The environment is set as shown above just after installation.

server.compatibility.v1.ssl.accelerator

Specify this parameter if Manager manages the version 1 Agent on the configuration using an SSL accelerator.

  • true: Configuration using an SSL accelerator
  • false: Basic configuration

For details of the configuration using an SSL accelerator and the basic configuration, see the figures of (1) Configuration and settings for the Manager environment in HULFT over TLS.

If the user does not enable this parameter when Manager manages the version 1 Agent on the configuration using an SSL accelerator, the file receive function of Agent and update function of Agent might not be available.

Monitoring logs
# Notifications
# transfer.log.notification.cron=0 * * * * *
# receive.log.notification.cron=0 * * * * *
# trace.log.notification.cron=0 * * * * *

These lines are commented out (the lines begin with a number sign [#]) after installation.

These are the values that are used after Manager is installed. If you want to change these values, delete the number signs and change the appropriate values.

transfer.log.notification.cron

Specify when Agent monitors Transfer Logs.

receive.log.notification.cron

Specify when Agent monitors Receive Logs.

trace.log.notification.cron

Specify when Agent monitors Trace Logs.

Specification method

  • Default: 0 * * * * * (confirm the logs every minute)

  • Format: second minute hour day month day-of-week
    Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Example

If you want to confirm the logs every minute between 10:00 a.m. and 5:59 p.m. from Monday to Friday, specify the values as follows:

0 * 10-17 * * MON-FRI

For details on how to notify the monitoring results, see Configuring notification emails.

Caching receive logs
hulrcv.log.cache.cron=0 * * * * *

hulrcv.log.cache.cron

Specify the interval for caching Receive Logs.

Specification method

  • Default: 0 * * * * * (cache Receive Logs every minute)

  • Format: second minute hour day month day-of-week
    Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Monitoring the license term
# term.key.expiration.notification.cron=0 0 0 * * *

This line is commented out (the line begins with a number sign [#]) after installation.

These are the values that are used after Manager is installed. If you want to change these values, delete the number sign and change the appropriate values.

term.key.expiration.notification.cron

Specify the time to confirm Term License Key.

Specification method

  • Default: 0 0 0 * * * (confirm Term License Key at 0 a.m. every day)

  • Format: second minute hour day month day-of-week
    Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Example

If you want to confirm Term License Key at 0 a.m. from Monday to Friday, specify the values as follows:

0 0 0 * * MON-FRI

For details on how to notify the term, see Configuring notification emails.

Specification of a notification email
# Email
# spring.mail.protocol=smtp
# spring.mail.default-encoding=UTF-8
# spring.mail.host=localhost
# spring.mail.port=25
# spring.mail.username=
# spring.mail.password=
# spring.mail.properties.mail.smtp.auth=false
# spring.mail.properties.mail.smtp.from=notification@hulftiot.com
# spring.mail.properties.mail.smtp.connectiontimeout=5000
# spring.mail.properties.mail.smtp.timeout=3000
# spring.mail.properties.mail.smtp.writetimeout=5000

These lines are commented out (the lines begin with a number sign [#]) after installation.

The specified values are samples other than the protocol and the default-encoding. If you want to change these values, delete the number signs and change the appropriate values.

spring.mail.protocol

This is the specification for the communication protocol to be used when notification emails are sent.

This value must be fixed to smtp.

spring.mail.default-encoding

This is the specification for the character encoding set to be used when notification emails are sent.

This value must be fixed to UTF-8.

spring.mail.host

Specify the host name for the SMTP server.

spring.mail.port

Specify the port number for the SMTP server.

spring.mail.username

Specify the user name for the SMTP server.

If you specify "false" for spring.mail.properties.mail.smtp.auth, you must comment out this line.

spring.mail.password

Specify the password for the SMTP server.

If you specify "false" for spring.mail.properties.mail.smtp.auth, you must comment out this line.

spring.mail.properties.mail.smtp.auth

If you perform the mail sending by using the SMTP-AUTH, set true.

spring.mail.properties.mail.smtp.from

Specify the email address of the sender. The email address must be based on the RFC.

spring.mail.properties.mail.smtp.connectiontimeout

Specify the time (in milliseconds) after which a trial for establishing the connection with the SMTP server times out. Specify only the value (do not specify the unit).

  • Range of value: From 0 to 2147483647

spring.mail.properties.mail.smtp.timeout

Specify the time (in milliseconds) after which a connection with the SMTP server for reading data times out. Specify only the value (do not specify the unit).

  • Range of value: From 0 to 2147483647

spring.mail.properties.mail.smtp.writetimeout

Specify the time (in milliseconds) after which a connection with the SMTP server for writing data times out. Specify only the value (do not specify the unit).

  • Range of value: From 0 to 2147483647

HULFT over TLS
ssl.route.cipher=false
ssl.route.multiplicity=10
ssl.route.timeout=3600

The environment is set as shown above just after installation.

ssl.route.cipher

If you use HULFT over TLS, set true.

ssl.route.multiplicity

Specify the communication multiplex level so that Manager can relay file transfers at the same time.

  • Range of value: From 1 to 99

If the number of file transfers at the same time exceeds the specified value, Agent will attempt to retry a connection with Manager according to the following values set on the Agent Operation Settings screen.

  • Connection Retry Count
  • Connection Retry Interval

ssl.route.timeout

Specify the non-communication timeout (in seconds) when Manager relays a file transfer. Specify only the value (do not specify the unit).

  • Range of value: From 1 to 259200