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 SuccessFactors SFAPI User

SAP SuccessFactors SFAPI User

To collect data from SAP SuccessFactors for Business Process Monitoring or Exception Monitoring an endpoint needs to be created in SAP Cloud ALM.

To create this endpoint a user is needed in SAP SuccessFactors. It is recommended to create a dedicated user in SAP SuccessFactors (e.g. SFAPI) for this purpose instead of using a personal or an admin user.

Required User Settings

Disable Password Expiration

To avoid that the password for the user expires, please create a login exception for the SFAPI user.

  1. Go to Admin Center → Password & Login Policy Settings
  2. Click on "Set API Login Exceptions"
    1. Click the "Add" button
    2. Enter the username of the SFAPI user
    3. Set the parameter 'Maximum password age(days)' = -1
    4. Enter the IP address of your SAP Cloud ALM tenant.
      1. You can look for the IP range of your SAP Cloud ALM tenant here.
      2. You can also enter the range 1.1.1.1-255.255.255.255 to cover any possible IP address.

For more information refer to SAP note 2161909 - How to enable SFAPI in SuccessFactors

Required User Permissions

To assign the required permissions to the SFAPI user please first create a new permission group and add your SFAPI user to the group:

  1. Go to Admin Center → Manage Permission Groups
  2. Create a new permission group using the "Create New..." button
  3. Enter a group name (e.g. SFAPI_CALM_USERS)
  4. Under "Choose Group Members" → "People Pool" choose "Username"
    1. Search for your SFAPI user and add it by clicking the check box in front of it
    2. Click Done
  5. Click Done

Then create a new permission role:

  1. Go to Admin Center → Manage Permission Roles
  2. Create a new permission role using the "Create New..." button
  3. Enter a role name (e.g. SFAPI_CALM)
  4. Under "Permission Settings" click the "Permission..." button
    1. Add the permission as described below depending on the use cases you want to use in SAP Cloud ALM
  5. Under "Grant this role to..." click the "Add..." button
    1. Select "Grant role to: Permission Group"
    2. Click the "Select..." button
    3. Search for your SFAPI permission group and check the box in front of it
    4. Click Done
  6. Save your new permission role

General Permissions

The following permissions need to be assigned to the SFAPI user independent of the use case it will be used for:

  • User Permissions
    • General User Permission
      • User Login
      • SFAPI User Login
    • Payroll Integration Permission
      • Data Replication Proxy (View, Edit)
      • Trigger Data Replication Proxy Status Reset (View, Edit)
  • Administrator Permissions
    • Manage Integration Tools
      • Allow Admin to Access OData API through Basic Authentication
    • Employee Central API
      • Employee Central Foundation OData API (editable)
      • Employee Central HRIS OData API (editable)
    • Metadata Framework
      • Admin access to MDF OData API

Permissions for Integration & Exception Monitoring

The following permissions are required for the Integration & Exception Monitoring user case:

  • Administrator Permissions
    • Manage Integration Tools
      • Access to Integration Center
      • Access to Data Replication Monitor
    • Admin Center Permissions
      • Read Execution Manager Events
      • Read Execution Manager Event Payload or Event Report
      • Monitor Scheduled Jobs

Permissions for Business Process Monitoring

The following permissions are required for the Business Process Monitoring user case:

  • Administrator Permissions
    • Manage Recruiting
      • Detailed Requisition Reporting Privileges
      • Manage Recruiting Templates
    • Manage Integration Tools
      • Access to OData API Metadata Refresh and Export
      • Access to OData API Data Dictionary
  • User Permissions
    • Recruiting Permissions
      • OData API Application Export
      • OData API Candidate Export
      • OData API Job Requisition Export
      • OData API Application Audit Export
      • OData API Job Offer Export
      • OData API Offer Letter Export

View permissions for the following MDF objects:

  • Administrator Permissions
    • Manage MDF Recruiting Objects
      • Candidate Relationship Management Status Set
      • Campaign Limits
      • EmailBrandTemplate
      • MarketingBrand
      • Recruiting Rules Assignment Configuration
      • Candidate Relationship Management Status Map
      • Recruiting User Personalization Object Configuration.fields (Recruiting User Personalization Field Configuration)
      • Candidate Relationship Management Status
      • Pool Limits
      • Recruiting User Personalization Object Configuration
  • User Permissions
    • MDF Recruiting Permissions
      • Campaign
      • CampaignContent
      • CandidateActivity
      • Pool
      • Pool Member
      • Share Pool with User
      • Recruiting Sensitive Personal Data Field List.spdFieldList (RCMSPDField)
      • Recruiting Sensitive Personal Data Field List
      • Candidate Follow
      • CampaignRecipient
      • CampaignPool
      • Share Pool with Group

SAP Order Management foundation

SAP Order Management foundation

Available Monitoring Content

The following monitoring content is available for SAP Order Management foundation

Category Type Description
SAP Order Management foundation Messages Messages Monitors messages for incoming orders and order dispatches in SAP Order Management foundation

Connect SAP Order Management foundation

To perform the necessary setup steps in the SAP Order Management foundation, please refer to:

  • Setup SAP Order Management foundation

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 Order Management Foundation.

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 SAP Order Management foundation Message Detected(Single): The event is created for each failed message in the managed service.
  • Erroneous SAP Order Management foundation Message 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
  • Component
  • Direction
  • Status
  • Status Group
  • Status Text
Read article
Integration & Exception Monitoring - Videos

Integration & Exception Monitoring - Videos

How to Set Up Integration & Exception Monitoring

Set Up Integration & Exception Monitoring for SAP Ariba

  • Prerequisites for this video:
    • You need a user with access to SAP Ariba Connect (https://support.ariba.com)

Set Up Integration & Exception Monitoring for SAP Field Service Management

  • Prerequisites for this video:
    • You need a user with account-level administrator authorizations
    • Log on to your SAP Field Service Management account with the option "Sign In with Account"

Set Up Integration & Exception Monitoring for SAP Fieldglass

  • Prerequisites for this video:
    • You need a user with Fieldglass Configuration Manager access
    • Create a user in SAP Fieldglass to be used in the web service created for the API application key

Collect Setup Information

  • The video explains how to check your SAP Integration Suite Cloud Integration platform and the identity provider to choose the correct follow up video

Set Up Application Monitoring for SAP Integration Suite Cloud Integration running in Cloud Foundry

  • Prerequisites for this video:
    • You need a sub-account member with "Space Developer" authorizations for the space in the SAP Integration Suite Cloud Integration sub-account in SAP BTP Cockpit
    • You need a user with the role "Integration Monitoring Integration Architect" in SAP Cloud ALM

Set Up Application Monitoring for SAP Integration Suite Cloud Integration running in Neo

  • Prerequisites for this video:
    • You need a sub-account member with "Administrator" access for the SAP Integration Suite Cloud Integration sub-account in SAP BTP Cockpit
    • You need a user with the role "Integration Monitoring Integration Architect" in SAP Cloud ALM

Set Up Monitoring for SAP S/4 HANA, SAP Business Suite or SAP Employee Central Payroll

  • Prerequisites for this video:
    • Download SAP Cloud ALM service key
    • Find prerequisites in the ABAP system here

Set Up Application Monitoring for SAP S/4HANA Cloud and SAP Marketing Cloud

  • Prerequisites for this video:
    • Download SAP Cloud ALM service key
    • You need a user with the role SAP_BR_ADMINISTRATOR in the SAP Marketing Cloud tenant.

Set Up Monitoring for SAP Sales & Services Cloud

  • Prerequisites for this video:
    • You need a user with administrator authorizations in the SAP Sales & Services Cloud tenant

Set Up Integration & Exception Monitoring for SAP SuccessFactors

  • Prerequisites for this video:
    • Download the SAP Cloud ALM service key
    • Create an SFAPI user in SAP SuccessFactors as described here
    • Your user in SAP SuccessFactors needs needs "Access to Integration Service Registration Center UI" permissions
    • You need a user with the role "Integration Monitoring Integration Architect" in SAP Cloud ALM

How to Configure Integration & Exception Monitoring

This video explains the general setup of Integration and Exceptions Monitoring.

For information how to connect the different service types, please choose the respective video above.

This video describes how to create a monitoring scenario in Integration & Exception Monitoring.

How to Use Integration & Exception Monitoring

Read article
SAP BTP, ABAP environment

SAP BTP, ABAP Environment

Available Monitoring Content

Category Type Description
AIF Messages Messages Monitors messages sent in the SAP Application Interface Framework
ABAP Gateway Errors Exceptions Exceptions in the ABAP Gateway
Extensibility Transport Management Exceptions Exceptions in Extensibility Transport Management

Connect SAP BTP, ABAP environment

To perform the necessary setup steps in the SAP BTP, ABAP environment, please refer to:

  • Setup SAP BTP, ABAP environment

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 BTP, ABAP environment.

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 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
  • Message
  • Location
  • Message Id

Available Events
  • Erroneous Extensibility Transport Management: The event is created for exceptions in Extensibility Transport Management.

Available Filters

Filters for Data Collection Filters for Events (planned)

Predefined (not changeable)

  • Object: ATO
  • Subobject: EXPORT, FORWARD, IMPORT
  • External ID
  • Message ID
  • Message Number
  • Text
  • Program
  • Transaction
  • User
Read article
SAP Mobile Services

SAP Mobile Services

Available Monitoring Content

Category Type Description
SAP Mobile Services Messages Messages Collects messages send from and to SAP Mobile Services

Connect SAP Mobile Services

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

  • Setup SAP Mobile Services

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 Mobile Services.

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 SAP Mobile Service Messages Detected (Single): The event is created for each failed message in the managed service.
  • Erroneous SAP Mobile Service 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
  • Application ID
  • Direction
  • Feature
  • Status
  • Status Group
  • Status Text
  • User Name
Read article
SAP Concur

SAP Concur

Available Monitoring Content

Messages send from and to SAP Concur are currently only monitored in the context of SAP S/4HANA Cloud, SAP S/4HANA Private Cloud Edition, SAP S/4HANA or in SAP Master Data Integration not in SAP Concur itself.

The following monitoring content is available for SAP Concur related messages.

Cloud Service Category Type Description
SAP S/4HANA Cloud Concur Objects Messages Monitors messages sent from SAP S/4HANA Cloud for the integration with SAP Concur
SAP S/4HANA Private Cloud Edition Concur Objects Messages Monitors messages sent from SAP S/4HANA Private Cloud Edition for the integration with SAP Concur
SAP S/4HANA Concur Objects Messages Monitors messages sent from SAP S/4HANA for the integration with SAP Concur
SAP Master Data Integration SAP Master Data Integration Messages Messages Monitors messages send through SAP Master Data Integration, messages to SAP Concur can be identified by the object types (e.g. CostCenter)

Setup Monitoring for SAP Concur Messages

To monitor the messages related to SAP Concur in the related cloud services please perform the monitoring setup for the relevant cloud services. After the setup you can create alerts specific to SAP Concur related messages in the Integration & Exception Monitoring application:

  • SAP S/4HANA Cloud
  • SAP S/4HANA Private Cloud Edition
  • SAP S/4HANA
  • SAP Master Data Integration

Read article