connecting-systems-services-integration-suite-codejam

Prerequisites

There are hardware, software and service prerequisites for participating in this CodeJam. The exercises will be developed using different SAP Integration Suite services and communicating with remote services that will be made available for the CodeJam.

Accessing the supporting material referenced in exercises

In this CodeJam, you will see that across exercises, there are references to files that will help you get started or that are needed to complete the activities. To access these files, you can download the individual files directly from the repository website, or you can make a copy of the repository on your local machine by following one of the options below:

  1. (Recommended) Clone the git repository in your local machine with the following command: 
    $ git clone https://github.com/SAP-samples/connecting-systems-services-integration-suite-codejam.git

    If you’ve set up SSH to communicate with GitHub from your local machine, you can clone it using the following command: git clone git@github.com:SAP-samples/connecting-systems-services-integration-suite-codejam.git

    Using git is recommended as there might be future updates on the CodeJam content; updating your local copy will just be a command away.

    $ git pull origin main
  2. Alternatively, download the repository as a zip, and unzip it.

Hardware

None.

Software

Web browser

A web browser supported by the SAP Integration Suite1: For the UIs of the service, the following browsers are supported on Microsoft Windows PCs and, where mentioned below, on macOS. Note that, however, certain limitations might apply for specific browsers:

Cloud Integration has been tested using the following browsers:
- Google Chrome (latest version)
- Microsoft Edge (latest version)
- Mozilla Firefox (latest version)
- Windows Internet Explorer (as of version 10)

The application can also be used with Safari browser and Internet Explorer 9. However, some features might not work as expected.

Postman

Postman, to send requests to the integration flows that we deploy to SAP Cloud Integration. Follow the installation instructions included in this tutorial: Install Postman REST Client.

Once installed you can import the collection and environments included in the ./connecting-systems-services-integration-suite-codejam/assets/postman folder.

Import objects to Postman

Services

🚨 It is recommended to use the SAP BTP Trial and create an account in the 🇸🇬 Singapore region.

Using the SAP BTP Trial account (⚡️ recommended ⚡️)
1. Get an SAP Business Technology Platform trial account: [Tutorial: Get an account on SAP BTP Trial](https://developers.sap.com/tutorials/hcp-create-trial-account.html) 2. Subscribe to the SAP Integration Suite service and activate capabilities by following the instructions included in [Tutorial: Set up the SAP Integration Suite trial](https://developers.sap.com/tutorials/cp-starter-isuite-onboard-subscribe.html#f55ec71c-2853-4b83-8092-4e3031f8d6e6). This tutorial will guide you through the steps to subscribe to the SAP Integration Suite service and activate capabilities. We will need to provision the following capabilities: Cloud Integration, Manage APIs (API Management), and Extend Non-SAP Connectivity (Open Connectors)
⚠️ Although the tutorial screenshot doesn't select the Extend Non-SAP Connectivity, don't be misguided by this... do include the Extend Non-SAP Connectivity capability.
Using the SAP BTP Free Tier
1. Get a free SAP Business Technology Platform account (if you don't already have one): * [Tutorial: Get an Account on SAP BTP to Try Out Free Tier Service Plans](https://developers.sap.com/tutorials/btp-free-tier-account.html) * [Video: SAP BTP Free Tier: Create Your Individual Account](https://www.youtube.com/watch?v=0zGuMus4R10) 2. Subscribe to the SAP Integration Suite service and activate capabilities by following the instructions included in [Tutorial: Set up the SAP Integration Suite trial](https://developers.sap.com/tutorials/cp-starter-isuite-onboard-subscribe.html#f55ec71c-2853-4b83-8092-4e3031f8d6e6).

(Optional) Create SAP Cloud Integration runtime client credentials

🚨 This is only required if you didn’t complete the Tutorial: Set up the SAP Integration Suite trial. As part of the tutorial you run the Enable Integration Suite booster, which will end up creating some client credentials on your behalf.

Once subscribed to the SAP Integration Suite, we will need to provision the create an instance of the Process Integration runtime. This service allow us to create client credentials which can be used to retrieve data from the SAP Cloud Integration APIs or calling an integration flow.

From command line:

# Login to Cloud Foundry
$ cf login --sso

# Create instance of service
$ cf create-service it-rt integration-flow pi-rt-iflow -c '{"roles": ["ESBMessaging.send"],"grant-types": ["client_credentials"],"redirect-uris": [] }'

# Create service key
$ cf create-service-key  pi-rt-iflow iflow-client

# Get the credentials
$ cf service-key pi-rt-iflow iflow-client

From the BTP Cockpit:

  1. Create instance of service create-service-instance

    Ensure the ESBMessaging.send role is selected and the grant-type is Client Credentials

    create-service-params

    Finalise by clicking the create button

    create-service-finalise

  2. Create service key create-service-key

  3. Copy credentials: click on the service key just created and a pop-up will appear with the service key details, e.g. clientid, clientsecret, url, tokenurl. view-service-key

👉 Copy and paste the credentials details from iflow-client service key in the Cloud Integration Postman environment.

API Management

For API Management we will need to do two things:

  1. Set up the API Management capability if you are using an instance of the SAP Integration Suite that is not on the trial environment.
  2. Access the Developer Hub to complete set up.

Set up API Management capability

🚨 This is only required if you are running in a non-trial environment

Complete setup of SAP API Management
Before being able to access API Management, you will need to complete the setup. Go to the API Management settings by navigating within the Integration Suite UI to *Settings > APIs*.

API Management settings
API Management settings

Enter a host alias, add a notification contact (your email address) and click the `Set Up` button on the upper right corner.

Set up API Management capability
Set up API Management capability

Set up API Management - Complete
Set up API Management - Complete

For detailed steps, follow the instructions included in [step 5 - Configure the API Management Service](https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup.html#93fee77e-606e-425c-a6c3-1b6946d2ec87) of the _Set Up API Management from Integration Suite_ tutorial.

Access the Developer Hub

You can access the developer hub from the SAP Integration Suite UI. Click on the Explore our ecosystem button on the top bar and then select the Developer Hub tile.

Access Developer Hub
Access Developer Hub

[!IMPORTANT] We need to carry out this step in order to finish the set up of the API Management capability. If we don’t complete this step, we won’t be able to Publish a Product to the Developer Hub, which is required in exercise 6.

After the first time you access the Developer Hub, the set up will complete and you will need to logout from it and log back in to access the Developer Hub.

BigQuery

In exercise 05 we will configure a connection to Google’s BigQuery via Open Connectors. Google Cloud Platform offers a free tier, through which you can use BigQuery. Go ahead and create a free account if you don’t have access to Google Cloud Platform – https://cloud.google.com/free/.

Once you have an account, navigate to BigQuery - https://console.cloud.google.com/bigquery, create a dataset and a table under your project.

👉 Create dataset under your Google Cloud project. Enable table expiration and set the maximum table age to 60 days.

Create bp_dependants_log dataset

Create bp_dependants_log dataset

👉 Create a table named api-requests under the bp_dependants_log dataset created with the schema below.

Field name Type Max Length
request_timestamp TIMESTAMP  
employee_id STRING 15
employee_country STRING 2

Create api-requests table

Create api-requests table

Suite](https://help.sap.com/doc/e50e61e7b66c4b60ae5e88c00c01486a/sap.cp.integration.suite/en-US/FSD_IntegrationSuite.pdf)

Running the services outside of a CodeJam event

Alternatively, the remote services can be run locally or deployed to Cloud Foundry.

Deploying to Cloud Foundry

You can use the manifest.yml included in the assets/cf folder to deploy the services to your SAP BTP subaccount.

# Login to Cloud Foundry
cf login --sso

# Deploy the services using the manifest file
cf push -f assets/cf/manifest.yml

Running locally

When running the services locally, we can use Cloud Connector to enable the communication between SAP BTP and the local service. The prerequisites to run it locally are included in running-locally-prerequisites.md Note: This is recommended if you are doing this exercise outside of a CodeJam event.

  1. [Feature Scope Description for SAP Integration ↩

This site is open source. Improve this page.