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:
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
| PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | note_element_restrictions |
---|
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName |
---|
|
create_project | whats_a_service | DisableCaching | true |
---|
|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
Image RemovedCreating a Service
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName |
---|
|
projectcreatedservice | PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
Image Removed
| Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | project_content |
---|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
| |
Image Modified
| Right click a service to open its context menu. The context menu displays all options available for a service: Edit Service Name |
Editing the Service Name
Image Removed
| If you want to change the name of a service, choose the option Edit Service Name. |
Image Removed
| Cutting and Pasting
Enter the new name in the pop-up window Edit Service.
Click Save.
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName |
---|
|
noteelement_restrictionspasting_explorer | DisableCaching | true |
---|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
_big | shouldDisplayInlineCommentsInIncludes | false |
---|
|
Exporting and Importing
You cannot import elements 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
Image Removed
| The new name is displayed in the tree.DisableCaching | true |
---|
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName |
---|
|
cutting_and_pasting | note_access_restrictions_on_several_levels |
|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
Image Added
| Select the option Permissions in the context menu if you want to manage the access to a service. |
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | tree_export_with_library | DisableCaching | truepermission_administration |
---|
PageWithExcerpt | INTERNAL:_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 |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | toast_confirmation |
---|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
|
Image Modified
| Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | paste_url |
---|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
|
Publishing a Service to the Cockpit
Renaming the Service
Image Added
|
Image Removed 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 |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName |
---|
|
|
toast_confirmationnote_explorer_name_restrictions | PageWithExcerpt | INTERNAL:_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 include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | cockpit_tip |
---|
DisableCaching | true |
---|
PageWithExcerpt | INTERNAL:_designer_excerptsDeleting 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 |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | description_editor |
---|
PageWithExcerpt | INTERNAL:_designer_excerpts |
---|
|
|
Image Removed
| Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | description_editor_save |
---|
PageWithExcerpt | INTERNAL:_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
| Click this button to open the service overview. All available processes are shown. Select the process you want to go to. |
Image Removed
| The process overview opens and you can start a new process using the displayed link. |
Image Removed
| The first form opens and you can start to fill it. |
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 Property | Input Type | Description |
---|
Version | text | Insert a version number for your service. |
Category | text | Category in which the service is displayed in the Bridge. As a default, the folder name the service is stored in is used. |
Control Port | integer | Enter the number of the service control port (for further information see page xUML Service Details). |
Service Port | integer | Enter the number of the service port (for further information see page xUML Service Details). |
Proxy Port | integer | 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.
Button | Description |
---|
Start Service | Use this button to start your service on the Bridge. |
Stop Service | A 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 Service | Click on this button to deploy your service to the Bridge. |