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

Compare with Current View Page History

« Previous Version 3 Next »

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.

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 of the controls panel.

The service details will then be displayed on the right side of the service panel.

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.

Service Details

Editing the Service Description

Click the icon in the Description section if you want to enter a description for your service.

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.
Refer to Documentation of an xUML Service for more information on where to find the service documentation on the integration component.

Enter your text in the editor. Various formatting tools are provided.

Click icon to confirm your text or icon to abort the action.

Editing the Service Properties

Within a service you manage one executable service. If you want to change the service properties, click icon to enable edit mode.

The table below displays the properties you are able to change.

Hover over a property name to display further information about it.

GENERAL
Service PropertyInput TypeDescription
Versiontext

Insert a version number for your service. The version number is displayed in the integration component (Bridge).

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.

CategorytextCategory in which the service is displayed in the integration component (Bridge). By default, the name of the folder where the service is stored is used.
Control PortintegerEnter the number of the service control port. This port is used by the integration component (Bridge) to control the service and must be unique to the integration component. For further information see page xUML Service Details.
Service PortintegerEnter the port number the service is listening to. The port number must be unique to the integration component (Bridge). For further information see page xUML Service Details.
Proxy Portinteger

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.

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

Example: https://acme-corp.com:1234/myProject/

API MANAGEMENT
Service PropertyInput Type

Description

Organization
text

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.

Go to the API Management Guide for further information about Scheer PAS API Management and API Developer Portal.

Secure Service
boolean

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.

Go to the API Management Guide > Keycloak OAuth for further information.

Checking the Service Status

Section Deployed Service allows you to check on the status of the service showing the following information:

OptionDescriptionPossible Values
Service StatusShows the current status of the service.
  • Not deployed (default)
  • Running
  • Stopped
Deployed VersionShows the version number of the currently deployed version.
  • Version number registered in section Service Properties

The content of this section is read-only.

Expert Advice

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.

On this Page:
Related Pages:

  • No labels