Adding a User Signup Workflow

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

Configuring the Business Process Server

1. Download WSO2 Business Process Server.  

2. Set an offset of 2 to the default BPS port in the <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>

   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 thehostname 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.

   <TaskCoordinationEnabled>true</TaskCoordinationEnabled>

4. Copy the following from the <APIM_HOME>/business-processes/epr folder to the <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. 

   • UserSignupService.epr
   • UserSignupProcess.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/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip 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/user-signup/HumanTask/UserApprovalTask-1.0.0.zip file to BPS. This is the human task archived file.

Configuring the API Manager

1. Open the <APIM_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 user signup workflow.

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

2. Go to /_system/governance/apimgt/applicationdata/workflow-extensions.xml resource, d isable the Simple Workflow Executor and enable WS Workflow Executor. Also 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).

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

   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 and sign up.
   It invokes the signup process and creates a Human Task instance that holds the execution of the BPEL until some action is performed on it.

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

5. Log in to the Admin Portal ( https://<Server Host>:9443/admin ) and approve the user signup task. It resumes the BPEL process and completes the signup process.

6. Go back to the API Store and see that the user is now registered.

   Whenever a user tries to sign up to the API Store, a request of the following format is sent to the workflow endpoint:

   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wor="http://workflow.subscription.apimgt.carbon.wso2.org">
      <soapenv:Header />
      <soapenv:Body>
         <wor:registerUser xmlns:wor="http://workflow.registeruser.apimgt.carbon.wso2.org">
            <wor:userName>sampleuser</wor:userName>
            <wor:tenantDomain>foo.com</wor:tenantDomain>
            <wor:workflowExternalRef>c0aad878-278c-4439-8d7e-712ee71d3f1c</wor:workflowExternalRef>
            <wor:callbackURL>https://localhost:8243/services/WorkflowCallbackService</wor:callBackURL>
         </wor:registerUser>
      </soapenv:Body>
   </soapenv:Envelope>

   Elements of the above configuration are described below:

   Element	Description
   userName	The user name requested by the user
   tenantDomain	Domain to which the user belongs to
   workflowExternalRef	The unique reference against which a workflow is tracked. This needs to be sent from the workflow engine to the API Manager at the time of workflow completion.
   callBackURL	The URL to which the workflow completion request is sent by the workflow engine, at the time of workflow completion. This property is configured under the callBackURL property in the api-manager.xml file.