Versions Compared

Old Version 3

changes.mady.by.user Annegret Bernhardt

Saved on

compared with

New Version 4

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WADMINPAS and version 23.1

You can run xUML services in a Docker container instead of running it in the integration component (Bridge). The administration offers a deployment wizard for this , (refer to Working With the Deployment Wizard for details) and you can also deploy Designer services directly to a container (refer to Designer Guide > Selecting the Deployment Target). xUML services that run in a Docker container have extended container details to manage this type of service.

Using the Container Details

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameopen_container_details
PageWithExcerptINTERNAL:_admin_portal_excerpts

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamedetails_page
PageWithExcerptINTERNAL:_admin_portal_excerpts

It also contains different collapsable sections:

Information

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamedocker_information
PageWithExcerptINTERNAL:_admin_portal_excerpts

Details

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

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamedetails_section
PageWithExcerptINTERNAL:_admin_portal_excerpts

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

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

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_general_section
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_license_info
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Removed

TimerShows wether a timer is enabled or not.
SchedulerShows wether 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.

Image Removed

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 Build details contain information about the Docker image:

Image NameName of the image in the local Docker registry.
Base ImageName of the image the xUML container is based on. Default is latest. Can be configured by env, can also be changed during the build process, refer to Working With the Deployment Wizard.
Build UserUsername of the user that triggered the build process.
Build DateBuild date and time of the service repository.
Compiler VersionVersion of the compiler the service has been compiled with.
Compile DateTimestamp of the compilation of the service.

The Deployment details contain information about the deployment:

Service NameName of the xUML service.
Deployment UserUsername of the user that triggered the deployment process.
Deployment DateCreation date and time of the container.
Container Start Date

Date and time of the last (re-)start of the container.

API Management OrganizationName of the organization in Scheer PAS API Management, where REST/SOAP services are registered. Default is the organization xuml.

Below the three sections that contain read-only information, you can find the two tabs Controlling Containerized xUML Services and Controlling Containerized xUML Services.

Endpoints

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

Image Removed

ColumnDescriptionPossible ValuesNameName of the registered endpoint.Any string.Type

Type of the registered endpoint.

  • control
  • rest
  • shadow
  • soap
  • ui
URL

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

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

Image Removed

Interface/Descriptor

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

Tip
titleExpert Advice

In API Management, you can use the private descriptor URL to create an API. During API creation, paste the descriptor URL in field API Endpoint  in tab Implementation. Go to API Management Guide > API Settings for details.

Image Removed

Image Removed

Image Removed

Use the filter field to search for a specific endpoint.

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

Image Removed

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

  • Type
  • Reset Filter

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

Image Removed

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

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

Libraries

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

Image Removed

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.

Image Removed

Use the filter field to search for a specific library.

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

Deleting a Service

Image Removed

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

Image Removed

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

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

Image Removed

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

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_endpoints_and_libraries
PageWithExcerptINTERNAL:_admin_portal_excerpts

Endpoints

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_tab_endpoints
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_service_endpoints
PageWithExcerptINTERNAL:_admin_portal_excerpts_big

Image Added


Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_endpoints_filter
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_endpoints_extended_filter
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_endpoints_filter_reset
PageWithExcerptINTERNAL:_admin_portal_excerpts

Libraries

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_tab_libraries
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_library_tab_content
PageWithExcerptINTERNAL:_admin_portal_excerpts

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_library_tab_content_filter
PageWithExcerptINTERNAL:_admin_portal_excerpts

Deleting a Service

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_service_deletion
PageWithExcerptINTERNAL:_admin_portal_excerpts_big

Documentation

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_service_documentation
PageWithExcerptINTERNAL:_admin_portal_excerpts_big

Documentation

Image Removed

Open the Documentation section to display the documentation of the xUML service.

Image Removed

Use the list Select Document to choose the documentation you want to see.

The list contains:

  • The documentation of the xUML service itself (if it is a service that has been created in the DESIGNER, you will see the content of field Description from the service details page).

Image Removed

The documentation of the libraries that are used in the service.

Logs

In section Logs you can change the log level. Go to page Changing the Log Level of a Containerized xUML Service for detailed information.

The link in section Logs gives you direct access to the Log Analyzer, where you can inspect the logs. Refer to Showing Logs of a Containerized xUML Service and Using Kibana for further information.

Persistent State

In section Persistent State you can manage persistent state objects.
Refer to Persistent States of Containerized xUML Services for detailed information.

Configuration

In the Configuration section you can change the configuration file of the Docker container.
Refer to Adapting the Configuration of Containerized xUML Services for detailed information.

Otp
Floatingfalse
maxHLevel3

Rp