_bridge_excerpts

Runtime 2021.6 Use writeTypeDiscriminator to suppress the generation of xUML type properties ("e2e:type") to the generated JSON. If this option is true, the Runtime will write the original xUML type to the generated JSON in form of "e2e:type": "<name of the original xUML type>" if the type being serialized does not match the expected metadata.

The xUML Runtime assigns a correlation ID to each adapter call. This ID is stored in header field X-Bridge-CorrelationID. Adapter calls can be identified by this ID. Also, it is logged to the transaction log.

Builder 7.12.0 Runtime 2020.12 In the context of HTTP based adapters (URL, REST, SOAP), enable automatic header generation for the listed headers. These definitions overwrite the default behavior, and X-Transaction-Id, X-Request-Id, X-Sender-Host and/or X-Sender-Service will be substituted by this definition.

requestHttpHeaderRoles can hold a list of definitions in format <http header name>:<role>, that will automatically be generated for each adapter call on this alias. <role> can be one of the listed allowed values (one list entry per line).
Refer to HTTP Header Support > Overwriting the Standard HTTP Headers for more details on header roles.

The BRIDGE is delivered with comprehensive documentation. Apart from this self-study, the BRIDGE also comes with many examples you can have a look at. Each feature is subject of an example that is ready to run.

This chapter provides an overview about all documentation available after installation. How to access the xUML examples is explained on Unzipping Examples.
The complete documentation is available online.

Never change the guilessinstaller.properties after first installation, but use the same file for every update afterwards!

Bridge 5.1.39.6 Bridge 6.0.40.2 Only exception is, when you are moving from a version below 6.0.40.2/5.1.39.6 to a higher version. Since then, the settings console.ip.address and console.hostname are mandatory. It is necessary that you edit your existing guilessinstaller.properties file before making an update installation. If you don't specify these settings, you will get additional node instances and proxy nodes and won't be able to deploy services anymore.

• If console.hostname is empty use the value of Node Instance Name you find on the Preferences tab of the BRIDGE node instance.
• If console.ip.address is empty use 0.0.0.0.

When filtering the log entries of a service by date and time, you can use a date picker to select a date from/to. Click the date picker icon  next to the input fields to open the a tiny calendar to pick the dates from.

The time part will be only visible if the related log entries contain a time part in format "HH:MM:SS". In all other cases, it is not possible to select log entries by time.

Some dates within the calendar are colored to help you finding the appropriate date:

Select a day, enter a time (if necessary), and click OK to apply the selected date to the search field.

Select the date/time range you want to inspect.

• Upon opening the logging tab, from is set to (now - 10 minutes) if there are log entries existing within this range of time. If not, from will be set to the point of time the first entries are found.  
  
• An empty to field displays all log entries from the from date/time until the most recent entries.
  An empty from field triggers a search backwards until the first entries are found.
• You can remove the time part of the to field to search until the end of the day, and of the from field to search from the beginning of the day.

Click View to update the displayed logging information.
As per default, for logs with a time stamp the log entries are displayed latest first in the search results. Click the tiny arrow in the table header to change the order to oldest first.

The date filter settings will be kept as long as your Browser tab is open. They will be reset to default as soon as you open the Logging tab in a new Browser tab.

Insert a string or a valid regular expression to search the log entries for. Only log entries that match the expression will be displayed.
Refer to Java Regular Expressions for more information on which regular expressions you can use here.

Pressing Enter in this field triggers the search.

The Persistent State Control Adapter gives access to persistent state metadata directly from within a service (self context). The same data can be retrieved using the xUML Runtime API.

In Load Balancing context, when e.g. running multiple Bridges, you can setup persistent state services to share persistent state objects. The persistent state objects are distinguished by an owner and owner id reflecting the actual service that owns these objects.
Prerequisite is that these services share the same persistent state database, see Load Balanced Persistent State for more details.

Transfer the service to another Bridge (e.g. by service export and re-deployment).
In this case, you also need to transfer file PersistentState.tab from the service directory (<your Bridge data directory>/<service directory>) to the new location. This file contains the actual owner ID of the service. If not present, a new owner ID will be assigned and all objects with the old owner ID will still be stalled.

If the service is up and running, you can see the system process id (PID) of the service. To match the PID with the Bridge service, you can also use system commands:

ps -efa | grep -- --instance

...  15228  ...  /opt/e2e_bridge_prog/nodejs-8.11.4/linux-64/node index.js --instance /opt/e2e_bridge_data/nodejs_NodeService
...  15265  ...  /opt/e2e_bridge_prog/nodejs-8.11.4/linux-64/node app.js --instance /opt/e2e_bridge_data/nodejs_api-test-helloworld_43
...  15853  ...  /opt/e2e_bridge_prog/j2re-11.0.2/linux-64/bin/java -jar repository.jar --instance /opt/e2e_bridge_data/java_helloworld

wmic process where "caption='bridgeserver.exe' or caption='node.exe' or caption='java.exe'" get processid,caption,commandLine /format:csv| findstr /C:--instance

...,bridgeserver.exe,"C:\E2E_BRIDGE_PROG\bridgeserver-2018.12\win32-64\bridgeserver.exe"  --config "C:\var\E2E_BRIDGE_DATA\server.cfg" --instance "C:\var\E2E_BRIDGE_DATA\bridge_SoapWait",17600
...,node.exe,C:\E2E_BRIDGE_PROG\nodejs-8.11.4\win32-64\node app.js "--instance C:\var\E2E_BRIDGE_DATA\nodejs_api-test-helloworld",20144

Runtime 2020.12 If the standard HTTP header handling does not meet your needs, you can take control of the header handling by defining your own header roles.
Refer to HTTP Header Support > Overwriting the Standard HTTP Headers for a detailed explanation of how to use this feature.

Runtime 2019.9 Bridge xUML services read the following incoming HTTP headers containing correlation information:

• X-Transaction-Id or xTransactionId (in JMS context)
  This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one.
  This header will be passed through the callstack to identify all service calls that belong to a transaction.
• X-Request-Id 
  This header should identify the unique request.
• X-Sender-Host and X-Sender-Service
  These headers should contain the sender host resp. the sender service.

These headers will be all logged to the transaction log. Having this information, you can use this for error analysis or usage metrics.

Runtime 2019.9 With xUML service adapter calls, the xUML Runtime adds the following outgoing HTTP headers containing correlation information to the request:

• X-Transaction-Id or xTransactionId (in JMS context)
  This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one.
  This header will be passed through the callstack to identify all service calls that belong to a transaction.
• X-Request-Id
  This header identifies the unique request. The Runtime generates a unique number for each adapter call.
• X-Sender-Host and X-Sender-Service
  These headers contain the sender host resp. the sender service. They are set by the Runtime automatically.

Transaction id and request id will be logged to the transaction log on the adapter call. Having this information, you can use this for error analysis or usage metrics.

Runtime 2020.11 Header information as a map. The map contains arrays of header value strings whereas the header name is the key of the map.

• Header names are lowercase and treated case insensitive.
• Multiple headers with the same name are treated as arrays.

Refer to HTTP Header Support for more information on the standard xUML HTTP headers.

Bridge 7.2.0 The Kill functionality will first try to regularly stop the service. When the service is still running after 10 seconds, it will forcibly terminate the service with Java Process.destroyForcibly().

Runtime 2021.2 Specifies the maximum size of the request in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the payload of the service exceeds the given maximum, incoming request are rejected.

Runtime 2022.6 Specifies the maximum size of the request header in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the header payload of the service exceeds the given maximum, incoming request are rejected.

Bridge 7.2.0 Clicking Stop will send  SIGTERM to the service.
Older Bridges called Java Process.destroy().

The Transaction ID identifies a transaction. It is a unique number used to trace service calls through the call stack of multiple service calls.

• Runtime 2019.9  Clients calling a service running on the Bridge can provide a transaction ID in HTTP header X-Transaction-ID or xTransactionId (in JMS context).
• SOAP clients can also use the SOAP headers to provide a transaction ID.
• If an xUML service is called without providing a transaction ID, the xUML Runtime will generate such an ID.

This ID will be passed on through the call stack of the xUML service, so that the whole transaction can be traced. This can be useful, when analyzing the log file in case of error.

When updating the BRIDGE, all deployed services (xUML, Node.js, and Java services) will be kept. However, the automatic startup option will be ignored on the very first start-up after the update.