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 created for generated from each BPMN model. Users with authorization for the . 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)

of the platform

, you have access to

the yaml file and to the swagger test interface.

Via a link on the xUML service page, you can access a REST service documentation page where you can inspect the service interface:

Image Removed

In section  Rest Ports, you find, maybe among others, the RESTService

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

When the service has been deployed successfully, click Administration in the deployment 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.

On this page, open section Details:

Image Added

Scroll down to tab Endpoints. For each endpoint, you can now use the corresponding option Image Added in section Test.

Image Added

A click on the test icon will open the test UI within your PAS Administration:

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:

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 contain forms:

  • Leave 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

Integration Service without Forms

Image Added

If your service does not contain any forms:

  • Leave 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

Accessing the Test UI

When the service has been deployed successfully, click API in the deployment 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 Added

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

  • Click the
port type BPMN_model_nameREST to access
  • link below the REST service
documentation page.Click Yaml
  • name to download the
related Swagger

Image Removed

On this page, you can inspect
  • API definition file.

RESTService Documentation

  • Inspect the BPMN
Process
  • process API interface.
Image Removed

Image Added

Expand the REST operation to see the necessary parameters

and response.
Rp

Children Display

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

Image Added

Scroll down to check the test responses:

Image Added

RdeBridge User Guide
xUML Runtime API