Versions Compared

Old Version 13

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section explains how to attach a custom workflow to the application registration operation in the API Manager. First, see Workflow Extensions for information on different types of workflow executors.

Introduction to the application registration workflow

Application creation and registration are different workflows. After an application is created, you can subscribe to available APIs, but you get the consumer key/secret and access tokens only after registering the application. There are two types of registrations that can be done to an application: production and sandbox. You change the default application registration workflow in situations such as the following:

...

Tip

Before you begin, if you have changed the API Manager's default user and role, make sure you do the following changes:

  • Give the correct credentials in the <BPS_HOME>/repository/conf/epr files.
  • 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.
  • Change the .ht file of the relevant human task.

    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>
  • Change the allowedRoles parameter in the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json file.

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. Also 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/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 <APIM_HOME>/business-processes/epr to <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.

    • RegistrationService.epr
    • RegistrationCallbackService.epr

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

  6. Select Add 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/HumanTaskBPEL/ApplicationRegistrationTask-1.0.0.zip file to BPS. This is the human task archived file.

  Configuring the API Manager

Open the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json file and configure "workFlowServerURL" under "workflows" to point to the BPS server (e.g. "workFlowServerURL": "https://localhost:9445/services/")

Engaging the WS Workflow Executor in the API Manager

First, enable the application registration workflow.

...