...
- 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, 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).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 EI/BPS run on port 9765 because you changed its default port (9763) with an offset of 2.
Note Localtabgroup Localtab active true id ForEI title Using EI When enabling the workflow features, make sure you import the certificate of the API Manager into the
client-truststore
located inside the<EI_HOME>/wso2/business-process/repository/resources/security
directory.Localtab id ForBPS title Using BPS When enabling the workflow features, make sure you import the certificate of the API Manager into the
client-truststore
located inside the<BPS_HOME>/repository/resources/security
directory.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 Portal (
https://<Server Host>:9443/admin
) 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 theworkflow-extensions.xml registry
file.