Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
A service is a deployment unit that may contain multiple processes. On the service details page, you can
see a summary of service related information such as service details, service status and service components.Image Removed
If you want to open the service details, click on the service panel tab. You can also use the menu option Service Properties in the additional menu Image Removed of the controls panel.
The service details will then be displayed on the right side of the service panel.
Image Removed
On top of the service details page, a breadcrump navigation is displayed, showing the levels of your namespace. It helps you to orientate in which namespace, service and folder you are currently working.
can control the service deployment and change the service configuration.
Service Details
Editing the Service Description
Image Removed
Click the Image Removed icon in the Description section if you want to enter a description for your service.
Tip |
---|
Once you have deployed your model to the integration component (Bridge), this description will be visible in the model notes of the xUML service. This helps Bridge operators to identify the purpose of a service and who is responsible. |
Image Removed
Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName
Image Removed
recommendation_container_deployment
PageWithExcerpt INTERNAL:_
general_excerpts
Editing the Service Properties
Image Removed
Within a service you manage one executable service. If you want to change the service properties, click icon Image Removed to enable edit mode.
The table below displays the properties you are able to change.
Image Removed
Insert a version number for your service. The version number is displayed in the integration component (Bridge).
Info |
---|
The version of the service must follow Semantic Versioning 2.0.0: Major.Minor.Patch. A pre-release tag is optional. Version numbering that differs from this will lead to deployment errors. |
Enter a proxy port (optional). If the service ports are not exposed and a proxy server is configured, enter the proxy port you want to use for your service here.
For Designer applications containing forms, you need to configure 5444 as a proxy port.
Info |
---|
Please note: The proxy protocol is always https and the proxy path is always the name of the service. The final URL is composed as follows: https://{bridge.host.name}:{proxyPort}/{projectName}. |
Description
Select one of your API Management organizations (optional). The REST API will be exposed by API Management and will be visible in the API Developer Portal.
Tip |
---|
Go to the API Management Guide for further information about Scheer PAS API Management and API Developer Portal. |
Activate this option (Yes) to create an OAuth policy on each published API endpoint or deactivate (No) to remove any existing OAuth policy. If the option is enabled, you need a PAS login to call the API. If the option is disabled, no authetication is needed.
Tip |
---|
Go to the API Management Guide > Keycloak OAuth for further information. |
Checking the Service Status
Image Removed
Section Deployed Service allows you to check on the status of the service showing the following information:
- Not deployed (default)
- Running
- Stopped
- Version number registered in section Service Properties
Info |
---|
The content of this section is read-only. |
Image Removed
Tip | ||
---|---|---|
| ||
The designer of the service himself sets set the service number in section Service Properties. Before you redeploy a service, you should change the service number when you have made relevant changes to the service. In case of deployment problems, comparing version number and the number of the deployed version will help you to find out if the latest version of the service is running in the integration component (Bridge). |
Adding Aliases
In this section you can add Aliases to the service, which can then be used on adapters. Currently, REST aliases are supported.
To open the service details page, click on the service panel tab. The service details are displayed to the right of the service panel:
Image Added
The service details page is divided into the following sections:
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Panel | ||||
---|---|---|---|---|
| ||||
|
Otp | ||||
---|---|---|---|---|
|
Rp |
---|