The following is a description of each option you can include in your
gateway.toml file.
- atwdt_auto_update_failed_title
- The title for the installation failure dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_auto_update_failed_title=""
- atwdt_auto_update_failed_message
- The message to appear in the installation failure dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_auto_update_failed_message="The update was not
completed.\\n\\nPlease try again using the installer."
- atwdt_auto_update_notify_fail
- Determines whether an installation failure dialog box appears.
Valid values:
true|false
Section:
[desktop.autoupdate]
Example:
atwdt_auto_update_notify_fail=false
- atwdt_auto_update_query
- Determines whether a query dialog for this update should appear. If
false, it downloads the installer and starts it automatically.
Valid values:
true|false
Section:
[desktop.autoupdate]
- atwdt_auto_update_query_message
- The message to appear in the query dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_auto_update_query_message="Your AcuToWeb
Desktop requires an update. Please click OK to launch the update."
- atwdt_auto_update_query_title
- The title for the query dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_auto_update_query_title="ACUCOBOL-GT AcuToWeb Desktop"
- atwdt_check_installer_timestamp
-
Valid values:
true|false
Section:
[desktop.autoupdate]
- atwdt_disable_auto_update
- Determines whether to enable or disable auto update.
Valid values:
true|false
Section:
[desktop.autoupdate]
- atwdt_download_cancel_message
- The message to appear in the installer download cancel dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_download_cancel_message="Please wait while the download
is being cancelled..."
- atwdt_download_description
- The message to appear in the installer download progress dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_download_description="Downloading installation file..."
- atwdt_download_dialog
- Determines whether to show the installer download progress dialog box.
Valid values:
true|false
Section:
[desktop.autoupdate]
- atwdt_download_dialog_title
- The title for the installer download progress dialog box.
Section:
[desktop.autoupdate]
Example:
atwdt_download_dialog_title="ACUCOBOL-GT AcuToWeb
Desktop Automatic Update"
- atwdt_installer_args
- Additional arguments for the MSI installer.
Section:
[desktop.autoupdate]
- atwdt_installer_run_async
- Determines whether the program process should wait until the Desktop update procedure finishes.
Valid values:
true|false
Section:
[desktop.autoupdate]
Example:
atwdt_installer_run_async=false
Note: When set to
true, the program process does not wait until the Desktop update procedure finishes.
- atwdt_installer_server_file1
- The name of the file used to install the server, which is
Installer.exe by default.
Section:
[desktop.autoupdate]
Example:
atwdt_installer_server_file="Installer.exe"
- atwdt_installer_target_dir1
- The path where the auto-update files are installed.
Section:
[desktop.autoupdate]
Example:
atwdt_installer_target_dir="\etc\ATW Desktop\"
- atwdt_installer_ui_level1
- The level set for the installer user interface.
Valid value:
n, where
n represents a digit.
Section:
[desktop.autoupdate]
Example:
atwdt_installer_ui_level="1"
- atwdt_requires_build_number
- The build number required by auto-update.
Valid value:
build-number, where
build-number represents a digit.
Section:
[desktop.autoupdate]
Example:
atwdt_requires_build_number="1"
Note: To show the Build number, right click the
Connection Setup screen and select
View page source.
- append_log_file
- Determines if logging information is appended to an existing log file (1) or a new logging file is created (0).
Valid values:
true|false.
Example:
append_log_file=false
- authorized_access
- When set to
true, the web page prompts for a username and password before trying to connect. These details are verified in the AcuConnect
access file.
Section:
[acuconnect]
Example:
authorized_access=true
- enable_rsa_enc
- Adds additional encryption to obfuscated URLs by encrypting important information such as alias, user, and password. The
encryption is performed before the base64 encoding of the entire URL.
Note: To ensure that enable_rsa_enc works correctly, configure
https in the gateway.
When enable_rsa_enc is enabled (that is, set to
true), a 2048-bit RSA key (crytRSA.pem) is generated when the gateway is started. You must ensure that this key remains in the
AcuToWeb subdirectory of your product installation directory in order to correctly apply the encryption when you click
Make URL when the
Obfuscate Param option is selected.
By default, this option is disabled.
Example:
enable_rsa_enc=true
- file_cache
- The location of cached files, which needs to be a writable directory
Example:
file_cache="C:\\tmp\\Web\\cache"
- handshake_timeout
- The interval (in seconds) after which the handshake between the Gateway and AcuConnect will time out. This setting has no
effect on other communications. The default value is 3 (seconds). Increase the value if the Gateway and AcuConnect are on
different machines and/or there are network issues.
Section:
[acuconnect]
Example:
handshake_timeout=3
- log_level
- The level of logging that is carried out. Permissible values are:
- 0
- Logs startup/connection information, and the loaded gateway configuration.
- 1
- Logs startup/connection information, tracing, and generic error reporting.
- 2
- Logs protocol information, tracing, and protocol error reporting.
- 4
- Logs detailed protocol information, tracing, and specific acuthin message handler information tracing (TC_W_BITMAP, TC_W_ICON…)
- 8
- Logs a hexdump of the transmission data.
To specify more than one level, add the values together.
Example: Log protocol info(4) and transmission data(8)
log_level = 12
- logfile
- An alternative path and file name for the log file used to record the level of information specified by
log_level.
The default for Windows systems is
%PROGRAMDATA%\Micro Focus\extend\x.x.x\AcuToWeb\logs\atw_gateway.log where
x.x.x is your extend version number, and the defaut for Linux/UNIX systems is
atw_installation_dir/logs/atw_gateway.log.
Example:
logfile="C:\\etc\\log\\gateway.log"
- max_pkg_size
- The maximum size of packages exchanged between the client and the server (in bytes). Messages bigger than the default will
be split; messages smaller than the default will be sent immediately without waiting for the buffer to be filled (and therefore
this setting would have no effect). The default is 64000 (bytes)
Example:
max_pkg_size=64000
- max_reconnect_attempts
- The maximum number of attempts made to reconnect. Unlimited if set to
-1. See
Recovering Dropped Connections for list of related options.
Recommended value: 20 - 30
- max_reconnect_interval
- The time frame, in milliseconds, in which the reconnection(s) will be attempted. See
Recovering Dropped Connections for list of related options.
Recommended value: 30000
- path_custom_js
- The name and file location of a Javascript file that can be loaded into the host page of your application. You can use this
file to provide tracking, load other
.js libraries, and call custom created functionality that can alter or monitor specific DOM objects. You can use jQuery as a
framework within this file, because AcuToWeb already makes this available as a library.
Example:
path_custom_js="C:\\atw\\js\\customtour.js
Tip: If you use URL notation to specify the file, you can pick up any updated version of the Javascript file using an additional
parameter, TIMESTAMP, to refresh the browser after a specified number of seconds:
url[HOST]:[WEB_PORT]/js/customjs.js?_=[TIMESTAMP]
For example:
www.mya2whost.com:1234/js/customjs.js?_=86400
- path_fill_combo
- The location of
fillcombo.js: the JavaScript file that is used to populate a drop-down list in the
Alias field of the
Connection Setup screen.
Example:
PATH_FILL_COMBO="C:\\my-acutoweb\\fillcombo.js"
The following excerpt of
fillcombo.js adds aliases for the Calculator and Tour applications:
[
{"type": "category", "text": "Main Applications"},
{"type": "elem", "text": "Calculator", "value": "calc-alias"},
{"type": "elem", "text": "Tour", "value": "tour-alias"}
]
- path_resources [SRC]: ]
- The
[SRC] prefix causes the client browser to look for resources in the
%ACUCOBOL%\acutoweb\Web (Windows) or
$ACUCOBOL/acutoweb/Web (UNIX) directory by default. To override the default, you must use Virtual Directory with the
resource virtual folder name in the path of the asset you want to add.
For example, on a Windows machine, if the resources you want to find are
my-js1.js and
my-js2.js stored in the
c:\extra-scripts directory, the gateway configuration would have
path_resources=C:\\extra-scripts and would modify the COBOL as follows:
add("s2", "[SRC]:resources\my-js2.js")
Note: path_resources does not support multiple paths.
- probing_connection
- The waiting time, in milliseconds, on the internal PING sent to verify that the connection is active. The default minimum
value is
3000.
The reconnection system is triggered when the waiting time expires.
When dealing with systems/networks that have higher latency, you might want to increase the default value.
- public_root_dir
- The location of the AcuToWeb website files
Example:
public_root_dir=".\web"
- reconnect_decay
- The rate of increase of the reconnect delay. Allows reconnection attempts to back off when problems persist. See
Recovering Dropped Connections for list of related options.
Recommended value: 1
- reconnect_interval
- The number of milliseconds to delay (after connection has dropped) before attempting to reconnect. See
Recovering Dropped Connections for list of related options.
Recommended value: 1000
- ssl_key_file
- Specifies the key file to use when SSL is enabled
Example:
ssl_key_file="C:\\certs\\my-web-key.key"
- ssl_crt_file
- Specifies the certificate file to use when SSL is enabled
Example:
ssl_crt_file="C:\\certs\\my-web-cert.crt"
- tcp_port
- The port that the Gateway is listening on, and uniquely identifies the service
Example:
tcp_port=8009
- timeout_atw_conn
- Inserts a time delay to ensure connection to the AcuToWeb Desktop is established before your application runs. Increase the
value of this option if you are having connection problems for applications requiring the AcuToWeb Desktop. The default value
is 100 (milliseconds); a suggested value is 450.
- timeout_interval
- The maximum time, in milliseconds, to wait for a connection to succeed before closing and retrying. See
Recovering Dropped Connections for list of related options.
Recommended value: 200000
- use_ssl
- Enables to use of SSL when connecting through the gateway
Example:
use_ssl=true
- webserver_port
- The port number that receives HTTP requests and routes them to the AcuToWeb Gateway
Example:
webserver_port=3000
- ws_compression
- Enables or disables WebSocket compression
Example:
ws_compression=true