Connecting to an xUML Service
After having imported the service description, all service resources are listed in the asynchronous (lower) part of the Trace Analyzer.
You can find the following:
(1) A state machine for each BPMN process that is part of the service.
(2) A list of rest resources that describe service interfaces.
(3) and (4) State machines and resources that are part of libraries being used in the imported service.
Service Resources Overview
An xUML service that has been compiled with the Designer contains some standard elements (see list below). Depending on what you want to inspect, you need to connect to a different element of the service. Find below a table listing all available resources from an xUML service.
Type | Description | Inspection Possibilities | Example | |||
|---|---|---|---|---|---|---|
| State Machine | State machine that represents the states of the BPMN process. |
|
| ||
| Service | Group of REST resources provided by the xUML service. |
|
| ||
| REST Resource | REST resource that is available within the service (top node). Resources are generated for:
|
|
| ||
| Operation | Operation that can be used to access the REST resource. | Depending on the resource:
|
| ||
Refer to How BPMN Elements Are Generated to xUML for hints which element to inspect for what use case.
Configuring the Connection Properties
You need to connect each resource/operation you want to inspect to the deployed service, and enable trace (see list of elements above). Select the element you want to inspect:
Refer to How BPMN Elements Are Generated to xUML for hints which element to inspect for what use case.
The content pane on the right displays the trace settings and actions for the selected element. The upper part of the content pane displays the configuration details:
(1) the service locations
(2) the trace settings
Service Locations
You have different configuration possibilities, depending on where your service is running.
Location | Description | Example | |
|---|---|---|---|
Service | Use this to connect to a service that is running locally, and where you do not need to authenticate. | ||
Custom | Use this to connect to a service that is running in the Designer test environment, and where you do not need to authenticate. | ||
| URL | Specify the URL to the service. For further information on how to get the URL of the service running in the test container, see below. |
|
Use OAuth2 | Not required | ||
User/Password | Not required | ||
Use this to connect to a custom service deployment, e.g. a containerized xUML service. | |||
URL | as e.g. defined with API Management. |
| |
Use OAuth2 | Check to be able to provide credentials for your connection. | ||
User/Password | Provide a valid user and password to connect to the service. | ||
Bridge | Use this to connect to a service running on an Integration (Bridge). | ||
| Protocol | Specify the protocol for connecting to the Integration (Bridge). |
|
Host | Specify the host the Integration (Bridge) is running on. |
| |
Port | Specify a port (if needed). |
| |
Path Prefix | Specify your PAS client as a path prefix, trailed by /bridge. |
| |
User/Password | Provide a valid Integration (Bridge) user and password to connect to the service. | ||
How to Get the Custom Location of Services Running in the Designer Test Environment
Open the application of the respective service via Open Application 
The application opens in a new tab:
Copy the URL of the application up to angular/ui/ ... from the address bar of your browser:
Paste the URL to the field Custom in section Locations of the Analyzer:
Append /xuml/21111/api to the URL:
Trace Settings
You can configure the tracing process itself using the following settings:
Setting | Description | Possible Values / Examples | |
|---|---|---|---|
Trace Level | Specify the trace level: truncated or full. | Truncated | Collect limited tracing information from the service (default):
This option is useful for services with high data load. |
Full | Collect a full trace, means all runtime values without limitations. This may result in a large amount of storage capacity being used. | ||
Max. Size (MB) | Limit the size of the trace being collected to a certain amount of disc space. | 10 | The default is 10 MB. |
Inspection List | Limit the amount of data collected by selecting only certain parts of the execution path that should be traced.  | ||
Start Tracing
Once you have configured the service location and the trace settings as required, you can activate the tracing by clicking Enable Trace / Apply.
Also use this button after you have changed some of the configurations and want to apply the changes.
The Trace Analyzer displays trace being active on the selected element by highlighting it with green color:
Be aware of the fact, that trace is now enabled on the service. Even if you close the Analyzer now, trace is still running on the service, data being collected, and stored to the service context.
Keeping trace running on multiple services may lead to file storage issues on your server.
Click Disable Trace (see Stop Tracing below) to stop tracing the service.
Stop Tracing
After you are done with tracing, disable trace by clicking Disable Trace.
The Trace Analyzer displays trace being not activated on the selected element by highlighting it with orange color:
Related Pages: