This section explains how to attach a custom workflow to the application creation operation in WSO2 API Manager (WSO2 API-M). First, see Workflow Extensions for information on different types of workflow executors.
Attaching a custom workflow to application creation allows you to control the creation of applications within the Store. An application is the entity that holds a set of subscribed API's that would be accessed by a authorization key specified for that praticular application. Hence, controlling the creation of these applications would be a decision based on the oragnization's requirement. Some example use cases would be
- Review the information of the application by a specific reviewer before the application is created.
- The application creation would be offered as a paid service.
- The application creation should be allowed only to users who are in a specific role.
| Localtabgroup |
|---|
| Localtab |
|---|
| active | true |
|---|
| id | UsingEI |
|---|
| title | Using WSO2 EI |
|---|
| | Tip |
|---|
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 following 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 any exist.
Unzip the <API-M>/business-processes/application-creation/HumanTask/ApplicationsApprovalTask-1.0.0.zip file, update the role as follows in the ApplicationsApprovalTask.ht file, and ZIP the ApplicationsApprovalTask-1.0.0 folder. | Code Block |
|---|
| <htd:argument name="role">
[new-role-name]
</htd:argument> |
|
Configuring the Business Process Server- Download WSO2 Business Process Server.
Set an offset of 2 to the default BPS port in the <EI_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. | Code Block |
|---|
| <Offset>2</Offset> |
| Tip |
|---|
Tip: If you change the BPS port offset to a value other than 2 or run WSO2 API-M and WSO2 BPS on different machines (therefore, want to set the hostname to a different value than localhost), you need to search and replace the value 9765 in all the files ( .epr) inside the <API-M_HOME>/business-processes directory with the new port (i.e., the value of 9763 + <port-offset>). |
Open the <EI_HOME>/repository/conf/humantask.xml file and <EI_HOME>/repository/conf/b4p-coordination-config.xml file and set the TaskCoordinationEnabled property to true. | Code Block |
|---|
| <TaskCoordinationEnabled>true</TaskCoordinationEnabled> |
Copy the following from the <API-M_HOME>/business-processes/epr directory to the <EI_HOME>/repository/conf/epr directory.
If the <EI_HOME>/repository/conf/epr directory does not exist, create it. | Note |
|---|
Make sure to give the correct credentials in the <BPS_HOME>/repository/conf/epr files. |
ApplicationService.eprApplicationCallbackService.epr
Start the BPS server and sign in to the Management Console (https://<Server Host>:9443+<port-offset>/carbon). | Warning |
|---|
If you are using Mac OS with High Sierra, you may encounter the following warning when logging in to the Management Console due to a compression issue that exists in the High Sierra SDK. | Code Block |
|---|
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 the compression="on" to compression="off" in the Connector configuration, and restart the BPS. |
- Click Add under Processes and upload the
<API-M_HOME>/business-processes/application-creation/BPEL/ApplicationApprovalWorkFlowProcess_1.0.0.zip file to BPS.
This is the business process archive file.
 - Select Add under the Human Tasks menu and upload the
<API-M_HOME>/business-processes/application-creation/HumanTask/ApplicationsApprovalTask-1.0.0.zip file to BPS.
This is the human task archived file.
|
| Localtab |
|---|
| id | UsingBPS |
|---|
| title | Using WSO2 BPS |
|---|
| | Tip |
|---|
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 following 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 any exist.
Unzip the <API-M>/business-processes/application-creation/HumanTask/ApplicationsApprovalTask-1.0.0.zip file, update the role as follows in the ApplicationsApprovalTask.ht file, and ZIP the ApplicationsApprovalTask-1.0.0 folder. | Code Block |
|---|
| <htd:argument name="role">
[new-role-name]
</htd:argument> |
|
Configuring the Business Process Server- Download WSO2 Enterprise Integrator.
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. | Code Block |
|---|
| <Offset>2</Offset> |
| Tip |
|---|
Tip: If you change the BPS port offset to a value other than 2 or run WSO2 API-M and WSO2 BPS on different machines (therefore, want to set the hostname to a different value than localhost), you need to search and replace the value 9765 in all the files ( .epr) inside the <API-M_HOME>/business-processes directory with the new port (i.e., the value of 9763 + <port-offset>). |
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. | Code Block |
|---|
| <TaskCoordinationEnabled>true</TaskCoordinationEnabled> |
Copy the following from the <API-M_HOME>/business-processes/epr directory to the <BPS_HOME>/repository/conf/epr directory.
If the <BPS_HOME>/repository/conf/epr directory does not exist, create it. | Note |
|---|
Make sure to give the correct credentials in the <BPS_HOME>/repository/conf/epr files. |
ApplicationService.eprApplicationCallbackService.epr
Start the BPS server and sign in to the Management Console (https://<Server Host>:9443+<port-offset>/carbon). | Warning |
|---|
If you are using Mac OS with High Sierra, you may encounter the following warning when logging in to the Management Console due to a compression issue that exists in the High Sierra SDK. | Code Block |
|---|
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 the compression="on" to compression="off" in the Connector configuration, and restart the BPS. |
- Click Add under Processes and upload the
<API-M_HOME>/business-processes/application-creation/BPEL/ApplicationApprovalWorkFlowProcess_1.0.0.zip file to BPS.
This is the business process archive file.
- Select Add under the Human Tasks menu and upload the
<API-M_HOME>/business-processes/application-creation/HumanTask/ApplicationsApprovalTask-1.0.0.zip file to BPS.
This is the human task archived file.
|
|
...