Page Comparison

...

Tip

Before you begin, if you have changed the API Manager's default user and role, make sure you do the following changes:

Give the correct credentials in the <BPS_HOME>/repository/conf/epr files.
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.
Change the user credentials in <APIM_HOME>/repository/conf/api_manager.xml file.Change the .ht file of the relevant human task.
Change the allowedRoles parameter in the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json file.

...

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

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

Code Block

language	html/xml

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

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

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.
Note the message that appears if the BPEL is invoked correctly, saying that the request is successfully submitted.
Log in to the Admin Dashboard Web application (https://<Server Host>:9443/admin-dashboard) and approve the user signup task. It resumes the BPEL process and completes the signup process.

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:

Code Block

language	html/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: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.

Versions Compared

Old Version 9

New Version 10

Key