All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

    Code Block
    languagehtml/xml
    <WorkFlowExtensions>
    ...
        <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>
        </ApplicationCreation>
    ... 
    </WorkFlowExtensions>
    Tip

    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.    
    Note You will see the message that appears following message saying "Waiting for approval" if the BPEL is invoked correctly, saying 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:

    Code Block
    languagehtml/xml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wor="http://workflow.subscription.apimgt.carbon.wso2.org">
       <soapenv:Header />
       <soapenv:Body>
          <wor:createApplication xmlns:wor="http://workflow.application.apimgt.carbon.wso2.org">
             <wor:applicationName>application1</wor:applicationName>
             <wor:applicationTier>Gold</wor:applicationTier>
             <wor:applicationCallbackUrl>http://webapp/url</wor:applicationCallbackUrl>
             <wor:applicationDescription>Application 1</wor:applicationDescription>
             <wor:tenantDomain>wso2.com</wor:tenantDomain>
             <wor:userName>user1</wor:userName>
             <wor:workflowExternalRef>c0aad878-278c-4439-8d7e-712ee71d3f1c</wor:workflowExternalRef>
             <wor:callBackURL>https://localhost:8243/services/WorkflowCallbackService</wor:callBackURL>
          </wor:createApplication>
       </soapenv:Body>
    </soapenv:Envelope>

    Elements of the above configuration are described below:

    ElementDescription
    applicationName
    Name of the application the user creates.
    applicationTier
    Throttling tier of the application.
    applicationCallbackUrl
    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.
    applicationDescription
    Description of the application
    tenantDomain
    Tenant domain associated with the application (domain of the user creating the application).
    userName
    Username of the user creating the application.
    workflowExternalRef
    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.
    callBackURL

    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.