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

When compiling a service from the Designer to a deployable repository, a REST service is generated from each BPMN model. Depending on your deployment target, you can test this service in the PAS Administration or in API Management.

Deployment as a ContainerDeployment to Integration Component (Bridge)

For services that have been deployed as container, you have access to the test UI via the PAS Administration:

For services that have been deployed to the PAS integration component (Bridge), you have access to the test UI via the API Management. To test a service in API Management, you have to make sure that the service settings are set correctly before you start the deployment. The settings are different depending on whether a service has a user interface or not:

Testing Containerized xUML Services

Image Removed

When the service has been deployed successfully,

use icon Open

click Administration

Image Removed

in the deployment

controls

Controls.

This will open the details of the service within PAS Administration

.

:

Image Added

Tip

For detailed information about the PAS Administration see our ADMIN.

Image Removed

On this page, open section Details

.

:

Image Removed

Image Added

Scroll down to tab Endpoints.

For each endpoint, you can now use the corresponding option Image Modified

icon

in section Test.

Image Removed

Image Added

A click on the test icon will open the

Swagger

test UI within your PAS Administration

.

:

Image Removed

Image Added

Expand the REST operation to see the necessary parameters.

To start testing, enter the required data and click the Execute button.

Scroll down to check the test responses

.

Integration Service without UI

Image Removed

:

Image Added

Testing Integration xUML Services

Panel
titleOn this Page:
Table of Contents
Panel
titleRelated Pages:
Panel
titleRelated Documentation:

Integration Service with Forms

Image Added

If your service does

not

contain

any

forms:

  • Leave
field Proxy Port in the deployment properties empty
  • proxy port 5444.
Info

From PAS 22.1.2 on, the proxy port 5444 is displayed by default when creating a new service.

  • In section API Management, select the organization you want to use.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNametip_api_organizations
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

When the service has been deployed successfully, use icon Open Test API Image Removed in the deployment controls.

Image Removed

The test UI opens within API Management. You can do the following here:

  • Click the link below the REST service name to download the API definition file.
  • Inspect the BPMN process API interface.

Image Removed

Expand the REST operation to see the necessary parameters.

To start testing, enter the required data and click the Execute button.

Image Removed

Scroll down to check the test responses.

Integration Service without Forms

Image Added

Integration Service with UI

Image Removed

If your service does not contain any forms:

  • Leave
proxy port 5444. InfoFrom PAS 22.1.2 on, the proxy port 5444 is displayed by default when creating a new service
  • field Proxy Port in the deployment Options empty.
  • In section API Management, select the organization you want to use.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNametip_api_organizations
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Accessing the Test UI

When the service has been deployed successfully,

use icon Open Test

click API

Image Removed

in the deployment

controls.

Controls:

Image Added

If your service contains more than one BPMN model, a list of all available processes opens. Select the one you want to test

.

:

Image Removed

Image Added

The test UI opens within API Management.

Note

Before you can start testing, you need to adjust the API's endpoint to use http.

Open the sidebar menu APIs and select My APIs.

Image Removed

Use the filter to search for your API. Click its name to open it.

Image Removed

Open tab Implementation and check the API Endpoint.

The displayed URL will start with https://...

Image Removed

Now you have to change the API Endpoint:

  • from https://<HOST>:5444/<SERVICE>/rest/process/<BPMN>
  • to http://<TENANT>-bridge:<SERVICE PORT>/rest/process/<BPMN>

Example:

  • from  https://scheer-acme.com:5444/OrderProcessing/rest/process/OrderApproval
  • to http://pas-doc-bridge:14003/rest/process/OrderApproval

Now Save and Re-Publish to activate the change.

Info

If your service contains several processes (BPMNs), you must adapt the endpoint for each of them.

Image Removed

Now switch back to the Designer and click the Open Test API icon Image Removedagain.

The test UI opens. Now you can do the following

You can do the following here:

  • Click the link below the REST service name to download the API definition file.
  • Inspect the BPMN process API interface.
Image Removed

Image Added

Expand the REST operation to see the necessary parameters.

To start testing, enter the required data and click the Execute button

.

:

Image Removed

Image Added

Scroll down to check the test responses

.

Otp
Floatingfalse
maxHLevel2

Rp

:

Image Added

Rde
  • ADMIN
  • API Management Guide
  • Bridge User Guide
    xUML Runtime API