Skip to main content

SAP Cloud ALM (CALM)

note

This feature is only available for beta customers. Please email support@avantra.com or contact your customer success manager to discuss access.

The SAP Cloud ALM (CALM) Cloud Service type is available as an integration with Avantra, extending the monitoring views available and allowing for CALM monitoring on a more granular level.

Avantra utilises a three-way mapping function between Avantra, CALM and SAP for Me, where you map CALM / SAP for Me systems to Avantra systems. See Mapping CALM systems to Avantra systems for information on how to perform mapping. Multiple CALM systems can be added and managed, and Avantra uses the customer hierarchies to identify the available mappings between Avantra, CALM and SAP for Me.

note

The SAP for Me mapping, while displayed, is currently not in use.

With the data from CALM displayed in Avantra, it is also possible to view data about metrics that Avantra does not monitor natively by using the custom check SAP_CLOUD_ALM_HEALTH_METRICS. This custom check allows you to retrieve data from CALM and display it within the check tab of a managed system. You are then able to interact with this as you would any other check in Avantra. See SAP_CLOUD_ALM_HEALTH_METRICS for more information about the check functionality.

Prerequisites​

Before setting up a CALM system in Avantra, SAP needs to be configured:

  1. In the BTP Cockpit, identify the correct Global Account and Subaccount for Cloud ALM. Typically, these are both named SAP Cloud ALM. SAP BTP Cockpit CALM
  2. Create a new instance binding of the SAP Cloud ALM API service in the subaccount. See Enabling SAP Cloud ALM APIs for more information.
    The JSON of scopes required during the creation of the service instance is:
{
    "xs-security": {
        "xsappname": "<my-api-instance>",
        "authorities": [
          "$XSMASTERAPPNAME.calm-api.analytics.read",
          "$XSMASTERAPPNAME.calm-api.analytics.providers.read",
          "$XSMASTERAPPNAME.calm-api.projects.read",
          "$XSMASTERAPPNAME.calm-api.hm.read",
          "$XSMASTERAPPNAME.calm-api.itsm.attachements.read",
          "$XSMASTERAPPNAME.calm-api.itsm.attachements.write",
          "$XSMASTERAPPNAME.calm-api.itsm.personal.read",
          "$XSMASTERAPPNAME.calm-api.itsm.personal.write",
          "$XSMASTERAPPNAME.calm-api.itsm.read",
          "$XSMASTERAPPNAME.calm-api.itsm.write",
          "$XSMASTERAPPNAME.calm-api.landscape.read",
          "$XSMASTERAPPNAME.calm-api.logs.read",
          "$XSMASTERAPPNAME.calm-api.metrics.read",
          "$XSMASTERAPPNAME.calm-api.rum.read",
          "$XSMASTERAPPNAME.calm-api.sum.read",
          "$XSMASTERAPPNAME.calm-api.traces.read",
          "$XSMASTERAPPNAME.calm-api.demo-tasks.read",
          "$XSMASTERAPPNAME.calm-api.tasks.read",
          "$XSMASTERAPPNAME.calm-api.tests.read",
          "$XSMASTERAPPNAME.calm-api.integration-monitoring.read",
          "$XSMASTERAPPNAME.calm-api.bsm.read",
          "$XSMASTERAPPNAME.calm-api.defects.read",
          "$XSMASTERAPPNAME.calm-api.requirements.read",
          "$XSMASTERAPPNAME.calm-api.bm.read",
          "$XSMASTERAPPNAME.calm-api.jobs.read",
          "$XSMASTERAPPNAME.calm-api.exm.read",
          "$XSMASTERAPPNAME.calm-api.iep.read",
          "$XSMASTERAPPNAME.calm-api.csa.read"
        ],
        "oauth2-configuration": {
            "credential-types": [
                "binding-secret"
            ]
        }
    }
}

Replace <my-api-instance> with the name of your API instance.

You can remove scopes for ITSM (calm-api.itsm.*) if you do not ever want to integrate Avantra with SAP ITSM for cases, incidents or service requests.

note

ITSM integration will be available in a future Avantra release.

  1. Store important information from the service binding. Service binding
  2. (Optional) If preparing an ITSM integration, you can create destinations between CALM and SAP for Me by following the SAP Documentation: ITSM API Configuration documentation. The Configuration section is the only important section. An example of correct destinations is shown below: Correct Destinations Correct Destinations

See SAP Note 2767159 - How to install an SAP Passport browser certificate in Chrome for information on how to get the .pfx file for ClientCertificateAuthentication.

Setup in Avantra​

To add Cloud ALM to Avantra, in Avantra Classic UI:

  1. Navigate to System > Cloud Services.
  2. Click Add Cloud Service
  3. Select the Service Type - SAP Cloud ALM (CALM).
  4. Define a Service.
  5. Select a Customer.
  6. Select a System Role.
  7. Click New.
  8. Double-click the newly created service to open its Properties panel.
  9. Enter the following values from the binding created in CALM in the SAP Cloud ALM Info section:
    • Select a monitoring server from the Monitoring Server dropdown. This should be a server that can access the CALM APIs.
    • If required, select a Proxy.
    • In the URL field, enter the URL from the identify zone found in uaa.identityzone and the first part of the endpoints.Api, including the final / but not including the api. For example, if the uaa.identityzone is example-clouldalm and endpoints.Api is https://eu10.alm.cloud.sap/api then the final result is: https://example-clouldalm.eu10.alm.cloud.sap/.
  10. Click Apply to save the changes.
  11. In the Credentials tab, click the checkbox to allow editing of the SAP Cloud ALM API (OAUTH_CLIENT) information.
  12. Click the Edit icon to add the OAuth information.
    • Define a Name. This is a free text field.
    • Define a Client ID. This is the clientid in CALM.
    • Define a Client Secret. This is the clientsecret in CALM.
    • Define an Access Token URL. This is the url in CALM, with oauth/token at the end. For example, https://company-cloudalm.authentication.eu10.hana.ondemand.com/oauth/token.
    • Leave Scope blank.
  13. Click OK to save the credential.
  14. You can test the connection with the credential by clicking Test.
  15. Click Apply to save changes.

In the Avantra New UI:

  1. Navigate to System > Cloud Services.
  2. Click View New Version.
    The Cloud Services page will open in the New UI.
  3. Click Add New, then SAP Cloud ALM from the dropdown menu.
  4. Complete the following:
    • Add a Name.
    • Select a Customer.
    • Select a System Role.
    • Select a Monitoring Server. This should be a server that can access the CALM APIs.
    • In the URL field, enter the first part of the endpoints.Api, including the final / but not including the api. For example, http://eu55.alm.cloud.sap/.
    • Fill in any optional fields as required.
  5. Click Test connectivity.
  6. If the connection is successful, click Continue. If the connection fails, click Reconfigure. Ensure that you have entered the correct Monitoring Server, URL and Customer.
  7. Click Create to add a new credential.
  8. Complete the following:
    • Add a Name. This is a free text field.
    • Define a Client ID. This is the clientid from the binding created in BTP.
    • Define a Client Secret. This is the clientsecret from the binding created in BTP.
    • Define an Access Token URL. This is the url created, with oauth/token at the end. For example, https://company-cloudalm.authentication.eu10.hana.ondemand.com/oauth/token.
    • Leave Scope blank.
  9. Click Test to test the credentials work.
  10. Click Continue to save the credential.
  11. The summary page will display all the information entered and the ALM_Connect check will show a successful connection in the Checks tab. Other checks are daily checks, therefore no results will be available until a check cycle has run.
note

Optionally, if you wish to prepare for an ITSM integration and map Avantra systems to SAP for Me systems, you need to set the correct SAP customer number on the Customer of the SAP Cloud ALM system in Avantra. You can find the customer number in Users & Contacts on SAP for Me.

To set in Avantra:

  1. Navigate to Administration > Customers.
  2. Double-click the customer to open its Properties panel.
  3. Enter the SAP Customer Number.
  4. Click Apply to save changes.

Mapping CALM systems to Avantra systems​

Mapping CALM systems to Avantra systems can only be done in the New UI in Avantra. To access the New UI:

  1. Navigate to System > Cloud Services.
  2. Click View New Version.
    The Cloud Services page will open in the New UI.
  3. Double-click on the CALM system you want to map to Avantra systems.
  4. Click on the Mapping tab.

This tab displays all the systems in Avantra, and all the systems in the CALM instance. Systems that have no mappings will be displayed at the top of the list.

When an Avantra system is selected, the CALM systems will be sorted by highest matching possibility. You can select a CALM system and click the Map map icon icon to map the systems to each other.

Additionally, auto-mapping is possible by clicking Auto match. Avantra will map systems that have perfect matching data. It is recommended to do this.

You are able to search the mapping lists.

At the bottom of the tab is a list of all the mapped systems. You can unlink the systems by clicking the Unlink unlink icon icon.

Monitoring mapped systems​

To extend the monitoring available on a mapped system in Avantra, you can use the custom check SAP_CLOUD_ALM_HEALTH_METRICS. This custom check allows you to add in metrics from your CALM instance to display as checks within the Avantra interface. You can interact with these metrics, in Avantra, as you would any built-in check.