This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.

All docs This doc
Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 10 Next »

This section explains how to attach a custom workflow to the application creation operation in WSO2 API Manager (WSO2 API-M). First, see Workflow Extensions for information on different types of workflow executors.

Attaching a custom workflow to application creation allows you to control the creation of applications within the Store. An application is the entity that holds a set of subscribed  API's that would be accessed by a authorization key specified for that praticular application. Hence, controlling the creation of these applications would be a decision based on the oragnization's requirement. Some example use cases would be

  • Review the information of the application by a specific reviewer before the application is created.
  • The application creation would be offered as a paid service.
  • The application creation should be allowed only to users who are in a specific role.

Before you begin, if you have changed the API Manager's default user and role, make sure you do the following changes:

  • Change the credentials of the workflow configurations in the registry resource _system/governance/apimgt/applicationdata/workflow-extensions.xml.
  • Point the database that has the API Manager user permissions to BPS.
  • Share any LDAPs, if exist.
  • Unzip the <API-M>/business-processes/application-creation/HumanTask/ file, update the role as follows in the file, and ZIP the ApplicationsApprovalTask-1.0.0 folder.

    <htd:argument name="role">    

Configuring the Business Process Server

  1. Download WSO2 Business Process Server.
  2. Set an offset of 2 to the default BPS port in <BPS_HOME>/repository/conf/carbon.xml file. This prevents port conflicts that occur when you start more than one WSO2 product on the same server. For more information, see Changing the Default Ports with Offset


    Tip: If you change the BPS port offset to a value other than 2 or run WSO2 API-M and WSO2 BPS on different machines (therefore, want to set the hostname to a different value than localhost), you need to search and replace the value 9765 in all the files (.epr) inside the <APIM_HOME>/business-processes directory with the new port (i.e., the value of 9763 + <port-offset>).

  3. Open the <BPS_HOME>/repository/conf/humantask.xml file and <BPS_HOME>/repository/conf/b4p-coordination-config.xml file and set the TaskCoordinationEnabled property to true.

  4. Copy the following from the <API-M_HOME>/business-processes/epr directory to the <BPS_HOME>/repository/conf/epr directory. 
    If the <BPS_HOME>/repository/conf/epr directory does not exist, create it. 

    Make sure to give the correct credentials in the  <BPS_HOME>/repository/conf/epr  files.

    • ApplicationService.epr
    • ApplicationCallbackService.epr
  5. Start the BPS server and sign in to the management console (https://<Server Host>:9443+<port-offset>/carbon).   

    If you are using Mac OS with High Sierra, you may encounter following warning when login into the Management console due to a compression issue exists in High Sierra SDK.

    WARN {org.owasp.csrfguard.log.JavaLogger} -  potential cross-site request forgery (CSRF) attack thwarted (user:<anonymous>,, method:POST, uri:/carbon/admin/login_action.jsp, error:required token is missing from the request)

    To avoid this issue open <BPS_HOME>/repository/conf/tomcat/catalina-server.xml and change the compression="on" to compression="off" in Connector configuration and restart the BPS.

  6. Select Processes > Add and upload the <APIM_HOME>/business-processes/application-creation/BPEL/ file to BPS.
    This is the business process archive file.
  7. Select Add under the Human Tasks menu and upload the <APIM_HOME>/business-processes/application-creation/HumanTask/ file to BPS.
    This is the human task archived file.

Configuring WSO2 API Manager

Open the <API-M_HOME>/repository/deployment/server/jaggeryapps/admin/site/conf/site.json file and configure "workFlowServerURL" under "workflows" to point to the BPS server (e.g., "workFlowServerURL": "https://localhost:9445/services/")

Engaging the WS Workflow Executor in the API Manager

First, enable the application creation workflow.

  1. Sign in to WSO2 API-M management console (https://<Server-Host>:9443/carbon) and select Browse under Resources.
  2. Go to the /_system/governance/apimgt/applicationdata/workflow-extensions.xml resource, disable the Simple Workflow Executor, and enable WS Workflow Executor. In addition, specify the service endpoint where the workflow engine is hosted and the credentials required to access the said service via basic authentication (i.e., username/password based authentication).

        <ApplicationCreation executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationCreationWSWorkflowExecutor">
             <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationApprovalWorkFlowProcess/</Property>
             <Property name="username">admin</Property>
             <Property name="password">admin</Property>
             <Property name="callbackURL">https://localhost:8243/services/WorkflowCallbackService</Property>

    All the workflow process services of the BPS run on port 9765 because you changed its default port (9763) with an offset of 2.

    The application creation WS Workflow Executor is now engaged.

  3. Go to the API Store, click Applications and create a new application.
    It invokes the application creation process and creates a Human Task instance that holds the execution of the BPEL process until some action is performed on it.    
    You will see the following message saying "Waiting for approval" if the BPEL is invoked correctly, indicating that the request is successfully submitted. 

  4. Sign in to the Admin Portal (https://localhost:9443/admin), list all the tasks for application creation and approve the task. It resumes the BPEL process and completes the application creation.

  5. Go back to the Applications page in WSO2 API Store and see the created application. 

    Whenever a user tries to create an application in the API Store, a request is sent to the workflow endpoint. Given below is a sample:

    <soapenv:Envelope xmlns:soapenv="" xmlns:wor="">
       <soapenv:Header />
          <wor:createApplication xmlns:wor="">
             <wor:applicationDescription>Application 1</wor:applicationDescription>

    Elements of the above configuration are described below:

    Name of the application the user creates.
    Throttling tier of the application.
    When the OAuth2 Authorization Code grant type is applied, this is the endpoint on which the callback needs to happen after the user is authenticated. This is an attribute of the actual application registered on the API Store.
    Description of the application
    Tenant domain associated with the application (domain of the user creating the application).
    Username of the user creating the application.
    The unique reference against which a workflow is tracked. This needs to be sent back from the workflow engine to the API Manager at the time of workflow completion.

    At the time of workflow completion, the workflow engine sends the workflow-completion request to this URL. This property is configured in the <callBackURL> element in the api-manager.xml file.

  • No labels