Setup for SAP Order Management foundation

This page explains how to connect SAP Order Management Foundation to SAP Cloud ALM to enable monitoring.

Currently, the following monitoring application is supported for SAP Order Management Foundation:

Prerequisites

To enable SAP Order Management Foundation to send monitoring data to SAP Cloud ALM:

  • You need a user with Destination Administrator authorizations in the SAP BTP subaccount where SAP Order Management Foundation is subscribed.
  • You need Space Developer access to a space in the SAP Order Management Foundation sub-account
  • You need to obtain the SAP Cloud ALM Service Key to connect to the SAP Cloud ALM system

Setup in SAP BTP Cockpit

Create Destination to SAP Cloud ALM

  1. Log on to SAP BTP Cockpit and navigate to the sub-account for your SAP Order Management foundation 
  2. Go to Connectivity > Destinations
  3. Click on "New Destination"
  4. Create a new destination using the "Blank Template" view
    1. Name: CloudALM
    2. Type: HTTP
    3. URL: SAP Cloud ALM service key parameter "Api"
    4. Authentication: Select 'OAuth2ClientCredentials'
    5. Client ID: SAP Cloud ALM service key parameter "clientid"
    6. Client Secret: SAP Cloud ALM service key parameter "clientsecret"
    7. Token Service URL: SAP Cloud ALM service key parameter "url" + /oauth/token
  5. Save the destination

Download Service Key

To successfully call the registration URL in SAP Order Management foundation, to register with SAP Cloud ALM, you need to download the service key for the SAP Order Management foundation instance.

  1. Log on to SAP BTP Cockpit and navigate to the sub-account for your SAP Order Management foundation 
  2. In the navigation panel, choose Services > Instances and Subscriptions.
  3. Under "Instances" click on the instance of the service SAP Order Management Foundation
  4. In the area that opens, choose "Service Keys".
  5. You see your service key in JSON format. The key includes the application URL, service URL, client ID, and client secret.
  6. Download this service key and save it for later

Register SAP Order Management foundation in SAP Cloud ALM

Get JSON Web Token (JWT) with Client ID and Client Secret

To be able to call the SAP Cloud ALM registration API you first need to acquire a JWT from your SAP Order Management foundation tenant.

Please find the process to acquire the JWT described here.

  1. The service key used for this step is the SAP Order Management foundation service key
  2. Enter the "scope" for the call as {XSA app name}.IntegrationMonitoring

You will get the JWT in the response to your call.

  1. Copy the content of the field "access_token" without the quotation marks

Register SAP Order Management foundation

Now you use the JWT acquired in the previous step to call the registration URL in SAP Order Management foundation.

This is in detail described in step 4 of the documentation provided here.

In the response to your API call you should find the message "The registration for Integration Monitoring was successful."

After performing the registration the SAP Order Management foundation cloud service will appear in the landscape management of SAP Cloud ALM with the ID CO_<environment>_<tenant ID>.

The registration will activate the PUSH data collection and automatically send monitoring data to SAP Cloud ALM.

Next Steps

After setting up the monitoring PUSH to SAP Cloud ALM in the managed service, the data collection will be activated automatically with default monitoring configurations. 

You can adjust the monitoring setup within the monitoring application. Find more information on the configuration on the "Setup & Configuration" pages for the application. 

Unregister from SAP Cloud ALM

To stop the monitoring data transfer and to unregister your SAP Order Management foundation tenant from SAP Cloud ALM please proceed as following.

  1. Get a JWT as described above
  2. Perform an API call as described in the "Offboarding" section of the documentation provided here.