Versions Compared

Old Version 2

changes.mady.by.user Annegret Bernhardt

Saved on

compared with

New Version 3

changes.mady.by.user Annegret Bernhardt

Saved on

Key

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

When compiling a service from the Designer, a REST service is created for generated from each BPMN model. Users with authorization for the integration component (Bridge) of the platform 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

You can test this service in Scheer PAS 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:

You can also test services, that have been deployed to a container:

Service without UI

Image Added

If your service does not contain any forms:

  • Leave the field Proxy Port in the service details empty.
  • In section API Management, select the organization you want to use.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNametip_api_organizations
PageWithExcerptINTERNAL:_designer_excerpts

Image Added

When the service has been deployed successfully, use icon Open Test API Image Added in the Controls panel.

Image Added

The test UI opens within API Management

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

. You can do the following here:

  • Click the
port type BPMN_model_nameREST to access the REST service documentation page.
  • Click Yaml to download the related Swagger file.
    • link below the REST service name to download the API definition file.
    • Inspect the BPMN process API interface.

    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.

    Service with UI

    Image Added

    If your service does contain forms:

    • Enter 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 Added

    When the service has been deployed successfully, use icon Open Test API Image Added in the Controls panel.

    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.

    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 Added

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

    Image Added

    Open tab Implementation and check the API Endpoint.

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

    Image Added

    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 Added

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

    The test UI opens. Now you can do the following:

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

    Image Added

    RESTService Documentation

    Image Removed

    On this page, you can inspect the BPMN Process API interface.

    Image Removed

    Expand the REST operation to see the necessary parameters and response..

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

    Image Added

    Scroll down to check the test responses.

    Service Running in a Container

    For services that have been deployed to a container, you have also access to the test UI.

    Image Added

    When the service has been deployed successfully, use icon Open Administration Image Added in the Controls panel.

    This will open the service details page in the PAS Administration.

    Tip

    For detailed information about the Scheer PAS Administration see our ADMIN.

    Image Added

    		On this page, open tab Details.

    Image Added

    Scroll down to tab Endpoints.

    For each endpoint, you can now use the corresponding Image Added icon in section Test.

    Image Added

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

    Otp
    Floatingfalse
    maxHLevel2

    Rp
    Rp
    children
    Rde