This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Adding an Application Registration Workflow - API Manager 1.10.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

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

Introduction to the application registration workflow

Application creation and registration are different workflows. After an application is created, you can subscribe to available APIs, but you get the consumer key/secret and access tokens only after registering the application. There are two types of registrations that can be done to an application: production and sandbox. You change the default application registration workflow in situations such as the following:

  1. To issue only sandbox keys when creating production keys is deferred until testing is complete.
  2. To restrict untrusted applications from creating production keys. You allow only the creation of sandbox keys.
  3. To make API subscribers go through an approval process before creating any type of access token.

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-registration/HumanTask/  file, update the role as follows in the  file, and ZIP the  ApplicationRegistrationTask-1.0.0 folder.

    <htd:argument name="role">
  • Change the allowedRoles parameter in the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json file.

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. Also see Changing the Default Ports with Offset.


    Tip: If you change the BPS port offset to a value other than 2 or run the API Manager and BPS on different machines (therefore, want to set the hostname to a different value than localhost), you do the following:

    • Search and replace the value 9765 in all the files (.epr) inside <APIM_HOME>/business-processes folder with the new port (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 <APIM_HOME>/business-processes/epr to <BPS_HOME>/repository/conf/epr folder. If the <BPS_HOME>/repository/conf/epr folder isn't there, please create it.

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

    • RegistrationService.epr
    • RegistrationCallbackService.epr
  5. Start the BPS server and log in to its management console (https://<Server Host>:9443+<port offset>/carbon).  

  6. Select Add under the Processes menu and upload the <APIM_HOME>/business-processes/application-registration/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-registration/HumanTaskBPEL/ file to BPS. This is the human task archived file.

  Configuring the API Manager

Open the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/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 registration workflow.

  1.   Log in to the APIM 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:

        <ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor">
            <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property>
            <Property name="username">admin</Property>
            <Property name="password">admin</Property>
            <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property>
        <SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor">
            <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property>
            <Property name="username">admin</Property>
            <Property name="password">admin</Property>
            <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property>

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

  3. Go to the API Store Web interface, open My Subscriptions page, select an application and click the Generate button associated with the production key.
    It invokes the ApplicationRegistrationWorkFlowProcess.bpel that is bundled with the file and creates a HumanTask instance that holds the execution of the BPEL process until some action is performed on it.   

  4. Note a message that appears saying that the request is successfully submitted if the BPEL was invoked correctly. For example,

  5. Log in to the Admin Dashboard Web application (https://<Server Host>:9443/admin-dashboard) and list all the tasks for application registrations. Click Start to start the Human Task and then change its state. Once you approve the task, it resumes the BPEL process and completes the registration.

  6. Go back to the My Subscriptions page on the API Store and view your application.

    It shows the application access token, consumer key and consumer secret. For example,

After the registration request is approved, keys are generated by invoking the APIKeyMgtSubscriber service hosted in Key Manger nodes. Even when the request is approved, key generation can fail if this service becomes unavailable. To address such failures, you can configure to trigger key generation at a time Key Manager nodes become available again. Given below is the message used to invoke the BPEL process:

<applicationregistrationworkflowprocessrequest xmlns:wor=""
  • No labels