Versions Compared

Old Version 8

changes.mady.by.user Former user

Saved on

compared with

New Version 9

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: ✉️ Need more clarity in Subscription workflow documentation

...

Localtabgroup
Localtab
activetrue
idUsingEI
titleUsing 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
    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 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
    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 <API-M_HOME>/business-processes directory with the new port (i.e., the value of 9763 + <port-offset>).

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

  4. 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.epr
    • ApplicationCallbackService.epr

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

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

Configuring the Business Process Server

  1. Download WSO2 Enterprise Integrator. 

  2. 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
    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 <API-M_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.

    • ApplicationService.epr
    • ApplicationCallbackService.epr

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

  6. 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.
  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 BPS. 
    This is the human task archived file.

...