Leveraging BMC Helix iPaaS APIs in a business process

After you add the APIs in BMC Helix Innovation Studio, you can leverage these APIs in the business process of your applications by configuring the iPaaS Jitterbit element in the BMC Helix Innovation Studio Process designer.

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

To configure the iPaas Jitterbit 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 BMC Helix iPaaS APIs.  
3. Perform one of the following tasks:
   
   • If you want to add the iPaaS Jitterbit APIs element to a new process, select Processes > New. 
   • If you want to add the iPaaS Jitterbit APIs 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 Jitterbit 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 the 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 that you have created the document definition. A document definition is a schema with fields defined in the JSON format. You create a document definition to access individual attributes within a metadata object and then use those attributes in an expression for a process. For more information, see Defining a document schema.

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 with REST services in a codeless way