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

Image Modified	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 to enable edit mode.The table below displays the properties you are able to change
Image Added	In the Deployment section, you can select the desired deployment target: deployment to the integration component (Bridge) deployment to a container The selected option is displayed in blue.
	Hover over a property name in the General section to display further information about it.

Anchor

If you have selected the integration component (Bridge) as the deployment target, an additional API Management section is displayed. Also in this section tooltips are displayed when hovering over a property name.

Which service properties are displayed and you are able to change depends on the selected deployment target.

Note

If you switch the deployment target, note the following:

The URL of the generated application changes.
If you are using an internal persistent state database to store running process instances, please note that these won't be transferred to the new deployment target automatically. You need to either finished them on the old deployment or transfer the data to the new deployment. For more ask your PAS administrator.

Deployment to the Integration Component (Bridge)

Image Added

The following service properties are displayed in the General and in the API Management section and can be changed:

service_propertiesservice_properties

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

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.

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.

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 }:{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 icon in the controls panel. The corresponding service is also compiled during a deployment, an export of the repository or similar actions, even if automatic compilation is disabled.

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.
If the option is enabled, an Angular project will be created for forms and for the instance table. Deactivate (No) the checkbox to disable the export. If the Angular build is disabled, it also will not build the Angular project on deployment.

Default is Yes.

Tip

title	Expert Advice

If you don't your process does not contain a user task and if you do not need the instance table, disable the this 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.

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

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

Checking the Service Status

Image Removed

Deployment to a Container

Image Added

If you are deploying the service to a Container, you will see the following additional information in the Deployment section that

Section Deployed Service

allows you to check

on

the status of the service.

Info
The content of this section is read-only.

Option

Anchor

	naming_container_deployment
	naming_container_deployment

Description

Possible Values

Container Name

Shows the name of the container to which the service will be/was deployed.

The container name is generated from the name of the service according to the following rules:

All letters are changed to lower case.
Underscores are changed to dashes.
All special characters are removed (only alphanumeric characters and dashes are left).
Leading and trailing dashes are removed.

Example:
Service Name: Janes_First_Service
Container Name: janes-first-service

Note

Naming of Services

Given two services: ServiceName and servicename

The two services in this example would get the same container name...
... so they would overwrite each other.

Service

showing the following information:OptionDescriptionPossible ValuesService

Status	Shows the current status of the service.	Not deployed (default) Running Stopped
Deployed Version	Shows the version number of the currently deployed version.	Version number registered in section

Service Properties InfoThe content of this section is read-only.

General

Image Modified

Tip

title	Expert Advice

The designer of the service himself sets

set the

an initial service version number in section General of the Service Properties. Before you redeploy a service, you should

change

increase the

service

version number

when

if you have made relevant changes to the service. We recommend to follow the concept of semantic versioning.

In case of deployment problems, comparing the version number and the number of the deployed version

will

can help you to find out

if the latest version of the service is running in the integration component (Bridge)

which version of the service is running in the container.

The following service properties are displayed in the General section and can be changed:

GENERAL

Service Property

Input Type

Description

Version

String

Insert a version number for your service. The version number is displayed in the container.

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.

Category

String

Category in which the service is displayed in the container. By default, the name of the folder where the service is stored is used.

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 Image Added icon in the controls panel. The corresponding service is also compiled during a deployment, an export of the repository or similar actions, even if automatic compilation is disabled.

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.
If the option is enabled, an Angular project will be created for forms and for the instance table. Deactivate (No) the checkbox to disable the export. If the Angular build is disabled, it also will not build the Angular project on deployment.

Default is Yes.

Tip

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

When you are done editing the service properties, click icon Image Added to save the changes or icon Image Added to discard them.

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:

Children Display

page	Adapters

Refer to Aliases for more information on creating, changing and deleting aliases.

Otp

Floating	false
maxHLevel	2

Rp

Service Panel
Children Display
page Service Panel
Controls Panel

Page tree

Versions Compared

Old Version 7

New Version 8

Key

Service Details

Editing the Service Description

Editing the Service Properties

Deployment to the Integration Component (Bridge)

Checking the Service Status

Deployment to a Container

Managing Aliases

Page tree

Page History

Versions Compared

Old Version 7

New Version 8

Key

Service Details

Editing the Service Description

Editing the Service Properties

Deployment to the Integration Component (Bridge)

Checking the Service Status

Deployment to a Container

Managing Aliases