This space contains files and text snippets that are used throughout the Scheer PAS documentation.
This content is not meant to be read independently from the rest of the documentation.
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Chapter
Name
Excerpt
Usage
Administration
history_log
The administration application gives you access to the history of a containerized xUML service ( PAS 24.0 ).
To access the service history, open the details page of the service and go to section History Log.
In the History Log section you can inspect the service history. The log shows all actions of the xUML service (creation, start, stop etc.) including setting changes.
The content of the history log is read-only.
Use the filter field to search for a specific entry.
The content of the filter field is applied to the column Action only.
Click Extended filter to display the extended filter options:
Action
User
If a filter is applied, the extended filter changes to .
Both extended filter options are loaded dynamically:
Option Action only lists actions that have already been executed in the service.
Option Users only lists users who have already performed an action in the service.
In the main filter window, you can reset all selected filters. Click Reset Filter.
In the filter option window, you can also reset the selection.
Shows the container limitations. If a container exceeds its memory request and the node that it runs on becomes short of memory overall, it is likely that the Pod the container belongs to will be evicted.
Limitations cannot be changed by users. They are set during system deployment
Limits
Requests
Memory
If the memory limit is exceeded, the container will run in state OutOfMemory and then be killed.
If a container exceeds its memory request and the node that it runs on becomes short of memory overall, it is likely that the Pod the container belongs to will be evicted.
CPU
If the CPU limit is exceeded, the container will be throttled, the process will slow down.
If the CPU memory request exceeds the nodes (server) capacity, the Pod can be stopped and stared on a different node.
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
Key
Value
DBType
Name of the SQL Service component, e.g. SQLite
DBName
Name of the database, e.g. ScheerACME_Customers
Connection Pooling
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.
Max Connection Reuse
This tagged value controls how often a connection can be re-used. After the connection has been re-used formaxConnectionReuse, 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-1means the connection will be re-used forever. In this case you should define reasonable values formaxConnectionAgeormaxConnectionIdleTime(see above).
Note that the pooling is implicitly switched off, ifmaxConnectionReuseis set to 0.
Max Connection Age
After a given connection age (in minutes) the connection will be closed and removed from the pool.
Max Connection Idle Time
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.
Key
Value
customers: DBUser
Database user
customers: DBPassword
Database password
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).
Settings Group
Setting
Specified in Model on
Description
Allowed Values
Dump Configuration
Caught Error Code
Only dump errors with the specified code.Specify a Bridge user defined error code.
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled.
a string
Caught Error Domain
Only dump errors of the specified error domain. Specify a Bridge user defined error domain.
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled.
a string
Dump Caught Errors: enabled
Enable/Disable writing an error dump file for errors that have been caught in the xUML service model.
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled.
Create a service dump for not caught errors (default).
false
Disable service dump for not caught errors. This disables error dump at all.
Persistent State
Owner
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.
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 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.
Test Tool: Cache Control: value
Specify the Browser caching options for the Swagger UI by setting a value for HTTP header Cache-Control. For more information on this header, refer to Cache-Control on the Mozilla pages.
REST Service Base
<your service name>: enabled
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.
WhenjsonCompactis true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON.jsonCompactdefaults to true - also on re-compile of an older model with Builder as of 7.0.0-beta3.
true
Generate compact JSON (default).
false
Generate pretty JSON.
<your service name>: JSONComposerOptions: keepNulls
Specify the JSON compose option for the REST request/response.
WhenjsonKeepNullsis 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).
true
Render attributes with NULL values to the REST call.
false
Leave out attributes with NULL values in the REST call (default).
<your service name>: MaximumConnections:
Change the maximum number of parallel requests to the service port.
<your service name>: Port
Change the port the xUML service listens to. The original value comes from the SOAP service component.
a valid port number
<your service name>: ResolveHostnames
Define whether the host name is logged to the service logs instead of the IP address.
true
Resolve the IP address to the hostname in the service logs (default).
false
Write the IP address to the service logs.
SOAP HTTP Server
Allow Tracing
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.
true
The Runtime returns tracing information on request (default).
false
The Runtime does not return tracing information.
Maximum Connections
Change the maximum number of parallel requests to the service port.
ResolveHostnames
Define whether the host name is logged to the service logs instead of the IP address.
true
Resolve the IP address to the hostname in the service logs (default).
false
Write the IP address to the service logs.
<your service name>Port
Change the port the xUML service listens to. The original value comes from the SOAP service component.
a valid port number
SOAP HTTP Server Request
<your service name>: <your port type>: enabled
Switch the service port on / off. When the service port is deactivated, it will not accept any request anymore.
Change the service URI. The default value comes from the component diagram of the xUML service.
SOAP HTTP UI Server
Library Cache Control: value
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.
WSDL: <your service name>
WSDL: <your service name> host
Specify the host name of the server for the xUML service WSDL.
${server_hostname}
Name of the Bridge node instance the service is deployed to.
Open the Documentation section to display the documentation of the xUML service.
Use the list Select Document to choose the documentation you want to see.
The list contains:
The documentation of the xUML service itself (if it is a service that has been created in the Designer, you will see the content of field Description from the service details page).
The documentation of the libraries that are used in the service.
Click the URL to copy the secured endpoint to the clipboard.
Click to display the URL of the internal endpoint . Click the URL to copy it to the clipboard.
Any URL.
Test
Click Open to switch to the interface that allows you to test the application/API. The test interface is available on running services only.
The PAS platform features an xUML Runtime API for each service. You can use the interface to obtain information on the states of the service's state machines in general, and to trigger state transitions. Refer to xUML Runtime API Reference for a comprehensive list of all available requests.
-
Interface/Descriptor
Click Download to download the description (OpenAPI/WSDL) of the service interface. Click Copy to clipboard to copy the private descriptor URL.
-
API
Click Import to import the API to Scheer PASAPI Management. A wizard will support you in creating the API in API Management. Refer to Creating an API in the API Management Guide for details.
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 (seeGlobal Settingsbelow).
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 inAdd-on Settings.
You can modify settings of a service no matter if the service is running or if it has been stopped. Saving the changes triggers a re-create and restart of the container. Changing the settings on a stopped service will start the service. Settings will be stored, so if you stop the service and restart it, the settings are restored.
If you delete a service, all settings are lost and cannot be recovered.
You can only access the User Management if profile user_management_admin has been assigned at least to one user. Therefore, every Scheer PAS installation is delivered with one standard user management admin.
_dashboard_access_processes: Grants access to the complete process data.
_dashboard_access_transactions: Grants access to the complete transaction data.
BPaaS customers do not need the two additional profiles. But they can use the profile _dashboard_access_processes to grant an administrator access to all processes available in the system for use in Process Mining.