With the introduction of workflows, when users try to sign up to the API Manager Store, their request for user accounts will go into an intermediary state where in which it will remain till approved by the workflow authorization administrator.
To enable User Sign Up workflow you will need to change the UserSign up executor from
UserSignUpWSWorkflowExecutor in the
<AM_HOME>/repository/conf/api-manager.xml (see below).
<!--UserSignUp executor="org.wso2.carbon.apimgt.impl.workflow.UserSignUpSimpleWorkflowExecutor"/--> <UserSignUp executor="org.wso2.carbon.apimgt.impl.workflow.UserSignUpWSWorkflowExecutor"> <Property name="serviceEndpoint">https://localhost:9444/services/UserSignUpWorkflowService</Property> <Property name="username">admin</Property> <Property name="password">admin</Property> <Property name="callbackURL">https://localhost:8243/services/WorkflowCallbackService</Property> </UserSignUp>
When making this change you need to specify the service endpoint at which the Workflow Engine is hosted along with the credentials required to access said service via Basic Authentication (i.e., username and password).
Invoking the Workflow Engine
UserSignUpWSWorkflowExecutor is engaged, whenever a user tries to sign up in API Manager Store, a request of the following format will be sent to the Workflow Endpoint (You may refer the WSDL here when implementing your custom Workflow Service) specified under
serviceEndpoint in the
<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>
A detailed explanation of each property is as follows.
|The user name requested by the user|
|tenantDomain||Domain to which said user belongs to|
|workflowExternalRef||The unique reference against which a workflow will be tracked. This will need to be sent back from the Workflow Engine to API Manager at the time of workflow completion.|
At the time of workflow completion, this is URL to which the "Workflow completed" request will be sent to by the Workflow Engine. This property is configured under the "callBackURL" property in the api-manager.xml
(Can be either a SOAP or REST endpoint)
In addition to invoking the Workflow Engine, at the time of executing a Workflow an entry will be added to the AM_WORKFLOWS table in the API Manager Database, indicating the workflow status and workflow external reference along with a host of other information. This entry in turn will be used to track the progress of the workflow throughout its lifecycle. At a given time, the status of a workflow can be either 'CREATED', APPROVED' or 'REJECTED'. 'CREATED' is the default status of a workflow, it will get promoted to either 'APPROVED' or 'REJECTED' state based on the response from Workflow Engine.