Important Note

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.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 246 Next »

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

ChapterNameExcerptUsage
Administrationapplicable_actions

Only icons for applicable actions are enabled.

Administrationdocker_types

  • database
  • init
  • pas-app
  • pas-nestjs
  • pas-service
  • xuml-legacy-service
  • xuml-service
  • other
  • undefined

Other service types may be displayed.

Administrationkubernetes_types

  • custom
  • java
  • minio
  • pas-app
  • pas-nestjs
  • pas-service
  • postgresql
  • xuml-legacy-service
  • xuml-service
  • other
  • unknown
  • MIT SVEN ABKLÄREN; WELCHE TYPES WIR SINNVOLLERWEISE ANGEBEN

Other service types may be displayed.

Administrationaccess_docker_logs_icon

You have two options to access the logs:

  • Use icon in the quick actions bar in the services' list.

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

Administrationtip_log_analyzer_usage

Go 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 Creating an Index Pattern.

Administrationaccess_docker_logs_details

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

Administrationchange_docker_log_level_icon

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

  • Use icon in the quick actions bar in the services' list. This will open a pop-up window.

Administrationchange_docker_log_level_details

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

Administrationchange_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

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

Administrationchange_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

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

  • Save your changes to apply them to the service.
  • Use button Reset to return to the default value. In most cases this is info.
  • If you opened the pop-up window by using the icon 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

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

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

Administrationchange_nestjs_log_level_6

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

Administrationdetails_section

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

Administrationdocker_information

The Information section contains the main information about the container:

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

Administrationkubernetes_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_logs

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

Administrationkubernetes_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

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

Administrationinfo_nestjs_services

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

Administrationtip_details_on_containerized_services

Go to page Controlling Containerized xUML Services for detailed information how to handle containerized xUML services after successfull deployment.

Administrationdetails_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
Shows the current state of the service.

Press this icon to start the service.

Press this icon to stop the service.
Press this icon to restart the service.

Administrationopen_container_details

You can open a details page for each container.

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

Administrationopen_workload_details

You can open a details page for each workload.

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

Administrationopen_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:

  • Use icon in the quick actions bar in the services' list.

Administrationopen_docker_configuration_details

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

Administrationlog_section_not_available

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

Administrationnote_bridge_user_guide

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

Administrationnote_config_json

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

Administrationnote_config_not_available

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

Administrationinfo_xuml_services

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

Administrationnote_log_level

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

Administration

reset_log_level

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

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

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

Administrationservices_list

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

Administrationservices_list_name

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

Administrationservices_list_type

Indicates the type of the service.

Administrationservices_list_status

Indicates the status of the service.

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

Administrationservices_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

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

Administrationservice_type_docker

Icon indicates a Docker container.

Administrationservice_type_kubernetes

Icon indicates a Kubernetes workload.

Administrationservice_type_integration

Icon  indicates an integration service.

Administrationxuml_services_change_config

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

Administrationxuml_services_change_log_level

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

Administrationxuml_services_endpoints_and_libraries

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

Administrationxuml_services_endpoints_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_endpoints_extended_filter

Click the filter icon  to display the extended filter options:

  • Type
  • Reset Filter

If a filter is applied, the filter icon changes: .

Administrationxuml_services_endpoints_filter_reset

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

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

Administrationxuml_services_general_section

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.
License Expiration Date

Shows the date on which your integration license expires. You can click on the date for detailed information.

Administrationxuml_services_info_logging_concept

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.

Administrationxuml_services_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_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_license_info

If you click on the License Expiration Date the following information is displayed:

IDThe ID of the license key.
NameThe name of the company the license was issued to.
ConnectionsThe number of licensed concurrent connections that have been issued.
Licensed ModulesList of the licensed modules.
License Expiration DateDate on which your license expires.
Machine ID

The hostname for which this license has been created.
_unspecified_ indicates that the license is not bound to a specific hostname.

Administrationxuml_services_section_logs

In sections Logs, you can choose between two channels:

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

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

Administrationxuml_services_sink_filter_options

Use icon to add more filters.

Use icon to delete single filters.

Administrationxuml_services_sink_level

On the sink level, you can now adapt:

Administrationxuml_services_tab_endpoints

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

Administrationxuml_services_tab_libraries

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

All Documentations

portal_login_forgot_password

WITH 23.1 moved to _admin_portal_excerpts_big

After publication, check and delete

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 Documentationsportal_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 Documentationscheck_password

If you want to check your input for typos, use icon to display your password.


All Documentationsportal_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 press the Sign in button. Alternatively, you can also confirm your input by pressing Enter.

All Documentationsportal_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

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

All Documentations

portal_logout

WITH 23.1 moved to _admin_portal_excerpts_big

After publication, check and delete

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.

All Documentationsportal_open_user_menu

Open the user menu on top right and select the option User Preferences.

Cron Managernote_cron_user

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

Cron Managercron_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 Managernote_cron_log_size

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

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_patterndo_not_change_JSON

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:

Frequently 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

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 this button to format your input with proper intendation and line feeds (default).
Click this button to remove all whitespaces and show compact JSON data.
Click this button to undo your last action in the editor.
Click this button to redo your last action in the editor.

Cron Managercron_payload_editor

The editor displays erroneous input:

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

Cron Managercron_service

Service

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

Cron Managercron_general_note_on_services

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


Service Monitorbridge_generated_meta_info

Meta information generated by the integration component (Bridge).


Service Monitordoubleclick_downtime

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


Service Monitordowntime_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

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_specifics

The downtime specifics will open in a pop-up window.

Click Create New Entry to enter a new downtime.


Process Miningcalculation_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 Mininglog_level

The different log levels are explained in detail on page Transaction Log Levels of an xUML Service in the Bridge User Guide.

Process Miningnote_calculation_offset

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

Process Miningnote_calculation_rules

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

Process Miningprocess_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 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 Miningenable_collector_scheduler

Important 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.
"collectorScheduler": {
    "enable": true,
   ...                }


Process Miningtip_calculation_rules

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

User Managementedit_translations

Use window Translations to insert the display name in different languages.

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.

User Managementlogin_unchangeable

Please note: Once set up, the Login cannot be changed anymore.

User Managementnamespace_equal_name

Use the same identifier for name and namespace of a profile.

User Managementpassword_constraints

Make sure that the password ...

  • is 8 to 42 characters long.
  • starts with a character.
  • is alphanumeric.
  • contains at least one number.
  • contains only the allowed special characters (!, @, #, $, %).

User Managementpermission_without_json

Do not change or create permissions without any knowledge of JSON.

User Managementpermissions_based_on_rbac

The authorization check of the user management is based on Role-based Access Control (RBAC).

User Managementrole_change

When a user is added or removed a role, they must log into the system again for the changes to affect their account. This also applies to the Scheer PAS Mobile App.

User Managementroles_not_applied

Menu Roles is currently not used for Process Mining.

User Management
save_before_closing


Do not forget to save the data sheet before closing it.

User Management

standard_admin_profiles

WITH 23.1 moved to _admin_portal_excerpts_big

After publication, check and delete

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

Portal TileProfileDescriptionFurther InformationPAS Version
administration_user
  • Grants full access to the platform component administration, all platform services are displayed.
PAS 21.1
xuml_container_admin
  • Grants limited access to the platform component administration, only customer-specific services are displayed.
PAS 22.1
analytics_admin
  • Grants access to the Process Mining view in the user management.
  • Allows to create and manage templates in Scheer PAS Process Mining.

api_management_admin
  • Grants access to the administration menu in the API Management UI and the API Developer Portal.
PAS 21.1
keycloak_user
  • Grants access to the login page of the identity management tool Keycloak. You will need separate credentials to log in to Keycloak.

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

PAS 21.1
kibana_user
  • Grants access to the Log Analyzer.
PAS 21.1
pas_admin_user
  • Grants access to the administration menu in the Designer.
PAS 21.1
user_management_admin
  • Grants access to the user management.

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.

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

WITH 23.1 moved to _admin_portal_excerpts_big

After publication, check and delete

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

Portal TileProfileDescriptionFurther InformationPAS Version

api_devportal_user

  • Grants access to the API Developer Portal.
PAS 21.1
api_management_user
  • Grants access to API Management.
PAS 21.1
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.

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.


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.

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.

cron_manager
  • Grants access to the Cron Manager.
PAS 20.1
file_manager_user
  • Grants access to the File Manager, the UI of the file storage.
PAS 21.1.2
integration_user
  • Grants access to the Integration (Bridge).
PAS 21.1
-

pas_base

  • Grants access to the Portal and contains basic permissions for the Scheer PAS platform.
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.
PAS 22.1.1
pas_user
  • Grants access to the Designer.
PAS 20.1
process_monitor_user
  • Grants access to the Process Monitor.

PAS 21.1.2
xuml_monitor_user
  • Grants access to the xUML Service Monitor.
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

User Managementunchangeable_meta_data

The content of section Meta is for documentation purposes only: meta data cannot be changed.

User Managementuser_needs_namespace

Users need at least one profile having a namespace to be able to save data within one of the platform components.

User Managementwrite_permission

Individual write permissions can be granted or denied for profiles with namespace. See page Editing a User for information on how to grant write permissions on profiles.

User Managementnote_sso

Single Sign-on is available throughout all platform components: Log in once, and use all Scheer PAS components that are configured for your user.

User Managementnote_assigning_permissions

Generally, it is not necessary to assign a permission to a profile:

  • Personal profiles ("sandbox") do not need own permissions.
  • The standard profiles already grant all necessary permissions to use the platform components.

User Managementnote_admin_rights

Please note that your user must have special admin profiles to be allowed to use the corresponding admin views. Go to page Overview on Administration Profiles for details.

User Managementrole_during_modeling

When a role is created during modeling, only the role's name is determined. All other settings have to be inserted in the role's data sheet in the user management.

User Managementpas_base_mandatory

The profile pas_base is mandatory as it grants access to the Scheer PAS Portal , the entry into the platform.

User Managementnote_write_permission_in_user_datasheet

If you want to grant the user write permission, you have to switch to the user's data sheet and enable the corresponding checkbox in section Profiles.

User Managementuse_filter_to_limit

Use the filter to limit the content of the list.

User Managementvalid_until_expired

If the date set for Valid until has expired, the user can no longer log in to the system, even if his account is still activated.

  • No labels