Versions Compared

Key

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

A Service contains one executable service. Within a service you manage the necessary settings for your service such as the used libraries, the BPMN model, the service properties and forms. Each newly created service contains already further folders:

  • Libraries
  • Models
  • Forms

Creating a Service

Image Removed

Services can only be created in folders.

To add a service to a folder, right click on the folder and choose the option Add Service from the context menu.

Image Removed

Image Removed

PageWithExcerptINTERNAL:_designer_excerpts Multiexcerpt includeSpaceWithExcerptINTERNALMultiExcerptNamenote_element_restrictions

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptName

create_project

whats_a_service
DisableCachingtrue

PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Creating a Service

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptName

project

creating_a_

created

service
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameproject_content
PageWithExcerptINTERNAL:_designer_excerpts

_big

The Service Context Menu

Image Modified

Right click a service to open its context menu.

The context menu displays all options available for a service:

Editing the Service Name

Image Removed

If you want to change the name of a service, choose the option Edit Service Name.

Image Removed

Enter the new name in the pop-up window Edit Service.

Click Save.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamenote_element_restrictions
PageWithExcerptINTERNAL:_designer_excerpts

Cutting and Pasting

Image Removed

The new name is displayed in the tree.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamecutting_and_pasting_explorer
DisableCachingtrue
PageWithExcerptINTERNAL:_designer_excerpts_big
shouldDisplayInlineCommentsInIncludesfalse

Exporting and Importing

You cannot import whole serviceselements into a service. But it is possible to export services from folders. For detailed information see page Exporting and Importing Explorer Contents.

Managing the Service Permissions

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamenote_access_restrictions_on_several_levels
PageWithExcerptINTERNAL:_designer_excerpts

Image Added

Select the option Permissions in the context menu if you want to manage the access to a service.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamepermission_administration
PageWithExcerptINTERNAL:_designer_excerpts_big

Sharing a Service

Image Modified

You can also share the link for a service.

Choose the option

Select Share from the context menu to copy the link of the service to the clipboard.

Image Modified

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNametoast_confirmation
PageWithExcerptINTERNAL:_designer_excerpts

Image Modified

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamepaste_url
PageWithExcerptINTERNAL:_designer_excerpts

Publishing a Service to the Cockpit

Renaming the Service

Image Added

Image Removed

If you want
direct access
to change the name of a service
in your Cockpit, open the context menu and choose option Publish to Cockpit.Image Removed
, select Rename.

Image Added

Enter the new name in the pop-up window Edit Service.

Click Save.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptName

toast_confirmation

note_explorer_name_restrictions
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Image Added

The new name is displayed in the tree.

If you open your cockpit the next time, an external link tile grants you direct access to your service.

Multiexcerpt includeSpaceWithExcerptINTERNALMultiExcerptNamecockpit_tipDisableCachingtruePageWithExcerptINTERNAL:_designer_excerpts

Deleting a Service

Image Modified

To remove a service from the tree, open its context menu and select option Delete Service.

Confirm the security query prompt in the pop-up window with Yes to delete the service from the tree.

Note

Please note that all contents of the service are also deleted.

Service Settings

If you click on a service in the tree, its settings are displayed in the settings window on the right side:

Image Removed

Editing the Service Description

Image Removed

Click the Edit Description button if you want to enter a description for your service.

Tip

Once you have deployed your model to the 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 Bridge.

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamedescription_editor
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamedescription_editor_save
PageWithExcerptINTERNAL:_designer_excerpts

Accessing the Application UI

Image Removed

You can access your application UIs directly from the service settings area.

If the service already has been deployed and it contains forms, the Open Application button is enabled.

Image Removed

If the service contains forms, you can download the generated Angular app project via Download Application button. You can use this to do your own Pro Code development.

Editing the Service Properties

Image Removed

Within a service you manage one executable service. You can edit the service properties in the settings window. Click on the Edit Properties button to enable edit mode.

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

Service PropertyInput TypeDescriptionVersiontextInsert a version number for your service.CategorytextCategory in which the service is displayed in the Bridge. As a default, the folder name the service is stored in is used.Control PortintegerEnter the number of the service control port (for further information see page xUML Service Details).Service PortintegerEnter the number of the service port (for further information see page xUML Service Details).Proxy Portinteger

The input in this field is optional. If a proxy server is configured, you can enter the proxy port you want to use for your service here.

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}.
Example: https://acme-corp.com:1234/myProject/

Managing the Service

In this section you can manage your service.

  • Service Status: Shows the status of the service.
  • Deployed Version: Displays the numer of the currently deployed version of the service.
ButtonDescriptionStart ServiceUse this button to start your service on the Bridge.Stop ServiceA click on this button stops the service on the Bridge.Open Bridge
If you want to switch to the UI of your Bridge, use this button.Deploy ServiceClick on this button to deploy your service to the Bridge.