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 The service details will then be displayed on the right side of the service panel. |
| On top of the service details page, a breadcrumb navigation is displayed, showing the path to your service within the namespace. It helps you to orientate in which namespace, service and folder you are currently working. |
Service Details
Editing the Service Description
Click the 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. | |
Enter your text in the editor. Various formatting tools are provided. | |
Click icon |
Editing the Service Properties
The necessary settings for your micro service such as the service properties, the BPMN model, the data model, used libraries and forms are managed within the service. If you want to change the service properties, click icon The table below displays the properties you are able to change. | |
| Hover over a property name to display further information about it. |
| GENERAL | ||
|---|---|---|
| Service Property | Input Type | Description |
| Version | String | 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. |
| Category | String | Category 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 Port | Integer | Enter 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 Port | Integer | Enter 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 Port | Integer | When you create a new service, the proxy port is automatically set to 5444 by default. Do not change it if your Designer application contains forms. However, if necessary, you can change the proxy port for applications without forms. 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 }:{proxy port}/{service name}. Example: https://acme-corp.com:12345/myService |
| Enable Validation | Boolean | Activate this option (Yes) to enable the automatic compilation with each change of the respective model. Deactivate (No) the checkbox to disable the automatic compilation of a model. If you have chosen this option, you can trigger a single compilation of the model via the Default is Yes. |
| Enable Angular Build | Boolean | Activate this option (Yes) to enable the possibility to export your service as an Angular project for further pro-code development. You can find the export option in the additional menu of the controls panel. Default is Yes. Expert Advice If you don't need the instance table, disable the option. The deployment will be much faster and the repository file much smaller. |
| API MANAGEMENT | ||
| Service Property | Input Type | Description |
| Organization | String | Select one of your API Management organizations (optional). The REST API of the deployed service 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. Default is Yes. 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:
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). |
Managing Aliases
| In this section you can manage the aliases of the service. Aliases are configuration units for adapters. |
You can create aliases for the following adapters:
- Apache Kafka Producer Adapter
- Filesystem Adapter
- Flat File Adapter
- JSON Adapter
- Logger Adapter
- Memory Adapter
- MongoDB Adapter
- REST Adapter
- S3 Adapter
- SAP Adapter
- SQL Adapter
- URL Adapter
Refer to Aliases for more information on creating, changing and deleting aliases.
Overview
Content Tools