Versions Compared

Old Version 291

changes.mady.by.user Annegret Bernhardt

Saved on

compared with

New Version Current

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: default_log_files adapted

...

Table Filter
totalrow,,,
hidelabelsfalse
sparkNameSparkline
hidePaneFiltration panel
sparklinefalse
default,,,
isFirstTimeEnterfalse
cell-width150,150,150,150
hideColumnsfalse
disabledfalse
enabledInEditorfalse
globalFiltertrue
id1678969416914_-746687494
order0,1,2,3
hideControlstrue
inversefalse,false,false,false
sortChapter ⇧,Name ⇧
disableSavefalse
separatorPoint (.)
labelsChapter‚Name‚Excerpt‚Filter whole table
userfilterChapter,Name,Excerpt
datepatterndd M yy
updateSelectOptionsfalse
worklog365|5|8|y w d h m|y w d h m
isORAND


ChapterNameExcerptUsage
Administrationaccess_docker_logs_details


Multiexcerpt
MultiExcerptNameaccess_docker_logs_details
  • Open the details page of the service, open section Logs and click on the Log Analyzer link.


Administrationaccess_docker_logs_icon


Multiexcerpt
MultiExcerptNameaccess_docker_logs_icon

You have two options to access the logs:

  • Click Open logs in the quick actions bar in the services' list.


Administrationapplicable_actions


Multiexcerpt
MultiExcerptNameapplicable_actions


Info

Only applicable actions are enabled.



Administrationchange_docker_log_level_details


Multiexcerpt
MultiExcerptNamechange_docker_log_level_details
  • Open the details page of the service and scroll down to section Logs.


Administrationchange_docker_log_level_icon


Multiexcerpt
MultiExcerptNamechange_docker_log_level_icon

You have two options to open the input form where you can change the log level:

  • Click Change log level in the quick actions bar in the services' list. This will open a pop-up window.


Administrationchange_nestjs_log_level_1


Multiexcerpt
MultiExcerptNamechange_nestjs_log_level_1

On the details page of a pas-nestjs service, scroll down to section Logs and expand the section.


Administrationchange_nestjs_log_level_2


Multiexcerpt
MultiExcerptNamechange_nestjs_log_level_2

If you open the pop-up window via the quick actions, you have the same options for the Configuration of the logs:

  • Global (default)
  • Custom


Administrationchange_nestjs_log_level_3


Multiexcerpt
MultiExcerptNamechange_nestjs_log_level_3

Global

In the global configuration, you set the log level for all sinks.

Available log levels are:

  • verbose
  • trace
  • debug
  • info
  • warn
  • error
Info

If you have turned down the log level to see more logs, do not forget to turn it up again after you have finished your analysis. The performance of the system may deteriorate if a lot of logs are stored for a long time. The log level settings are reset to its default value during a restart of the service.



Administrationchange_nestjs_log_level_4


Multiexcerpt
MultiExcerptNamechange_nestjs_log_level_4
  • Save your changes to apply them to the service.
  • Use Reset to return to the default value. In most cases this is info.
  • If you opened the pop-up window from the quick action menu in the service list, you have also a Cancel button. Click Cancel to discard your changes and to close the pop-up window.


Administrationchange_nestjs_log_level_5


Multiexcerpt
MultiExcerptNamechange_nestjs_log_level_5

Custom

The Custom tab allows a fine grained setting of the log level.

For each channel, you can set the log level for the different sinks:

  • Console
  • OpenSearch (relevant for analyzing log entries via Log Analyzer)

Use the Filter to show only the channels you are looking for.


Administrationchange_nestjs_log_level_6


Multiexcerpt
MultiExcerptNamechange_nestjs_log_level_6

In the Custom tab, option Save will only be enabled when at least one of the entries has been changed.


Administrationdetailsdefault_log_pagefiles


Click on a name in the service list to open its details page.
The details page shows you the title of the service and some quick action icons:

Multiexcerpt
MultiExcerptNamedetailsdefault_log_page
IconDescription
Image Removed
Shows the current state of the service.
Image Removed

Starts the service.

Image Removed
Stops the service.
Image Removed
Restarts the service.
files


Info
titleDefault Retention Time of Log Files

The following retention times are valid for log files of your PAS installation:

  • Container logs: Log files inside all containers are deleted after 7 days.
  • Log Analyzer (OpenSearch) logs:
    • Single cluster: Log files are deleted after 14 days.
    • High Availability cluster: Log files are deleted after 30 days.
  • Integration (Bridge) logs: The default retention time for Bridge logs is 30 days. This is configurable in the UI, refer to Integration Platform User's Guide > Node Instance Preferences.



Administrationdetails_pageAdministrationdetails_section


Multiexcerpt
MultiExcerptNamedetails_section

On top of the Details section, you can find the option Delete Service (refer to Deleting a Service below for further information). The boxes General, Build and Deployment contain read-only information.

Administrationdocker_information
page

Click on a name in the service list to open its details page.
The details page shows you the title of the service and some quick action icons:

IconDescription
Image Added
Shows the current state of the service.
Image Added

Starts the service.

Image Added
Stops the service.
Image Added
Restarts the service.



Multiexcerpt
MultiExcerptNamedocker_information

The Information section contains the main information about the container:

  • Name
  • Source is Docker for Docker containers
  • Type
  • Created/Updated
  • Version
Administrationdockerdetails_typessection


Multiexcerpt
MultiExcerptNamedockerdetails_typessection

On top of the Details section, you can find the option Delete Service (refer to Deleting a Service below for further information). The boxes General, Build and Deployment contain read-only information.


Administrationdocker_information


Multiexcerpt
MultiExcerptNamedocker_information

The Information section contains the main information about the container:

  • Name
  • Source is Docker for Docker containers
  • Type
  • Created/Updated
  • Version


Administrationdocker_types


Multiexcerpt
MultiExcerptNamedocker_types
  • database
  • init
  • other
  • pas-app
  • pas-nestjs
  • pas-service
  • undefined
  • xuml-legacy-service
  • xuml-service (=
  • database
  • init
  • other
  • pas-app
  • pas-nestjs
  • pas-service
  • undefined
  • xuml-legacy-service
  • xuml-service (= services created in Designer or with deployment wizard)
Info

Other service types may be displayed.



Administrationinfo_nestjs_configurationservices


Multiexcerpt
MultiExcerptNameinfo_nestjs_services

For services of type pas-nestjs, the information section also contains a link to the Swagger UI.


Administrationinfo_xuml_servicesDeprecated mit 24.0 - löschen, wenn version 24.0 published ist


Multiexcerpt
MultiExcerptNameinfo_nestjsxuml_configurationservices


For services of type pas-nestjs (= internal services of the PAS platform) developers can define a service-specific schema and documentation. If a schema is available, the display in section Configuration will change and show the defined configuration options.

Info
titleException for Services of Type pas-nestjs
Note

Be careful: Changing these options may result in an unusable service and may affect other parts of the platform as well.

Administration

This option is only available for type xuml-service (= containerized xUML services).



Administrationinfo_nestjs_services
inspect_docker_logs



Multiexcerpt
MultiExcerptName
info
inspect_
nestjs
docker_
services

For services of type pas-nestjs, the information section also contains a link to the Swagger UI.

logs

Both ways will open the logs of the corresponding Docker container in the Log Analyzer where you can view, filter and search the platform log s for all services.


AdministrationAdministrationinfo_xuml_serviceskubernetes_acces_to_xuml_logs


Multiexcerpt
MultiExcerptNameinfokubernetes_acces_to_xuml_services
Info

This option is only available for type xuml-service (= containerized xUML services).

logs

The administration application gives you access to the logs of Kubernetes workloads.


Administrationinspectkubernetes_docker_logsinformation


Multiexcerpt
MultiExcerptName
inspect
kubernetes_
docker_logs

Both ways will open the logs of the corresponding Docker container in the Log Analyzer where you can view, filter and search the platform log s for all services.

information

The Information section contains the main information about the Kubernetes workload:

  • Name
  • Source is Kubernetes for workloads
  • Type
  • Created/Updated
  • Version


Administrationkubernetes_acces_to_xuml_logsonly


Multiexcerpt
MultiExcerptNamekubernetes_acces_to_xuml_logs

The administration application gives you access to the logs of Kubernetes workloads.

only


Info

This feature is only available in a Kubernetes setup.



Administrationkubernetes_informationtypes


Multiexcerpt
MultiExcerptNamekubernetes_information

The Information section contains the main information about the Kubernetes workload:

  • Name
  • Source is Kubernetes for workloads
  • Type
  • Created/Updated
  • Version
Administrationkubernetes_only Multiexcerpt
MultiExcerptNamekubernetes_only
Info

This feature is only available in a Kubernetes setup.

types
  • custom
  • gitea
  • java
  • minio
  • other
  • pas-app
  • pas-nestjs
  • pas-service
  • postgresql
Administrationkubernetes_types
Multiexcerpt
MultiExcerptNamekubernetes_types
  • custom
  • gitea
  • java
  • minio
  • other
  • pas-app
  • pas-nestjs
  • pas-service
  • postgresql
  • unknown
  • xuml-legacy-service
  • xuml-service (= services created in Designer or with deployment wizard)
Info

Other service types may be displayed.



Administrationkubernetes_xuml_logs_open


Multiexcerpt
MultiExcerptNamekubernetes_xuml_logs_open

Both ways will open the logs of the corresponding Kubernetes workload in the Log Analyzer where you can view, filter and search the platform logs for all services.


Administrationlog_analyzer_opens


Multiexcerpt
MultiExcerptNamelog_analyzer_opens

The Log Analyzer will open, showing you the corresponding logs.


Administrationlog_section_not_available


Multiexcerpt
MultiExcerptNamelog_section_not_available

The Logs section also informs you if there are no logs available for a service type.


Administrationnote_bridge_user_guide


Multiexcerpt
MultiExcerptNamenote_bridge_user_guide


Tip

Go Refer to the Bridge User Guide for detailed information about the functionalities of the integration component.



Administrationnote_config_json


Multiexcerpt
MultiExcerptNamenote_config_json


Note

Do not edit content in the Configuration section without any knowledge of JSON.



Administrationnote_config_not_available


Multiexcerpt
MultiExcerptNamenote_config_not_available

The Configuration section also informs you if the configuration UI is not available for a service type.


Administrationnote_log_level


Multiexcerpt
MultiExcerptNamenote_log_level


Info

This option is only available for type pas-service (= PAS applications without UI).



Administrationopen_container_details


Multiexcerpt
MultiExcerptNameopen_container_details

You can open a details page for each container.

To do so, click on the service name in the list.


Administrationopen_docker_configuration_details


Multiexcerpt
MultiExcerptNameopen_docker_configuration_details
  • Open the details page of the service and scroll down to section Configuration.


Administrationopen_docker_configuration_icon


Multiexcerpt
MultiExcerptNameopen_docker_configuration_icon

The administration application allows you to change the configuration of a Docker container.

You have two options to open the configuration of a container:

  • Click Edit configuration in the quick actions bar in the services' list.


Administrationopen_log_analyzer_via_link


Multiexcerpt
MultiExcerptNameopen_log_analyzer_via_link

In the Logs section of the service details page, you can also use the link Open Log Analyzer to inspect logs.


Administrationopen_workload_details


Multiexcerpt
MultiExcerptNameopen_workload_details

You can open a details page for each workload.

To do so, click on the service name in the list.


Administrationpas_nestjs_configuration_intro


Multiexcerpt
MultiExcerptNamepas_nestjs_configuration_intro

For services of type pas-nestjs (= internal services of the PAS platform) developers can define a service-specific schema and documentation. If a schema is available, the display in section Configuration will change and show the defined configuration options.

Note

Be careful: Changing these options may result in an unusable service and may affect other parts of the platform as well.



Administration

reset_log_level


Multiexcerpt
MultiExcerptNamereset_log_level


Info

If you have turned down the log level to see more logs, do not forget to turn it up again after you have finished your analysis. The performance of the system may deteriorate if a lot of logs are stored for a long time. The log level settings are reset to its default value during a restart of the service.



Administrationservice_definition


Multiexcerpt
MultiExcerptNameservice_definition


Info

What is the difference between pas-app and pas-service?

  • pas-app: Applications accessible via UI.
  • pas-service: Applications without UI.



Administrationservice_type_docker


Multiexcerpt
MultiExcerptNameservice_type_docker

indicates a Docker container.


Administrationservice_type_integration


Multiexcerpt
MultiExcerptNameservice_type_integration

indicates an integration service.


Administrationservice_type_kubernetes


Multiexcerpt
MultiExcerptNameservice_type_kubernetes

indicates a Kubernetes workload.


Administrationservices_list


Multiexcerpt
MultiExcerptNameservices_list

All available services are displayed in the list on the administration start page.


Administrationservices_list_date


Multiexcerpt
MultiExcerptNameservices_list_date

Shows the date and time of the last update of the service. If the service has not been updated yet, its creation date is displayed.


Administrationservices_list_date_format


Multiexcerpt
MultiExcerptNameservices_list_date_format

Datetime in format dd.mm.yyyy, hh:mm:ss


Administrationservices_list_name


Multiexcerpt
MultiExcerptNameservices_list_name

Name of the service. Click on the name to access the service details page.


Administrationservices_list_status


Multiexcerpt
MultiExcerptNameservices_list_status

Indicates the status of the service.


Administrationservices_list_type


Multiexcerpt
MultiExcerptNameservices_list_type

Indicates the type of the service.


Administrationtip_details_on_containerized_services


Multiexcerpt
MultiExcerptNametip_details_on_containerized_services


Tip

Go to page Controlling Containerized xUML Services for For detailed information how to handle containerized xUML services after successfull deployment., refer to one of the following pages (depending on your setup):



Administrationtip_log_analyzer_usage


Multiexcerpt
MultiExcerptNametip_log_analyzer_usage


Tip

Go Refer to page Analyzing Platform Logs for further information. If you access the Log Analyzer for the first time on a newly installed platform, you will have to create an index pattern first, see refer to Creating an Index Pattern.



Administrationxuml_servicesservice_add_changeon_configsettings


Multiexcerpt
MultiExcerptNamexuml_servicesservice_add_changeon_config

The administration application allows you to change the configuration of a containerized xUML service.

Administration

xuml_services_change_config_current_value

Removed in 24.0 - delete when this version has ben published

Multiexcerpt
MultiExcerptNamexuml_services_change_config_current_value

You can change the Current Value of a service setting.

The Default Value is displayed next to the current value.
If you want to reset the setting to its default, click Reset Image Removed.

Click Save after you have completed your changed.

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.

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.



Administration

xuml_service_add_on_settings_sql_adapter_authorization

Delete when Admin Guide 24.1 has been published


Multiexcerpt
MultiExcerptNamexuml_service_add_on_settings_sql_adapter_authorization

These settings allow you to adapt the SQL database user and password of the xUML service.

KeyValue
customers: DBUserDatabase user
customers: DBPasswordDatabase password
Administrationxuml_services_change_config_faulty_settings
Multiexcerpt
MultiExcerptNamexuml_services_change_config_faulty_settings

Service settings can be erroneous if a setting name contains special characters or whitespaces. Invalid service settings are marked Image Removed. Their number is also displayed on top right of the list.

If a service setting is erroneous, you cannot change its current value.

In case that your service contains erroneous settings, you can do the following:

  • If it is a setting in a Designer service ("custom value"): Open the service in the DESIGNER, correct the settings' name and redeploy the service.
    • If it is a setting in a platform service, please contact our support team.



    Administrationxuml_servicesservice_changesettings_config_filternote


    Multiexcerpt
    MultiExcerptNamexuml_servicesservice_change_config_filter

    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.

    settings_note


    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.



    Administrationxuml_services_change_config_filter_extended


    Multiexcerpt
    MultiExcerptNamexuml_services_change_config_filter_extended

    The administration application allows you to change the configuration of a containerized xUML service

    Click Extended filter Image Removed to display the extended filter options:

    • Category
    • Section
    • Reset Filter

    If a filter is applied, the extended filter changes to Image Removed.


    Administrationxuml_services_change_config_filterfaulty_resetsettings


    Multiexcerpt
    MultiExcerptNamexuml_services_change_config_filterfaulty_reset

    In the main filter window, you can reset all selected filters. Click Image Removed Reset Filter.

    In the filter option window, you can also reset the selection.

    Administration

    xuml_services_change_config_note

    Please note:

  • Save is only enabled when changes have been made.
    • Clicking Save triggers a restart, changes in the Configuration section are directly applied to the service
    • .
    settings

    Service settings can be erroneous if a setting name contains special characters or whitespaces. Invalid service settings are marked Image Added. Their number is also displayed on top right of the list.

    If a service setting is erroneous, you cannot change its current value.

    In case that your service contains erroneous settings, you can do the following:

    • If it is a setting in a Designer service ("custom value"): Open the service in the DESIGNER, correct the settings' name and redeploy the service.
    • If it is a setting in a platform service, please contact our support team
    Multiexcerpt
    MultiExcerptNamexuml_services_change_config_note
    Note


    Administrationxuml_services_change_logconfig_levelfilter


    Multiexcerpt
    MultiExcerptNamexuml_services_change_logconfig_level

    In the administration application you have the possibility to change the log level for a containerized xUML service.

    filter

    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 Section and Key.


    Administrationxuml_services_configuration_sectionchange_config_filter_extended


    Multiexcerpt
    MultiExcerptNamexuml_services_configuration_sectionchange_config_filter_extended

    Click Extended filter Image Added to display the extended filter options:

    • Section
    • Reset Filter

    If a filter is applied, the extended filter changes to Image Added.In the Configuration section you can directly modify xUML service settings. When you save your changes, the container will be re-created and restarted. Changes are possible after the first deployment of the containerized service.


    Administrationxuml_services_change_endpointsconfig_andfilter_librariesreset


    Multiexcerpt
    MultiExcerptNamexuml_services_change_endpointsconfig_andfilter_librariesreset

    Below the three sections that contain read-only information, you can find the two tabs Endpoints and Libraries.

    In the main filter window, you can reset all selected filters. Click Image Added Reset Filter.

    In the filter option window, you can also reset the selection.


    Administration

    xuml_services_

    endpoints

    change_

    extended

    config_

    filter

    note


    Multiexcerpt
    MultiExcerptNamexuml_services_endpointschange_extendedconfig_filter

    Click Extended filter Image Removed to display the extended filter options:

    • Type
    • Reset Filter

    If a filter is applied, the extended filter changes to Image Removed.

    note


    Note

    Please note:

    • Save is only enabled when changes have been made.
    • Clicking Save triggers a restart, changes in the Configuration section are directly applied to the service.



    Administrationxuml_services_change_endpointslog_filterlevel


    Multiexcerpt
    MultiExcerptNamexuml_services_change_endpointslog_filter

    Use the filter field to search for a specific endpoint.

    The content of the filter field is applied to the columns Name and Type.

    level

    In the administration application you have the possibility to change the log level for a containerized xUML service.


    Administrationxuml_services_endpointsconfiguration_filter_resetsection


    Multiexcerpt
    MultiExcerptNamexuml_services_endpointsconfiguration_filter_resetsection

    In the main filter window, you can reset all selected filters. Click Image Removed Reset Filter.

    In the filter option window, you can also reset the selection.

    the Configuration section you can directly modify xUML service settings. When you save your changes, the container will be re-created and restarted. Changes are possible after the first deployment of the containerized service.


    Administrationxuml_services_endpoints_generaland_sectionlibraries


    Version of the compiled service

    .

    Multiexcerpt
    MultiExcerptNamexuml_services_endpoints_generaland_sectionlibraries

    Below the three sections that contain read-only information, you can find the two tabs Endpoints and Libraries (see below for details)

    The General details contain common information about the compiled .rep file:

    TimerShows whether a timer is enabled or not.
    SchedulerShows whether a scheduler is enabled or not.
    NameName of the compiled service.
    Version


    Administrationxuml_services_infoendpoints_loggingextended_conceptfilter


    Multiexcerpt
    MultiExcerptNamexuml_services_infoendpoints_logging_concept
    Info

    The logging concept of the xUML Runtime is build around the concepts of channels and sinks. Refer to xUML Runtime Logger Configuration for detailed information.

    extended_filter

    Click Extended filter Image Added to display the extended filter options:

    • Type
    • Reset Filter

    If a filter is applied, the extended filter changes to Image Added.


    Administrationxuml_services_libraryendpoints_tab_contentfilter


    Multiexcerpt
    MultiExcerptNamexuml_services_libraryendpoints_tab_content
    ColumnDescription
    NameName of the library.
    VersionVersion of the library.
    Compiler VersionVersion of the compiler the library has been compiled with.
    Compile DateTimestamp of the compilation of the library.
    filter

    Use the filter field to search for a specific endpoint.

    The content of the filter field is applied to the columns Name and Type.


    Administrationxuml_services_libraryendpoints_tabfilter_content_filterreset


    Multiexcerpt
    MultiExcerptNamexuml_services_libraryendpoints_tabfilter_content_filterreset

    Use In the main filter window, you can reset all selected filters. Click Image Added Reset Filter.

    In the filter option window, you can also reset the selection filter field to search for a specific library.The content of the filter field is applied to the column Name only.


    Administrationxuml_services_general_section_logs


    Multiexcerpt
    MultiExcerptNamexuml_services_general_section_logs

    In sections Logs, you can choose between two channels:

    • error to write service logging data.
    • access to write transaction logging data.

    The General details contain common information about the compiled .rep file:

    TimerShows whether a timer is enabled or not.
    SchedulerShows whether a scheduler is enabled or not.
    NameName of the compiled service.
    VersionVersion of the compiled service.



    Administrationxuml_services_sinkinfo_filterlogging_optionsconcept


    Multiexcerpt
    MultiExcerptNamexuml_services_sinkinfo_filterlogging_optionsconcept


    Info

    The logging concept of the xUML Runtime is build around the concepts of channels and sinks. Refer to xUML Runtime Logger Configuration for detailed information

    Click Add Image Removed to add more filters.

    Click Delete Image Removed to delete single filters

    .



    Administrationxuml_services_library_sinktab_levelcontent


    On the sink level, you can now adapt:

    • the Log Level (see below)
    • the Transaction Log Level (see below)
    • the Log Domain
    Multiexcerpt
    MultiExcerptNamexuml_services_sink_level
    Info

    If you have selected log level Debug, a lot of information is logged. It can then be helpful to exclude certain log domains in order to narrow down the number of logs. Refer to Log Errors for an overview on all error domains and their error codes.

    library_tab_content


    ColumnDescription
    NameName of the library.
    VersionVersion of the library.
    Compiler VersionVersion of the compiler the library has been compiled with.
    Compile DateTimestamp of the compilation of the library.



    Administrationxuml_services_sinks_library_tab_content_filter


    Multiexcerpt
    MultiExcerptNamexuml_services_sinks
    Select a channel to open the related channel sinks. Sinks define the logging output and how it is written. Refer to xUML Runtime Logger Configuration for detailed information.
    _library_tab_content_filter

    Use the filter field to search for a specific library.

    The content of the filter field is applied to the column Name only.


    Administrationxuml_services_tabsection_endpointslogs


    Multiexcerpt
    MultiExcerptNamexuml_services_tabsection_endpointslogs

    In tab Endpoints you can find the necessary information regarding the API endpoints of this service:sections Logs, you can choose between two channels:

    • error to write service logging data.
    • access to write transaction logging data.


    Administrationxuml_services_tabsink_filter_librariesoptions


    Multiexcerpt
    MultiExcerptNamexuml_services_tab_libraries

    In tab Libraries you can find a list of all libraries that are used in this service:

    All Documentationscheck_password
    Multiexcerpt
    MultiExcerptNamecheck_password

    If you want to check your input for typos, use Show Image Removed to display your password.

    sink_filter_options

    Click Add Image Added to add more filters.

    Click Delete Image Added to delete single filters.


    Administrationxuml_services_sink_levelAll Documentationsportal_login_invalid_login


    Multiexcerpt
    MultiExcerptNameportalxuml_loginservices_invalidsink_loginlevel

    If the username or the password do not match or contain typing errors, an error message is displayed on the login screen.

    In a first step try again to log in with your username and password. In particular, check that the input is case sensitive.

    If logging in is still not possible, please use the link Forgot Password? link to change your password.

    Should you not be able to log in after changing your password, please contact the support.

    All Documentationsportal_login_login_page
    Multiexcerpt
    MultiExcerptNameportal_login_login_page

    To start working with Scheer PAS, you must first log in to your system. Go to your company's address, for example https://customers.scheer-solutions.com/acme-prod/app/portal/home and log in.

    You need valid user data consisting of a username and a password. Enter the credentials in the corresponding fields and click Sign In. Alternatively, you can also confirm your input by pressing Enter.

    All Documentationsportal_login_portal_home
    Multiexcerpt
    MultiExcerptNameportal_login_portal_home

    After a successful login you are in the Scheer PAS Portal - your access to the world of Scheer PAS: For each component of the platform you are authorized to use, you will see a corresponding tile.

    Click on a tile to open the corresponding component within the portal.

    All Documentationsreference_log_analyzer
     Multiexcerpt
    MultiExcerptNamereference_log_analyzer
    Info

    For more information about the Log Analyzer, refer to Analyzing Platform Logs.

    Cron Managercron_activate_after_saving
    Multiexcerpt
    MultiExcerptNamecron_activate_after_saving

    Activate Job After Saving

    The field allows you to activate the job directly:

    • Choose option Activate to activate the job when it is created.
    • If you choose Don't activate (default), the job remains deactivated until you activate it manually (see Editing a Cron Job for details).
    Cron Managercron_event
    Multiexcerpt
    MultiExcerptNamecron_event

    Event

    Open the drop-down list to select the appropriate event. The list shows all events that are available in the selected service.

    Cron Managercron_execute_after_saving
    Multiexcerpt
    MultiExcerptNamecron_execute_after_saving

    Execute Job After Saving

    The field allows you to initiate the first execution of the job regardless of the pattern:

    • If you choose Execute, the job will be executed initially after its creation - regardless of the defined pattern. The second execution is then based on the pattern.
    • If you select Don't execute (default), the execution will be based directly on the pattern if the job is activated.
    Cron Managercron_general_note_on_services Multiexcerpt
    MultiExcerptNamecron_general_note_on_services
    Info

    Scheer PAS Cron Manager can address platform services only. Customer-specific services are currently not supported.

    Cron Managercron_patterndo_not_change_JSON Multiexcerpt
    MultiExcerptNamecron_pattern

    Pattern

    You can enter a six-digit pattern. If you use only five digits, the seconds are omitted. The pattern defines the schedule of the job. Using the correct pattern, you can determine whether the job should be executed at fixed times, dates, or intervals.

    Formatting of the Pattern:

    • Separate the individual digits by spaces.
    • You can use * as a wildcard.
    • The following order applies to the input:

    On the sink level, you can now adapt:

    • the Log Level (see below)
    • the Transaction Log Level (see below)
    • the Log Domain
    Info

    If you have selected log level Debug, a lot of information is logged. It can then be helpful to exclude certain log domains in order to narrow down the number of logs. Refer to Designer Guide > Log Errors for an overview on all error domains and their error codes.



    Administrationxuml_services_sinks


    Multiexcerpt
    MultiExcerptNamexuml_services_sinks
    Select a channel to open the related channel sinks. Sinks define the logging output and how it is written. Refer to xUML Runtime Logger Configuration for detailed information.


    Administration

    xuml_services_tab_endpoints


    Multiexcerpt
    MultiExcerptNamexuml_services_tab_endpoints

    In tab Endpoints you can find the necessary information regarding the API endpoints of this service:


    Administrationxuml_services_tab_libraries


    Multiexcerpt
    MultiExcerptNamexuml_services_tab_libraries

    In tab Libraries you can find a list of all libraries that are used in this service:


    All Documentationscheck_password


    Multiexcerpt
    MultiExcerptNamecheck_password

    If you want to check your input for typos, use Show Image Added to display your password.



    All Documentationsportal_login_invalid_login


    Multiexcerpt
    MultiExcerptNameportal_login_invalid_login

    If the username or the password do not match or contain typing errors, an error message is displayed on the login screen.

    In a first step try again to log in with your username and password. In particular, check that the input is case sensitive.

    If logging in is still not possible, please use the link Forgot Password? link to change your password.

    Should you not be able to log in after changing your password, please contact the support.


    All Documentationsportal_login_login_page


    Multiexcerpt
    MultiExcerptNameportal_login_login_page

    To start working with Scheer PAS, you must first log in to your system. Go to your company's address, for example https://customers.scheer-solutions.com/acme-prod/app/portal/home and log in.

    You need valid user data consisting of a username and a password. Enter the credentials in the corresponding fields and click Sign In. Alternatively, you can also confirm your input by pressing Enter.


    All Documentationsportal_login_portal_home


    Multiexcerpt
    MultiExcerptNameportal_login_portal_home

    After a successful login you are in the Scheer PAS Portal - your access to the world of Scheer PAS: For each component of the platform you are authorized to use, you will see a corresponding tile.

    Click on a tile to open the corresponding component within the portal.


    All Documentationsreference_log_analyzer


    Multiexcerpt
    MultiExcerptNamereference_log_analyzer


    Info

    For more information about the Log Analyzer, refer to Analyzing Platform Logs.



    Cron Managercron_activate_after_saving


    Multiexcerpt
    MultiExcerptNamecron_activate_after_saving

    Activate Job After Saving

    The field allows you to activate the job directly:

    • Choose option Activate to activate the job when it is created.
    • If you choose Don't activate (default), the job remains deactivated until you activate it manually (refer to 2024-05-23_10-01-23_Editing a Cron Job for details).


    Cron Managercron_event


    Multiexcerpt
    MultiExcerptNamecron_event

    Event

    Open the drop-down list to select the appropriate event. The list shows all events that are available in the selected service.


    Cron Managercron_execute_after_saving


    Multiexcerpt
    MultiExcerptNamecron_execute_after_saving

    Execute Job After Saving

    The field allows you to initiate the first execution of the job regardless of the pattern:

    • If you choose Execute, the job will be executed initially after its creation - regardless of the defined pattern. The second execution is then based on the pattern.
    • If you select Don't execute (default), the execution will be based directly on the pattern if the job is activated.


    Cron Managercron_general_note_on_services


    Multiexcerpt
    MultiExcerptNamecron_general_note_on_services


    Info

    Scheer PAS Cron Manager can address platform services only. Customer-specific services are currently not supported.




    Cron

    Image Removed

    Tip
    titleFrequently Used Patterns
    • Every minute: * * * * *
    • Every second: * * * * * *
    • Every midnight: 0 0 * * *
    • All 15 seconds, but only on sundays: */15 * * * * 0
    • Every minute between 17:30 and 17:45: 30-45 17 * * *
    • Mondays to fridays at 01:20 and 01:30: 20,30 1 * * 1-5
    Cron Managercron_payload


    Multiexcerpt
    MultiExcerptNamecron_payload

    Payload

    Enter your service request in the editor. The payload must contain a valid JSON. The editor supports you to insert valid JSON:

    IconDescription
    		Click Format to format your input with proper intendation and line feeds (default).
    		Click Compact to remove all whitespaces and show compact JSON data.
    		Click Undo to undo your last action in the editor.
    		Click Redo to redo your last action in the editor.



    Cron Managercron_payload_editor


    Multiexcerpt
    MultiExcerptNamecron_payload_editor

    The editor displays erroneous input:

    • Hover over Error in front of the line number to display a hint for the errors in this line.
    • Click Error in the footer to parse all errors. The result will be shown in the footer.


    Cron Managercron_service


    Multiexcerpt
    MultiExcerptNamecron_service

    Service

    Open the drop-down list to select the appropriate service.


    Cron Managernote_cron_log_size


    Multiexcerpt
    MultiExcerptNamenote_cron_log_size


    Info

    The maximum size of the error log for each cron job is per default 100. You can adjust the value in the service-specific configuration file, see refer to Adapting Integration Service Configuration for further information. In the configuration file, adjust the property errorLogMaxSize and restart the cron-service.

    Please note that old logs will be deleted if you decrease the value (sorted by their creation date). Changing the value affects all cron jobs.



    Cron Managernote_cron_user


    Multiexcerpt
    MultiExcerptNamenote_cron_user


    Info
    titleNote on Cron Users
    • Users with cron permission have access to all available cron jobs.
    • The cron jobs are executed in the user context of the logged-in user. Therefore we recommend to use a special cron user to use the application to ensure that the jobs always run in the same context.



    Process Miningcalculation_rule_options


    Multiexcerpt
    MultiExcerptNamecalculation_rule_options

    In section Calculation Rule you can define the rules that should be applied to your metric.

    You have two options:

    • Use the Calculation Rule (UI) to create a new calculation using the available process steps and custom attributes within a simple drag&drop interface.
    • Use Calculation Rule (Editor) to enter your calculation directly in valid JSON format.



    Process Miningenable_collector_scheduler


    Multiexcerpt
    MultiExcerptNameenable_collector_scheduler


    Note
    titleImportant Prerequisites
    • Only users with profile analytics_admin are able to use the Process Mining view in the user management.
    • With PAS 22.1, the collector scheduler has been disabled by default in the analytics-collector-service.
      If you want to collect data from any service you have to enable the scheduler first:
    1. Open the service details in the Administration.
    2. Go to tab Configuration and unlock it.
    3. Set variable enable to true.
    Code Block
    "collectorScheduler": {
    "enable": true,
   ...                }





    Process Mininglog_level


    Multiexcerpt
    MultiExcerptNamelog_level


    Tip

    The different log levels are explained in detail on page Refer to Bridge Guide > Transaction Log Levels of an xUML Service in the Bridge User Guide for detailed explanations of the different log levels.



    Process Miningnote_calculation_offset


    Multiexcerpt
    MultiExcerptNamenote_calculation_offset


    Info

    Currently it is only possible to offset numbers against each other.



    Process Miningnote_calculation_rules


    Multiexcerpt
    MultiExcerptNamenote_calculation_rules


    Note

    Do not work in the Calculation Rule (Editor) without any knowledge of JSON.



    Process Miningprocess_list_content


    Multiexcerpt
    MultiExcerptNameprocess_list_content

    The process list contains the following information:

    Column NameDescription
    ProcessName of the process in your system.
    Source System

    Name of the PAS component providing the data (BPaaS or Bridge).

    Retention TimeRetention time set for the instances of this process.
    Go Refer to page Setting a Retention Time for Instance Data for detailed information.
    Upload

    The Upload Diagram button allows you to add a BPMN diagram to Bridge processes.
    You can display the diagram in the Process Mining component.



    Process Miningtip_calculation_rules


    Multiexcerpt
    MultiExcerptNametip_calculation_rules


    Tip

    Go Refer to page Creating Calculations for detailed information about available operators and expressions.

    If you need further help with the implementation of your calculations, do not hesitate to contact your Scheer PAS consultant.

    Service Monitordoubleclick_downtime
    Multiexcerpt
    MultiExcerptNamedoubleclick_downtime

    Double-click the downtime entry you want to change or delete.

    and expressions.
    If you need further help with the implementation of your calculations, do not hesitate to contact your Scheer PAS consultant.



    Service Monitordoubleclick_downtimeService Monitordowntime_definition
    Multiexcerpt
    MultiExcerptNamedowntime_definition

    Set the new downtime in the Dowtime Definition pop-up.

    Downtimes can either be created for a certain date, or on a day pattern.

    Service Monitordowntime_definition_options


    Multiexcerpt
    MultiExcerptNamedoubleclick_downtime_definition_options

    Double-click the downtime entry you want to change or delete

    The dowtime definition of this entry will open.

  • Change the settings and click Modify to save the changes.
    • Click Delete if you do not want to use this downtime any more

    .



    Service Monitordowntime_specificsdefinition


    Multiexcerpt
    MultiExcerptNamedowntime_specificsdefinition

    The downtime specifics will open in a Set the new downtime in the Dowtime Definition pop-up window.

    Click Create New Entry to enter a new downtime.

    User Management

    .

    Downtimes can either be created for a certain date, or on a day pattern.



    Service Monitordowntime_definition_optionsedit_translations


    Multiexcerpt
    MultiExcerptNameeditdowntime_definition_translations
    Image Removed
    		Use window Translations to insert the display name in different languages.
    Image Removed

    Clicking button Edit Translations will show the fields German, English and French.

    The names inserted in those fields will be shown in BPaaS according to the language selected for the user interface.

    options

    The dowtime definition of this entry will open.

    • Change the settings and click Modify to save the changes.
    • Click Delete if you do not want to use this downtime any more.