Raw Data Outbound Logs API

Log Providers	SAP Cloud ALM Monitoring Use Cases
exm.im	Exception Monitoring for Integration Monitoring
exm.jam	Exception Monitoring for Job Monitoring
bsm	Business Services Management (status events)
im	Integration Monitoring
iep	Monitoring Events (see prerequisites)
jam.def	Job Automation Monitoring Definition Logs
jam.run	Job Automation Monitoring Runtime Logs
jam.run_step	Job Automation Monitoring Runtime Step Logs

Security Scope	Description
calm-api.logs.read	Mandatory security scope to access any CALM logs
calm-api.exm.read	To access Exception Monitoring use case data
calm-api.exm.personal.read	To read log in Exception Monitoring use case. This security scope is necessary to allow extraction of data that could contain personal and sensitive data.
calm-api.bsm.read	To get access to Business Services Management data
calm-api.integration-monitoring.read	To get access to the Integration Monitoring data
calm-api.integration-monitoring.personal.read	To read log in Integration Monitoring use case. This security scope is necessary to allow extraction of data that could contain personal and sensitive data.
calm-api.iep.read	To get access to the Monitoring Event data
calm-api.jobs.read	To get access to the Jobs & Automation Monitoring data
calm-api.jobs.personal.read	To get access to the Jobs & Automation Monitoring personal data

Query parameters

Name	Description	Comments
format	Expected output format of the logs api. You can select between text, protobuf-binary or protobuf-json format. Supported Values: protobuf-binary protobuf-json	String Default: protobuf-binary
provider	The log data provider accessed though the logs api. Supported values: exm.im exm.jam bsm im iep jam.def jam.run jam.run_step	String Mandatory
version	Version of the logs provider.	String Example: v1 Default: Oldest non-deprecated version.
period	Semantic period to collect. This parameter can be used instead of parameters “from” and “to”; it is converted to “from” and “to”. Parameter “to” is set to Now, where 'Now' is the current UTC unix time on SAP Cloud ALM side, and parameter “from” is calculated by subtracting “period” to parameter “to”. If parameters “to” and/or “from” are provided in addition to “period”, then an error is returned (incompatible parameters “from”/”to” and “period”). Possible values: <X>M where X is in [1,60] unless provider authorizes larger from/to period (e.g. bsm has no restriction for requested from/to period).. Examples 5M	String Default: 5M
from	UTC timestamp indicating the beginning of the collection period. The largest possible period to collect is 1 hour; if the period (from/to) goes above one hour, then an error is returned. Caution: “from” timestamp is inclusive.	Optional Format: YYYYMMDDHHmmss
to	UTC timestamp indicating the end of the collection period. The oldest timestamp accepted for parameter “to” is defined by the Logs Provider, if “to” goes beyond this limit an error should be returned by the Logs Provider. If “to” is not provided or if “to” value is in the future, then the newest log records until Now are returned. Caution: “to” is exclusive.	Optional Format: YYYYMMDDHHmmss Default: Now
observedTimestamp	Boolean. Indicates if the "from" & "to" timestamps correspond to measured timestamps (observedTimestamp = false) or observed timestamps (observedTimestamp = true). Since a log measured at time t1 might be observed later at t1+delta (delta time is due to data collection infrastructure), it may be interesting to rely on observed timestamps which guarantee the presence of the logs. Not relevant for providers bsm since they doesn't distinguish between timestamp and observed timestamp. For provider jam.run, observedTimestamp=true is the default and the only mode supported. For provider jam.def, period (from/to) is not used, all job definitions are always returned.	Default: false
<filters>	Log Records filters are passed as URL parameter. The list of filters depends on the Logs Data Provider. See next chapter for a description of filters per logs data providers.	Optional
limit	Pagination support. Maximum number of log records to return. Minimum value is 1, maximum value is 1000.	Default: 100
offset	Pagination support. Number of log records to skip. If the offset goes beyond the total number of log records available, then no log records are returned (no error).	Default: 0
onLimit	Indicates what to do if the number of records goes above the maximum limit (parameter “limit”). Possible values are: ERROR (return an error), TRUNCATE: truncate the response.	Default: ERROR

Filters

Exception Monitoring

The table below describes the filters available for Exception Monitoring.

Filter Name	Description	Comment
serviceId	Comma-separated list of LMS service Ids. Minimum 1 service id, maximum 30 service ids.	Mandatory
category	Exception source category	Optional
status	Resolved, Warning or Error	Optional
message	Wildcard '' can be used to support following scenarios: Starts with: text Ends with: text Contains: text* Exact match: text	Optional

Business Service Management

Remark: only the log corresponding to the last event status is returned and not the complete action logs. For example, if an event has been announced, updated and completed today and we request the BSM logs for today, we get only the log "event completed".

The table below describes the filters available for Business Service Management.

Filter Name	Description	Comment
serviceId	LMS service Id	Mandatory. Can be for business service, cloud service or system
from	Timestamp indicating the beginning of the collection period.	from and to indicate the time when the event was updated and not necessarily the time when the event starts or stops For example: If an event was announced in the past for the future the API returns a corresponding log message if from< announcement time < to If an event was already started the API returns a corresponding log message if from< start time < to BSM OTEL API does not distinguish between observedTimestamp and measured timestamp There is no restriction on period length and on how far we can go in the past. Only restriction is from <= to.
to	Timestamp indicating the end of the collection period.	from and to indicate the time when the event was updated and not necessarily the time when the event starts or stops For example: If an event was announced in the past for the future the API returns a corresponding log message if from< announcement time < to If an event was already started the API returns a corresponding log message if from< start time < to BSM OTEL API does not distinguish between observedTimestamp and measured timestamp There is no restriction on period length and on how far we can go in the past. Only restriction is from <= to.
eventDomain	Event type for which the client needs to get events. Available values: Maintenance, Degradation, Disruption, Communication	Optional
eventPhase	Phase of the event . Available values: Announcement, Detection, Status Update, Start, Completion, Resolution, Root Cause Analysis.	Optional
showDescription	Whether the description should be returned or not . Possible values X or <space>. Default <space>
eventSource	source of the event. possible values: SAP, Customer, API or External (in the future )

Integration Monitoring

The table below describes the filters available for Integration Monitoring.

Filter Name	Description	Comment
serviceId	Comma-separated list of LMS service Ids	Mandatory
from / to	Timestamp indicating the beginning and the end of the collection period. All messages with start time between from and to timestamps will be returned by the interface.	Mandatory from/to or period
category	Comma-separated list of Category labels as displayed in Integration Monitoring UI	Mandatory

Filter Name

Description

Comment

serviceId

Comma-separated list of LMS service Ids

Mandatory

from / to

Timestamp indicating the beginning and the end of the collection period. All messages with start time between from and to timestamps will be returned by the interface.

Mandatory

from/to or period

Filter Name	Description	Comment
serviceId	LMS service Id	Mandatory
from / to	Timestamp indicating the beginning and the end of the collection period. All messages with start time between from and to timestamps will be returned by the interface.	Mandatory
usecase	Monitoring usecase Allowed values: "CALM.EXM", "CALM.IM", "CALM.BPMON", "CALM.BSM", "CALM.HM", "CALM.JM", "CALM.SUM"	Optional Only one value
eventsubtype	Metric technical name Ex: "calm.im.cpi.msg"	Optional Only one value

Jobs & Automation Monitoring

The table below describes the filters available for Jobs & Automation Monitoring (providers: jam.def and jam.run)

Filter Name	Description	Comment
serviceId	Comma-separated list of LMS service Ids. Minimum 1 service id, maximum 27 service ids.	Mandatory
from / to	Timestamp indicating the beginning and the end of the collection period. All messages with start time between from and to timestamps will be returned by the interface.	Mandatory from / to or period
jobType	Job type CF_DM_PROCESS → SAP DM Production Process HCP_IPS_JOB → SAP Cloud Identity Provisioning Job IRPA → SAP Intelligent RPA Job NW_ABAP_JOB → SAP ABAP Job NW_ABAP_PC → SAP BW Process Chain NW_ABAP_WF → SAP Business Workflow NW_APPL_JOB → SAP Application Job SPA_AUTOMATION → SAP Build Automation Job SPA_PROCESS → SAP Build Process	Optional
jobName	Job name	Optional
jobContext	Job context	Optional
name	Step name	Optional. Relevant with provider jam.run_step

Status Codes

The following status codes apply to this HTTP action:

Status Code	Description
202	Data accepted
400	Structure of the request is invalid. Unknown parameter “XYZ” Parameters “from”/”to” and “period” are incompatible. Parameter XYZ has an unsupported value “XYZ”
403	Authentication failure. Security scope is missing
404	The request path is incorrect. Unknown use-case "XYZ" Unknown use-case version "X" Service "XYZ" not found
408	The request took too long to reach the endpoint.
413	The payload was too big.
428	Pre-condition not full filled.
429	The request rate quota has been exceeded.
500	Internal Server Error
502	Bad Gateway
503	Service unavailable
504	Gateway Timeout

Response headers

Header	Description
x-total-count	Total number of log records. Returned only if parameter "onLimit" = "TRUNCATE"

Response Body Example

EXM - Response Body Example
Sample Code { "resourceLogs": [ { "resource": { "attributes": [ { "key": "service.name", "value": { "stringValue": "QM7002" } }, { "key": "sap.service.display_name", "value": { "stringValue": "QM7 (QM7002)" } }, { "key": "service.instance.id", "value": { "stringValue": "312733191" } }, { "key": "service.namespace", "value": { "stringValue": "SAP_S4HANA_OP" } }, { "key": "telemetry.sdk.name", "value": { "stringValue": "sap.calm" } }, { "key": "telemetry.sdk.version", "value": { "stringValue": "1.0.0" } }, { "key": "telemetry.sdk.language", "value": { "stringValue": "java" } } ] }, "scopeLogs": [ { "scope": { "name": "default" }, "logRecords": [ { "timeUnixNano": "1695910805000000000", "severityNumber": "SEVERITY_NUMBER_ERROR", "severityText": "Error", "body": { "stringValue": "Logon of user in client 002 failed when starting a step" }, "attributes": [ { "key": "exception.type", "value": { "stringValue": "ABAP Aborted Job" } }, { "key": "sap.exm.correlationId", "value": { "stringValue": "CONSENT MANAGEMENT@16180400" } }, { "key": "Subcategory", "value": { "stringValue": "CONSENT MANAGEMENT" } } ], "observedTimeUnixNano": "1695910887309000000" },

EXM - Response Body Example

Sample Code

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "service.name",
                        "value": {
                            "stringValue": "QM7002"
                        }
                    },
                    {
                        "key": "sap.service.display_name",
                        "value": {
                            "stringValue": "QM7 (QM7002)"
                        }
                    },
                    {
                        "key": "service.instance.id",
                        "value": {
                            "stringValue": "312733191"
                        }
                    },
                    {
                        "key": "service.namespace",
                        "value": {
                            "stringValue": "SAP_S4HANA_OP"
                        }
                    },
                    {
                        "key": "telemetry.sdk.name",
                        "value": {
                            "stringValue": "sap.calm"
                        }
                    },
                    {
                        "key": "telemetry.sdk.version",
                        "value": {
                            "stringValue": "1.0.0"
                        }
                    },
                    {
                        "key": "telemetry.sdk.language",
                        "value": {
                            "stringValue": "java"
                        }
                    }
                ]
            },
            "scopeLogs": [
                {
                    "scope": {
                        "name": "default"
                    },
                    "logRecords": [
                        {
                            "timeUnixNano": "1695910805000000000",
                            "severityNumber": "SEVERITY_NUMBER_ERROR",
                            "severityText": "Error",
                            "body": {
                                "stringValue": "Logon of user in client 002 failed when starting a step"
                            },
                            "attributes": [
                                {
                                    "key": "exception.type",
                                    "value": {
                                        "stringValue": "ABAP Aborted Job"
                                    }
                                },
                                {
                                    "key": "sap.exm.correlationId",
                                    "value": {
                                        "stringValue": "CONSENT MANAGEMENT@16180400"
                                    }
                                },
                                {
                                    "key": "Subcategory",
                                    "value": {
                                        "stringValue": "CONSENT MANAGEMENT"
                                    }
                                }
                            ],
                            "observedTimeUnixNano": "1695910887309000000"
                        },

BSM - Response Body Example
Sample Code { "resourceLogs": [ { "resource": { "attributes": [ { "key": "service.name", "value": { "stringValue": "John Functional Tests" } }, { "key": "sap.service.display_name", "value": { "stringValue": "For Manual tests " } }, { "key": "telemetry.sdk.name", "value": { "stringValue": "sap.calm" } }, { "key": "telemetry.sdk.version", "value": { "stringValue": "1.0.0" } }, { "key": "telemetry.sdk.language", "value": { "stringValue": "java" } }, { "key": "service.name", "value": { "stringValue": "John Functional Tests" } }, { "key": "service.instance.id", "value": { "stringValue": "b8bfa970-6351-4d4a-af70-9d169d54f5f8" } }, { "key": "sap.service.display_name", "value": { "stringValue": "For Manual tests " } }, { "key": "service.namespace", "value": { "stringValue": "BusinessService" } } ] }, "scopeLogs": [ { "scope": { "name": "default" }, "logRecords": [ { "timeUnixNano": "1710229807781000000", "severityNumber": "SEVERITY_NUMBER_INFO", "severityText": "INFO", "body": { "stringValue": "Disruption [Detection]: csf-cpi" }, "attributes": [ { "key": "sap.bsm.event.id", "value": { "stringValue": "009afb32-f120-3ad8-a2b2-cdf0461355d7" } }, { "key": "sap.bsm.event.name", "value": { "stringValue": "VNS9849051" } }, { "key": "sap.bsm.event.source", "value": { "stringValue": "SAP" } }, { "key": "sap.bsm.event.phase", "value": { "stringValue": "Detection" } }, { "key": "sap.bsm.event.description", "value": { "stringValue": "<p><u>Impact Description</u></p><p>A technical issue has been identified in the landscape.You may experience issues while accessing the Web UI and deployment of new content to your tenant. The running integration scenarios will not be impacted.</p>" } }, { "key": "sap.bsm.event.startTime", "value": { "stringValue": "2024-03-11T13:20:00Z" } }, { "key": "sap.bsm.event.endTime", "value": { "stringValue": "" } }, { "key": "sap.bsm.event.domain", "value": { "stringValue": "Disruption" } }, { "key": "sap.bsm.event.cssid", "value": { "stringValue": "" } }, { "key": "sap.bsm.event.affectedservices", "value": { "stringValue": "[{\"serviceName\":\"csf-cpi\",\"type\":\"SAP Integration Suite (Cloud Integration)\",\"role\":\"TEST\"}]" } } ], ... } ] } ] } ] }

BSM - Response Body Example

Sample Code

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "service.name",
                        "value": {
                            "stringValue": "John Functional Tests"
                        }
                    },
                    {
                        "key": "sap.service.display_name",
                        "value": {
                            "stringValue": "For Manual tests "
                        }
                    },
                    {
                        "key": "telemetry.sdk.name",
                        "value": {
                            "stringValue": "sap.calm"
                        }
                    },
                    {
                        "key": "telemetry.sdk.version",
                        "value": {
                            "stringValue": "1.0.0"
                        }
                    },
                    {
                        "key": "telemetry.sdk.language",
                        "value": {
                            "stringValue": "java"
                        }
                    },
                    {
                        "key": "service.name",
                        "value": {
                            "stringValue": "John Functional Tests"
                        }
                    },
                    {
                        "key": "service.instance.id",
                        "value": {
                            "stringValue": "b8bfa970-6351-4d4a-af70-9d169d54f5f8"
                        }
                    },
                    {
                        "key": "sap.service.display_name",
                        "value": {
                            "stringValue": "For Manual tests "
                        }
                    },
                    {
                        "key": "service.namespace",
                        "value": {
                            "stringValue": "BusinessService"
                        }
                    }
                ]
            },
            "scopeLogs": [
                {
                    "scope": {
                        "name": "default"
                    },
                    "logRecords": [
                        {
                            "timeUnixNano": "1710229807781000000",
                            "severityNumber": "SEVERITY_NUMBER_INFO",
                            "severityText": "INFO",
                            "body": {
                                "stringValue": "Disruption [Detection]: csf-cpi"
                            },
                            "attributes": [
                                {
                                    "key": "sap.bsm.event.id",
                                    "value": {
                                        "stringValue": "009afb32-f120-3ad8-a2b2-cdf0461355d7"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.name",
                                    "value": {
                                        "stringValue": "VNS9849051"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.source",
                                    "value": {
                                        "stringValue": "SAP"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.phase",
                                    "value": {
                                        "stringValue": "Detection"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.description",
                                    "value": {
                                        "stringValue": "<p><u>Impact Description</u></p><p>A technical issue has been identified in the landscape.You may experience issues while accessing the Web UI and deployment of new content to your tenant. The running integration scenarios will not be impacted.</p>"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.startTime",
                                    "value": {
                                        "stringValue": "2024-03-11T13:20:00Z"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.endTime",
                                    "value": {
                                        "stringValue": ""
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.domain",
                                    "value": {
                                        "stringValue": "Disruption"
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.cssid",
                                    "value": {
                                        "stringValue": ""
                                    }
                                },
                                {
                                    "key": "sap.bsm.event.affectedservices",
                                    "value": {
                                        "stringValue": "[{\"serviceName\":\"csf-cpi\",\"type\":\"SAP Integration Suite (Cloud Integration)\",\"role\":\"TEST\"}]"
                                    }
                                }
                            ], ...
                        }
                    ]
                }
            ]
        }
    ]
}

Monitoring Event - Response body example
Sample Code { "resourceLogs": [ { "resource": { "attributes": [ { "key": "service.name", "value": { "stringValue": "H2RCPI" } }, { "key": "sap.service.display_name", "value": { "stringValue": "Test CPI Update" } }, { "key": "service.namespace", "value": { "stringValue": "SAP_CPI" } }, { "key": "service.instance.id", "value": { "stringValue": "" } }, { "key": "service.instance.id", "value": { "stringValue": "" } }, { "key": "telemetry.sdk.name", "value": { "stringValue": "sap.calm" } }, { "key": "telemetry.sdk.version", "value": { "stringValue": "1.0.0" } }, { "key": "telemetry.sdk.language", "value": { "stringValue": "java" } } ] }, "scopeLogs": [ { "logRecords": [ { "timeUnixNano": "411818600000000000", "body": { "stringValue": "Destination Interface = Bank \| Direction = INBOUND \| Integration Name = Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26 \| Source Interface = A_BankDetail \| Status = APPLICATION ERROR \| Status Text = Replication of 16 records failed." }, "attributes": [ { "key": "sap.iep.event.rating", "value": { "stringValue": "WARNING" } }, { "key": "sap.iep.event.event_subtype", "value": { "stringValue": "calm.im.cpi.msg" } }, { "key": "sap.iep.event.subject", "value": { "stringValue": "SAP Business Network Freight" } }, { "key": "sap.iep.event.use_case", "value": { "stringValue": "CALM.IM" } }, { "key": "sap.iep.event.event_state", "value": { "stringValue": "CREATE" } }, { "key": "sap.iep.event.major_update", "value": { "stringValue": "false" } }, { "key": "sap.iep.event.event_name", "value": { "stringValue": "CALM.IM_calm.im.cpi.msg" } }, { "key": "sap.iep.event.event_config_id", "value": { "stringValue": "33a8eb28-6b3e-4f00-8d40-f1039237d58c" } }, { "key": "sap.iep.event.tags", "value": { "stringValue": "{path=Destination Interface = Bank \| Direction = INBOUND \| Integration Name = Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26 \| Source Interface = A_BankDetail \| Status = APPLICATION ERROR \| Status Text = Replication of 16 records failed., eventDetailsTable={rowsTotalCount=1, columnsCount=8, rows=[[995724e1-3b7a-496e-b09c-083609c1e983, ERROR, APPLICATION ERROR \| Replication of 16 records failed., 2024-06-30T12:26:39.458Z, Bank, INBOUND, A_BankDetail, Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26]], rowsCount=1, columns=[Message ID, Status Group, Status \| Status Text, Timestamp, Destination Interface, Direction, Source Interface, Integration Name], rowFormat=array}, sourceInterface=A_BankDetail, integrationName=Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26, statusText=Replication of 16 records failed., additionalInfo=<td align=\"left\" width=\"468\" valign=\"top\">\n <span class=\"textContent\">\n <p style=\"font-family:Arial,Arial,Helvetica,sans-serif;font-size:13px;font-weight:inherit;line-height:13pt;margin:0 50px 10px;color:#666564;text-align:center\">\n <strong>Additional Information</strong>\n </p>\n </span>\n <div style=\"overflow-x:auto;font-family:Arial,Arial,Helvetica,sans-serif;font-size:13px;font-weight:inherit;line-height:13pt;margin:0 0 10px;color:#666564\">\n <style>\n table.IM {\n border: 1px solid #b3adad;\n border-collapse: collapse;\n padding: 5px\n }\n\n table.IM th {\n border: 1px solid #b3adad;\n padding: 5px;\n background: #f0f0f0;\n color: #666564;\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: 700\n }\n\n table.IM td {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: #666564;\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: inherit\n }\n table.IM td.red {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(187, 0, 0);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.yellow {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(231, 140, 7);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.green {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(57, 173, 12);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.blue {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(4, 118, 152);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.purple {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(130, 7, 231);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n </style>\n <p>Total Messages (1) </p>\n <table class=\"IM\" border=\"1\" width=\"580\" valign=\"top\"><tr><th>Message ID</th><th>Status</th><th>Status Text</th><th>Timestamp</th></tr><tr><td>995724e1-3b7a-496e-b09c-083609c1e983</td><td class=red>APPLICATION ERROR</td><td>Replication of 16 records failed.</td><td>2024-06-30T12:26:39.458Z</td></tr></table>\n</td>, destinationInterface=Bank, status=APPLICATION ERROR, direction=INBOUND}" } } ] } ] } ] } ] }

Monitoring Event - Response body example

Sample Code

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "service.name",
                        "value": {
                            "stringValue": "H2RCPI"
                        }
                    },
                    {
                        "key": "sap.service.display_name",
                        "value": {
                            "stringValue": "Test CPI Update"
                        }
                    },
                    {
                        "key": "service.namespace",
                        "value": {
                            "stringValue": "SAP_CPI"
                        }
                    },
                    {
                        "key": "service.instance.id",
                        "value": {
                            "stringValue": ""
                        }
                    },
                    {
                        "key": "service.instance.id",
                        "value": {
                            "stringValue": ""
                        }
                    },
                    {
                        "key": "telemetry.sdk.name",
                        "value": {
                            "stringValue": "sap.calm"
                        }
                    },
                    {
                        "key": "telemetry.sdk.version",
                        "value": {
                            "stringValue": "1.0.0"
                        }
                    },
                    {
                        "key": "telemetry.sdk.language",
                        "value": {
                            "stringValue": "java"
                        }
                    }
                ]
            },
            "scopeLogs": [
                {
                    "logRecords": [
                        {
                            "timeUnixNano": "411818600000000000",
                            "body": {
                                "stringValue": "Destination Interface = Bank | Direction = INBOUND | Integration Name = Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26 | Source Interface = A_BankDetail | Status = APPLICATION ERROR | Status Text = Replication of 16 records failed."
                            },
                            "attributes": [
                                {
                                    "key": "sap.iep.event.rating",
                                    "value": {
                                        "stringValue": "WARNING"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.event_subtype",
                                    "value": {
                                        "stringValue": "calm.im.cpi.msg"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.subject",
                                    "value": {
                                        "stringValue": "SAP Business Network Freight"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.use_case",
                                    "value": {
                                        "stringValue": "CALM.IM"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.event_state",
                                    "value": {
                                        "stringValue": "CREATE"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.major_update",
                                    "value": {
                                        "stringValue": "false"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.event_name",
                                    "value": {
                                        "stringValue": "CALM.IM_calm.im.cpi.msg"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.event_config_id",
                                    "value": {
                                        "stringValue": "33a8eb28-6b3e-4f00-8d40-f1039237d58c"
                                    }
                                },
                                {
                                    "key": "sap.iep.event.tags",
                                    "value": {
                                        "stringValue": "{path=Destination Interface = Bank | Direction = INBOUND | Integration Name = Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26 | Source Interface = A_BankDetail | Status = APPLICATION ERROR | Status Text = Replication of 16 records failed., eventDetailsTable={rowsTotalCount=1, columnsCount=8, rows=[[995724e1-3b7a-496e-b09c-083609c1e983, ERROR, APPLICATION ERROR | Replication of 16 records failed., 2024-06-30T12:26:39.458Z, Bank, INBOUND, A_BankDetail, Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26]], rowsCount=1, columns=[Message ID, Status Group, Status | Status Text, Timestamp, Destination Interface, Direction, Source Interface, Integration Name], rowFormat=array}, sourceInterface=A_BankDetail, integrationName=Bank Data Replication from S/4HANA Cloud to Employee Central - Version 26, statusText=Replication of 16 records failed., additionalInfo=<td align=\"left\" width=\"468\" valign=\"top\">\n <span class=\"textContent\">\n <p style=\"font-family:Arial,Arial,Helvetica,sans-serif;font-size:13px;font-weight:inherit;line-height:13pt;margin:0 50px 10px;color:#666564;text-align:center\">\n <strong>Additional Information</strong>\n </p>\n </span>\n <div style=\"overflow-x:auto;font-family:Arial,Arial,Helvetica,sans-serif;font-size:13px;font-weight:inherit;line-height:13pt;margin:0 0 10px;color:#666564\">\n <style>\n table.IM {\n border: 1px solid #b3adad;\n border-collapse: collapse;\n padding: 5px\n }\n\n table.IM th {\n border: 1px solid #b3adad;\n padding: 5px;\n background: #f0f0f0;\n color: #666564;\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: 700\n }\n\n table.IM td {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: #666564;\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: inherit\n }\n table.IM td.red {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(187, 0, 0);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.yellow {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(231, 140, 7);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.green {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(57, 173, 12);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.blue {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(4, 118, 152);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n table.IM td.purple {\n border: 1px solid #b3adad;\n text-align: left;\n padding: 5px;\n background: #fff;\n color: rgb(130, 7, 231);\n font-family: Arial, Arial, Helvetica, sans-serif;\n font-size: 13px;\n font-weight: bold;\n line-height: 13pt;\n }\n\n </style>\n <p>Total Messages (1) </p>\n <table class=\"IM\" border=\"1\" width=\"580\" valign=\"top\"><tr><th>Message ID</th><th>Status</th><th>Status Text</th><th>Timestamp</th></tr><tr><td>995724e1-3b7a-496e-b09c-083609c1e983</td><td class=red>APPLICATION ERROR</td><td>Replication of 16 records failed.</td><td>2024-06-30T12:26:39.458Z</td></tr></table>\n</td>, destinationInterface=Bank, status=APPLICATION ERROR, direction=INBOUND}"
                                    }
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Limitations

The following rules apply when accessing the SAP Cloud ALM Logs API.

Throughput:
- Maximum 100 requests per minute
Limits:
- Maximum log records per response: 1000 (HTTP Error Code 403 + Error Message)

Prerequisites

Before to access the Raw Data Outbound Logs API for Monitoring Event, you must enable the action "Store Event Payload for 24 Hours" on the required events. More details are available in Intelligent Event Processing documentation here.

Restrictions

The json protobuf encoding does not support the deviations described https://opentelemetry.io/docs/specs/otlp/#json-protobuf-encoding Information published on non-SAP site ; to manage correlation id use the protobuf binary format. With protobuf json format, spanId and traceId are base-64-encoded and not case-insensitive-hex-encoded-strings.

Models mapping

This section details how the SAP Cloud ALM data model is mapped to the OTLP data model.

Some mapping rules are common to all scenarios (see section Common mapping).
Some mapping rules are specific to each scenario (see dedicated scenario mapping tables).

Common Mapping

SAP Cloud ALM (source)	OTLP (target)	Comments
Service type	resourceLogs / resource / attribute / service.namespace
Service name	resourceLogs / resource / attribute / service.name
Service description	resourceLogs / resource / attribute / sap.service.display_name
Service attributes	list of key value-pairs resources attributes	Depends on data source
Logs data provider's version	resourceLogs / scopeLogs / scope / version	Depends on data source
Logs data provider's technical name	resourceLogs / scopeLogs / scope / name	Depends on data source
externalId for Cloud Service systemNumber for Technical System	resourceLogs / resource / attribute / service.instance.id
	resourceLogs / resource / attribute / telemetry.sdk.name	Depends on data source
	resourceLogs / resource / attribute / telemetry.sdk.language	Depends on data source
	resourceLogs / resource / attribute / telemetry.sdk.version	Depends on data source

Exception Monitoring Mapping

In addition to the common mapping rules, the table below describes the mapping rules specific to Exception Monitoring scenario.

LogRecord

Exception Monitoring	OTLP LogRecord	Comment
Message	logRecord.body
Status	logRecord.severityNumber / logRecord.severityText
Timestamp	logRecord.timeUnixNano
Saved_timestamp	logRecord.observedTimeUnixNano
Association Context trace_id	logRecord.trace_id	traceId (if available)
Association Context span_id	logRecord.span_id	span_id (if available)
Association Context <attribute_name>	logRecord.attributes → sap.exm.related.<attribute_name>	SAP Extension
Exception Category	logRecord.attributes → sap.exm.category	SAP Extension (label visible in UI).
Association Context correlation_id	logRecord.attributes → sap.exm.correlation_id	SAP Extension
Collection Context aggregated exception count	logRecord.attributes → sap.exm.aggregated_count	SAP Extension. Optional. Number of log occurrences.
CollectionContext	logRecord.attributes	List of key-value pairs depending on the exception category attributes

Business Service Management Mapping

In addition to the common mapping rules, the table below describes the mapping rules specific to Business Service Management scenario.

BSM	OTLP LogRecord	Comment
subject	logRecord.body	Event type eventphase: servicename Example: Maintenance [Announcement]: Brain Software
Constant "9"	logRecord.severityNumber
Constant "INFO"	logRecord.severityText
Announcement/start/update/Closure timestamp	logRecord.timeUnixNano	Time when announcement/update/start/closure happened. BSM will not distinguish between Timestamp and observed timestamp.
Not used	logRecord.observed
Not used	logRecord.trace_id
Not used	logRecord.span_id
	Attributes
eventId	sap.bsm.event.id	The CALM internal event id e.g. "1cea186c-52f7-477d-84e8-d6475251e566"
eventName	sap.bsm.event.name	Event name e.g. "EV23456789" or "Regular weekend maintenance"
eventSource	sap.bsm.event.source	Whether the event was created by SAP, by customer in SAP Cloud ALM, or from inbound API Possible values: "SAP", "Customer", "API" or "External" tbd
eventphase	sap.bsm.event.phase	Phase of the event . Possible values: "Announcement", "Detection", "Status Update", "Start", "Completion", "Resolution", "Root Cause Analysis"
eventDescription	sap.bsm.event.description	Description of the event formatted as http text (only if showDescription = X )
eventStartTime	sap.bsm.event.start_time	Start Time of Event in UTC
eventEndTime	sap.bsm.event.end_time	End Time of Event in UTC
eventType	sap.bsm.event.domain	Event type for which the client needs to get events. Available values: "Maintenance", "Degradation", "Disruption", "Communication"
CSSIncidentID	sap.bsm.event.cssid	CSS id of related ticket (if exists)
affectedServices	sap.bsm.event.affected_services	If logs are requested for a business service but events were created for services or systems of the business service, then this contains information about affected services

Integration Monitoring Mapping

In addition to the common mapping rules, the table below describes the mapping rules specific to Integration Monitoring scenario.

Version 1

Log Record

Integration Monitoring	OTLP Log Record	Comment
Start time of the message	logRecord.timeUnixNano
json complex structure describing the message payload	logRecord.body	See below Caution: the body is stringified; the example below is unstringified for better readability.

Integration Monitoring

OTLP Log Record

Comment

Start time of the message

logRecord.timeUnixNano

json complex structure describing the message payload

logRecord.body

See below

Caution: the body is stringified; the example below is unstringified for better readability.

Sample Code

{
    "NormalizedEvents": {
        "Category": "<Category>", //This is a category onboarded in CALM. Please check with the CALM Integration Monitoring on what is the category.
        "SourceEventId": "413f8d8c-c93d-4823-91df-01afa017aac6", // Unique identifier of the message in managed cloud tenant
        "EventTimestamp": "2022-02-18T12:00:10.000+00:00", //Start time of the Message
        "EventEndTimestamp": "2022-02-18T12:00:10.000+00:00", //End time of the Message
        "Direction": "INBOUND", // To specify whether it incoming or outgoing message for the managed cloud. Accepted values 'INBOUND' and 'OUTBOUND'
        "Status": "SUCCESS", // Status of the message. Can you cloud lob specific. No restriction from CALM.
        "StatusGroup": "SUCCESSFUL", // Status described in CALM. Allowed values are ERROR,WARNING,IN_PROCESS,CANCELED,SUCCESSFUL,INFO,OTHERS
        "StatusText": "Success", // Detailed description of the status of the message
        "CorrelationData" : {
            "Passport": { // SAP Passport
                "TransactionId": "18A6908EE4123E15132C2F216B23D299",
                "ConnectionId": "18A6908EE4117B3A237338334F3B6375",
                "ConnectionCounter": 1,
                "PreviousComponent": "IHLS_CORE",
                "ComponentName": "IHLS_CORE                       ",
                "ComponentType": 29,
                "Service": 0,
                "Action": "REPLICATION",
                "ActionType": 11,
                "RootContextId": "18A6908EE411723B2190828C1D0242EB"
            },
            "W3CTraceContext": { // W3C trace context
                "traceId": "A00ADE1DE68D0700E0066E0BA036D692",
                "spanId": "AAA4ABCD1234ABCD"
            },
            "RelatedPassport": [],
            "RelatedW3CTraceContext": []
      },
          
      "ApplicationData": [ // Managed cloud Specific business data to be sent to CALM to be displayed in customer calm tenant.
            {
                "ParamId": <ParamId>,
                "ParamValue": <ParamValue>,
                "DisplayText": "Display Text",
                "ValueType": "SIMPLE",
                "Classification": "MESSAGE",
                "IsPersonalData": false,
                "IsSensitiveData": false                 
            },
            {               
                "ParamId": <ParamId>,
                "ParamValue": <ParamValue>,
              "DisplayText": "Display Text",
                "ValueType": "SIMPLE",
                "Classification": "MESSAGE",
                "IsPersonalData": false,
                "IsSensitiveData": false               
           }]
    }
}

Version 2

LogRecord

Message Section	Field Name	LogRecord
	Timestamp in nano seconds	timeUnixNano
	W3C trace ID	traceid base 64 encoded
Header	Message Category	sap.im.category
	Source event ID	sap.im.source_eventid
	Event start timestamp	sap.im.event_timestamp
	EventEndTimestamp	sap.im.event_end_timestamp
	Direction of the message	sap.im.direction
	Status of the message	sap.im.status
	Status group of the message	sap.im.status_group
	Status text of the message	sap.im.status_text
Passport	Transaction ID	sap.im.passport.transaction_id
	Connection ID	sap.im.passport.connection_id
	Connection counter	sap.im.passport.connection_counter
	Component name	sap.im.passport.component_name
	Component type	sap.im.passport.component_type
	Previous component	sap.im.passport.previous_component
	Service	sap.im.passport.service
	Action	sap.im.passport.action
	Action type	sap.im.passport.action_type
	Root context ID	sap.im.passport.root_context_id
Application data sent by the managed component as name-value pairs	Parameter	sap.im.application_data.<paramid>

Sample Code

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                 
                ]
            },
            "scopeLogs": [
                {
                    "logRecords": [
                        {
                            "timeUnixNano": "1730153151000000000",
                          "traceId": "H7tHTHr1SxmEYdNYTKyrhQ==",
                            "body": {
                                "stringValue": ""
                            },
                            "attributes": [
                                {
                                    "key": "sap.im.category",
                                    "value": {
                                        "stringValue": "CPI"
                                    }
                                },
                                {
                                    "key": "sap.im.source_eventid",
                                    "value": {
                                        "stringValue": "AGcgCr92nJCh5n1dWMIYSuwEhjJH"
                                    }
                                },
                                {
                                    "key": "sap.im.event_timestamp",
                                    "value": {
                                        "stringValue": "2024-10-24T10:24:30.874"
                                    }
                                },
                                {
                                    "key": "sap.im.event_end_timestamp",
                                    "value": {
                                        "stringValue": "2024-10-24T10:24:30.874"
                                    }
                                },
                                {
                                    "key": "sap.im.direction",
                                    "value": {
                                        "stringValue": "NA"
                                    }
                                },
                                {
                                    "key": "sap.im.status",
                                    "value": {
                                        "stringValue": "FAILED"
                                    }
                                },
                                {
                                    "key": "sap.im.status_group",
                                    "value": {
                                        "stringValue": "ERROR"
                                    }
                                },
                                {
                                    "key": "sap.im.status_text",
                                    "value": {
                                        "stringValue": "Inbound processing in an endpoint at failed with message: No additional products to transfer.  Reason: Missing or invalid sales area information."
                                    }
                                },
                                {
                                    "key": "sap.im.passport.transaction_id",
                                    "value": {
                                        "stringValue": "2B27C06CC1BF0310E00671ED45FCCE6B"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.connection_id",
                                    "value": {
                                        "stringValue": ""
                                    }
                                },
                                {
                                    "key": "sap.im.passport.connection_counter",
                                    "value": {
                                        "stringValue": "0"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.component_name",
                                    "value": {
                                        "stringValue": ""
                                    }
                                },
                                {
                                    "key": "sap.im.passport.component_type",
                                    "value": {
                                        "stringValue": "0"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.previous_component",
                                    "value": {
                                        "stringValue": "000000000730402004"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.service",
                                    "value": {
                                        "stringValue": "0"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.action",
                                    "value": {
                                        "stringValue": "1"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.action_type",
                                    "value": {
                                        "stringValue": "0"
                                    }
                                },
                                {
                                    "key": "sap.im.passport.root_context_id",
                                    "value": {
                                        "stringValue": "0"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.IntegrationArtifactName",
                                    "value": {
                                        "stringValue": "Replicate Physical Product from SAP S4HANA Cloud to SAP Order Management Foundation"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.Sender",
                                    "value": {
                                        "stringValue": "S4HANACloud_IDOC"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.CustomStatus",
                                    "value": {
                                        "stringValue": "FAILED"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.IntegrationArtifactPackageId",
                                    "value": {
                                        "stringValue": "CentralOrderIntegrationwithSAPS4HANACloud"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.AlternateWebLink",
                                    "value": {
                                        "stringValue": "https://co-sci-quality.integrationsuite.cfapps.eu10.hana.ondemand.com:443/shell/monitoring/Messages/%7B%22identifier%22%3A%22AGcgCr92nJCh5n1dWMIYSuwEhjJH%22%7D"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.IntegrationFlowName",
                                    "value": {
                                        "stringValue": "Replicate.Physical.Product.from.SAP.S4HANA.Cloud.to.Central.Order"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.IntegrationArtifactPackageName",
                                    "value": {
                                        "stringValue": "SAP Order Management Foundation Integration with SAP S/4HANA Cloud - CG4 <> Cloud Staging"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.IntegrationArtifactType",
                                    "value": {
                                        "stringValue": "INTEGRATION_FLOW"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.LocalComponentName",
                                    "value": {
                                        "stringValue": "CPI_co-sci-quality"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.CorrelationId",
                                    "value": {
                                        "stringValue": "AGcgCr8SCMAlNlWCCJ0bWlaWljXs"
                                    }
                                },
                                {
                                    "key": "sap.im.application_data.OriginComponentName",
                                    "value": {
                                        "stringValue": "000000000730402004"
                                    }
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Monitoring Event Mapping

In addition to the common mapping rules, the table below describes the mapping rules specific to Monitoring Event scenario.

OTLP LogRecord	IEP	Comment
body		Short description of the event
timeUnixNano	timestamp converted to timeUnixNano	Should be the timestamp of the monitoring event (When it was detected, updated etc) in UTC
observedTimeUnixNano	observed timestamp

OTLP LogRecord Attributes	IEP	Comment
sap.iep.event.event_config_id	eventConfigId	CALM internal event config id
sap.iep.event.event_name	eventname	Event name
sap.iep.event.event_state	eventstate	State of the event. Ex: CREATE, UPDATE, CLOSE
sap.iep.event.event_subtype	eventsubtype	Metric technical name Ex: "calm.im.cpi.msg"
sap.iep.event.major_update	majorupdate	Indicates if the event is a major update or not
sap.iep.event.rating	rating	Rating/severity of the event Possible values: OK, INFO, WARNING, ERROR, FATAL
sap.iep.event.subject	subject	Short description of the event
sap.iep.event.tags	tags	Additional attributes/data from use case
sap.iep.event.use_case	usecase	Use case that sent the event to IEP Possible values: CALM.EXM, CALM.IM, CALM.BPMON, CALM.BSM, CALM.HM, CALM.JM, CALM.SUM

Job & Automation Monitoring Mapping

In addition to the common mapping rules, the table below describes the mapping rules specific to the Jobs & Automation Monitoring scenario.

Remark: Job and Automation Monitoring have two types of source: OpenTelemetry sources and non OpenTelemetry sources.

LogRecord for Job Definition

provider = jam.def

OTLP LogRecord	JAM
timeUnixNano	Event timestamp
observed	Event observed timestamp
Attributes
sap.jam.job_type	Type of Job (e.g. NW_ABAP_JOB).
sap.jam.def.job_id	ID of Job
sap.jam.def.job_name	Name of job Displayed in SAP Cloud ALM JAM list and can be used for filtering
sap.jam.def.job_description	Description of bob
sap.jam.job_context	Additional header level information, that should not be part of the name, but is needed for filtering
sap.jam.schedules[]	Array of schedule details JSON string
sap.jam.def.schedules[].id	ID of schedule
sap.jam.def.schedules[].description	Verbal description
sap.jam.def.schedules[].cron
sap.jam.def.schedules[].repeatInterval	Repeat interval
sap.jam.def.schedules[].scheduledBy	User that scheduled the executions, displayed in JAM UI
sap.jam.def.schedules[].scheduledPriority	Priority of job execution. 1, 2, 3 (i.e. prio 1 or 2 or 3)
sap.jam.def.executables[]	Array of step execution details JSON string
sap.jam.def.executables[].id	ID of executable or step, 1 for first step, 2 for second step, but can also be another stable ID (needs to be sent with every execution as well)
sap.jam.def.executables[].name	Name of executable or step
sap.jam.def.executables[].executedBy	User that executes the job step
sap.jam.def.add_info[]	Array of definition additional info JSON string
sap.jam.def.add_info[].name	Name
sap.jam.def.add_info[].value	Value

Sample Code

jam.def body example

{
  "resourceLogs": [
    {
      "resource": {
        "attributes": [
          {
            "key": "service.name",
            "value": {
              "stringValue": "E8P200"
            }
          },
          {
            "key": "service.instance.id",
            "value": {
              "stringValue": "850779797"
            }
          },
          {
            "key": "service.namespace",
            "value": {
              "stringValue": "SAP_S4HANA_OP"
            }
          },
          {
            "key": "telemetry.sdk.name",
            "value": {
              "stringValue": "sap.calm"
            }
          },
          {
            "key": "telemetry.sdk.version",
            "value": {
              "stringValue": "1.0.0"
            }
          },
          {
            "key": "telemetry.sdk.language",
            "value": {
              "stringValue": "java"
            }
          }
        ]
      },
      "scopeLogs": [
        {
          "logRecords": [
            {
              "timeUnixNano": "1745414825858000000",
              "observed": "1745414825858000000",
              "attributes": [
                {
                  "key": "sap.jam.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.def.job_id",
                  "value": {
                    "stringValue": "0005DBB5D227D0DDC86C6BC3445251F9"
                  }
                },
                {
                  "key": "sap.jam.def.job_name",
                  "value": {
                    "stringValue": "SUT_ATC_NOTIFICATION/MEOLA 1"
                  }
                },
                {
                  "key": "sap.jam.job_context",
                  "value": {
                    "stringValue": "200"
                  }
                },
                {
                  "key": "sap.jam.def.schedules",
                  "value": {
                    "stringValue": "[{\"id\":\"A449BF12D4881DBA1602AD4B9433F8CA\",\"description\":\"SUT_ATC_NOTIFICATION/MEOLA 1\",\"cron\":null,\"interval\":\"1 Week\",\"scheduledBy\":\"C5262026\",\"scheduledPriority\":1}]"
                  }
                },
                {
                  "key": "sap.jam.def.executables",
                  "value": {
                    "stringValue": "[{\"id\":\"1\",\"name\":\"SUT_ATC_NOTIFICATION|MEOLA 1\",\"executedBy\":\"C5262026\"}]"
                  }
                },
                {
                  "key": "sap.jam.def.add_info",
                  "value": {
                    "stringValue": "[]"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

LogRecord for Job Execution

provider = jam.run

OTLP LogRecord	JAM
timeUnixNano	Event timestamp
observedTimeUnixNano	Event observed timestamp
Attributes
sap.jam.run.job_id	ID of job
sap.jam.run.job_name	Name of the job
sap.jam.run.job_type	Type of the job
sap.jam.run.schedule_id	ID of schedule
sap.jam.run.id	Run ID of job execution
sap.jam.run.planned_start_time	Planned start time of job execution DD/MM/YYYY hh:mm:ss.ms UTC
sap.jam.run.start_time	Start time of job execution DD/MM/YYYY hh:mm:ss.ms UTC
sap.jam.run.end_time	End time of job execution DD/MM/YYYY hh:mm:ss.ms UTC
sap.jam.run.status_rating	Technical Status (grey as long as job is running, green, if all job steps could be started successfully, else red or yellow) One of the following: 0, 1, 2, 3 (grey, green, yellow, red)
sap.jam.run.status_text	Job execution status text One of the following: Scheduled, Started, Finished, Failed
sap.jam.run.status_text_long	Job Execution Status long text
sap.jam.run.appl_status_long_text	Job Application Status long text
sap.jam.run.appl_status_text	Job Application Status
sap.jam.run.appl_status_rating	Job Application Status rating (grey as long as job is running, green, if all no errors or warnings with data processing successfully, else red or yellow). One of following 0, 1, 2, 3 (grey, green, yellow, red)
sap.exm.correlation_id	Exception Monitoring correlation-id.
sap.jam.run.executables[]	Not available with provider "jam.run". Use provider "jam.run_step" to retrieve this information.
sap.jam.run.add_info[]	Additional information related to run data
sap.jam.run.add_info[].name	for example for navigation URL: NAV_URL
sap.jam.run.add_info[].value

Sample Code

jam.run body example

{
  "resourceLogs": [
    {
      "resource": {
        "attributes": [
          {
            "key": "service.name",
            "value": {
              "stringValue": "E8P200"
            }
          },
          {
            "key": "service.instance.id",
            "value": {
              "stringValue": "850779797"
            }
          },
          {
            "key": "service.namespace",
            "value": {
              "stringValue": "SAP_S4HANA_OP"
            }
          },
          {
            "key": "telemetry.sdk.name",
            "value": {
              "stringValue": "sap.calm"
            }
          },
          {
            "key": "telemetry.sdk.version",
            "value": {
              "stringValue": "1.0.0"
            }
          },
          {
            "key": "telemetry.sdk.language",
            "value": {
              "stringValue": "java"
            }
          }
        ]
      },
      "scopeLogs": [
        {
          "logRecords": [
            {
              "timeUnixNano": "1745415199565000000",
              "observedTimeUnixNano": "1745415199565000000",
              "attributes": [
                {
                  "key": "sap.jam.run.job_id",
                  "value": {
                    "stringValue": "001033EDC65C015CB7487C1989432BCB"
                  }
                },
                {
                  "key": "sap.jam.run.job_name",
                  "value": {
                    "stringValue": "SM_CCLM:SIMIL_SO7"
                  }
                },
                {
                  "key": "sap.jam.run.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.run.schedule_id",
                  "value": {
                    "stringValue": "48618E4ACE3785F4BF94535317755ABC"
                  }
                },
                {
                  "key": "sap.jam.run.id",
                  "value": {
                    "stringValue": "02151200"
                  }
                },
                {
                  "key": "sap.jam.run.planned_start_time",
                  "value": {
                    "stringValue": "2025-04-10 01:15:06.000000000"
                  }
                },
                {
                  "key": "sap.jam.run.start_time",
                  "value": {
                    "stringValue": "2025-04-10 01:15:12.000000000"
                  }
                },
                {
                  "key": "sap.jam.run.end_time",
                  "value": {
                    "stringValue": "2025-04-10 01:16:42.000000000"
                  }
                },
                {
                  "key": "sap.jam.run.status_text",
                  "value": {
                    "stringValue": "Cancelled/Aborted"
                  }
                },
                {
                  "key": "sap.jam.run.status_text_long",
                  "value": {
                    "stringValue": "2025-04-10 01:16:42.000000000"
                  }
                },
                {
                  "key": "sap.jam.run.status_rating",
                  "value": {
                    "stringValue": "3"
                  }
                },
                {
                  "key": "sap.jam.run.appl_status_text",
                  "value": {
                    "stringValue": "No messages found"
                  }
                },
                {
                  "key": "sap.jam.run.appl_status_long_text",
                  "value": {
                    "stringValue": "No application log (SLG1) found for job"
                  }
                },
                {
                  "key": "sap.jam.run.appl_status_rating",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run.add_info",
                  "value": {
                    "stringValue": "[]"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

LogRecord for Job Step Execution

provider = jam.run_step

OTLP LogRecord	JAM
timeUnixNano	Event timestamp
observedTimeUnixNano	Event observed timestamp
Attributes
sap.jam.run_exec.job_id	ID of job
sap.jam.run_exec.job_name	Name of Job (displayed in CALM JAM list and can be used for filtered)
sap.jam.run_exec.job_type	Type of the job
sap.jam.run_exec.runId	Run ID of Job execution
sap.jam.run_exec.schedule_id	Schedule ID of job
sap.jam.run_exec.id	ID of executable or step, 1 for first step .
sap.jam.run_exec.execRunId	Run ID of Job Step (in case of chain of jobs)
sap.jam.run_exec.parentId	ID of preceding executable or step
sap.jam.run_exec.context
sap.jam.run_exec.name	If dynamic, i.e. different from executable name that has been sent with definition
sap.jam.run_exec.startTime	DD/MM/YYYY hh:mm:ss.ms UTC
sap.jam.run_exec.endTime	DD/MM/YYYY hh:mm:ss.ms UTC
sap.jam.run.exec.statusRating	Technical Status (grey as long as step is running, green, if step finished successfully, else red or yellow). One of following: 0, 1, 2, 3 (grey, green, yellow, red)
sap.jam.run_exec.statusText
sap.jam.run_exec.applStatusRating	Application Status (grey as long as step is running, green, if step finished without application errors or warnings, else red or yellow). One of following: 0, 1, 2, 3 (grey, green, yellow, red)

Sample Code

jam.run_step body example

{
  "resourceLogs": [
    {
      "resource": {
        "attributes": [
          {
            "key": "sap.calm.service.lms_id",
            "value": {
              "stringValue": "cfd0a8bd-5edd-4556-a975-ef2086cc50fa"
            }
          },
          {
            "key": "service.name",
            "value": {
              "stringValue": "FQ4.200"
            }
          },
          {
            "key": "sap.service.object_type",
            "value": {
              "stringValue": "LogicalSystem"
            }
          },
          {
            "key": "sap.service.display_name",
            "value": {
              "stringValue": "FQ4 (FQ4200)"
            }
          },
          {
            "key": "service.instance.id",
            "value": {
              "stringValue": "850028405"
            }
          },
          {
            "key": "service.namespace",
            "value": {
              "stringValue": "SAP_FRUN"
            }
          },
          {
            "key": "sap.service.name",
            "value": {
              "stringValue": "FQ4.200"
            }
          },
          {
            "key": "sap.service.modified_at",
            "value": {
              "stringValue": "2023-02-07 09:28:35.0"
            }
          },
          {
            "key": "telemetry.sdk.name",
            "value": {
              "stringValue": "sap.calm"
            }
          },
          {
            "key": "telemetry.sdk.version",
            "value": {
              "stringValue": "1.0.0"
            }
          },
          {
            "key": "telemetry.sdk.language",
            "value": {
              "stringValue": "java"
            }
          }
        ]
      },
      "scopeLogs": [
        {
          "logRecords": [
            {
              "attributes": [
                {
                  "key": "sap.jam.run_exec.job_id",
                  "value": {
                    "stringValue": "E13861C856D004CF530F37EF17E26886"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_name",
                  "value": {
                    "stringValue": "SAP_LMDB_NOTIFY_DISPATCHER"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.run_exec.runId",
                  "value": {
                    "stringValue": "00284600"
                  }
                },
                {
                  "key": "sap.jam.run_exec.execRunId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.id",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.parentId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.name",
                  "value": {
                    "stringValue": "RLMDB_NTFC_DISPATCH"
                  }
                },
                {
                  "key": "sap.jam.run_exec.context",
                  "value": {
                    "stringValue": ""
                  }
                },
                {
                  "key": "sap.jam.run_exec.startTime",
                  "value": {
                    "stringValue": "2025-09-03 22:38:57.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.endTime",
                  "value": {
                    "stringValue": "2025-09-03 22:49:07.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusText",
                  "value": {
                    "stringValue": "Finished"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusRating",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.applStatusRating",
                  "value": {
                    "stringValue": "0"
                  }
                }
              ]
            },
            {
              "attributes": [
                {
                  "key": "sap.jam.run_exec.job_id",
                  "value": {
                    "stringValue": "E13861C856D004CF530F37EF17E26886"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_name",
                  "value": {
                    "stringValue": "SAP_LMDB_NOTIFY_DISPATCHER"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.run_exec.runId",
                  "value": {
                    "stringValue": "00183300"
                  }
                },
                {
                  "key": "sap.jam.run_exec.execRunId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.id",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.parentId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.name",
                  "value": {
                    "stringValue": "RLMDB_NTFC_DISPATCH"
                  }
                },
                {
                  "key": "sap.jam.run_exec.context",
                  "value": {
                    "stringValue": ""
                  }
                },
                {
                  "key": "sap.jam.run_exec.startTime",
                  "value": {
                    "stringValue": "2025-09-03 22:28:46.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.endTime",
                  "value": {
                    "stringValue": "2025-09-03 22:38:57.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusText",
                  "value": {
                    "stringValue": "Finished"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusRating",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.applStatusRating",
                  "value": {
                    "stringValue": "0"
                  }
                }
              ]
            },
            {
              "attributes": [
                {
                  "key": "sap.jam.run_exec.job_id",
                  "value": {
                    "stringValue": "E13861C856D004CF530F37EF17E26886"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_name",
                  "value": {
                    "stringValue": "SAP_LMDB_NOTIFY_DISPATCHER"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.run_exec.runId",
                  "value": {
                    "stringValue": "00082200"
                  }
                },
                {
                  "key": "sap.jam.run_exec.execRunId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.id",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.parentId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.name",
                  "value": {
                    "stringValue": "RLMDB_NTFC_DISPATCH"
                  }
                },
                {
                  "key": "sap.jam.run_exec.context",
                  "value": {
                    "stringValue": ""
                  }
                },
                {
                  "key": "sap.jam.run_exec.startTime",
                  "value": {
                    "stringValue": "2025-09-03 22:18:33.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.endTime",
                  "value": {
                    "stringValue": "2025-09-03 22:28:46.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusText",
                  "value": {
                    "stringValue": "Finished"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusRating",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.applStatusRating",
                  "value": {
                    "stringValue": "0"
                  }
                }
              ]
            },
            {
              "attributes": [
                {
                  "key": "sap.jam.run_exec.job_id",
                  "value": {
                    "stringValue": "E13861C856D004CF530F37EF17E26886"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_name",
                  "value": {
                    "stringValue": "SAP_LMDB_NOTIFY_DISPATCHER"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.run_exec.runId",
                  "value": {
                    "stringValue": "23581100"
                  }
                },
                {
                  "key": "sap.jam.run_exec.execRunId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.id",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.parentId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.name",
                  "value": {
                    "stringValue": "RLMDB_NTFC_DISPATCH"
                  }
                },
                {
                  "key": "sap.jam.run_exec.context",
                  "value": {
                    "stringValue": ""
                  }
                },
                {
                  "key": "sap.jam.run_exec.startTime",
                  "value": {
                    "stringValue": "2025-09-03 22:08:22.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.endTime",
                  "value": {
                    "stringValue": "2025-09-03 22:18:33.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusText",
                  "value": {
                    "stringValue": "Finished"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusRating",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.applStatusRating",
                  "value": {
                    "stringValue": "0"
                  }
                }
              ]
            },
            {
              "attributes": [
                {
                  "key": "sap.jam.run_exec.job_id",
                  "value": {
                    "stringValue": "E13861C856D004CF530F37EF17E26886"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_name",
                  "value": {
                    "stringValue": "SAP_LMDB_NOTIFY_DISPATCHER"
                  }
                },
                {
                  "key": "sap.jam.run_exec.job_type",
                  "value": {
                    "stringValue": "NW_ABAP_JOB"
                  }
                },
                {
                  "key": "sap.jam.run_exec.runId",
                  "value": {
                    "stringValue": "23480000"
                  }
                },
                {
                  "key": "sap.jam.run_exec.execRunId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.id",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.parentId",
                  "value": {
                    "stringValue": "0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.name",
                  "value": {
                    "stringValue": "RLMDB_NTFC_DISPATCH"
                  }
                },
                {
                  "key": "sap.jam.run_exec.context",
                  "value": {
                    "stringValue": ""
                  }
                },
                {
                  "key": "sap.jam.run_exec.startTime",
                  "value": {
                    "stringValue": "2025-09-03 21:58:11.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.endTime",
                  "value": {
                    "stringValue": "2025-09-03 22:08:22.0"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusText",
                  "value": {
                    "stringValue": "Finished"
                  }
                },
                {
                  "key": "sap.jam.run_exec.statusRating",
                  "value": {
                    "stringValue": "1"
                  }
                },
                {
                  "key": "sap.jam.run_exec.applStatusRating",
                  "value": {
                    "stringValue": "0"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Raw Data Outbound Logs API

Introduction

Type

URL Format

Documentation

Operations

Authorizations

Examples

API Details

Query parameters

Filters

Jobs & Automation Monitoring

Status Codes

Response headers

Response Body Example

Limitations

Models mapping

Exception Monitoring Mapping

Business Service Management Mapping

Monitoring Event Mapping

Job & Automation Monitoring Mapping

LogRecord for Job Execution

LogRecord for Job Step Execution