isCOBOL WebClient : WebClient commands : Command-line startup options
Command-line startup options
The WebClient commands support the following command line options:
Option
Description
Default value
-c <arg>
Configuration file name.
A relative path is resolved from the WebClient’s bin directory
webclient/webclient.config in the WebClient installation directory
-d <arg>
Create a new temp folder for every intsance
false
-h <arg>
Local interface address where the web server will listen
0.0.0.0
-kp <arg>
Keystore password
 
-ks <arg>
Keystore file location for SSL configuration
 
-p <arg>
HTTP port where the web server will listen. If 0 HTTP is disabled.
8080
-s <arg>
HTTPS port where the web server will listen.If 0 HTTP is disabled.
 
-t <arg>
The temp folder will be created for the WebClient server.
A relative path is resolved from the WebClient’s bin directory
webclient/tmp in the WebClient installation directory
-tc <arg>
Clean the temp folder before WebClient start
true
-tp <arg>
Truststore password
 
-ts <arg>
Truststore file location for SSL configuration
 
-id <arg>
Server id (visible in admin console)
 
-ctx <arg>
Context path where WebClient is deployed.
Random uuid
-pf <arg>
Properties file name.
A relative path is resolved from the WebClient’s bin directory
webclient/webclient.properties in the WebClient installation directory
Note - hostname, ports and SSL configuration defaults are inherited from the jetty.properties configuration file and can be overridden by these command-line options. The values listed in this table reflect the content of the default jetty.properties file installed with isCOBOL and might be different if you edited that file.
Example
In order to start WebClient on the HTTP port 12345 using C:\Develop\mywebclient.config as configuration file, use the command:
webcclient -p 12345 -c C:\Develop\mywebclient.config
Startup configuration properties
The following properties can be specified on the command-line to customize the pathname of the logs directory and the pathname of the tmp directory:
Property
Description
webclient.logsDir
Specifies the directory where log files will be created. See Logging for the list of log files generated by WebClient commands.
This property takes a pathname in the form of a string and requires the file separator character at the end.
 
Example of valid setting:
 
webclient.logsDir=/tmp/logs/
 
If the directory doesn’t exist, it’s automatically created.
webclient.tempDirPath
Specifies the directory where temp files will be created.
This property takes a pathname in the form of a URI and requires the file separator character at the end.
 
Example of valid setting:
 
webclient.tempDirPath=file:/tmp/
 
If the directory doesn’t exist, an error occurs.
You can pass the options directly on the command-line by prefixing them with -J-D.
Example
In order to start WebClient having log files created under C:\Temp\Logs, use the command:
webcclient -J-Dwebclient.logsDir=C:\Temp\Logs
Alternatively, only on Windows, you can add these options in the vmoptions file of the desired WebClient command.
Example
Content of webclient.vmoptions to have log files created under C:\Temp\Logs:
# isCOBOL WebClient setting added from isCOBOL WEBC2022.1 setup
# Comments in .vmoptions files are prefixed by a hash, each VM option is on
# a separate line
# -Discobol.conf=myconf.properties
#-Xmx256m
#-Xms128m
-classpath/p .
-XX:+HeapDumpOnOutOfMemoryError
-Dwebclient.logsDir=C:/Temp/Logs/