This documentation is for WSO2 API Manager 2.1.0 View documentation for the latest release.
Adding a User Signup Workflow - API Manager 2.1.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

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.

Note that this documentation is based on WSO2 EI 6.1.1

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 EI.
  • Share any LDAPs, if exist.
  • Unzip the <API-M>/business-processes/user-signup/UserApprovalTask-1.0.0.zip file, update the role as follows in the UserApprovalTask.ht file.

    Format
    <htd:argument name="role">
        [new-role-name]
    </htd:argument>
  • Zip the UserApprovalTask.ht folder.

Configuring the Business Process Server

  1. Download WSO2 Enterprise Integrator.

    Before you begin configuring EI, please update your EI 6.1.1 pack using WUM. For more information, see Updating WSO2 Products.

    • Import the EI server's public cert into the APIM's client-trustore.jks keystore. For instructions on importing, see Creating New Keystores.
  2. Set an offset of 2 to the default EI port in the <EI_HOME>/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.

    <Offset>2</Offset>

    Tip: If you change the EI port offset to a value other than 2 or run the API Manager and EI 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.)

    Note: Make sure that the port offset is updated in the following files as well. Note that the zipped files should be unzipped for you to be able to see the files

    1. <API-M_HOME>//business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip/UserApprovalTask.wsdl

    2. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/UserApprovalTask.wsdl

    3. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/WorkflowCallbackService.wsdl

  3. Open the  <EI_HOME>/wso2/business-process/conf/humantask.xml file and <EI_HOME>/wso2/business-process/conf/b4p-coordination-config.xml  file and set the  TaskCoordinationEnabled property to true. For further information on this configuration, see Configuring Human Task Coordination.

    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>
  4. Copy the following from the <API-M_HOME>/business-processes/epr folder to the <EI_HOME>/wso2/business-process/repository/conf/epr folder. 
    Create the <EI_HOME>/wso2/business-process/repository/conf/epr folder if it does not exist.

    Make sure to give the correct credentials in the  <EI_HOME>/wso2/business-process/repository/conf/epr  files.


    • UserSignupService.epr - This is the service that invokes the  EIs business process engine
    • UserSignupProcess.epr - This is the workflow call back service.
  5. Start the BPS profile of the WSO2 EI server and sign in to its management console (https://<Server Host>:9443+<port offset>/carbon). .  

    If you are using a Mac OS with High Sierra, you may encounter the following warning when you sign in to the management console. This is because of a compression issue that exists in High Sierra SDK.

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

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

  6. Select Add under the Processes menu and upload the <API-M_HOME>/business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip file to EI. This is the business process archive file.
  7. Select Add under the Human Tasks menu and upload the <API-M_HOME>/business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip file to EI. This is the human task archived file.

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/user-signup/UserApprovalTask-1.0.0.zip file, update the role as follows in the UserApprovalTask.ht file, and ZIP the UserApprovalTask.ht folder.

    Format
    <htd:argument name="role">
        [new-role-name]
    </htd:argument>

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. For more information, 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 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.)

    Note: Make sure that the port offset is updated in the following files as well. Note that the zipped files should be unzipped for you to be able to see the files

    1. <API-M_HOME>//business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip/UserApprovalTask.wsdl

    2. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/UserApprovalTask.wsdl

    3. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/WorkflowCallbackService.wsdl

  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. For further information on this configuration see Configuring Human Task Coordination.

    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>
  4. Copy the following from the <API-M_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 - This is the service that will call the BPS
    • UserSignupProcess.epr - This is the workflow call back service
  5. Start the BPS server and log in to its management console (https://<Server Host>:9443+<port offset>/carbon).  

    If you are using a Mac OS with High Sierra, you may encounter the following warning when you sign in to the management console. This is because of a compression issue that exists in High Sierra SDK.

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

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

  6. Select Add under the Processes menu and upload the <API-M_HOME>/business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip file to BPS. This is the business process archive file. At minimum this file should contain
    • The deployment descriptor
    • One or more process definitions (BPEL), WSDL and XSDs

      Additionally, the zip file can also contain other files such as SVGs or XSLs.

  7. Select Add under the Human Tasks menu and upload the <API-M_HOME>/business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip file to BPS. This is the human task archived file where the tasks definition includes input and output message formats for the human task.


Configuring the API Manager

  1. 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 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, disable 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 EI/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:

    ElementDescription
    userName
    The user name requested by the user
    tenantDomainDomain to which the user belongs to
    workflowExternalRefThe 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.

  • No labels