Integrating BMC Helix Innovation Studio applications with third-party applications by using BMC Helix iPaaS, powered by MuleSoft

You can use BMC Helix iPaaS, powered by MuleSoft, to integrate BMC Helix Innovation Studio applications with third-party applications. BMC Helix Integration Platform as a Service (BMC Helix iPaaS), connects BMC products with on-premises, cloud, and legacy third-party applications. Learn more about BMC Helix iPaaS in  BMC Helix iPaaS  documentation.

You can define the APIs in MuleSoft Anypoint Platform to establish a connection and transfer data between BMC Helix Innovation Studio and an external third-party application. You can then reuse these APIs in the business processes of your applications without having to rebuild the integration for each application or use.

For example, if you want to connect to a Jira REST service to get details of a Jira issue in your application, first connect to BMC Helix iPaaS, powered by MuleSoft and add the APIs required to connect to JIRA. Then leverage the iPaaS MuleSoft activity element in a process to access the details of the Jira issue in your process.

Before you begin

Make sure you have the following subscriptions and files to successfully set up and use MuleSoft in Anypoint Platform:

• A valid  MuleSoft Anypoint Platform  subscription.
• Application business analyst and administrator access to BMC Helix Innovation Studio to create workflows and processes.

Process for connecting to BMC Helix iPaaS and integrating BMC Helix Innovation Studio applications with third-party applications

The following table explains the process for connecting to BMC Helix iPaaS:

To connect to MuleSoft Anypoint Platform

1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
2. Select Integrations > iPaas MuleSoft > iPaaS MuleSoft configuration. 
   

3. On the iPaaS MuleSoft configuration page, enter the following details:

   Field	Description
   iPaaS MuleSoft API endpoint URL	The API URL to the MuleSoft Anypoint Platform; for example, https://anypoint.mulesoft.com
   User name	User login name to connect to MuleSoft Anypoint Platform.
   Password	Password to connect to the MuleSoft Anypoint Platform.

4. Click Test connection.

   Important

   If the connection fails, verify that you have entered the correct endpoint API, user name, and password.

5. Click Save.

To add iPaaS Mulesoft APIs to BMC Helix Innovation Studio

Before you add the APIs available in MuleSoft in Anypoint Platform, make sure that you have defined Organization, Environment, and generate and publish the APIs in MuleSoft Anypoint Platform. For more information, see the  MuleSoft documentation  on MuleSoft Success Central.

1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
2. Select Integrations > iPaas MuleSoft > iPaaS MuleSoft APIs. 

3. On the iPaaS MuleSoft APIs page, click Add. 
   

4. On the Add API page, enter the details described in the following table:

   Field	Description
   API path
   Organization	Select the organization that you have defined in MuleSoft Anypoint Platform. If you have defined a single organization in MuleSoft, the value is automatically populated. You create and manage your company's integration projects in an organization. For more information, see Organization .
   Environment	Select the environment within the organization defined in MuleSoft Anypoint Platform. You define and manage the project's lifecycle in an environment like Development, Test, and Production within an organization. For more information, see Environments .
   API path	Select the API you created within the environment; for example, /development/createIssue. For more information, see  API Manager .
   API properties
   API group name	Select the existing group name. To create a new group, click Add new. An API group is used to organize related APIs. For example, you can use one group to add all the APIs with the same endpoint.
   API name	Enter a name for the API.
   Request method	Select the HTTP method for the API. If you have defined a single request method for the API path in MuleSoft, this value is automatically populated when you select the API path.
   Authorization type	Select the authorization type for the API path. If you have defined a single authorization type for the API path in MuleSoft, this value is automatically populated when you select the API path.
   API variables
   Headers	Add the headers for this API request. Headers represent the metadata associated with the API request and response.
   Query parameters	Add the query parameters for this API request. Query parameters control what data is returned in the endpoint responses.

5. Click Save. 

6. (Optional) To edit the APIs, perform the following steps: 

   1. On the iPaaS MuleSoft APIs page, click the API name or select the check box, and click Edit.

   2. From the Edit API page, update the field values that you want, and click Save.

7. (Optional) To rename an API group, perform the following steps: 
   1. On the iPaaS MuleSoft APIs page, click the Group name that you want to rename. 
   2. On the Rename API group dialog box, in the API group name, update the existing group name, and click Save.

To configure the iPaas MuleSoft element in a process

1. Log in to BMC Helix Innovation Studio. 
2. From the Workspace tab, navigate to the application where you want to use the MuleSoft APIs.  
3. Perform one of the following tasks:
   
   • If you want to add the iPaaS MuleSoft element to a new process, select Processes > New. 
   • If you want to add the iPaaS MuleSoft element to an existing process, click the Processes tab and click the name of the process.

4. From the Palette, on the canvas, drag the iPaaS MuleSoft element to the canvas at that point in the process where you want to invoke the API request.

5. On the Element properties  tab, in the Label field, type a meaningful name for the web request, such as Create Issue.

6. In the INPUT MAP section, from the API Name list, select the API you have already added in BMC Helix Innovation Studio.

7. In Mapping Mode, select one of the following options:

   • Fields—Click Add/Remove Document Nodes, and select the fields manually.

   • Document—Select Click to build an expression, and select the request body.

     Important

     Make sure you have created the document definition. A document definition is a schema with fields defined in the JSON format. For more information, see Defining a document schema.

     If the API has request and response bodies, the generated request and response documents will be in the following format under the Helix iPaaS MuleSoft application:

     <group>-<API name>_Request and <group>-<API name>_Response

8. In Headers > head, click Click to build an expression, and select headers for the selected API request.

9. In Query Parameters > param, click Click to build an expression, and add the query parameters for the selected API request.

10. Click Save. 

Related topic

Integrating BMC Helix Innovation Studio applications with third-party applications by using BMC Helix iPaaS, powered by Jitterbit