This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.
API Manager 2.1.0

All docs This doc
Expand all   Collapse all

Versions Compared

Old Version 14

changes.mady.by.user Mariangela Hills

Saved on

compared with

New Version 15

changes.mady.by.user Mariangela Hills

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed minor formatting issue

...

Localtab Group
Localtab
activetrue
idUsingEI
titleUsing WSO2 EI
Note

Note that this documentation is based on WSO2 EI 6.1.1

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 registry resource _system/governance/apimgt/applicationdata/workflow-extensions.xml.
  • Point the database that has the API Manager user permissions to EI.
  • Share any LDAPs that 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,

    Code Block
    titleFormat
    <htd:argument name="role">    
	[new-role-name]
</htd:argument> 

  • Zip the ApplicationsApprovalTask-1.0.0 folder.

Configuring the Business Process Server

  1. Download WSO2 Enterprise Integrator.  Please note that this documentation is based on WSO2 EI 6.1.1.

    Tip

    Before you begin configuring EI, please update your EI 6.1.1 pack using WUM. For more information, see Updating WSO2 Products.

    • Import the EI server's public cert into the API-M's client-trustore.jks keystore. For instructions on importing, see Creating New Keystores.

  2. Set an offset of 2 to the default EI port in <EI_HOME>/wso2/business-process/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
    languagexml
    <Offset>2</Offset>
    Tip

    Tip: If you change the EI port offset to a value other than 2 or run WSO2 API-M and WSO2 EI 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>).

  3. Open the <EI_HOME>/wso2/business-process/conf/humantask.xml  file xml  file and <EI_HOME>/wso2/business-process/conf/b4p-coordination-config.xml file and set the TaskCoordinationEnabled property to true.

    Code Block
    languagexml
    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>

  4. Copy the following from the <API-M_HOME>/business-processes/epr directory to the <EI_HOME>/wso2/business-process/repository/conf/epr directory. 

    Note

    • If the <EI_HOME>/wso2/business-process/repository/conf/epr  directory does not exist, create it. 

    • Make sure to give the correct credentials in the  <EI_HOME>/wso2/business-process/repository/conf/epr  files.


    • Update the <API-M_HOME>/business-processes/epr/ApplicationCallbackService.epr file according to API Manager.

      Code Block
      <wsa:Address>https://localhost:8243/services/WorkflowCallbackService</wsa:Address>

    • Update the <API-M_HOME>/business-processes/epr/ApplicationService.epr file according to EI.

      Code Block
      <wsa:Address>http://localhost:9765/services/ApplicationService</wsa:Address>

  5.  Start the EI server and sign in to its management console (https://<Server Host>:9443+<port offset>/carbon).

    Warning

    If you are using Mac OS with High Sierra, you may encounter following warning when login into the Management console due to a compression issue exists in 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 <EI_HOME>/wso2/business-processconf/tomcat/catalina-server.xml file and change the compression="on" to compression="off" in Connector configuration.Restart the EI server.

  6. Select Processes > Add and upload the <API-M_HOME>/business-processes/application-creation/BPEL/ApplicationApprovalWorkFlowProcess_1.0.0.zip file to EI. 
    This is the business process archive file.
  7. 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 EI. 
    This is the human task archived file.
Localtab
idUsingBPS
titleUsing 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 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.

  • 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
    titleFormat
    <htd:argument name="role">    
	[new-role-name]
</htd:argument> 

Configuring the Business Process Server

  1. Download WSO2 Business Process Server.

  2. Set an offset of 2 to the default BPS port in <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
    languagexml
    <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 <APIM_HOME>/business-processes directory with the new port (i.e., the value of 9763 + <port-offset>).

  3. 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
    languagexml
    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>

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

    • Update the <API-M_HOME>/business-processes/epr/ApplicationCallbackService.epr file according to API Manager.

      Code Block
      <wsa:Address>https://localhost:8243/services/WorkflowCallbackService</wsa:Address>

    • Update the <API-M_HOME>/business-processes/epr/ApplicationService.epr file according to BPS.

      Code Block
      <wsa:Address>http://localhost:9765/services/ApplicationService</wsa:Address>

  5. 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 following warning when login into the Management console due to a compression issue exists in 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 <BPS_HOME>/repository/conf/tomcat/catalina-server.xml and change the compression="on" to compression="off" in Connector configuration and restart the BPS.

  6. Select Processes > Add and upload the <APIM_HOME>/business-processes/application-creation/BPEL/ApplicationApprovalWorkFlowProcess_1.0.0.zip file to BPS. 
    This is the business process archive file.
  7. Select Add under the Human Tasks menu and upload the <APIM_HOME>/business-processes/application-creation/HumanTask/ApplicationsApprovalTask-1.0.0.zip file to BPS. 
    This is the human task archived file.

...