Skip to content

publishing tutorials for a new mission #23071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
parser: v2
auto_validation: true
time: 30
tags: [tutorial>beginner, software-product>sap-business-technology-platform, software-product>sap-btp--cloud-foundry-environment]
primary_tag: software-product>sap-integration-suite
author_name: Karunaharan V
author_profile: https://github.com/Karunaharan
---

# Design an Integration Flow to Connect with Open Connectors
<!-- description --> Design an integration flow to integrate the capabilities Cloud Integration and Open Connectors that creates an endpoint to fetch data from BambooHR trial system.


## You will learn
- How to design and deploy an integration flow using Cloud Integration's web-based integration flow editor
- How to design an integration flow to fetch data via an API of Open Connectors


### Create an Integration Package and Integration Flow

1. In your SAP Integration Suite home page, choose **Design** > **Integrations** > **Create** to create an integration package.

<!-- border -->![Create-Package](1-1-Create-Package.png)

> An integration flow is always associated to an integration package.

2. In the **Header** tab, provide a **Name** and **Short Description** for your integration package. Choose **Save**.

<!-- border -->![Package-Header](1-2-Package-Header.png)

>The **Technical Name** gets populated automatically based on the name that you provide.

3. Choose **Artifacts** tab. Here you will create your first integration flow. Choose **Add** > **Integration Flow**.

4. Enter a **Name** for the integration flow and choose **OK**.

<!-- border -->![1-4-Integration-Flow](1-4-Integration-Flow.png)

5. Choose **Save** and open the integration flow by selecting it.

6. Choose **Edit** to start editing the integration flow.

Choose **Restore** at the bottom right corner to bring up the **Property Sheet**. Property sheet is the place where you configure the parameters for every step in the integration flow.

<!-- border -->![1-6-Edit-Iflow](1-6-Edit-Iflow.png)


### Connect Sender Channel with HTTPS Adapter

In this step, you define your sender channel and sender adapter. In this case, we use an HTTPS sender adapter. This will help you create a simple HTTP endpoint which you can invoke to execute the integration scenario.

1. Choose the **Sender** step. Create the sender channel by clicking the arrow icon on **Sender** and dragging it to the **Start** step.

<!-- border -->![Create the sender channel](2-1-connect-sender-channel.png)

2. In the **Adapter Type** prompt, select the **HTTPS** adapter.

<!-- border -->![Select HTTPS adapter](2-2-select-https-adapter.png)

3. In the property sheet, select the **Connection** tab. In the **Address** field, enter **`/employees/getdetails`**.

Optionally, you can enter any value of your choice, but ensure that you use **"/"** symbol before specifying the endpoint name. Deselect the **CSRF Protected** checkbox (this will be selected by default).

<!-- border -->![Configure HTTPS connection](2-3-Configure-HTTPS-Connection.png)


### Add Request Reply Step

From the palette, choose **Call** > **External Call** > **Request Reply**. Connect it to the message path.

<!-- border -->![Select Request Reply](3-1-Request-Reply.png)

<!-- border -->![Add request reply](3-1-Request-Reply-Add.png)


### Connect Request Reply to Receiver

1. Move the **Receiver** step right below the **Request Reply** step by selecting it and dragging it. You do this to ensure that your integration flow is elegantly designed.

> **TIP:** Use the pan and zoom controls for resizing the canvas.

2. Drag the arrow icon on **Request Reply** to the **Receiver** step.

<!-- border -->![Connect Request Reply to Receiver](4-2-Connect Request Reply to Receiver.png)

3. In the **Adapter Type** dialog, select **OpenConnectors**.

4. Select the **Connection** tab in the Property Sheet.

5. In the **Base URI** field, paste the copied request URL from **Step 5** of [Establish Connection Between Your BambooHR Trial and Open Connectors](btp-integration-suite-nonsapconnectivity-openconnectors).

> Do not paste the full URL. Paste only till **/api-v2**. If your request URL is **`https://<request-URL>/elements/api-v2/employees`**, paste only **`https://<request-URL>/elements/api-v2`**.

6. For the **Credential Name**, choose **Select**. A list of available user credentials that are applicable for Open Connectors come up. Select the user credential that you created.

<!-- border -->![4-6-Credential-Name](4-6-Credential-Name.png)

7. For the **Resource**, choose **Select**.

> At this point, Cloud Integration tests the connection to the mentioned Base URI using the mentioned credential name. This is a way for you to check if everything is going as expected. This connection testing helps you choose the right API resource.

<!-- border -->![4-7-Resource](4-7-Resource.png)

8. For **Method**, choose **GET** operation.

<!-- border -->![4-8-Connection-Tab](4-8-Connection-Tab.png)

9. Leave the other fields as is. Choose **Save** to keep all your configuration changes.

Now you have configured the Open Connectors receiver adapter to fetch a list of employees from your BambooHR trial account when you attempt to invoke the HTTP endpoint.


### Deploy the integration flow

Now that you have designed your integration flow, let's deploy it for further execution.

1. Choose **Deploy** to deploy the integration flow. Choose **Yes** in the confirmation dialog for deployment. Upon deployment confirmation, choose the **Deployment Status** tab in the property sheet.

<!-- border -->![5-1-Deploy-Status](5-1-Deploy-Status.png)

2. In the **Deployment Status** tab, you can see details about the deployment for the integration flow. The expected deployment status is **Deployed** and runtime status is **Started**.

<!-- border -->![5-2-Deployment-Status](5-2-Deployment-Status.png)


Later in the mission, you will use the endpoint of the deployed integration flow. Using **Postman**, you will invoke the endpoint to fetch data from your BambooHR trial system.

---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
parser: v2
auto_validation: true
time: 20
tags: [tutorial>beginner, software-product>sap-business-technology-platform, software-product>sap-btp--cloud-foundry-environment]
primary_tag: software-product>sap-integration-suite
author_name: Karunaharan V
author_profile: https://github.com/Karunaharan
---

# Establish Connection Between Your BambooHR Trial and Open Connectors
<!-- description --> Use the APIs of Open Connectors to establish a connection to your BambooHR trial account.

## You will learn
- How to connect to BambooHR from SAP Integration Suite
- How to create a security material in the Cloud Integration capability for Open Connectors


### Access Open Connectors

1. In your SAP Integration Suite home page, under **Capabilities** section, look out for the tile **Extend Non-SAP Connectivity**. Choose **Discover Connectors**.

<!-- border -->![Access-OpenConnectors](1-1-Access-OpenConnectors.png)

You're now directed to the Open Connectors web page.

2. Choose **Connectors**.

<!-- border -->![Connectors-Catalog](1-2-Connectors-Catalog.png)

You see a catalog of various third-party applications that are supported by Open Connectors.


### Authenticate with your BambooHR's Domain Name and API Key

1. In the list, look out for **Bamboo HR** and choose **API Docs**.

<!-- border -->![Access-BambooHR](2-1-Access-BambooHR.png)

You see a list of operations that are supported by BambooHR via REST APIs.

2. Choose **Authenticate Instance** to connect to your BambooHR system.

<!-- border -->![Authenticate](2-2-Authenticate.png)

3. Enter a name for the instance.

4. In the **Company Name** field, enter the domain name that you created for your BambooHR trial. You've copied this value in [Preparing Your BambooHR Trial Account ](btp-integration-suite-nonsapconnectivity-settingup-thirdparty).

5. In the **API Key** field, enter the API Key that you generated for your BambooHR trial. You've copied this value in [Preparing Your BambooHR Trial Account ](btp-integration-suite-nonsapconnectivity-settingup-thirdparty).

6. Choose **Create Instance**.

<!-- border -->![Domain-APIKey](2-6-Domain-APIKey.png)


### Test the API Docs

You've now successfully created a BambooHR connector instance. In this step, you test an API to fetch employee details from the sample data that is available in your BambooHR trial account.

1. Choose **Test in the API docs**.

<!-- border -->![Test-API](3-1-Test-API.png)

2. In the list of APIs, look out for the category **employees** and the GET API **/employees**.

This API fetches a list of all employees (sample data) in your BambooHR trial system.

<!-- border -->![Get-Employees-API](3-2-Get-Employees-API.png)

3. Choose **Try Out** and **Execute** to test the API.

You see a successful response with response code 200 and a response body containing employees data from your BambooHR trial system.

<!-- border -->![API-Response](3-3-API-Response.png)

You've now successfully established a connection between your BambooHR trial system and the Open Connectors capability of SAP Integration Suite.


### Create a Security Material in Cloud Integration

In a further tutorial in the mission, you'll establish integration between Cloud Integration and BambooHR through Open Connectors. For this integration to work as expected, Open Connectors must authenticate you via a user credential.

In this step, you'll create a security material in Cloud Integration that takes care of this authentication.

1. In the successful API response, copy the authorization values for the properties **User**, **Organization**, and **Element**.

<!-- border -->![Authorization-Values](4-1-Authorization-Values.png)

2. In your SAP Integration Suite home page, choose **Monitor > Integrations**.

In case Open Connectors had opened in the same tab, click **SAP Integration Suite** at the top left to navigate to the SAP Integration Suite home page.

3. Choose **Security Material**.

4. Choose **Create > User Credentials**.

5. Enter a name for the user credentials.

6. For **Type**, select **OpenConnectors**.

7. Paste the values that you copied from Open Connectors. Choose **Deploy**.

<!-- border -->![Deploy-User-Credential](4-7-Deploy-User-Credential.png)


### Copy the Request URL

In a further tutorial in the mission, you will have to provide a request to this **GET /employees** API so that Cloud Integration invokes it.

In the successful API response, copy the **Request URL**.

<!-- border -->![5-1-Copy-Base-URI](5-1-Copy-Base-URI.png)


---
Loading