Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
| |||||||||
Image Modified |
| ||||||||
| |||||||||
You can change the Current Value of a service setting. The Default Value is displayed next to the current value. The Default Value is displayed next to the current value. Click Save after you have completed your changed.
Please note:
| |||||||||
Image Removed | As there are many available settings, use the filter field to search for the setting you want to modify. The content of the filter field is applied to the columns Category, Section and Key. | ||||||||
Image Removed | Click the filter icon Image Removed to display the extended filter options:
If a filter is applied, the filter icon changes: Image Removed. | ||||||||
Image Removed | In the main filter window, you can reset all selected filters. Click icon Image Removed Reset Filter. In the filter option window, you can also reset the selection. |
xUML Service Settings
The settings are categorized into the following:
- Global Settings: In this category, you can change setting values that are global to the xUML service. Deployment information retrieved with deployment macros can be overwritten in this category, too (see Global Settings below).
- Add-ons: In this category, the settings comprise add-on related values like tagged values, interface URIs, and others. For instance, data of the SQL adapter, File System adapter, Timer, or SOAP service request may be overwritten. For more details, refer to the example in Add-on Settings.
| |||||||||
Image Added |
| ||||||||
Image Added |
| ||||||||
Image Added |
| ||||||||
Image Added |
|
xUML Service Settings
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Global Settings
Settings Group | Setting | Description | Allowed Values | ||
---|---|---|---|---|---|
Settings / Deployment Macros | Service Composite | ||||
getCompositeCategory | Value returned by Action Language macro getCompositeCategory(). Initial value of this setting is the category specified in the service details (see Managing the Service Details). | any string | |||
getCompositeName | Value returned by Action Language macro getCompositeName(). Initial value of this setting is the service name. | any string | |||
getCompositeVersion | Value returned by Action Language macro getCompositeVersion(). Initial value of this setting is the service version in the service details (see Managing the Service Details). | a version string | |||
PAS Platform | |||||
AuthenticatorEnabled | Specify whether users are allowed to identify themselves using an x-pas-user header instead of a bearer token.
| true | Allow using an x-pas-header or a bearer token for authentication (default). | ||
false | Authentication only by bearer token. | ||||
AuthService::minimalAccessTokenLifeSpan | Define when a refresh token should be triggered. Default is 30 (if the token last less than 30 seconds it will be refreshed before it is used).
| any integer | |||
KeycloakInstance::clientId | Specify the clientId to use when authenticating the service. Default is keycloak-clientId.
| any string | |||
KeycloakInstance::clientSecret | Specify the clientSecret associated to the clientId. Default is keycloak-clientSecret.
| any string | |||
KeycloakAlias:Location:host | Specify the hostname (domain) of the Keycloak SSO system. Default is keycloak-host. | any string | |||
KeycloakAlias:Location:basePath | Specify the subpath of the Keycloak system. Default is keycloak-basePath. | any string | |||
KeycloakAlias:Location:port | Specify the port of the Keycloak system. Default cannot be changed. | 8080 | |||
KeycloakAlias:Location:protocol | Specify the protocol of the Keycloak system. Default cannot be changed. | http | |||
PasSecurityService::allowAnonymous | Specify whether anonymous users (no PAS users) should be allowed to send requests to the PAS BPMN service. In contrast to anonymous users, PAS users are identified by a bearer token or x-pas-user header). If this setting is set to false, requests of unauthenticated users will return HTTP error 401.
| true | Allow anonymous access (default). | ||
false | Access for identified users only. | ||||
Service | |||||
<service settings> | In your Designer service, you can define name-value pairs using the setting macro in an implementation. These values can be modified here. |
Add-on Settings
Each xUML service adapter has its own settings that are initialized in the xUML model and can be changed in the configuration.
If you are running an xUML service that is connecting to a database backend, you can modify the tagged values of the database interface respectively dependency. Before starting a deployed xUML service that connects to a database backend, you may want to redefine required database parameters.
SQL Adapter Connection Settings
This tagged value controls the connection pooling. If true, each connection is put into a pool after use. If an SQL adapter requires a connection, it is taken from the pool. If no connection is available, a new connection is being created and put into the pool after use. The time the connection is kept in the pool depends on the other pooling parameters.
This tagged value controls how often a connection can be re-used. After the connection has been re-used for maxConnectionReuse , it will be closed and not put back into the pool. This feature has been introduced because some databases had problems if the connection was re-used too often. Value -1 means the connection will be re-used forever. In this case you should define reasonable values for maxConnectionAge or maxConnectionIdleTime (see above).
Info |
---|
Note that the pooling is implicitly switched off, if maxConnectionReuse is set to 0. |
Connections not used for the time specified (in minutes) will be closed and removed from the pool.
This is useful for connections going through firewalls because such connections might be cut off after some time.
For more information on the SQL adapter settings (other tagged values, default values, ...) refer to the xUML Services Reference Guide.
SQL Adapter Authorization Settings
These settings allow you to adapt the SQL database user and password of the xUML service.
Other Add-on Settings
Generally, most of the add-on settings that are related to an xUML Service Adapter have a corresponding tagged value in the component diagram. Refer to the documentation of the corresponding adapter for these settings.
Find below a list of other add-on settings and their description. For the sake of completeness, we also mentioned settings coming from the model for some setting groups (see column Specified in Model on).
Only dump errors with the specified code.Specify a Bridge user defined error code.
Info |
---|
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled. |
Only dump errors of the specified error domain. Specify a Bridge user defined error domain.
Info |
---|
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled. |
Enable/Disable writing an error dump file for errors that have been caught in the xUML service model.
Info |
---|
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled. |
Change the name of the persistent state object owner here. Each persistent state object is owned by a persistent state engine. If you change the owner setting, all subsequently created persistent state objects will belong to the new owner.
Note |
---|
All existing persistent state objects of the old owner will not been processed anymore by this service as they belong to a different owner now. |
Specify the worker limit.
Workers defines the maximum number of parallel threads used to process pending events. The default setting is 5, which is used if none or 0 workers are configured. The implications of more or less workers are discussed in xUML Service Reference Guide > Performance Considerations of Persistent State .
Specify the Browser caching options for the YAML file by setting a value for HTTP header Cache-Control
.
For more information on this header, refer to Cache-Control on the Mozilla pages.
Cache-Control
.For more information on this header, refer to Cache-Control on the Mozilla pages.
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
SQL Adapter Connection Settings
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
SQL Adapter Authorization Settings
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Other Add-on Settings
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Switch the service port on / off. When the service port is deactivated, it will not accept any request anymore.
Specify the JSON compose option for the REST request/response.
When jsonCompact is true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. jsonCompact defaults to true - also on re-compile of an older model with Builder as of 7.0.0-beta3.
Specify the JSON compose option for the REST request/response.
When jsonKeepNulls is true, attributes of the REST response object having NULL values will be rendered to the REST response, otherwise they will be left out completely (refer to xUML Service Reference Guide > NULL Values ).
Switching tracing on / off.
All xUML services are compiled with tracing enabled. This option allows you to turn off the tracing, so that no trace information is returned by the Bridge when a service is called.
Switch the service port on / off. When the service port is deactivated, it will not accept any request anymore.
Specify the Browser caching options for the UI files (HTML, CSS, ...) by setting a value for HTTP header Cache-Control
.
For more information on this header, refer to Cache-Control on the Mozilla pages.
${server_hostname}
Expert Mode
Use the checkbox Expert Mode to display further options:
Option | Description |
---|---|
RAM | Use the slider to increase or decrease the RAM of a service. This option allows you to avoid that one service can comsume all resources. Default is 256 MB, the RAM maximum is 4 GB. You can change the RAM in steps of 64 MB. |
Name | If you want to set xUML service settings for containerized services from the outside using the xuml-tool, you will need the Name (= friendly Id) as the environment variable. Refer to Integration Platform User's Guide > xUML Runtime Tool for details. |
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
|
Otp | ||||
---|---|---|---|---|
|
Panel | ||
---|---|---|
| ||