Adding an Application Registration Workflow

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.

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.

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.

   <Offset>2</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.

   <TaskCoordinationEnabled>true</TaskCoordinationEnabled>

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.

   • 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/ApplicationRegistrationWorkflowProcess_1.0.0.zip file to BPS. This is the business process archive file.
   

   Open

   

7. Select Add under the Human Tasks menu and upload the <APIM_HOME>/business-processes/application-registration/HumanTaskBPEL/ApplicationRegistrationTask-1.0.0.zip file to BPS. This is the human task archived file.

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/")

First, enable the application registration workflow.

1.   Log in to the APIM management console (https://<Server Host>:9443/carbon) and select Browse under Resources.
   

   Open

   

2. Go to the /_system/governance/apimgt/applicationdata/workflow-extensions.xml resource, disable the Simple Workflow Executor and enable WS Workflow Executor:

   <WorkFlowExtensions> ... <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> </ProductionApplicationRegistration> ...   <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> </SandboxApplicationRegistration> ... </WorkFlowExtensions>

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 ApplicationRegistrationWorkflowProcess_1.0.0.zip 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,

   Open