SAP CPI Monitor
Monitors the number of completed and failed iFlows (integration flows) on SAP Cloud Platform Integration in a defined timeframe (e.g. the last hour). Also the keystore entries are monitored and the validation respectively expiration of the certificates are displayed.
General
S-User or P-User with sufficient permissions for Basic Auth is required! (See also https://support.sap.com/en/alm/sap-cloud-alm/operations/expert-portal/integration-monitoring/calm-cpi.html):
For NEO environment assign the following roles:
IntegrationOperationServer.readNodeManager.read
For Cloud Foundry assign the following role template:
MonitoringDataRead
For OAuth authentication you created a service for "Process Integration" instance with service plan "api" and grant-type "client credentials" and associate it with a role (MonitoringDataRead) that is to be used to authorize the API client to call the OData API (see also https://help.sap.com/docs/cloud-integration/sap-cloud-integration/oauth-authentication-with-client-credentials-grant-inbound-cloud-foundry-environment)
| Executable | SAP_CPI_Monitor.exe |
| Connection method | HTTP |
| Ports |
|
Default parameters
| Parameter name | Possible values | Default | Description |
|---|---|---|---|
| SAPUsername | string | empty | SAP user |
| SAPPassword | string | empty | Password of the SAP user |
Sensor-specific parameters
| Parameter name | Possible values | Default | Description |
|---|---|---|---|
| Minutes | number | 1 - n | 60 | Past minutes in which the status of the integration flows are checked. |
| Url | <url> | SAP CPI tenant URL that is accessed with your S-User or P-User and the corresponding password to check the status of the iFlows. Example: http://<tenant-id>-tmn.hci.eu1.hana.ondemand.com | |
| AuthenticationMethod | BASIC | OAUTH | BASIC | Select authorization method |
| ClientId | <clientId> | Client ID used to retrieve the access token. You get the value of the Client ID from the service key generated for the service instance. | |
| ClientSecret | <clientSecret> | Client secret for the Client ID. You get the value of the Client Secret from the service key generated for the service instance. | |
| TokenUrl | <url> | The TokenUrl value is the address of the token server. The API client uses the service key data (ClientId, ClientSecret & TokenUrl) to call the token server and get the access token. Example: https://<tenant>.authentication.eu20.hana.ondemand.com/oauth/token |
Channels
| Channel name | Description | Lookup file |
|---|---|---|
| Completed iFlows | Total number of successfully completed integration flows | |
| Failed iFlows | Total number of failed integration flows. The name of the failed iFlows will be displayed in the sensor text. | |
| Valid certificates | Total number of valid certificates | |
| Not yet valid certificates | Total number of certificates which are not yet valid | |
| Expiring certificates < 30d | Total number of certificates which will expire in less than 30 days | |
| Expiring certificates < 7d | Total number of certificates which will expire in less than 7 days | |
| Expired Certificates | Total number of expired certificates |
Important notes
Timezone of the CPI API is UTC.
Changelog
| Version | Changes |
|---|---|
| 2024.04 | Implemented the functionality to use OAuth client credentials (clientID & clientSecret) for inbound calls to the SAP integration suite |
| 2021.12 | Added channels to monitor the keystore and check the validation respectively the expiration of the certificates.The alias name of the not valid certificates is displayed in the sensor text. |
| 2021.06 | First stable release |