SAP Integration Suite – Cloud Integration
SAP Integration Suite – Cloud Integration is a technology used to integrate processes and data between SAP cloud applications, 3rd party applications and on-premise solutions. We can monitor this integration with Interface and Connection Monitoring and Exception Management by monitoring the iFlows inside SAP Integration Suite – Cloud Integration and create alerts in case of errors or performance problems.
Technical Prerequisites
The following technical prerequisites have to be met in order to monitor this scenario:
- Requires at least SAP Solution Manager 7.1 SP12 or SAP Solution Manager 7.2 SP03
- Setting up an HTTP end-point using OAuth requires at least SAP Solution Manager 7.2 SP09
Available Monitoring Content
For SAP Integration Suite – Cloud Integration, SAP Solution Manager can collect IFlows in error status as exceptions. SAP Solution Manager can also collect performance information directly from SAP Integration Suite – Cloud Integration.
SAP Integration Suite – Cloud Integration is used as integration solution for several other SAP cloud solutions. Which IFlows are relevant to monitor depends on the cloud scenario that is integrated via SAP Cloud Integration. Please check the portal pages for the respective cloud solution (e.g. SAP C4C, Success Factors etc.)
Monitoring Template: Cloud (SAP Cloud Integration)
| Metric Name | Description | MAI Category | Since SP |
|---|---|---|---|
Number of erroneous iFlows in SAP Cloud Integration | Number of erroneous iFlows detected in SAP Cloud Integration. The exceptions are retrieved from SAP Cloud Integration via the central Exception Management in Solution Manager. | Exceptions | 7.1 SP12 |
Number of erroneous iFlows in SAP Cloud Integration (Delta) | Number of erroneous iFlows detected in SAP Cloud Integration. The exceptions are retrieved directly from SAP Cloud Integration. Exception Management setup is not necessary for this metric. | Exceptions | 7.1 SP13 |
Number of erroneous iFlows in SAP Cloud Integration (Delta - from ExcMgmt) | Single exceptions detected in SAP Integration Suite – Cloud Integration. Exceptions are retrieved via an API from SAP Cloud Integration into central Exception Management in Solution Manager. Data Collection is executed in delta mode. | Exceptions | 7.1 SP12 |
Number of erroneous iFlows in SAP Cloud Integration (last 24h) | Number of erroneous iFlows detected in SAP Cloud Integration during the last 24h. The exceptions are directly retrieved from SAP Integration Suite - Cloud Integration. Exception Management setup is not necessary for this metric. | Exceptions | 7.1 SP13 |
Number of erroneous iFlows in SAP Cloud Integration (last 24h - from ExcMgmt) | Number of erroneous iFlows detected in SAP Cloud Integration during the last 24h. The exceptions are retrieved from SAP Cloud Integration via the central Exception Management in Solution Manager. | Exceptions | 7.1 SP12 |
Average Response Time of iFlows in SAP Cloud Integration | Response Time in sec collected from SAP Cloud Integration. Exception Management setup is not necessary for this metric. | Performance | 7.1 SP13 |
Average Response Time of iFlows in SAP Cloud Integration per iFlow | Average SAP Cloud Integration Response Time per iFlow in sec collected from SAP Cloud Integration. Exception Management setup is not necessary for this metric. | Performance | 7.1 SP13 |
Number of iFlow executions in SAP Cloud Integration | Number of iFlow executions retrieved directly from SAP Cloud Integration. Exception Management setup is not necessary for this metric. | Performance | 7.1 SP13 |
Connect Cloud Service
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Preparations in SAP Integration Suite - Cloud Integration
Create Communication User (BASIC Authentication)
If you plan to use BASIC authentication to connect to SAP Integration Suite – Cloud Integration you need to create a communication user.
The user can be a company S-user. Please contact your companies S-User super-admin to request a new S-user for this purpose.
- The user will be maintained in the HTTP endpoint and must be must have a role which contains the following privilege:
- In the Neo environment:
- IntegrationOperationServer.read
- NodeManager.read
- IntegrationOperationServer.read
- In the Cloud Foundry environment:
- MonitoringDataRead
- In the Neo environment:
- For more information about default role assignments, please refer to SAP Integration Suite – Cloud Integration documentation: https://help.sap.com/viewer/product/CLOUD_INTEGRATION/Cloud/en-US?task=operate_task → Security → Select the link for your platform → Identity and Access Management → Persona → Tasks and Permissions
Prepare and gather OAuth Information for SAP Integration Suite - Cloud Integration on SAP Cloud Foundry
To enable OAuth authentication between SAP Solution Manager and SAP Integration Suite - Cloud Integration you need to create an instance with a service key for the Process Integration service with the necessary authorizations.
Create Service Instance
- Go to your SAP BTP Cockpit → Access the subaccount used for SAP Cloud Integration
- Go to "Instances and Subscriptions"
- Click the 'Create' button to create a new instance
- Basic Info
- Service: Process Integration (it-rt)
- Plan: api
- Runtime Environment: Choose Cloud Foundry
- Space: Select the appropriate space (depending on your company)
- Instance Name: Enter an instance name
- Click 'Next'
- Parameters
- Select the role "MonitoringDataRead" in the 'Roles' drop-down on the Form tab
- Click "Create Instance"
Create Service Key
After the instance is created you can create the service key.
- Select the row of the instance
- Go to tab "Service Keys"
- Click 'Create'
- Enter a name for the service key
- Click 'Create'
Download the service key file. You will need the information in the file later when you create the end-point in SAP Solution Manager.
Prepare and gather OAuth Information for SAP Integration Suite - Cloud Integration in the Neo environment
If you want to use OAuth authentication to connect to SAP Integration Suite - Cloud Integration in the Neo environment, you need to create a client with the correct authorizations:
- Go to the SAP Business Technology Platform Cockpit
- Navigate to Security → OAuth
- Go to tab 'Clients'
- Click 'Register New Client'
- Choose a name
- Set the subscription to the CPI tenant (ends with xxxx.tnm)
- Generate an ID (it is recommended to use the suggested unique ID)
- Select Authorization Grant as 'Client Credentials'
- Choose a Secret
- Click on Save
- Note down the Client ID and the Client secret for later use in SAP Solution Manager
- Go to tab 'Branding'
- Note down the 'Token Endpoint' URL to be used as OAuth URL
- Navigate to Security → Authorizations
- As a user enter 'oauth_client_<client_ID>' (the Client ID generated in the previous step)
- Grant the user the roles:
- IntegrationOperationServer.read
- NodeManager.read
- Save you changes.
Connect Cloud Service to SAP Solution Manager
The Cloud Services configuration is now accessible from the SAP Solution Manager Configuration (SOLMAN_SETUP) → Managed Systems Configuration → Tab 'Cloud Services'.
Create Cloud Service:
- Select 'Cloud Service Operations' → Create Cloud Service
- Select Service Type: 'SAP Integration Suite' from the drop-down list.
- Define Service:
- Tenant: The SAP Cloud Integration tenant ID. This information is not necessarily provided by SAP. You may choose to document here a relevant identifier for your Cloud Service.
- Define Root URL: Enter the main URL (e.g. https://< myhost >.hana.ondemand.com)
- You can also adjust the extended service ID (The ID used as SID in LMDB) here.
- Confirmation: Check your input values and click 'Finish'
The second step is to create the end-point for the cloud service.
Create the End-Point:
- Select your SAP Cloud Integration cloud service from the list and click 'Configure Cloud Service'
- Configure Endpoints: Click the 'Add' button on the 'HTTP Endpoints' tab.
- Enter the following information:
- Description: A meaningful description
- Authorization: Select OAUTH or BASIC
- The next fields depend on the selected authorization method:
- BASIC
- User: Connection user created before
- Password: Password for the user
- OAUTH
- OAuth URL: the 'Token Endpoint' URL from SAP Integration Suite – Cloud Integration
- Client ID: The ID of the client you want to use
- Client Secret: The Secret of the client you want to use
- BASIC
- If necessary add proxy information to connect to Cloud Integration
Monitoring Configuration
Step 1: Configure Exception Management
After the basic configuration you now have to configure Exception Management, as the exceptions collected via Exception Management and stored in the central exception store are the basis for the Integration Monitoring data collection.
For SAP Cloud Integration you only have to configure Exception Management, if you want to be able to analyze the single exceptions in SAP Solution Manager. Some metrics available for SAP Cloud Integration do not require the Exception Management setup. Check the list of available metrics for details.
Configuration for SAP Cloud Integration
To access the Exception Management setup please go to transaction SOLMAN_SETUP → Application Operations → Exception Management
- In the step 'Define Scope' select the tab 'Cloud Services' and your SAP Cloud Integration system. If you didn't configure the system before make sure to select 'All Cloud Services' in the view drop-down. Click on 'Configure' or click 'Next' two times. You will enter the step 'Exception Configuration'.
- Click 'Add / Configure Log Store'. Select 'SAP BTP Integration'. Select the correct end-point for the SAP Cloud Integration cloud service if you have more than one.
- Select the fields for filtering for your log store. The following filter fields are available:
- iFlow ID: Name of the Artifact ID for which you want to receive exceptions
- Message: Filter on the error message
- Maintain the filter values for the fields in the Filter Definition panel under the log stores table. You can also add, remove or change filter fields and values later on in the area. You can use different operators for your filter value. You can add more than one filter filed combination per log store. To add an additional filter field combination click on the button 'Add Filter' in the 'Configured Log Stores' panel.
- You should not set up the monitoring for the exceptions in the Exception Management. If you activate the monitoring here, you will receive an alert (and if set up this way an email) for every single exception in the application log. Instead we will use Interface and Connection Monitoring to monitor the central exceptions store for exceptions.
Step 2: Configure Interface and Connection Monitoring
The last step is the configuration of Interface and Connection Monitoring. The Interface and Connection Monitoring setup can be accessed via SAP Solution Manager Configuration (SOLMAN_SETUP).
Configuration for Monitoring Template: Cloud (SAP Cloud Integration)
To access the Integration Monitoring setup please go to SAP Solution Manager Configuration (SOLMAN_SETUP) → Application Operations → Integration Monitoring → Interface and Connections.
Navigate to the step 'Define Scope'. You can create a new scenario for the SAP Cloud Integration monitoring or use an existing one. Make sure the on premise system for the SAP Cloud Integration scenario and the Cloud Service created for SAP Cloud Integration is part of the Interface and Connection Monitoring scenario.
Create the Interface Channel:
- Select the scenario and click 'Next'
- In step 'Preparation' perform all relevant manual activities and run all automatic activities.
- In step 'Configuration' click the 'Add' button.
- Channel Name: Enter a meaning full name (max. 30 characters)
- Type: Select 'Cloud'
- Monitoring Template: Select 'Cloud (SAP Cloud Integration)'
- Description: Enter a description for the channel
- Click Next.
- Source type:
- If the source system is the on premise system, please select 'Technical System'
- If the source system is the SAP Cloud Integration service please select 'External Service'
- Source: Select the on premise system resp. the SAP Integration Suite - Cloud Integration Cloud Service from the drop-down list
- Target Type:
- If the target system is the on premise system, please select 'Technical System'
- If the target system is the SAP Cloud Integration service please select 'External Service'
- Target: Select the on premise system resp. the SAP Cloud Integration Cloud Service from the drop-down list
- The measuring point is selected automatically
- If more than one client are connected for the on premise system please select the correct client for the monitoring
- Click Next.
- Click Finish.
Maintain the Interface:
- Select the interface channel you created
- On the 'Interfaces' tab click the 'Add' button.
- Provide the following information:
- Interface name: Enter a name for the interface
- Endpoint ID (mandatory): Select the end point created for the SAP Cloud Integration cloud service
- IFlow ID (mandatory): Enter the name if the IFlow you want to retrieve exceptions for. You can use '*' to collect all exceptions
Select Metrics:
- On the tab 'Metrics' select the metrics you want to monitor SAP Cloud Integration Metrics
- Save your interface channel by clicking on the 'Save' button.
Metrics in Interface and Connection Monitoring
Only the some metrics on the metric list are retrieved from the SAP Exception Management, the rest of the metrics is collected directly from SAP Cloud Integration. For these metrics you must maintain filter criteria to collect them.
For the metrics collected from Exceptions Management, filters are optional. For these metrics the data collection is based on the content of the global exceptions store, you can always check the collected exceptions in Exception Management. All filter parameters are part of the collection context of the exceptions. The filters applied in Interface and Connection Monitoring allow you to filter the exceptions collected by the Exception Management further. However if the filters in Exception Management do not collect an exception, it is not available in the central exception store and you will not be able to find it in Interface and Connection Monitoring!
If you choose to use the metrics from SAP Cloud Integration directly to monitor the number of exceptions, you will not have the exception details available in SAP Solution Manager Exception Management, but only get the information how many exceptions occurred.
You can maintain attributes as described in the Interface and Connection Monitoring Setup on the tab 'Attributes'.
Thresholds and the collection schedule are maintained in the next step of the guided procedure. Once you have maintained all your channels, click 'Next' in the main guided procedure to move to the step 'Activation'.
Maintain Thresholds and Schedule:
- Select the Alert for the interface channel (the alert is the line with the red flash icon next to it)
- On alert level you can maintain notification and incident message creation
- Do not remove the flag for 'Do not Group Individual Occurrences' as this flag ensures that an alert each time new exceptions are found during a data collection interval
- Select the Metrics
- Do not change the data collector type or data collector name on the tab 'Data Collection' as the monitor will not work anymore if this is changed.
- Do not change the threshold if it is set to 'Already Rated'.
- Click 'Apply and Activate' → <Choose one option> to activate the monitoring
If not active you can also activate the reporting for the channels by checking the box in the column 'Reporting'. This way you can see a history of the number of exceptions that happened and also place the metric on the OCC Dashboard in Focused Insights.