Chapter | Name | Excerpt | Usage |
---|
Administration | access_docker_logs_details |
Multiexcerpt |
---|
MultiExcerptName | access_docker_logs_details |
---|
| - Open the details page of the service, open section Logs and click on the Log Analyzer link.
|
| |
Administration | access_docker_logs_icon |
Multiexcerpt |
---|
MultiExcerptName | access_docker_logs_icon |
---|
| You have two options to access the logs: - Click Open logs Image Added in the quick actions bar in the services' list.
|
| |
Administration | applicable_actions |
Multiexcerpt |
---|
MultiExcerptName | applicable_actions |
---|
|
Info |
---|
Only applicable actions are enabled. |
|
| |
Administration | change_docker_log_level_details |
Multiexcerpt |
---|
MultiExcerptName | change_docker_log_level_details |
---|
| - Open the details page of the service and scroll down to section Logs.
|
| |
Administration | change_docker_log_level_icon
|
Multiexcerpt |
---|
MultiExcerptName | change_docker_log_level_icon |
---|
| You have two options to open the input form where you can change the log level: - Click Change log level Image Added in the quick actions bar in the services' list. This will open a pop-up window.
|
| |
Administration | change_nestjs_log_level_1
|
Multiexcerpt |
---|
MultiExcerptName | change_nestjs_log_level_1 |
---|
| On the details page of a pas-nestjs service, scroll down to section Logs and expand the section. |
| |
Administration | change_nestjs_log_level_2 |
Multiexcerpt |
---|
MultiExcerptName | change_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: |
| |
Administration | change_nestjs_log_level_3 |
Multiexcerpt |
---|
MultiExcerptName | change_nestjs_log_level_3 |
---|
| GlobalIn 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. |
|
| |
Administration | change_nestjs_log_level_4 |
Multiexcerpt |
---|
MultiExcerptName | change_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.
|
| |
Administration | change_nestjs_log_level_5 |
Multiexcerpt |
---|
MultiExcerptName | change_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. |
| |
Administration | change_nestjs_log_level_6 |
Multiexcerpt |
---|
MultiExcerptName | change_nestjs_log_level_6 |
---|
| In the Custom tab, option Save will only be enabled when at least one of the entries has been changed. |
| |
Administration | details_page |
Multiexcerpt |
---|
MultiExcerptName | details_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:
|
| |
Administration | details_section
|
Multiexcerpt |
---|
MultiExcerptName | details_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. |
| |
Administration | docker_information
|
Multiexcerpt |
---|
MultiExcerptName | docker_information |
---|
| The Information section contains the main information about the container: - Name
- Source is Docker for Docker containers
- Type
- Created/Updated
- Version
|
| |
Administration | docker_types
|
Multiexcerpt |
---|
MultiExcerptName | docker_types |
---|
| - 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. |
|
| |
Administration | info_nestjs_services
|
Multiexcerpt |
---|
MultiExcerptName | info_nestjs_services |
---|
| For services of type pas-nestjs, the information section also contains a link to the Swagger UI. |
| |
Administration | info_xuml_services |
Multiexcerpt |
---|
MultiExcerptName | info_xuml_services |
---|
|
Info |
---|
This option is only available for type xuml-service (= containerized xUML services). |
|
| |
Administration | |
Multiexcerpt |
---|
MultiExcerptName | 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. |
| |
Administration | kubernetes_acces_to_xuml_logs
|
Multiexcerpt |
---|
MultiExcerptName | kubernetes_acces_to_xuml_logs |
---|
| The administration application gives you access to the logs of Kubernetes workloads. |
| |
Administration | kubernetes_information |
Multiexcerpt |
---|
MultiExcerptName | kubernetes_information |
---|
| The Information section contains the main information about the Kubernetes workload: - Name
- Source is Kubernetes for workloads
- Type
- Created/Updated
- Version
|
| |
Administration | kubernetes_only |
Multiexcerpt |
---|
MultiExcerptName | kubernetes_only |
---|
|
Info |
---|
This feature is only available in a Kubernetes setup. |
|
| |
Administration | kubernetes_types
|
Multiexcerpt |
---|
MultiExcerptName | kubernetes_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. |
|
| |
Administration | kubernetes_xuml_logs_open |
Multiexcerpt |
---|
MultiExcerptName | kubernetes_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. |
| |
Administration | log_analyzer_opens
|
Multiexcerpt |
---|
MultiExcerptName | log_analyzer_opens |
---|
| The Log Analyzer will open, showing you the corresponding logs. |
| |
Administration | log_section_not_available
|
Multiexcerpt |
---|
MultiExcerptName | log_section_not_available |
---|
| The Logs section also informs you if there are no logs available for a service type. |
| |
Administration | note_bridge_user_guide |
Multiexcerpt |
---|
MultiExcerptName | note_bridge_user_guide |
---|
|
Tip |
---|
Refer to the Bridge User Guide for detailed information about the functionalities of the integration component. |
|
| |
Administration | note_config_json |
Multiexcerpt |
---|
MultiExcerptName | note_config_json |
---|
|
Note |
---|
Do not edit content in the Configuration section without any knowledge of JSON. |
|
| |
Administration | note_config_not_available |
Multiexcerpt |
---|
MultiExcerptName | note_config_not_available |
---|
| The Configuration section also informs you if the configuration UI is not available for a service type. |
| |
Administration | note_log_level |
Multiexcerpt |
---|
MultiExcerptName | note_log_level |
---|
|
Info |
---|
This option is only available for type pas-service (= PAS applications without UI). |
|
| |
Administration | open_container_details
|
Multiexcerpt |
---|
MultiExcerptName | open_container_details |
---|
| You can open a details page for each container. To do so, click on the service name in the list. |
| |
Administration | open_docker_configuration_details |
Multiexcerpt |
---|
MultiExcerptName | open_docker_configuration_details |
---|
| - Open the details page of the service and scroll down to section Configuration.
|
| |
Administration | open_docker_configuration_icon
|
Multiexcerpt |
---|
MultiExcerptName | open_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 Image Added in the quick actions bar in the services' list.
|
| |
Administration | open_log_analyzer_via_link
|
Multiexcerpt |
---|
MultiExcerptName | open_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. |
| |
Administration | open_workload_details |
Multiexcerpt |
---|
MultiExcerptName | open_workload_details |
---|
| You can open a details page for each workload. To do so, click on the service name in the list. |
| |
Administration | pas_nestjs_configuration_intro |
Multiexcerpt |
---|
MultiExcerptName | pas_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 |
---|
MultiExcerptName | reset_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. |
|
| |
Administration | service_definition |
Multiexcerpt |
---|
MultiExcerptName | service_definition |
---|
|
Info |
---|
What is the difference between pas-app and pas-service? - pas-app: Applications accessible via UI.
- pas-service: Applications without UI.
|
|
| |
Administration | service_type_docker |
Multiexcerpt |
---|
MultiExcerptName | service_type_docker |
---|
| Image Added indicates a Docker container. |
| |
Administration | service_type_integration |
Multiexcerpt |
---|
MultiExcerptName | service_type_integration |
---|
| Image Added indicates an integration service. |
| |
Administration | service_type_kubernetes |
Multiexcerpt |
---|
MultiExcerptName | service_type_kubernetes |
---|
| Image Added indicates a Kubernetes workload. |
| |
Administration | services_list |
Multiexcerpt |
---|
MultiExcerptName | services_list |
---|
| All available services are displayed in the list on the administration start page. |
| |
Administration | services_list_date |
Multiexcerpt |
---|
MultiExcerptName | services_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. |
| |
Administration | services_list_date_format |
Multiexcerpt |
---|
MultiExcerptName | services_list_date_format |
---|
| Datetime in format dd.mm.yyyy, hh:mm:ss |
| |
Administration | services_list_name |
Multiexcerpt |
---|
MultiExcerptName | services_list_name |
---|
| Name of the service. Click on the name to access the service details page. |
| |
Administration | services_list_status |
Multiexcerpt |
---|
MultiExcerptName | services_list_status |
---|
| Indicates the status of the service. |
| |
Administration | services_list_type |
Multiexcerpt |
---|
MultiExcerptName | services_list_type |
---|
| Indicates the type of the service. |
| |
Administration | tip_details_on_containerized_services
|
Multiexcerpt |
---|
MultiExcerptName | tip_details_on_containerized_services |
---|
|
Tip |
---|
For detailed information how to handle containerized xUML services after successfull deployment, refer to one of the following pages (depending on your setup): |
|
| |
Administration | tip_log_analyzer_usage
|
Multiexcerpt |
---|
MultiExcerptName | tip_log_analyzer_usage |
---|
|
|
| |
Administration | xuml_service_settings_note |
Multiexcerpt |
---|
MultiExcerptName | xuml_service_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. |
|
| |
Administration | xuml_service_add_on_settings_sql_adapter_authorization Delete when Admin Guide 24.1 has been published |
Multiexcerpt |
---|
MultiExcerptName | xuml_service_add_on_settings_sql_adapter_authorization |
---|
| These settings allow you to adapt the SQL database user and password of the xUML service. Key | Value |
---|
customers: DBUser | Database user | customers: DBPassword | Database password |
|
| |
Administration | xuml_service_add_on_settings |
Multiexcerpt |
---|
MultiExcerptName | xuml_service_add_on_settings |
---|
| Each xUML service adapter has its own settings that are initialized in the xUML model and can be changed in the configuration. If you are running an xUML service that is connecting to a database backend, you can modify the tagged values of the database interface respectively dependency. Before starting a deployed xUML service that connects to a database backend, you may want to redefine required database parameters. 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_services_change_config |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_change_config |
---|
| The administration application allows you to change the configuration of a containerized xUML service. |
| |
Administration | xuml_services_change_config_faulty_settings |
Multiexcerpt |
---|
MultiExcerptName | xuml_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 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.
|
| |
Administration | xuml_services_change_config_filter |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_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 Section and Key. |
| |
Administration | xuml_services_change_config_filter_extended |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_change_config_filter_extended |
---|
| Click Extended filter Image Added to display the extended filter options: If a filter is applied, the extended filter changes to Image Added. |
| |
Administration | xuml_services_change_config_filter_reset |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_change_config_filter_reset |
---|
| 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_change_config_note |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_change_config_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.
|
|
| |
Administration | xuml_services_change_log_level |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_change_log_level |
---|
| In the administration application you have the possibility to change the log level for a containerized xUML service. |
| |
Administration | xuml_services_configuration_section |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_configuration_section |
---|
| 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. |
| |
Administration | xuml_services_endpoints_and_libraries |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_endpoints_and_libraries |
---|
| Below the three sections that contain read-only information, you can find the two tabs Endpoints and Libraries (see below for details). |
| |
Administration | xuml_services_endpoints_extended_filter |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_endpoints_extended_filter |
---|
| Click Extended filter Image Added to display the extended filter options: If a filter is applied, the extended filter changes to Image Added. |
| |
Administration | xuml_services_endpoints_filter |
Multiexcerpt |
---|
MultiExcerptName | xuml_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. |
| |
Administration | xuml_services_endpoints_filter_reset |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_endpoints_filter_reset |
---|
| 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_general_section
|
Multiexcerpt |
---|
MultiExcerptName | xuml_services_general_section |
---|
| The General details contain common information about the compiled .rep file: Timer | Shows whether a timer is enabled or not. | Scheduler | Shows whether a scheduler is enabled or not. | Name | Name of the compiled service. | Version | Version of the compiled service. |
|
| |
Administration | xuml_services_info_logging_concept |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_info_logging_concept |
---|
|
|
| |
Administration | xuml_services_library_tab_content |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_library_tab_content |
---|
|
Column | Description |
---|
Name | Name of the library. | Version | Version of the library. | Compiler Version | Version of the compiler the library has been compiled with. | Compile Date | Timestamp of the compilation of the library. |
|
| |
Administration | xuml_services_library_tab_content_filter |
Multiexcerpt |
---|
MultiExcerptName | xuml_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. |
| |
Administration | xuml_services_section_logs |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_section_logs |
---|
| In sections Logs, you can choose between two channels: - error to write service logging data.
- access to write transaction logging data.
|
| |
Administration | xuml_services_sink_filter_options |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_sink_filter_options |
---|
| Click Add Image Added to add more filters. Click Delete Image Added to delete single filters. |
| |
Administration | xuml_services_sink_level |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_sink_level |
---|
| 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. |
|
| |
Administration | xuml_services_sinks |
Multiexcerpt |
---|
MultiExcerptName | xuml_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 |
---|
MultiExcerptName | xuml_services_tab_endpoints |
---|
| In tab Endpoints you can find the necessary information regarding the API endpoints of this service: |
| |
Administration | xuml_services_tab_libraries |
Multiexcerpt |
---|
MultiExcerptName | xuml_services_tab_libraries |
---|
| In tab Libraries you can find a list of all libraries that are used in this service: |
| |
All Documentations | check_password |
Multiexcerpt |
---|
MultiExcerptName | check_password |
---|
| If you want to check your input for typos, use Show Image Added to display your password |
|