Page History
Div | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Runtime 2020.7 xuml-tool 1.0.0 The xUML Runtime Tool xuml-tool is a tool that provides means to work with xUML repositories. You can
...
- Linux kernel 4.19
- GLibc 2.28
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 | 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. |
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.
...
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).
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||
---|---|---|---|---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be deployed and started. The deploy target directory is derived from the configuration file specified with --server-config . | a valid path | xuml-tool run ./hello_world.rep --server-config config.json | ||||||
--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). |
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 defined in file substitutions.xml.
Code Block | ||||
---|---|---|---|---|
| ||||
<Substitutions>
[...]
<Variables>
<Variable default="2" friendlyId="AL_PS_WORKERLIMIT"
name="ALIAS_Persistent State_WorkerLimit"
type=""/>
[...]
</Variables>
[...]
<Display>
<Category label="Add-Ons">
<Section label="Persistent State">
<Override label="Persistent State: WorkerLimit: "
variable="ALIAS_Persistent State_WorkerLimit"/>
[...]
</Section>
[...]
</Category>
[...]
</Display>
[...]
</Substitutions> |
To find this file, unpack the service repository. You can find this file in the root directory.
Refer to the picture below for how to find the friendly id of a setting and use it to build the name of the environment variable.
...
dump-info
xuml-tool 1.3.0Display all information on a repository. This command prints the information returned by
show-modules
show-notes
show-services
show-settings
show-ui
in one command.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |
---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be analyzed. | a valid path | xuml-tool dump-info ./hello_world.rep --format json-pretty --include-passwords=0
| ||
--format | Specify in which format the information should be displayed. | human-readable | Display the results in a human-readable way. | ||
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-modules
xuml-tool 1.3.0Display information on the modules inside the repository.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |
---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be analyzed. | a valid path | xuml-tool show-modules ./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 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 | |
---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be analyzed. | a valid path | xuml-tool show-notes ./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 service notes within this repository as an array element each. | ||||
doc | Service documentation text. | "<html>\n <head>\n\t\t<style>\n\t\t\tp {padding:0px; margin:0px;}[...] | |||
isIndex | Origin of the documentation. | true | Model notes from main service. | ||
false | 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 | |
---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be analyzed. | a valid path | xuml-tool show-services ./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 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 | |
---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be analyzed. | a valid path | xuml-tool show-seetings ./hello_world.rep --format json-pretty --include-passwords=1
| ||
--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. | ||||
--include-passwords=0 | Specify if passwords should be printed in clear text. | 0 | Hide passwords (default). | ||
1 | Display passwords. |
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 | |
---|---|---|---|---|---|
Path to a repository file. | Provide the path to the repository file to be analyzed. | 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 |
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
...
.