API Manager 2.1.0

All docs This doc
Expand all   Collapse all

Versions Compared

Old Version 23

changes.mady.by.user Ruthryi Kulasekaran

Saved on

compared with

New Version Current

changes.mady.by.user Mariangela Hills

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed the EI links

...

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, if exist.

  • Unzip the <API-M>/business-processes/user-signup/UserApprovalTask-1.0.0.zip file, update the role as follows in the UserApprovalTask.ht file.

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

  • Zip the UserApprovalTask.ht folder.

Configuring the Business Process Server

  1. Download WSO2 Enterprise Integrator.

    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 APIM'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 the <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 the API Manager and EI on different machines (therefore, want to set the hostname to a different value than localhost), you do the following:

    • Search and replace the value 9765 in all the files (.epr) inside <APIM_HOME>/business-processes folder with the  new port (9763 + port offset.)
    Note

    Note: Make sure that the port offset is updated in the following files as well. Note that the zipped files should be unzipped for you to be able to see the files

    1. <API <API-M_HOME>//business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip/UserApprovalTask.wsdl

    2. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/UserApprovalTask.wsdl

    3. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/WorkflowCallbackService.wsdl

  3. Open the  <EI_HOME>/wso2/business-process/conf/humantask.xml file and <EI_HOME>/wso2/business-process/conf/b4p-coordination-config.xml  file and set the  TaskCoordinationEnabled property to true. For further information on this configuration, see Configuring Human Task Coordination.

    Code Block
    languagexml
    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>

  4. Copy the following from the <API-M_HOME>/business-processes/epr folder to the <EI_HOME>/wso2/business-process/repository/conf/epr folder. 
    Create the <EI_HOME>/wso2/business-process/repository/conf/epr folder if it does not exist.

    Note

    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/UserSignupProcess.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/UserSignupService.epr file according to EI.

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

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

    Warning

    If you are using a Mac OS with High Sierra, you may encounter the following warning when you sign in to the management console. This is because of a compression issue that 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>/conf/tomcat/catalina-server.xml file and change compression="on" to compression="off" in the Connector configuration, and restart the EI server.

  6. Select Add under the Processes menu and upload the <API-M_HOME>/business-processes/user-signup/BPEL/UserSignupApprovalProcess_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/user-signup/HumanTask/UserApprovalTask-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/user-signup/UserApprovalTask-1.0.0.zip file, update the role as follows in the UserApprovalTask.ht file, and ZIP the UserApprovalTask.ht 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 <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 the API Manager and BPS on different machines (therefore, want to set the hostname to a different value than localhost), you do the following:

    • Search and replace the value 9765 in all the files (.epr) inside <APIM_HOME>/business-processes folder with the  new port (9763 + port offset.)
    Note

    Note: Make sure that the port offset is updated in the following files as well. Note that the zipped files should be unzipped for you to be able to see the files

    1. <API <API-M_HOME>//business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip/UserApprovalTask.wsdl

    2. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/UserApprovalTask.wsdl

    3. <API-M_HOME>//business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip/WorkflowCallbackService.wsdl

  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. For further information on this configuration see Configuring Human Task Coordination.

    Code Block
    languagexml
    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>

  4. Copy the following from the <API-M_HOME>/business-processes/epr folder to the <BPS_HOME>/repository/conf/epr folder. 
    If the <BPS_HOME>/repository/conf/epr folder isn't there, please 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/UserSignupProcess.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/UserSignupService.epr file according to BPS.

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

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

    Warning

    If you are using a Mac OS with High Sierra, you may encounter the following warning when you sign in to the management console. This is because of a compression issue that 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 <BPS_HOME>/repository/conf/tomcat/catalina-server.xml file and change compression="on" to compression="off" in the Connector configuration, and restart BPS.

  6. Select Add under the Processes menu and upload the <API-M_HOME>/business-processes/user-signup/BPEL/UserSignupApprovalProcess_1.0.0.zip file to BPS. This is the business process archive file. At minimum this file should contain
    • The deployment descriptor

    • One or more process definitions (BPEL), WSDL and XSDs

      Additionally, the zip file can also contain other files such as SVGs or XSLs.

  7. Select Add under the Human Tasks menu and upload the <API-M_HOME>/business-processes/user-signup/HumanTask/UserApprovalTask-1.0.0.zip file to BPS. This is the human task archived file where the tasks definition includes input and output message formats for the human task.

...