This documentation supports the 21.3 version of BMC Helix Innovation Studio.

To view an earlier version, select the version from the Product version menu.

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

As a developer or an application business analyst, you can use BMC Helix iPaaS, powered by Jitterbit, to integrate BMC Helix Innovation Studio applications with third-party applications. BMC Helix iPaaS is an Integration Platform as a Service (iPaaS), used to connect BMC products with on-premises, cloud, and legacy third-party applications. Learn more about BMC Helix iPaaS in  BMC Helix iPaaS documentation.

In BMC Helix iPaaSdefine the APIs that you want to use to establish a connection to 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, 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 in your process.

Before you begin

Before you connect to BMC Helix iPaaS, make sure you have the following subscriptions and files to successfully set up and use BMC Helix iPaaS:

  • A valid  BMC Helix iPaaS  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 tasks in the process of connecting to BMC Helix iPaaS:

Task

Action

Reference

1

Connect to BMC Helix iPaaS to integrate your BMC Helix Innovation Studio applications with other third-party applications.

Connecting to BMC Helix iPaaS

2

Add the APIs available in BMC Helix iPaaS to BMC Helix Innovation Studio

Adding BMC Helix iPaaS APIs to BMC Helix Innovation Studio

3

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

Leveraging BMC Helix iPaaS APIs in a business process

To connect to BMC Helix iPaaS

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Integrations > iPaas Jitterbit > iPaaS Jitterbit configuration
  3. On the Helix iPaaS Jitterbit configuration page, enter the following details:

    FieldDescription
    iPaaS Jitterbit API endpoint URL

    The API URL for the BMC Helix iPaaS service. 

    For example, https://calbro.jitterbit.com/

    User nameUser login name to connect to BMC Helix iPaaS service.
    PasswordPassword to connect to the BMC Helix iPaaS service.
  4. Click Test connection.

    Important

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

  5. After successfully testing the connection, click Save.

To add BMC Helix iPaaS APIs to BMC Helix Innovation Studio

Before you add the APIs available in BMC Helix iPaaS, make sure that you have defined the Organization, Environment, and generated and published the APIs in BMC Helix iPaaS. For more information, see the following topics on Jitterbit Success Central:

  • Cloud Studio Quick Start Guide
  • Jitterbit Harmony API Integration Platform documentation
  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Integrations > iPaas Jitterbit > iPaaS Jitterbit APIs
  3. On the iPaaS Jitterbit APIs page, click Add

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

    FieldDescription
    API path
    Organization

    Select the organization that you have defined in BMC Helix iPaaS. If you have defined a single organization in BMC Helix iPaaS, then the value is automatically populated.

    You create and manage your company's integration projects in an organization.

    Environment

    Select the environment within the organization defined in BMC Helix iPaaS.

    You define and manage the project's lifecycle in an environment like Development, Test, and Production within an organization.  

    API paths

    Select the API you created within the environment; for example, /development/createIssue.

    Important: If the API paths are not displayed for the selected environment, make sure that you select the appropriate environment on the Portal Manager page, and click Regenerate Docs & Publish. 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 nameEnter a name for the API.
    Request methods

    Select the HTTP method for the API. If you have defined a single request method for the API path in BMC Helix iPaaS, 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 BMC Helix iPaaS, this value is automatically populated when you select the API path.

    API variables
    HeadersAdd the headers for this API request. Headers represent the metadata associated with the API request and response.
    Query parametersAdd 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, on the iPaaS Jitterbit APIs page, click on the API name that you want to edit. 
    From the Edit API page, update the value of the fields you want to update, and click Save
  7. (Optional) To rename an API group, on the iPaaS Jitterbit APIs page, select the Group name that you want to rename. 
    On the Rename API group dialog box, in the API group name, update the existing group name, and click Save.

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.

Related topic

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

Was this page helpful? Yes No Submitting... Thank you

Comments