Group | Name | Excerpt |
---|
Action Language | deprecated_alias_macros | Multiexcerpt |
---|
MultiExcerptName | deprecated_alias_macros |
---|
| Info |
---|
| All macros that get information from aliases are deprecated since Builder 7.5.0. Please use the new Alias Reader instead. |
|
|
Adapter | correlation_ID | Multiexcerpt |
---|
MultiExcerptName | correlation_ID |
---|
| 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. |
|
Logging | date_picker | Multiexcerpt |
---|
MultiExcerptName | date_picker |
---|
| 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: Color | Meaning |
---|
dark blue border
| Today. | dark blue
| The selected date. | bright blue
| A weekday on which data has been logged. | light blue
| A weekend day on which data has been logged. | grey | A day on which no data has been logged. | Select a day, enter a time (if necessary), and click OK to apply the selected date to the search field. |
|
Logging | date_search | Multiexcerpt |
---|
MultiExcerptName | date_search |
---|
| 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.
|
|
Logging | ls_date_filter_settings | Multiexcerpt |
---|
MultiExcerptName | ls_date_filter_settings |
---|
| 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. Info |
---|
| If you close your Browser with the Logging tab open, and start your Browser again with restoring all recent tabs (session restore), your date filter settings will be reloaded from your previous search. |
|
|
Logging | ls_search_for | Multiexcerpt |
---|
MultiExcerptName | ls_search_for |
---|
| 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. |
|
PState | pstate_owner | Multiexcerpt |
---|
MultiExcerptName | pstate_owner |
---|
| 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. |
|
PState | pstate_service_transfer | Multiexcerpt |
---|
MultiExcerptName | pstate_service_transfer |
---|
| 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. |
|
PState | pstate_warning_external_attributes | Multiexcerpt |
---|
MultiExcerptName | pstate_warning_external_attributes |
---|
| Note |
---|
| Do not switch an attribute between internal and external unless you are sure that no objects of the related class are still pending in the persistent state db. The attribute contents will get lost in this case. This behavior will be improved in future versions. |
|
|
Service | get_pid | Multiexcerpt |
---|
| 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: System | Command / Output |
---|
Linux | Code Block |
---|
| 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 [...] | Windows | Run with administration privileges: Code Block |
---|
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 | |
|
Service | http_headers | Multiexcerpt |
---|
MultiExcerptName | http_headers |
---|
| Runtime 2019.9 Bridge services read the following HTTP headers containing correlation information: - X-Transaction-ID
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. |
|
Service | http_headers_adapter | Multiexcerpt |
---|
MultiExcerptName | http_headers_adapter |
---|
| Runtime 2019.9 xUML service adapters add the following HTTP headers containing correlation information to the request: - X-Transaction-ID
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. |
|
Service | kill_service | Multiexcerpt |
---|
MultiExcerptName | kill_service |
---|
| 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(). |
|
Service | stop_service | Multiexcerpt |
---|
MultiExcerptName | stop_service |
---|
| Bridge 7.2.0 Clicking Stop will send SIGTERM to the service. Older Bridges called Java Process.destroy(). |
|
Service | transaction_id | Multiexcerpt |
---|
MultiExcerptName | transaction_id |
---|
| 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.
- 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. |
|
Service Preferences | automatic_restart | Multiexcerpt |
---|
MultiExcerptName | automatic_restart |
---|
| Whenever the service crashes, it will restart immediately. Nevertheless, in the navigation the icon next to the xUML service name will indicate the abnormal termination. |
|
Service Preferences | automatic_startup | Multiexcerpt |
---|
MultiExcerptName | automatic_startup |
---|
| Select this option, if you want the service to startup automatically, whenever the Bridge is started. Only users who are member of a group, to which the role ADMIN has been assigned, are allowed to change this option. Info |
---|
| 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. |
|
|
Service Preferences | minimum_uptime | Multiexcerpt |
---|
MultiExcerptName | minimum_uptime |
---|
| To allow the Bridge to distinct whether the service has crashed during start-up or not, specify the minimum uptime of the Node.js service in seconds. Implications: - If the service crashes during the uptime period, the Bridge will assume that the service could not be started. No Automatic Restart will be applied.
- If the service crashes after the uptime period, the Bridge will assume a crash. If option Automatic Restart is set, the Bridge will try to restart the service.
|
|
Service Preferences | owner | Multiexcerpt |
---|
| The group id of the user who has deployed the service. Only users who are member of a group, to which the role ADMIN has been assigned, are allowed to modify the owner of the service. |
|
Update | service_startup_after_update | Multiexcerpt |
---|
MultiExcerptName | service_startup_after_update |
---|
| 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. |
|