Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: adapted the writing of Docker

...

Table Filter
hideControlstrue
inversefalse,false,false,false
sparkNameSparkline
sortChapter ⇧,Name ⇧
separatorPoint (.)
labels‚‚‚
default,,,
isFirstTimeEnterfalse
cell-width,,,
userfilterChapter,Name,Excerpt
datepatterndd M yy
globalFiltertrue
id1619080152340_-1724277853
worklog365|5|8|y w d h m|y w d h m
isORAND
order0,1,2,3


ChapterNameExcerptUsage
Administrationapplicable_actions


Multiexcerpt
MultiExcerptNameapplicable_actions


Info

Only icons for applicable actions are enabled.



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


Administrationtip_details_on_containerized_services


Multiexcerpt
MultiExcerptNametip_details_on_containerized_services


Tip

Go to page Managing Containerized xuml-services for detailed information how to handle containerized xUML services after successfull deployment.



Administrationdetails_page


Multiexcerpt
MultiExcerptNamedetails_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  to start the service.

Press  to stop the service.
Press  to restart the service.



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.


Administrationnote_bridge_user_guide


Multiexcerpt
MultiExcerptNamenote_bridge_user_guide


Tip

Go 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 for this type of service is not available.


Administrationnote_log_level


Multiexcerpt
MultiExcerptNamenote_log_level


Info

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



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.



Administrationservices_list


Multiexcerpt
MultiExcerptNameservices_list

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


Administrationservices_list_name


Multiexcerpt
MultiExcerptNameservices_list_name

Name of the service.


Administrationservices_list_type


Multiexcerpt
MultiExcerptNameservices_list_type

Indicates the type of the service.


Administrationservices_list_status


Multiexcerpt
MultiExcerptNameservices_list_status

Indicates the status of the service.


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


Administrationservice_type_docker


Multiexcerpt
MultiExcerptNameservice_type_docker

Icon indicates a docker Docker container.


Administrationservice_type_integration


Multiexcerpt
MultiExcerptNameservice_type_integration

Icon  indicates an integration service.


All Documentationsportal_login_forgot_password


Multiexcerpt
MultiExcerptNameportal_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 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 Documentationscheck_password


Multiexcerpt
MultiExcerptNamecheck_password

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



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 press the Sign in button. 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 Documentationsportal_logout


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



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.



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


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

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


Multiexcerpt
MultiExcerptNamecron_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


Multiexcerpt
MultiExcerptNamecron_service

Service

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


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.




Service Monitorbridge_generated_meta_info


Multiexcerpt
MultiExcerptNamebridge_generated_meta_info

Meta information generated by the integration component (Bridge).



Service Monitordoubleclick_downtime


Multiexcerpt
MultiExcerptNamedoubleclick_downtime

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



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


Multiexcerpt
MultiExcerptNamedowntime_specifics

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

Click Create New Entry to enter a new downtime.



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 Mininglog_level


Multiexcerpt
MultiExcerptNamelog_level


Tip

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


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


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 Miningtip_calculation_rules


Multiexcerpt
MultiExcerptNametip_calculation_rules


Tip

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


Multiexcerpt
MultiExcerptNameedit_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


Multiexcerpt
MultiExcerptNamelogin_unchangeable


Note

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



User Managementnamespace_equal_name


Multiexcerpt
MultiExcerptNamenamespace_equal_name


Tip

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



User Managementpassword_constraints


Multiexcerpt
MultiExcerptNamepassword_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


Multiexcerpt
MultiExcerptNamepermission_without_json


Note

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



User Managementpermissions_based_on_rbac


Multiexcerpt
MultiExcerptNamepermissions_based_on_rbac


Info

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



User Managementrole_change


Multiexcerpt
MultiExcerptNamerole_change


Info

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


Multiexcerpt
MultiExcerptNameroles_not_applied


Info

Menu Roles is currently not used for Process Mining.



User Management
save_before_closing



Multiexcerpt
MultiExcerptNamesave_before_closing


Info

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



User Managementstandard_admin_profiles


Multiexcerpt
MultiExcerptNamestandard_admin_profiles


Table Filter
hideControlstrue
inverse,,
sparkNameSparkline
separatorPoint (.)
labels‚‚
default,,
isFirstTimeEntertrue
cell-width,,
userfilterProfile,Description
datepatterndd M yy
globalFiltertrue
id1617189687165_171155140
worklog365|5|8|y w d h m|y w d h m
isORAND
order0,1,2


Portal TileProfileDescriptionFurther InformationPAS Version
administration_user
  • Grants access to the platform component administration.
PAS 21.1
xuml_container_admin
  • Grants access to the management UIs for the administration of xUML services running as container and to the deployment wizard. Only usable together with profile administration_user .

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
pas_admin_user
  • Grants access to the administration menu in the Designer.
PAS 21.1
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.


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 Managementstandard_user_profiles


Multiexcerpt
MultiExcerptNamestandard_user_profiles


Table Filter
hideControlstrue
inversefalse,false,false
sparkNameSparkline
separatorPoint (.)
labels‚‚
default,,
isFirstTimeEnterfalse
cell-width,,
userfilterProfile,Description
datepatterndd M yy
globalFiltertrue
id1617267117674_1259938276
worklog365|5|8|y w d h m|y w d h m
isORAND
order0,1,2


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



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.

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

If a user is assigned only pas_base, he can log in to the system but the Portal will be empty.


PAS 20.1
pas_user
  • Grants access to the Designer.
PAS 20.1
process_monitor_user
  • Grants access to the Process Monitor.

PAS 21.1.2
keycloak_user
  • Grants access to the login page of the third party 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.


PAS 21.1
kibana_user
  • Grants access to the third party tool Kibana.
PAS 21.1
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


Multiexcerpt
MultiExcerptNameunchangeable_meta_data


Info

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



User Managementuser_needs_namespace


Multiexcerpt
MultiExcerptNameuser_needs_namespace


Note

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



User Managementwrite_permission


Multiexcerpt
MultiExcerptNamewrite_permission


Info

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


Multiexcerpt
MultiExcerptNamenote_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


Multiexcerpt
MultiExcerptNamenote_assigning_permissions


Info

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


Multiexcerpt
MultiExcerptNamenote_admin_rights


Info

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


Multiexcerpt
MultiExcerptNamerole_during_modeling


Info

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


Multiexcerpt
MultiExcerptNamepas_base_mandatory


Info

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


Multiexcerpt
MultiExcerptNamenote_write_permission_in_user_datasheet


Info

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


Multiexcerpt
MultiExcerptNameuse_filter_to_limit


Tip

Use the filter to limit the content of the list.



User Managementvalid_until_expired


Multiexcerpt
MultiExcerptNamevalid_until_expired


Info

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.




...