You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

When compiling a service from the Designer, a REST service is generated from each BPMN model. 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

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.

For detailed information about the usage of organizations in API Management, refer to Organizations in the API Management guide.

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

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.

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

If your service does contain forms:

  • Enter proxy port 5444.

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.

For detailed information about the usage of organizations in API Management, refer to Organizations in the API Management guide.

When the service has been deployed successfully, use icon Open Test API  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.

The test UI opens within API Management.

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.

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

Open tab Implementation and check the API Endpoint.

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

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.

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

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

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.

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 Running in a Container

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

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

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

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

On this page, open tab Details.

Scroll down to tab Endpoints.

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

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

On this Page:
Related Pages:
Related Documentation:

  • No labels