...

Table Filter

fixedCols
totalrow	,,,
hidelabels	false
ddSeparator
sparkName	Sparkline
hidePane	Filtration panel
limitHeight
sparkline	false
default	,,,
isFirstTimeEnter	true
cell-width	250,250,250,250
hideColumns	false
totalRowName
totalColName
disabled	false
enabledInEditor	false
globalFilter	true
id	1679991952419_232691829
iconfilter
order	0,1,2,3
hideControls	true
inverse	false,false,false,false
numbering
datefilter
column
sort	Chapter ⇧,Name ⇧
totalcol
disableSave	false
rowsPerPage
separator	Point (.)
labels	Chapter‚Name‚Excerpt‚Filter whole table
thousandSeparator
ignoreFirstNrows
ddOperator
userfilter	Chapter,Name,Excerpt
datepattern	dd M yy
numberfilter
heightValue
updateSelectOptions	false
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
showNRowsifNotFiltered

Chapter Name Excerpt Usage

Administration

kubernetes_tab

Multiexcerpt

MultiExcerptName	kubernetes_tab

On top of the Kubernetes section, you find the information about

API Version: Defines the versioned schema of this representation of a Kubernetes workload.
Labels: Map of string keys and values that can be used to organize and categorize (scope and select) workloads.
Annotations: Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

Click Show all to display all available labels or annotations.

Below this information, you can find the two tabs Pod and Networking.

Pod

Tab Pod contains the sections General and Container. The information displayed in the two sections is read-only.

Pod - General

Section General contains common information about the Pod:

Name

Version name of the Pod.

Type

Shows the internal type of the replication controller.

Scaling

If available, you can adapt the number of Pod replicas, see below.

Replicas

Shows the number of Pod replicas.

Icon Color	Status
Green	Running
Orange	Starting
Red	Not running/erroneous

Additional Labels

Shows additional Pod labels if set.

Anchor

	change_replica_number
	change_replica_number

Scaling the Number of Replicas

Move the position of the slider to the desired number of replicas you want to set.

Click Apply.

A pop-up window opens displaying the number of replicas before and after the change.

Click Scale to confirm your choice or Cancel to abort.

The new number of replicas is displayed after a refresh of the browser tab.

Pod - Container

Section Container consists of several tabs, one tab for each container:

<Service Name> (default)

fluentd (for all services except type nestjs)

.

Anchor

	ports_volumes
	ports_volumes

The content of the tabs is the same for all containers and displays the container details:

Name

Name of the container.

Image

Image of the container.

Ports and Volumes

See below.

Memory and CPU

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.

Tip

Visit the official Kubernetes documentation for more information:

Resource Management for Pods and Containers for detailed information abour requests and limits.
Scheduling, Preemption and Eviction about the rules regarding the termination of pods.

If you click the link Ports and Volumes, the container details open in a separate pop-up.

Ports: Displays a list of all ports exposed portsin the internal network.
Volumes: Lists all mounted volumes.

Use the filter on top of each list to search for single ports or volumes.

Networking

Tab Networking gives you an overview on the details of the service mesh.

Use the filter to search for a port name.

Administration

xuml_service_add_on_settings

Multiexcerpt

MultiExcerptName	xuml_service_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

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 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.

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.

Info
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.

Info
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.

Info
This setting takes no effect if Dump not Caught Errors/Dump Context on Error is disabled.

true

Create a service dump for caught errors.

false Disable service dump for caught errors (default).

Dump not Caught Errors: enabled Enable/Disable writing an error dump file at all. This setting corresponds to the xUML service preference Dump Context on Error (refer to Integration Platform User's Guide > Preferences of an xUML Service). true 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.

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.

Worker Limit

Composite

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 .

REST Service HTTP Server

Descriptor: Cache Control: value

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.

true

Service port is active (default).

false Service port is deactivated.

<your service name>:JSONComposerOptions: compact

REST Service

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.

true

Generate compact JSON (default).

false Generate pretty JSON.

<your service name>: JSONComposerOptions: keepNulls

REST Service

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 ).

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.

true

Service port is active (default).

false Service port is deactivated.

<your service name>: <your port type>: URI Component diagram 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.

a fully qualified system name

Administration

xuml_service_deletion

Multiexcerpt

MultiExcerptName	xuml_service_deletion

If you want to delete a containerized xUML service, use the Delete Service button on top of the Details section.

Please note, that the deletion of a service has several consequences:

The service container (deployment) will be removed from the current system.
The registered routes are purged.
Persisted data stored in this service will be removed.

The Delete button is only enabled if you insert the correct service name.

Administration

xuml_service_documentation

Multiexcerpt

MultiExcerptName	xuml_service_documentation

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.

Administration

xuml_service_endpoints

Multiexcerpt

MultiExcerptName	xuml_service_endpoints

In API Management, you can use

the private descriptor URL

to create an API

.

During API creation, paste the descriptor URL in field API Endpoint in tab Implementation. Go to API Management Guide > API Settings for details.

Column

Description

Possible Values

Name

Name of the registered endpoint.

Any string.

Type

Type of the registered endpoint.

control
rest
shadow
soap
ui

URL

Click the URL to copy the secured endpoint URL to the clipboard.
Use icon to display the internal endpoint URL to the clipboard.

Any URL.

Test

Click the icon to open an interface to test the application/API. The test interface is available on running services only.

Interface/Descriptor

Click icon to download the description (OpenAPI/WSDL) of the service interface.
Click icon to copy the private descriptor URL.

Tip

title	Expert Advice

Administration

xuml_service_settings

Multiexcerpt

MultiExcerptName	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.

Note

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.

All Documentations

portal_login_forgot_password

Multiexcerpt

MultiExcerptName	portal_login_forgot_password

Forgotten Password

	If you have forgotten your password, use the link Forgot Password? below the Sign in button.
	First enter your username, then click on the Send New Password button.
	The following message will be displayed: An Email to reset your password has been sent. The email will be sent to the address stored for your account in the user administration. Check your mailbox.
	The email sent contains a link. This link is valid for 15 minutes. Click on the link to reset your password.
	The link takes you to a page where you can change your password yourself. Enter your new password in the first line. Confirm the new password by entering it again in the second line.
	If the password and the password confirmation do not match, your will not be able to submit your request. In that case, please enter your password again and make sure that your input is identical.
	Use icon to show your input. This helps you to check your passwords for typos.
	Your password has also to match the password criteria. Hover over the question mark to show the valid criteria.
	If you entered the new password click Submit. After a successful change of your password you will directly be logged in. Your are redirected to the Scheer PAS Portal.

All Documentations

portal_logout

Multiexcerpt

MultiExcerptName	portal_logout

There are several ways to finish your work in Scheer PAS.

	Using the logout button is the safest way to finish your work session: The current session is terminated in all tabs and the login page is displayed.
	The logout button is also available in the header menu if you have opened a tool in a separate browser tab.
	Alternatively you can close the browser tab, but this will not end your Scheer PAS session and is therefore not recommended.

User Management

standard_admin_profiles

Multiexcerpt

MultiExcerptName	standard_admin_profiles

Table Filter

hideControls	true
inverse	,,
sparkName	Sparkline
separator	Point (.)
labels	‚‚
default	,,
isFirstTimeEnter	true
cell-width	,,
userfilter	Profile,Description
datepattern	dd M yy
globalFilter	true
id	1679993155018_707575804
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
order	0,1,2

Portal Tile

Profile

Description

Further Information

PAS Version

Image Modified

administration_user

Grants full access to the platform component administration, all platform services are displayed.

Administration Guide > Administrating the Platform Components

PAS 21.1

xuml_container_admin

Grants limited access to the platform component administration, only customer-specific services are displayed.

Administration Guide > Administrating the Platform Components

PAS 22.1

Image Modified

analytics_admin

Grants access to the Process Mining view in the user management.
Allows to create and manage templates in Scheer PAS Process Mining.

Image Modified

api_management_admin

Grants access to the administration menu in the API Management UI and the API Developer Portal.

API Managament > Administration

PAS 21.1

Image Modified

keycloak_user

Grants access to the login page of the identity management tool Keycloak. You will need separate credentials to log in to Keycloak.

Info
The Keycloak installation is not part of Scheer PAS Single Sign-on.

Administration Guide > Using Keycloak

PAS 21.1

Image Modified

kibana_user

Grants access to the Log Analyzer.

Administration Guide > Using Kibana

PAS 21.1

Image Modified

pas_admin_user

Grants access to the administration menu in the Designer.

Designer Administration

PAS 21.1

Image Modified

user_management_admin

Grants access to the user management.

Info
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.

Administration Guide > Administrating Users

PAS 21.1

Deprecated Profiles*

-

platform_admin

Until version 20.1.8 this profile granted access to the user management.

-

Deprecated as of PAS 21.1

-

rpa_admin

Until version 20.1.8 this profile granted access to the RPA view in the user management.

-

Deprecated as of PAS 21.1

* in use until version 20.1.8

User Management

standard_user_profiles

Multiexcerpt

MultiExcerptName	standard_user_profiles

Table Filter

hideControls	true
inverse	false,false,false
sparkName	Sparkline
separator	Point (.)
labels	‚‚
default	,,
isFirstTimeEnter	false
cell-width	,,
userfilter	Profile,Description
datepattern	dd M yy
globalFilter	true
id	1679993179815_-885708532
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
order	0,1,2

Portal Tile

Profile

Description

Further Information

PAS Version

Image Modified

api_devportal_user

Grants access to the API Developer Portal.

Developer Portal

PAS 21.1

Image Modified

api_management_user

Grants access to API Management.

APIMGMNT

PAS 21.1

Image Modified

analytics_user

Grants access to Process Mining.

Additional profiles for Integration users:
- _dashboard_access_processes: Grants access to the complete process data.
- _dashboard_access_transactions: Grants access to the complete transaction data.

Info
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.

MINING

Image Modified

bpaas_design_user

bpaas_execution_user

Both profiles grant access to BPaaS.
- bpaas_design_user: Allows to model processes.
- bpaas_execution_user: Allows to execute apps.

Info
A BPaaS design user needs both profiles to be able to model and execute apps.

Additional profiles for BPaaS users:
- ml_user: Grants access to the Machine Learning adapter in the BPaaS editor.
- mobile_autosync: Grants access to the option Sync instances automatically in the user preferences of the Mobile app.

Image Modified

cron_manager

Grants access to the Cron Manager.

Administration Guide > Administrating Cron Jobs

PAS 20.1

Image Modified

file_manager_user

Grants access to the File Manager, the UI of the file storage.

Managing File Resources

PAS 21.1.2

Image Modified

integration_user

Grants access to the Integration (Bridge).

Integration (Bridge)

PAS 21.1

-

pas_base

Grants access to the Portal and contains basic permissions for the Scheer PAS platform.

START

PAS 20.1

-

portal_base

Grants access to the PAS Portal with a minimal set of required permissions.
The profile is a subset of pas_base. It is automatically assigned during a user self registration process.

START

PAS 22.1.1

Image Modified

pas_user

Grants access to the Designer.

DESIGNER

PAS 20.1

Image Modified

process_monitor_user

Grants access to the Process Monitor.

PAS 21.1.2

Image Modified

xuml_monitor_user

Grants access to the xUML Service Monitor.

Administration Guide > Monitoring Integration Services

PAS 21.1.4

Deprecated Profiles*

-

rpa_robot

Until version 20.1.8 this profile had to be assigned to the robot user (RPA).

-

Deprecated as of PAS 21.1

-

rpa_user

Until version 20.1.8 this profile had to be assigned to the execution and design users to use RPA.

-

Deprecated as of PAS 21.1

* in use until version 20.1.8

...

Page tree

Versions Compared

Old Version 20

New Version 21

Key

Pod

Pod - General

Pod - Container

Networking

SQL Adapter Connection Settings

SQL Adapter Authorization Settings

Other Add-on Settings

Forgotten Password

Page tree

Page History

Versions Compared

Old Version 20

New Version 21

Key

Pod

Pod - General

Pod - Container

Networking

SQL Adapter Connection Settings

SQL Adapter Authorization Settings

Other Add-on Settings

Forgotten Password