xUML Runtime Command Line Options

RUNTIME 2020.7 The xUML Runtime can be started via the executable bridgeserver. Find below a collection of all commands and options that are accepted by bridgeserver.

Runtime Commands

Parameter	Shortcut	Description	Example
`--help`	`-h`	Shows a list of all commands as a help text.
`--version`	`-v`	Displays the Runtime version of the bridgeserver executable.	<Version><Label>2020.7</Label></Version>

Runtime Startup Options

When bridgeserver is started without one of the above mentioned commands, the specified xUML service is started with the provided options. Options instance and license are mandatory.

You can specify the startup options directly in the startup command, or provide them via a configuration file for reuse, see Configuration File below.

Parameter	Mandatory	Usage		Description	Allowed Values / Examples
Parameter	Mandatory	Command Line	Configuration File	Description	Allowed Values / Examples
`--instance`				Specify the path to the deployed xUML service repository that should be started.	/opt/bridge_data/bridge_CustomerQuery
`--license`				Specify the path to the xUML Runtime license file.
`--config`				Specify the path to a configuration file if you want to use one.
`--controller-only`				Only start the xUML Runtime controller service of the specified service. This can be helpful when inspecting persistent state services. You may want to list persistent state objects without starting the service itself. Starting the service would mean that pending persistent state objects would be processed.
`--logging.config.file`				Specify the path to a logging configuration file.
`--ps_object_url_template`				Specify how to build the URL to a persistent state object within the service. You may use the following placeholders: `%instanceName%`, `%stateClass%`, `%stateObject%` This URL will be logged in case of error and picked up e.g. by the Bridge Monitoring service to allow that users can switch to the erroneous state directly from the monitoring mail.	https://scheer-acme.com/pas-doc/bridge/admin/Console/BridgeInstanceStateObject? node=pas-doc&instance=%instanceName%&stateClass=%stateClass%&stateObject=%stateObject%
					`%instanceName%`	Name of the deployed xUML service instance.
					`%stateClass%`	Name of the persistent state class.
					`%stateObject%`	Persistent state object ID.
Bridge Configurations
`--ip`				Specify a specific IP address to bind the service to. This is relevant for machines with multiple IP addresses.	`0.0.0.0`	Any IP (default).
`--ip`					`123.456.789.12`	A valid IP address.
`--http.service.bind.default-af`				Specify a default bind address family. This option is only regarded if `--ip` is not set.	inet	Bind to IPv4 address 0.0.0.0.
`--http.service.bind.default-af`					inet6	Bind to IPv6 address [::] and use IPv4-mapped IPv6 addresses (default).
`--dirs.binary`				Specify the path to the bridgeserver binary directory. Generally the Runtime is able to derive this path, but there may be cases where you want to point the Runtime to a different path when looking up certain tabfiles SQL scripts for persistent state
`--dirs.data`				Specify the path to the bridgeserver data directory. This is only relevant if you are using the `run` command of the xuml-tool (see xUML Runtime Tool).
`--dirs.resource`				Specify the path to the directory where the xUML service resources are stored on your Bridge installation.
xUML Services Preferences
`--db.db2.instance`				Specify the path to an IBM DB2 instance (equivalent of `DB2INSTANCE` environment variable.)
`--db.db2.lib`				Specify the path to an IBM DB2 client library.
`--db.mysql.lib`				Specify the path to a MySQL client library.
`--db.sqlserver.lib`				Specify the path to an MS SQL Server client library. This is relevant for Linux only. On Windows, the MS SQL driver is globally available.

Configuration File

You can store common Runtime options that are valid for multiple services in a configuration file. These configurations can be applied on Runtime startup using the --config option as described above.

The basic format of the file is as follows:

Example

CODE

ps_object_url_template = https://scheer-acme.com/pas-doc/bridge/admin/Console/BridgeInstanceStateObject?node=pas-doc&instance=%instanceName%&stateClass=%stateClass%&stateObject=%stateObject%
ip = 123.456.789.12
license = G:\E2E_BRIDGE_DATA\license.xml
  
[dirs]
binary = G:\E2E_BRIDGE_PROG\bridgeserver-2020.7\win32-64
resource = G:\E2E_BRIDGE_DATA\resource

The format of the file is based on the INI format as described in the boost docoumentation. To shorten and group options, e.g. dirs.binary and dirs.resource, you can use section names ([dirs]) but this is not mandatory.

Related Pages: