Page History
...
- unpack a repository to a chosen directory
- deploy a repository
- run a repository
- dump some info on the repository
- specify dedicated xUML service settings for deployment
System Requirements
This tool only works on Linux and xuml-tool 1.4.0Windows operating systems. You , though not all commands are available on Windows.
Command | Linux | Windows | |
---|---|---|---|
unpack | |||
deploy | |||
run | |||
dump-info (and all show commands) | |||
validate |
On Linux, you need at least
- Linux kernel 4.19
- GLibc 2.28
Commands
unpack
Common Options
All commands of the xuml-tool 1.0.0Unpack a given repository file to the destination directory.
The repository will be unpacked to a sub-directory in the destination directory. The name of the sub-directory is derived from the repository file name.accept the following common options:
Option | Description | Parameters / Options | Mandatory||
---|---|---|---|---|
Allowed Values | Example | Path to a repository file. | a valid path | |
-h | Show either the help of the xuml-tool (including a list of all available commands), or the help of the selected command. | xuml-tool | ||
deploy --verbose ./hello_world.rep | ||||
Path to a parent directory to extract the repository to. |
deploy
xuml-tool 1.0.0Deploy a given repository to a given destination.
The repository will be unpacked to a sub-directory in the destination directory.The name of the sub-directory is derived from the composite service name.
Info | ||
---|---|---|
| ||
Repositories that have been deployed with this command satisfy xUML Runtime requirements and can be run by starting the xUML Runtime as described on xUML Runtime Command Line Options. They do not satisfy Bridge requirements, though, and cannot be managed with a Bridge. Do not use |
...
name | deploy |
---|
...
| |||
--help-all | Show the complete help of the xuml-tool: all options, all commands. | ||
-log | Set the log level for the used command. | off | No logging. |
critical | Only log critical errors. | ||
error | Log all errors. | ||
warning | Log errors and warnings. | ||
info | Log errors, warnings, and some general information (default). | ||
debug | Log errors, warnings, general and debug information. | ||
trace | Log a complete trace. | ||
-m | Disable all logging. | ||
-v --verbose | Enable debug logging. |
Commands
unpack
xuml-tool 1.0.0Unpack a given repository file to the destination directory.
The repository will be unpacked to a sub-directory in the destination directory. The name of the sub-directory is derived from the repository file name.
...
Parameters / Options | Mandatory | Description | Allowed Values | Example | |
---|---|---|---|---|---|
Path to a repository file. |
a valid path | xuml-tool |
...
unpack ./hello_world.rep |
...
. | ||
Path to a parent directory to extract the repository to. | ||
-- |
...
create- |
...
Specify a value for setting ${server_hostname}
. Upon deploying to a Bridge, this setting is replaced automatically by the configured external host name. When deploying with xuml-tool, it must be set explicitly.
Info | ||
---|---|---|
| ||
|
...
directories | xuml-tool 1.5.0Create missing directories instead of aborting the command. | 0 | Do not create missing directories (default). | |
1 | Create missing directories during the command. | |||
--tmp-files-policy | xuml-tool 1.5.0Specify whether to keep or remove temporary files used during the execution of this command. |
| Keep the temporary files. | |
| Remove the temporary files (default). |
deploy
...
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.
run
xuml-tool 1.0.0Deploy and run a given repository .
This command uses the deploy
command described above in combination with Runtime command bridgeserver (see xUML Runtime Command Line Options).
...
to a given destination.
The repository will be unpacked to a sub-directory in the destination directory.The name of the sub-directory is derived from the composite service name.
Info | ||
---|---|---|
| ||
Repositories that have been deployed with this command satisfy xUML Runtime requirements and can be run by starting the xUML Runtime as described on xUML Runtime Command Line Options. They do not satisfy Bridge requirements, though, and cannot be managed with a Bridge. Do not use |
...
Table Excerpt | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
|
...
|
...
Provide the path to an an xUML Runtime configuration file containing Runtime command line options. The contents of such a file are described on xUML Runtime Command Line Options.
This file must at least contain a minimal configuration consisting of
- the path to a license file (
license
) - the path to the bridgeserver binary directory (
dirs.binary
) - the path to the data directory (equivalent of the Bridge data directory) (
dirs.data
)
|
...
|
...
|
...
|
...
show-modules
show-notes
show-services
show-settings
show-ui
in one command.
...
xuml-tool dump-info ./hello_world.rep --format json-pretty --include-passwords=0
...
Specify in which format the information should be displayed.
...
human-readable
...
Display the results in a human-readable way.
This format is not meant for any kind of automatic parsing. It may change anytime in the future.
...
|
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.
run
xuml-tool 1.0.0Deploy and run a given repository.
This command uses the deploy
command described above in combination with Runtime command bridgeserver (see xUML Runtime Command Line Options)
show-modules
xuml-tool 1.3.0Display information on the modules inside the repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool | show-modulesrun ./hello_world.rep --server- | formatconfig | json-pretty config.json | formathuman-readable | Display the results in a human-readable way (default). | |||||||
json | Display the results in compressed JSON. | ||||||||||||||
json-pretty | Display the results in pretty JSON. |
Output
Expand | ||
---|---|---|
| ||
|
...
modules
...
"2021-10-04T09:37:05+02:00"
...
"7.18.0-rc-9d5770a"
...
"REST_AccessSupportManagerExample"
...
"accessSupportManager.xml"
...
composite
...
Module is a service composite.
...
"7.0.0"
show-notes
xuml-tool 1.3.0Display the documentation and model notes from a repository.
...
xuml-tool show-notes ./hello_world.rep --format json-pretty
...
Specify in which format the information should be displayed.
...
human-readable
...
Display the results in a human-readable way (default).
This format is not meant for any kind of automatic parsing. It may change anytime in the future.
...
Output
Expand | ||
---|---|---|
| ||
|
...
notes
...
"<html>\n <head>\n\t\t<style>\n\t\t\tp {padding:0px; margin:0px;}[...]
server-hostname scheer-acme.com | |||||||||
--server-config | Provide the path to an an xUML Runtime configuration file containing Runtime command line options. The contents of such a file are described on xUML Runtime Command Line Options. This file must at least contain a minimal configuration consisting of
| a valid path to a configuration file | |||||||
--server-hostname | Specify a value for setting
| localhost | Default value if not specified. | ||||||
a valid external host name | |||||||||
--existing | Specify what to do if the repository being deployed is already existent in the target directory. | remove | Remove the repository from the target folder if already existent, and deploy the new repository. | ||||||
delete | |||||||||
overwrite | Overwrite files of an already existing repository. | ||||||||
abort | Abort deployment if the repository is already existent (default). | ||||||||
--forced-ps-owner-id | xuml-tool 1.4.0Set this value as a fix persistent state ower ID for this service.
| a positive integer | |||||||
--global-variables-file | xuml-tool 1.5.0Replace global variables in setting values with the values specified in the given file. The file is a JSON file containing key/value pairs like
You need to manually create this file. | a valid JSON file containing the variable names and values | |||||||
--create-directories | xuml-tool 1.5.0Create missing directories instead of aborting the command. | 0 | Do not create missing directories (default). | ||||||
1 | Create missing directories during the command. | ||||||||
--tmp-files-policy | xuml-tool 1.5.0Specify whether to keep or remove temporary files used during the execution of this command. |
| Keep the temporary files. | ||||||
| Remove the temporary files (default). |
dump-info
xuml-tool 1.3.0Display all information on a repository. This command prints the information returned by
show-addons
show-modules
show-notes
show-services
show-settings
show-ui
in one command
...
true
...
false
...
"accessSupportManager_1031998347.html"
show-services
xuml-tool 1.3.0Display all information on services contained in a repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Path to a repository file. | Provide
| a valid path | xuml-tool | showdump- | servicesinfo ./hello_world.rep --format json-pretty | |||||||||||||||
--format | Specify in which format the information should be displayed. | human-readable | Display the results in a human-readable way (default). | |||||||||||||||||||
json | Display the results in compressed JSON (default). | |||||||||||||||||||||
json-pretty | Display the results in pretty JSON. | |||||||||||||||||||||
--include-passwords=1 | Specify if passwords should be printed in clear text. |
...
0 |
...
Hide passwords. |
...
1 |
...
Display passwords (default). |
show-addons
xuml-tool 1.5.0Display the add-ons used by the repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool show-addons ./hello_world.rep --format json-pretty | ||||||||||||||
--format | Specify in which format the information should be displayed. |
| Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. |
Output
Expand | ||
---|---|---|
| ||
|
show-modules
xuml-tool 1.3.0Display information on the modules inside the repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool show-modules ./hello_world.rep --format json-pretty | ||||||||||||||
--format | Specify in which format the information should be displayed. |
| Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. |
Output
Expand | ||
---|---|---|
| ||
|
Output | Description | Values / Example | |||
---|---|---|---|---|---|
| Array containing model details within this repository as an array element each. | ||||
compilationDate | Compilation timestamp. | "2021-10-04T09:37:05+02:00" | |||
compilerVersion | Version of the xUML Compiler used for compilation. | "7.18.0-rc-9d5770a" | |||
name | Name of the module. | "REST_AccessSupportManagerExample" | |||
source | Name of the module source file. | "accessSupportManager.xml" | |||
type | Module type. | composite | Module is a service composite. | ||
library | Module is a library. | ||||
version | Module version. | "7.0.0" |
show-notes
xuml-tool 1.3.0Display the documentation and model notes from a repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool show-notes ./hello_world.rep --format json-pretty | ||||||||||||||
--format | Specify in which format the information should be displayed. |
| Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. |
Output
Expand | ||
---|---|---|
| ||
|
Output | Description | Values / Example | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| Array containing the service definitions notes within this repository as an array element each. | endpoints | Array of service endpoints (HTTP based services). | descriptor | Descriptor of the service (available for REST services only). | "/e2e.rest.descriptors/xUMLControllerService.xUML Runtime API.yaml" | ||||
name | Name of the service endpoint. | "xUML Runtime API" | ||||||||
path | Path of the service endpoint. | "/api" | ||||||||
version | Version of the service endpoint (available for REST services only). | "1.2.0" | ||||||||
name | Name of the service as displayed in the Bridge UI. | "xUMLControllerService" | ||||||||
port | Service port. | 29035 | ||||||||
type | Service type. | unknown | Other service type than listed below. Service types that cannot be recognized by the xuml-tool will be listed as unknown. | |||||||
control | xUML Controller service. | |||||||||
event_observer | Event observer service. | |||||||||
http | HTTP service. | |||||||||
java | Java service. | |||||||||
jms | JMS listener service . | |||||||||
jvm | JVM service for Java adapter. | |||||||||
rest | REST service. | |||||||||
sap | SAP service. | |||||||||
scheduler | Scheduler service. | |||||||||
shadow | SOAP shadow service for testing purposes. | |||||||||
soap | SOAP service. | |||||||||
timer | Timer service. | |||||||||
xslt | XSLT service for XSLT adapter. | |||||||||
wsdl | Relative link to the WSDL file (SOAP services only). | /HelloWorldService?wsdl |
show-settings
xuml-tool 1.3.0Display all information on the settings of a repository.
...
xuml-tool show-seetings ./hello_world.rep --format json-pretty --include-passwords=1
...
Specify in which format the information should be displayed.
...
human-readable
...
Display the results in a human-readable way (default).
This format is not meant for any kind of automatic parsing. It may change anytime in the future.
...
doc | Service documentation text. | "<html>\n <head>\n\t\t<style>\n\t\t\tp {padding:0px; margin:0px;}[...] | |||
isIndex | Origin of the documentation. |
| Model notes from main service. | ||
| Model notes from library or module. | ||||
name | File name of the documentation in the repository. | "accessSupportManager_1031998347.html" |
show-services
xuml-tool 1.3.0Display all information on services contained in a repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool show-services ./hello_world.rep --format json-pretty
| ||||||||||||||
--format | Specify in which format the information should be displayed. |
| Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. |
Output
Expand | ||
---|---|---|
| ||
|
Output | Description | Values / Example | |||
---|---|---|---|---|---|
| Array containing the service definitions within this repository as an array element each. | ||||
endpoints | Array of service endpoints (HTTP based services). | ||||
descriptor | Descriptor of the service (available for REST services only). | "/e2e.rest.descriptors/xUMLControllerService.xUML Runtime API.yaml" | |||
name | Name of the service endpoint. | "xUML Runtime API" | |||
path | Path of the service endpoint. | "/api" | |||
version | Version of the service endpoint (available for REST services only). | "1.2.0" | |||
name | Name of the service as displayed in the Bridge UI. | "xUMLControllerService" | |||
port | Service port. | 29035 | |||
type | Service type. | unknown | Other service type than listed below. Service types that cannot be recognized by the xuml-tool will be listed as unknown. | ||
control | xUML Controller service. | ||||
event_observer | Event observer service. | ||||
http | HTTP service. | ||||
java | Java service. | ||||
jms | JMS listener service . | ||||
jvm | JVM service for Java adapter. | ||||
rest | REST service. | ||||
sap | SAP service. | ||||
scheduler | Scheduler service. | ||||
shadow | SOAP shadow service for testing purposes. | ||||
soap | SOAP service. | ||||
timer | Timer service. | ||||
xslt | XSLT service for XSLT adapter. | ||||
wsdl | Relative link to the WSDL file (SOAP services only). | /HelloWorldService?wsdl |
show-settings
xuml-tool 1.3.0Display all information on the settings of a repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
>
|
| a valid path | xuml-tool show-seetings ./hello_world.rep --format json-pretty | ||||||||||||||
--format | Specify in which format the information should be displayed. |
| Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. | ||||||||||||||||
--include-passwords=0 | Specify if passwords should be printed in clear text. | 0 | Hide passwords (default). | ||||||||||||||
1 | Display passwords. |
Output
Expand | ||
---|---|---|
| ||
|
Output
Expand | ||
---|---|---|
| ||
|
Output | Description | Values / Example | |||
---|---|---|---|---|---|
| Array containing the service settings as an array element each. | ||||
aliases | Array of setting name aliases. This array also includes the name property (see below). | [ | |||
category | Setting category. In the Bridge UI, the setting sections (see below) are grouped by this category (see xUML Service Settings). | "Add-Ons" | |||
defaultValue | Default value of the setting. | "true" | |||
label | _ | Label of the setting in the Bridge UI (default language). | "RESTService: ConfigurationRest: enabled: " | ||
name | External (friendly) name of the setting. Use this name to build the environment variable as described below (see xUML Service Settings). | "AO_RESTSERVICE_CONFIGURATIONREST_ENABLED" | |||
schema | Extended JSON schema of the setting type. | ||||
type | Type of the setting. Possible types are: string, integer, boolean and password (masked string). | "string" | |||
section | Setting section within a category (see above). All settings of a section are listed together in the Bridge UI (see xUML Service Settings). | SQL Adapter Authorization |
show-ui
xuml-tool 1.3.0Display all information on UIs contained in a repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool show-seetings ./hello_world.rep --format json-pretty | ||||||||||||||
--format | Specify in which format the information should be displayed. | human-readable | Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. |
Output
Expand | ||
---|---|---|
| ||
|
Output | Description | Values / Example | |||
---|---|---|---|---|---|
| Array containing the UIs within this repository as an array element each. | ||||
name | Name of the UI. | "index" | |||
path | Relative path to the UI. | "/ui/index.html" | |||
port | UI port. | 11113 |
validate
xuml-tool 1.5.0Check the repository and report duplicate data items. This command is useful for support cases only.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool validate ./MongoDBAdapter_CustomerManagement_Example.rep | ||||||||||||||
--format | Specify in which format the information should be displayed. |
| Display the results in a human-readable way (default). | ||||||||||||||
json | Display the results in compressed JSON. | ||||||||||||||||
json-pretty | Display the results in pretty JSON. | ||||||||||||||||
--tmp-files-policy | Specify whether to keep or remove temporary files used during the execution of this command. |
| Keep the temporary files. | ||||||||||||||
| Remove the temporary files (default). |
Output
Expand | ||
---|---|---|
| ||
|
...
settings
...
|
...
"Add-Ons"
...
"true"
...
"RESTService: ConfigurationRest: enabled: "
...
"AO_RESTSERVICE_CONFIGURATIONREST_ENABLED"
...
"string"
...
SQL Adapter Authorization
show-ui
xuml-tool 1.3.0Display all information on UIs contained in a repository.
...
xuml-tool show-seetings ./hello_world.rep --format json-pretty
...
Specify in which format the information should be displayed.
...
human-readable
...
Display the results in a human-readable way (default).
This format is not meant for any kind of automatic parsing. It may change anytime in the future.
...
Output
Expand | ||
---|---|---|
| ||
|
...
ui
...
"index"
...
"/ui/index.html"
...
xUML Service Settings
A service repository contains lots of tab files that describe the service. Concerning xUML service settings, these tab files contain variable content that is substituted on deployment by default setting values.
Using the xuml-tool, you can overwrite those default by defining special environment variables on your system. The name format of these environment variables have to follow the following scheme: XUMLT_S_<setting id>
. <setting id>
is the friendly id of a setting as displayed by the show-settings
command, settings.name property of the output structure.
xuml-tool 1.5.0Also, you can replace the global variables by values provided from a file with option --global-variables-file
on the deploy
and on the run
command.