All docs This doc

Versions Compared

Key

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

...

<ProductionApplicationRegistration
  1. Download WSO2 Enterprise Integrator

Localtab Group

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.
a. Login to the Management console of WSO2 API Manager in https://localhost:9443/carbon.
b. Click on browse under Resources in left Navigation under Main tab.
c. Go to /_system/governance/apimgt/applicationdata/workflow-extensions.xml location in registry browser and open the workflow-extensions.xml clicking Edit as text.
Image Removed
d. Uncomment the following two sections and change the credentials of API Manager's default user credetials you have given.
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:

  1. Change the credentials of the workflow configurations in the registry resource _system/governance/apimgt/applicationdata/workflow-extensions.xml.
    a. Login to the Management console of WSO2 API Manager in <https://localhost:9443/carbon>.
    b. Click Browse under Resources, under the Main tab.
    c. Go to /_system/governance/apimgt/applicationdata/workflow-extensions.xml in registry the browser and open the workflow-extensions.xml clicking Edit as text.

    d. Uncomment the following two sections and change the credentials of API Manager's default user credentials you have given.

    Warning

    This configuration is provided assuming that WSO2 EI is running with offset 2. If you are running WSO2 EI in a different offset change the port of serviceEndpoint properties in following configuration according to the changed port offset.

    Code Block
    <ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor">
        <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property>
        <Property name="username">admin</Property>
        <Property name="password">admin</Property>
        <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property>
    </ProductionApplicationRegistration>
    
    <SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor">
        <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property>
        <Property name="username">admin</Property>
        <Property name="password">admin</Property>
        <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property>
    </SandboxApplicationRegistration>
    Note

    Make sure to comment out the existing ProductionApplicationRegistration and SandboxApplicationRegistration executors as shown below.

    Code Block
    <!--ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/-->
    <!--SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/-->
  2. Point the database that has the API Manager user permissions to EI.
    In this step you need to share the user store database in WSO2 API Manager with WSO2 EI.

    a. Copy the following datasource configuration to <API-M_HOME>/repository/conf/datasources/master-datasources.xml :

    Code Block
    <datasource> <name>WSO2UM_DB</name>
     <description>The datasource used by user manager</description>
     <jndiConfig>
       <name>jdbc/WSO2UM_DB</name>
     </jndiConfig>
     <definition type="RDBMS">
       <configuration>
         <url>jdbc:mysql://userdb.mysql-wso2.com:3306/userdb?autoReconnect=true</url>
         <username>user</username>
         <password>password</password>
         <driverClassName>com.mysql.jdbc.Driver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
       </configuration>
     </definition>
    </datasource>
    Note

    We are using MySQL to configure the datasources in this documentation. You can configure this according to the database you are using. Refer Setting up the Physical Database for more information.

    b. Change the datasource to point the WSO2UM_DB by changing the realm configuration in the <API-M_HOME>/repository/conf/user-mgt.xml file as shown below.

    Code Block
    <UserManager>
        <Realm>
            <Configuration>
                ....
                <Property name="dataSource">jdbc/WSO2UM_DB</Property>
            </Configuration>
                ....
        <Realm>
    <UserManager>

    c. Repeat the configurations described in step 2(a) and 2(b) in <EI_HOME>/conf/datasources/master-datasources.xml and <EI_HOME>/conf/user-mgt.xml respectively.

  3. Share any LDAPs that exist.
  4. Unzip the  <API-M>/business-processes/application-registration/HumanTask/ApplicationRegistrationTask-1.0.0.zip  file, update the role as follows in the  ApplicationRegsitrationTask.ht  file.

    Code Block
    titleFormat
    <htd:argument name="role">
        [new-role-name]
    </htd:argument>
  5. Zip the  ApplicationRegistrationTask-1.0.0 folder.

  6. Restart the API Manager server.


Configuring the Business Process Server

Tip
Warning

This configuration is provided assuming that WSO2 BPS is running with offset 2. If you are running WSO2 BPS in a different offset change the port of serviceEndpoint properties in following configuration according to the changed port offset.

Code Block
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.
  • Set an offset of 2 to the default EI port in the <EI_HOME>/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.)
  • 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.

    Code Block
    languagexml
    <TaskCoordinationEnabled>true</TaskCoordinationEnabled>
  • 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 does not exist, then please create it.

    Note

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

    • RegistrationService.epr - This is the service that invokes the  EIs business process engine
    • RegistrationCallbackService.epr - This is the workflow call back service.
  • 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 the following warning when logging into the Management console due to 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 the compression="on" to compression="off" in Connector configuration. Restart the EI server for the changes to take effect.

  • Log into Management console of WSO2 EI, select Add > BPEL under the Processes menu and upload the <APIM_HOME>/business-processes/application-registration/BPEL/ApplicationRegistrationWorkflowProcess_1.0.0.zip file to EI. This is the business process archive file.
    Image Removed
  • Select Add under the Human Tasks menu and upload the <APIM_HOME>/business-processes/application-registration/HumanTask/ApplicationRegistrationTask-1.0.0.zip file to EI. This is the human task archived file.
    Image Removed
  • Localtab
    idUsingBPS
    titleUsing WSO2 BPS

      • Update the <API-M_HOME>/business-processes/epr/RegistrationCallbackService.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/RegistrationService.epr file according to EI.

        Code Block
        <wsa:Address>http://localhost:9765/services/ApplicationRegistration</wsa:Address>
    1. 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 the following warning when logging into the Management console due to 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 the compression="on" to compression="off" in Connector configuration. Restart the EI server for the changes to take effect.

    2. Log into Management console of WSO2 EI, select Add > BPEL under the Processes menu and upload the <APIM_HOME>/business-processes/application-registration/BPEL/ApplicationRegistrationWorkflowProcess_1.0.0.zip file to EI. This is the business process archive file.
      Image Added
    3. Select Add under the Human Tasks menu and upload the <APIM_HOME>/business-processes/application-registration/HumanTask/ApplicationRegistrationTask-1.0.0.zip file to EI. This is the human task archived file.
      Image Added
    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:

    1. Change the credentials of the workflow configurations in the registry resource _system/governance/apimgt/applicationdata/workflow-extensions.xml.
      a. Login to the Management console of WSO2 API Manager in https://localhost:9443/carbon.
      b. Click on browse under Resources in left Navigation under Main tab.
      c. Go to /_system/governance/apimgt/applicationdata/workflow-extensions.xml location in registry browser and open the workflow-extensions.xml clicking Edit as text.
      Image Added

      d. Uncomment the following two sections and change the credentials of API Manager's default user credetials you have given.

      Warning

      This configuration is provided assuming that WSO2 BPS is running with offset 2. If you are running WSO2 BPS in a different offset change the port of serviceEndpoint properties in following configuration according to the changed port offset.

      Code Block
      <ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor">
          <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property>
          <Property name="username">admin</Property>
          <Property name="password">admin</Property>
          <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property>
      </ProductionApplicationRegistration>
      
      <SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor">
          <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property>
          <Property name="username">admin</Property>
          <Property name="password">admin</Property>
          <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property>
      </SandboxApplicationRegistration>
      Note

      Make sure to comment out the existing ProductionApplicationRegistration and SandboxApplicationRegistration executors as shown below.

      Code Block
      <!--ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/-->
      <!--SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.
      impl.workflow.ApplicationRegistrationWSWorkflowExecutor"> <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property> <Property name="username">admin</Property> <Property name="password">admin</Property> <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property> </ProductionApplicationRegistration> <SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor"> <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property> <Property name="username">admin</Property> <Property name="password">admin</Property> <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property> </SandboxApplicationRegistration>
      Note

      Make sure to comment out the existing ProductionApplicationRegistration and SandboxApplicationRegistration executors as shown below.

      Code Block
      <!--ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/-->
      <!--SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/-->
      Point the database that has the API Manager user permissions to BPS.
      In this step you need to share the user store database in WSO2 API Manager with WSO2 BPS.
      a. Copy the following datasource
      impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/-->
    2. Point the database that has the API Manager user permissions to BPS.
      In this step you need to share the user store database in WSO2 API Manager with WSO2 BPS.

      a. Copy the following datasource configuration in <API-M_HOME>/repository/conf/datasources/master-datasources.xml :

      Code Block
      <datasource> <name>WSO2UM_DB</name>
       <description>The datasource used by user manager</description>
       <jndiConfig>
         <name>jdbc/WSO2UM_DB</name>
       </jndiConfig>
       <definition type="RDBMS">
         <configuration>
           <url>jdbc:mysql://userdb.mysql-wso2.com:3306/userdb?autoReconnect=true</url>
           <username>user</username>
           <password>password</password>
           <driverClassName>com.mysql.jdbc.Driver</driverClassName>
           <maxActive>50</maxActive>
           <maxWait>60000</maxWait>
           <testOnBorrow>true</testOnBorrow>
           <validationQuery>SELECT 1</validationQuery>
           <validationInterval>30000</validationInterval>
         </configuration>
       </definition>
      </datasource>
      Note

      We are using MySQL to configure the datasources in this documentation. You can configure this according to the database you are using. Refer Setting up the Physical Database for more information.

      b. Change the datasource to point the WSO2UM_DB by changing the realm configuration in <API-M_HOME>/repository/conf/

      datasources/master

      user-

      datasources

      mgt.xml

      :

      as shown below.

      Code Block
      <datasource> <name>WSO2UM_DB</name><UserManager>
       <description>The datasource used by user manager</description>
       <jndiConfig>
       <Realm>
        <name>jdbc/WSO2UM_DB</name>  </jndiConfig>  <definition type="RDBMS"> <Configuration>
        <configuration>      <url>jdbc:mysql://userdb.mysql-wso2.com:3306/userdb?autoReconnect=true</url>    ....
       <username>user</username>      <password>password</password>      <driverClassName>com.mysql.jdbc.Driver</driverClassName><Property name="dataSource">jdbc/WSO2UM_DB</Property>
           <maxActive>50</maxActive>      <maxWait>60000</maxWait></Configuration>
           <testOnBorrow>true</testOnBorrow>      <validationQuery>SELECT 1</validationQuery> ....
           <validationInterval>30000</validationInterval>
         </configuration>
       </definition>
      </datasource>
      Note

      We are using MySQL to configure the datasources in this documentation. You can configure this according to the database you are using. Refer Setting up the Physical Database for more information.

      b. Change the datasource to point the WSO2UM_DB by changing the realm configuration in <API-M_HOME>/repository/conf/user-mgt.xml as shown below.

      Code Block
      <UserManager>
          <Realm>
              <Configuration>
                  ....
                  <Property name="dataSource">jdbc/WSO2UM_DB</Property>
              </Configuration>
                  ....
          <Realm>
      <UserManager>
      c. Do the configuration described in a and b in <BPS_HOME>/repository/conf/datasources/master-datasources.xml and
      <Realm>
      <UserManager>

      c. Do the configuration described in a and b in <BPS_HOME>/repository/conf/datasources/master-datasources.xml and <BPS_HOME>/repository/conf/user-mgt.xml respectively.

    3. Share any LDAPs, if exist.
    4. Unzip the  <API-M>/business-processes/application-registration/HumanTask/ApplicationRegistrationTask-1.0.0.zip  file, update the role as follows in the  ApplicationRegsitrationTask.ht  file, and ZIP the  ApplicationRegistrationTask-1.0.0 folder.

      Code Block
      titleFormat
      <htd:argument name="role">
          [new-role-name]
      </htd:argument>
    5. Restart the API Manager server.


    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/

    user-mgt
      1. carbon.xml

    respectively.
  • Share any LDAPs, if exist.
  • Unzip the  <API-M>/business-processes/application-registration/HumanTask/ApplicationRegistrationTask-1.0.0.zip  file, update the role as follows in the  ApplicationRegsitrationTask.ht  file, and ZIP the  ApplicationRegistrationTask-1.0.0 folder.

    Code Block
    titleFormat
    <htd:argument name="role">
        [new-role-name]
    </htd:argument>
  • Restart the API Manager server.
  • Configuring the Business Process Server

      1. Download WSO2 Business Process Server.
      2. Set an offset of 2 to the default BPS port in  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.)
      3. Open the <BPS_HOME>/repository/conf/carbonhumantask.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 Offsetand the <BPS_HOME>/repository/conf/b4p-coordination-config.xml file and set the TaskCoordinationEnabled property to true.

        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
        <TaskCoordinationEnabled>true</TaskCoordinationEnabled>
      4. Copy the following from the <API-M_HOME>/business-processes

        folder with the new port (9763 + port offset.)

        Open /epr folder to the <BPS_HOME>/repository/conf/epr folder. 
        If the <BPS_HOME>/repository/conf/humantask.xml file and the epr folder does not exist, create it.

        Note

        Make sure you give the correct credentials in the <BPS_HOME>/repository/conf/

        b4p-coordination-config.xml file and set the TaskCoordinationEnabled property to true.
        Code Block
        languagexml
        <TaskCoordinationEnabled>true</TaskCoordinationEnabled>
        Copy the following from the 

        epr files.

        • Update the <API-M_HOME>/business-processes/

        epr folder to the <BPS_HOME>/repository/conf/epr folder. 
        If the <BPS_HOME>/repository/conf/epr folder does not exist, create it.
        Note

        Make sure you give the correct credentials in the <BPS_HOME>/repository/conf/epr files.

        • RegistrationService.epr
        • RegistrationCallbackService.epr

          epr/RegistrationCallbackService.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/RegistrationService.epr file according to BPS.

          Code Block
          <wsa:Address>http://localhost:9765/services/ApplicationRegistration</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 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. Log into Management console of WSO2 BPS, select Add > BPEL under the Processes menu and upload the <APIM_HOME>/business-processes/application-registration/BPEL/ApplicationRegistrationWorkflowProcess_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-registration/HumanTask/ApplicationRegistrationTask-1.0.0.zip file to BPS. This is the human task archived file.

    ...