×

Welcome to Knowledge Base!

KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

Categories
All
ERP-SAP
SAP Cloud ALM Service Key

Retrieve SAP Cloud ALM Service Key

Some of the managed SAP Cloud services use a PUSH mechanism to send alerts and exceptions to SAP Cloud ALM. To successfully set up this PUSH mechanism you need the SAP Cloud ALM Service Key to enter the SAP Cloud ALM credentials during the PUSH setup in the managed SAP Cloud service.

Prerequisites

  • An instance for SAP Cloud ALM API has been created. Find more information here .
  • You must have "Space Developer" access for the space in which the instance was created in your SAP Cloud ALM sub-account in the SAP Business Technology Platform

The following video demonstrates the necessary steps to retrieve the SAP Cloud ALM service key from SAP BTP cockpit. A textual step by step description is provided in the section below the video.

To retrieve the SAP Cloud ALM Service Key please follow these steps:

Service Key Retrieval

  1. Log on to the SAP BTP cockpit.
  2. Click on your SAP Cloud ALM global account, then on your SAP Cloud ALM sub-account.
  3. In the navigation panel, choose Services > Instances and Subscriptions .
  4. Under Instances click on the relevant instance of the service SAP Cloud ALM API
  5. In the area that opens, choose Service Keys .
  6. You see your service key in JSON format. The key includes the application URL, service URL, client ID, and client secret.
  7. Download this service key and save it for later

Integration Scenarios in SAP Cloud ALM

Scenario Configuration

Create Scenario

  1. Click the 'Configuration' button in the Integration & Exception Monitoring UI
  2. Scroll down to the 'Integration Scenarios' section
  3. Click the pen icon to open the 'Scenario Configuration'
  4. Click the Add button
  5. Enter the name and the description for the scenario

Maintain Scenario Components

At first you have to add the components to the scenario.

  1. Click the Add button on top of the 'Services' table
  2. Select the services from the list by checking the checkbox in front of them
  3. Click the OK button
For each of the services in the scenario you can maintain filters and alerts. The filters make sure that only certain messages and exceptions are considered as part of the scenario, even if the monitoring was activated for all of them.
  1. Select the service for which you want to add the filter
  2. Click the Add button on top of the 'Filter for Data' table
  3. Select an available Category
  4. Enter a name for the filter and maintain the filter values
    • The available Categories depend on the selected service
    • The filter fields depend on the selected category
    • For more information on the meaning for the different filter fields please refer to the setup information for the respective service type
  5. Activate or deactivate alerts
    1. Select the alert in the table 'Alert Details for Filter' below the 'Filter for data' table
    2. Click the Edit button
    3. You can change the Display name and the alert description
    4. Use the 'Alerting Status' slider to activate or deactivate an alert

Maintain Paths

You can also maintain paths between the components to visualize a message flow.

  1. On the tab 'Paths' you find a matrix with all the components in the scenario
  2. Select the row that stands for the desired source
  3. Check the checkbox in the column that stands for the desired target

Read article
SAP Fieldglass

SAP Fieldglass

Available Monitoring Content

Category Type Description
SAP Fieldglass Messages Messages Messages send from and to SAP Fieldglass which are recorded in the Subscription Audit Trail, the Integration Audit Trail and the Event Driven Audit Trail

Connect SAP Fieldglass

To perform the necessary setup steps in the SAP Fieldglass, please refer to:

  • Setup SAP Fieldglass

Setup Integration & Exception Monitoring

To learn how to configure the monitoring, follow the documentation on the page Integration & Exception Monitoring - Setup & Configuration.

Below you find category-specific information for the monitoring categories available for SAP Fieldglass.

Please note:

  • If an input help is available for the filter parameters, this input help is filled based on the messages and exceptions collected in SAP Cloud ALM so far.
  • If no filter is set up for the data collection, all messages or exceptions will be collected for the category.

Available Events
  • Erroneous Fieldglass Message Detected(Single): The event is created for each failed message in the managed service.
  • Erroneous Fieldglass Messages Detected(Grouped): The event is created if one or more messages in the managed service failed since the last data collection.

Available Filters

Filters for Data Collection Filters for Events
  • Status
  • Status Group
  • Category Type
  • Direction
  • Name
  • Status
  • Status Group
  • Status Details
Read article
SAP S/4HANA & SAP Business Suite

SAP S/4HANA & SAP Business Suite

Available Monitoring Content

The following monitoring content is available for SAP S/4HANA and SAP Business Suite

Category Type Description
AIF Messages Messages Messages send via the Application Interface Framework
IDoc Messages IDocs sent or received by the SAP S/4HANA system
Web Service Messages Messages Messages sent or received via Web Services and Web Service Proxies
Concur Objects Messages Monitors messages sent for the integration with Concur
ABAP Web Service Provider Exceptions Web service errors for incoming web service calls (available with ST-PI 7.40 SP16)
ABAP Runtime Exceptions ABAP runtime errors (available with ST-PI 7.40 SP16)
ABAP Update Exceptions ABAP update errors (available with ST-PI 7.40 SP16)
ABAP Gateway Errors Exceptions Exceptions in the ABAP Gateway (available with ST-PI 7.40 SP16)
ABAP Aborted Job Exceptions ABAP aborted jobs (available with ST-PI 7.40 SP16)
ABAP System Log Exceptions ABAP system log errors (available with ST-PI 7.40 SP16)
ABAP Web Service Consumer Exceptions Web service errors for outgoing web service calls (available with ST-PI 7.40 SP16)
SAP S/4HANA Asset Central Foundation Integration Exceptions Collects exceptions happening in SAP Intelligent Asset Management

Connect SAP ABAP On-Premise System

To perform the necessary setup steps in the SAP S/4HANA or SAP Business Suite system, please refer to:

  • Setup SAP S/4HANA and SAP Business Suite

Setup Integration & Exception Monitoring

To learn how to configure the monitoring, follow the documentation on the page Integration & Exception Monitoring - Setup & Configuration.

Below you find category-specific information for the monitoring categories available for SAP S/4HANA and SAP Business Suite.

Please note:

  • If an input help is available for the filter parameters, this input help is filled based on the messages and exceptions collected in SAP Cloud ALM so far.
  • If no filter is set up for the data collection, all messages or exceptions will be collected for the category.

Available Events
  • Erroneous Message(AIF) Detected(Single): The event is created for each failed message.
  • Erroneous Messages(AIF) Detected(Grouped): The event is created if one or more messages failed since the last data collection.

Available Filters

AIF Sub-category Filters for Data Collection Filters for Events
All sub-categories
  • Status
  • Status Group
  • Direction
  • Namespace
  • Interface Name
  • Version
  • Status
  • Status Group
  • Status Text
bgRFC(queue)
  • Queue Name
  • RFC Destination
bgRFC(trans)
  • RFC Destination
  • Transaction Code
  • Program
  • User
IDOC
  • Sender port
  • Receiver port
  • Message type
Odata Client Proxy no additional filters
XI-runtime
  • Sender namespace
  • Sender interface
  • Sender party
  • Sender component
  • Receiver namespace
  • Receiver interface
  • Receiver party
  • Receiver component
qRFC
  • Queue Name
  • RFC Destination
tRFC
  • RFC Destination
  • Function Module
  • User
WS-runtime
  • Adapter Type
  • Sender Party
  • Sender Interface Name
  • Receiver Party
  • Receiver Interface Name
XML no additional filters
Sync Log no additional filters

Available Events
  • Erroneous Concur Object Detected(Single): The event is created for each failed message.
  • Erroneous Concur Objects Detected(Grouped): The event is created if one or more messages failed since the last data collection.

Available Filters

Filters for Data Collection Filters for Events
  • Status
  • Status Group
  • Concur Company ID
  • Connection Name
  • Direction
  • Object Type
  • SAP Logical System ID
  • SAP System Type
  • Status
  • Status Group

Available Events
  • Erroneous Message(IDOC) Detected(Single): The event is created for each failed IDoc.
  • Erroneous Messages(IDOC) Detected(Grouped): The event is created if one or more IDocs failed since the last data collection.

Available Filters

Filters for Data Collection Filters for Events
  • Message Type
  • Status
  • Status Group
  • Basic Type
  • Direction
  • Message Function
  • Message Type
  • Message Variant
  • Receiver Address
  • Receiver Partner Function
  • Receiver Partner Number
  • Receiver Partner Type
  • Receiver Port
  • Sender Address
  • Sender Partner Function
  • Sender Partner Number
  • Sender Partner Type
  • Sender Port
  • Status
  • Status Group
  • Status Text

Setup Collection for Additional Payload Attributes

You can collect payload data from IDocs. This data will be available in the message details on the tab "Message Data".

  1. To find the segment field name:
    1. Log on to the managed ABAP backend system
    2. Go to transaction WE05
    3. Enter the search parameters to find one IDoc message for the IDocs you are interested in
    4. Double-click on the IDoc to open it
    5. Expand 'Data Records'
    6. Select the segment that you are interested in
    7. You find the segment fields on the screen "Content of Selected Segment"
  2. To set up the data collection of payload attributes click on the > button at the end of the line for the category IDoc
  3. In the area "Collect Additional Attributes"
    1. Click the "Add" button to add the payload attribute
    2. Enter the filter value:
      1. Message Type
      2. Segment Name
      3. Field Name
    3. Click "OK"
  4. Click the "Save" button

You can search for the messages that contain the collected data in the Tracking application. Please enclose the value with '*' to successfully find the messages (e.g. *00123456*).

Prerequisites

  • The Minimum System Requirements to monitor SXMB_MONI for Web Services is SAP BASIS 7.02 SP08
Available Events
  • Erroneous Message(WS) Detected(Single): The event is created for each failed web service message.
  • Erroneous Messages(WS) Detected(Grouped): The event is created if one or more web service messages failed since the last data collection.

Available Filters

Filters for Data Collection Filters for Events
  • Status
  • Status Group
  • Adapter Type
  • Direction
  • Message State
  • Processing Status Group
  • Processing Status Group Text
  • Receiver Interface Name
  • Receiver Interface Namespace
  • Receiver Interface Operation
  • Receiver Party
  • Sender Interface Name
  • Sender Interface Namespace
  • Sender Interface Operation
  • Sender Party
  • Status
  • Status Group
  • Status Text

Setup Collection for Additional Payload Attributes

You can collect payload data from Web Service messages. This data will be available in the message details on the tab "Message Data".

  1. Find the payload attribute name:
    1. Log on to the managed ABAP backend system
    2. Go to transaction SRT_MONI
    3. Enter the search parameters to find one web service message for the web service you are interested in
    4. Double-click on the web service message to open it
    5. Select 'Message Body'
    6. Click the button 'Original XML' to open the formatted XML message
    7. Find the attribute you are interested in
    8. Note down the XML tag name
  2. To set up the data collection of payload attributes click on the > button at the end of the line for the category "Web Service Messages"
  3. In the area "Collect Additional Attributes"
    1. Click the "Add" button to add the payload attribute
    2. Enter the filter value:
      1. Attribute: The XML tag name on the attribute
    3. Click "OK"
  4. Click the "Save" button

You can search for the messages that contain the collected data in the Tracking application. Please enclose the value with '*' to successfully find the messages (e.g. *00123456*).

Available Events
  • Erroneous ABAP Aborted Job: The event is created for aborted ABAP jobs.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • Job Name
  • User

Available Events
  • Erroneous ABAP Gateway Errors: The event is created for ABAP gateway exceptions.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • Service Name
  • User
  • Host
  • Message
  • Location
  • Message Id

Available Events
  • Erroneous ABAP Runtime: The event is created for ABAP runtime errors.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • Runtime Error~Exception
  • Program
  • User
  • Message

Available Events
  • Erroneous ABAP System Log: The event is created for exceptions in the ABAP System Log.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • Message Id
  • Program
  • User
  • Status

Available Events
  • Erroneous ABAP Update: The event is created for ABAP Update errors.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • User
  • Transaction

Available Events
  • Erroneous ABAP Web Service Consumer: The event is created for errors in the web service log for ABAP Web Service Consumers.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • Message
  • Proxy Name
  • User

Available Events
  • Erroneous ABAP Web Service Provider: The event is created for errors in the web service log for ABAP Web Service Providers.

Available Filters

Filters for Data Collection Filters for Events (planned)

Coming soon.

  • Message
  • WS Name (Proxy)
  • User

Available Events
  • Erroneous SAP S/4HANA Asset Central Foundation Integration: The event is created for exceptions in SAP S/4HANA Asset Central Foundation Integration.

Available Filters

Filters for Data Collection Filters for Events (planned)

Predefined (not changeable)

  • Object: /SYCLO/
  • Subobject: /SYCLO/INB_TRANS
  • External ID
  • Message ID
  • Message Number
  • Text
  • Program
  • Transaction
  • User
Read article
SAP Intelligent Asset Management

SAP Intelligent Asset Management

Available Monitoring Content

Monitoring is supported for the following SAP Intelligent Asset Management solutions:

  • SAP Asset Intelligence Network
  • SAP Asset Strategy and Performance Management
  • SAP Predictive Asset Insights
If you have subscribed to more than one of the solutions above within the same sub-account, it is recommended to activate monitoring only for one of the solutions to avoid duplicate data collection.

The following monitoring content is available for SAP Intelligent Asset Management:

Category Type Description
SAP Asset Central Foundation Messages Messages Collects messages send from and to SAP Asset Central Foundation
SAP Event Distributor Messages Messages Collects event distributor messages sent from and to SAP Asset Intelligence Network and SAP Asset Strategy and Performance Management.

Connect SAP Intelligent Asset Management

To perform the necessary setup steps in SAP Intelligent Asset Management, please refer to:

  • Setup SAP Intelligent Asset Management

Setup Integration & Exception Monitoring

To learn how to configure the monitoring, follow the documentation on the page Integration & Exception Monitoring - Setup & Configuration.

Below you find category-specific information for the monitoring categories available for SAP Intelligent Asset Management.

Please note:

  • If an input help is available for the filter parameters, this input help is filled based on the messages and exceptions collected in SAP Cloud ALM so far.
  • If no filter is set up for the data collection, all messages or exceptions will be collected for the category.

Available Events
  • Erroneous Asset Central Foundation Message Detected(Single): The event is created for each failed message in the managed service.
  • Erroneous Asset Central Foundation Messages Detected(Grouped): The event is created if one or more messages in the managed service failed since the last data collection.

Available Filters

Filters for Data Collection Filters for Events
  • Status
  • Status Group
  • Description
  • Direction
  • Name
  • Object Type
  • Operation
  • Status
  • Status Group
  • Status Text

This category is only supported for:
  • SAP Asset Intelligence Network
  • SAP Asset Strategy and Performance Management
Available Events
  • Erroneous SAP Event Distributor Message Detected (Single): The event is created for each failed message in the managed service.
  • Erroneous SAP Event Distributor Messages Detected (Grouped): The event is created if one or more messages in the managed service failed since the last data collection.

Available Filters

Filters for Data Collection Filters for Events
  • Status
  • Status Group
  • Client Id
  • Description
  • Destination Name
  • Direction
  • Operation
  • Status
  • Status Group
  • Status Text
  • Subdomain Name
  • Tenant Id
  • Topic Name
Read article
Integration & Exception Monitoring - Setup & Configuration

Integration & Exception Monitoring - Setup & Configuration

Prerequisites

Before you can set up Integration & Exception Monitoring in SAP Cloud ALM, you have to connect your subscribed SAP cloud services to your SAP Cloud ALM instance.

This is done by setting up the Landscape Management Service. Please follow the Setting Up Landscape Management guide in SAP Help  on how to perform the setup.

Supported Products

To set up Integration & Exception Monitoring please follow the monitoring setup guide provided in the section "Monitoring Configuration" below.

On the product-specific pages you find additional information for each supported product like setup prerequisites, available monitoring categories, and available filter parameters.

  • SAP NetWeaver Application Server for ABAP (higher than 7.40)
  • SAP Ariba
  • SAP Batch Release Hub for Life Sciences
  • SAP BTP, ABAP environment
  • SAP BTP, Neo environment
  • *New* SAP Business ByDesign
  • SAP Business Suite
  • SAP Concur
  • SAP Field Service Management
  • SAP Fieldglass
  • SAP Integrated Business Planning for Supply Chain
  • SAP Integration Suite (Cloud Integration)
  • Integration Hub for Life Sciences

  • SAP Intelligent Asset Management
  • SAP Marketing Cloud
  • SAP Master Data Integration
  • SAP Mobile Services
  • *New* SAP Omnichannel Promotion Pricing
  • SAP Order Management foundation
  • SAP S/4HANA
  • SAP S/4HANA private cloud edition
  • SAP S/4HANA Cloud
  • SAP Sales & Service Cloud
  • SAP SuccessFactors
  • SAP SuccessFactors Employee Central Payroll

Monitoring Configuration

Configure Data Collection and Alerting

The following video describes:

  • How to activate or deactivate the monitoring data collection for a managed cloud service
  • How to create additional alerts for a cloud service
  • How to create notifications for the alert

Attention: The setup of alerts and notification has recently changed. Please follow the written documentation below this video to learn about the new process.

Prerequisites for the video:

  • You need one of the following the SAP Cloud ALM roles
    • Integration Architect
    • Integration Owner
    • Global Administrator
  • Make sure that the cloud service you want to configure is successfully connected to SAP Cloud ALM

Activate the Monitoring Data Collection

The data collection for all monitoring categories available for a managed system or service can be activated directly in the configuration tray in Integration & Exception Monitoring.

  1. Open the Integration & Exception Monitoring application from the launchpad
  2. Open the scope selection via the bulls-eye icon in the upper right corner
  3. Change the drop-down for "Display Service" to "All"
  4. Select the cloud service you want to set up in the scope
  5. Click "Apply"
  6. Click the rack-wheel icon in the upper right corner to access the configuration
  7. Expand the "Configuration" tray
  8. Change the toggle button next to the cloud service you want to set up from OFF to ON

Customize the Monitoring Data Collection

It is possible to customize the data collection for the managed services and systems by:

  • Activating or deactivating single monitoring categories
  • Adding filters to monitoring categories to collect only a subset of the messages or exceptions
  • Configure the collection of payload data for the categories IDoc and Web Services
  1. In the configuration tray, click on the name of the managed service or system
  2. The "Configuration of Services / Systems" screen opens
  3. In the "Configuration for Services / Systems" screen, click the > button at the end of the line for the service or system you want to change
  4. Use the toggle button in the column Active to turn a monitoring category "ON" or "OFF"
  5. To add filters on the data collection level access the filter configuration click on the > button at the end of the line for the category
    1. Click the "Add" button to create a new filter
    2. Enter a filter name
    3. Select the filter category
    4. Enter the filter parameters
    5. Press "Save"

Create Monitoring Events

Events are used to trigger a reaction if Integration & Exception Monitoring detects a situation that requires attention. These reactions can be an alert, sending a notification and/or triggering an operation flow.

  1. Navigate to the "Events" tab
  2. Use the toggle button in the column Active to turn on of off a predefined event
    1. You can change the setting of a predefined event by clicking on the > button at the end of the line
    2. Press the > button at the end of the line to access the detail setup for an existing event
  3. Use the "Add" button to create a new event
  4. Select the event you want to set up from the "Event Name" drop-down box
  5. Adjust the default "Display Name" to a descriptive name
  6. Expand the Event Actions tray. Trigger the desired action by switching them ON or OFF using the slider button:
    1. You can create an alert that will show up in the applications alert inbox
    2. To send an email, select the recipients from the list of verified recipients by click the '+' button
    3. To start an operations flow, select the relevant operations flow from the list of available flows using the '+' button
  7. Add filters to your event, to restrict the messages you react to.
  8. Expand the Filter Configuration tray
    1. Enter a filter name
    2. Select the filter category
    3. Maintain the available filter fields. Which filter fields are available depends on the managed service and system and the selected category.
  9. Save your changes.

Deleting the Monitoring Configuration

If necessary it is possible to delete the monitoring configuration for a service or system. The deletion goes further than just a deactivation, as it removes all configuration from the service or system and sets its status back to "Not Configured" for Integration & Exception Monitoring.

  1. In the configuration tray, click on the name of the managed service or system
  2. The "Configuration of Services / System" screen opens
  3. In the "Configuration for Services / System" screen, select the row of the service by clicking on the row selector in the very first column.
  4. Click the button "Remove Configuration" in the upper right corner of the table.
  5. Confirm the pop-up.

Business Services Configuration

A business service in Integration & Exception Monitoring of SAP Cloud ALM allows you to group point-to-point interfaces that belong to a more complex interface scenario. All connections that are part of a business service can then be displayed together in a topology. By adding filters to the connections you can define which messages and exceptions are in scope for a business service and isolate their status information in the monitoring application.

The following video explains the configuration of business services. You can find a step-by-step textual description of the business service setup below.

Prerequisites for the video:

  • You need one of the following the SAP Cloud ALM roles
    • Integration Architect
    • Integration Owner
    • Global Administrator
  • Make sure that the cloud service you want to configure is successfully connected to SAP Cloud ALM

Create Business Service

  1. Click the 'Configuration' button in the Integration & Exception Monitoring UI
  2. Scroll down to the 'Business Services' section
  3. Click the pen icon to open the 'Configuration for Business Services'
  4. Click the Add button
  5. Enter the name and the description for the Business Service

Maintain Business Services Components

At first, you have to add the components to the business service.

  1. Click the Add button on top of the 'Services / Systems' table
  2. Select the services from the list by checking the checkbox in front of them
  3. Click the OK button
For each of the services in the business service, you can maintain filters and alerts. The filters make sure that only certain messages and exceptions are considered as part of the business service, even if the monitoring was activated for all of them.
  1. Select the service for which you want to add the filter
  2. Click the Add button on top of the 'Filter for Data' table
  3. Select an available Category
  4. Enter a name for the filter and maintain the filter values
    • The available Categories depend on the selected service
    • The filter fields depend on the selected category
    • For more information on the meaning of the different filter fields please refer to the setup information for the respective service type
  5. Activate or deactivate alerts
    1. Select the alert in the table 'Event Details for Filter' below the 'Filter for data' table
    2. Click the Edit button
    3. You can change the Display name and the alert description
    4. Use the 'Status' slider to activate or deactivate an alert

Maintain Paths

You can also maintain paths between the components to visualize a message flow.

  1. On the tab 'Paths' you find a matrix with all the components in the business service
  2. Select the row that stands for the desired source
  3. Check the checkbox in the column that stands for the desired target

Read article

Still Thinking?
Give us a try!

We embrace agility in everything we do.
Our onboarding process is both simple and meaningful.
We can't wait to welcome you on AiDOOS!