Show TOC

Background documentationService Metering for Non-SAP Service Consumers Locate this document in the navigation structure

 

The service metering functionality allows SAP to collect statistical data about how SAP Enterprise Services are used. When you call these services using service consumers created with SAP tools, the service metering data is automatically transmitted. When you call these services using non-SAP service consumers, the service metering data should be explicitly created and added to the calls.

For more information about the service metering functionality provided by SAP, see Service Metering.

Metering Data Content

The service consuming side can provide the caller information using several attributes. Here you can find information about these attributes, including the restrictions and the semantics of the different attributes.

The SAP service metering data consists of the following attributes:

  • Calling application [SOAP: App; HTTP: CallingApp]

    During the partner certification process, a specific product version ID (a 20 digit number, for example 01200328610900001729) is provided by SAP to the partners for each application (product) in a certain version calling SAP Enterprise Services. This ID must be provided in the “calling application” attribute.

    In case longer data is provided, the attribute content is automatically truncated to 128 characters.

  • Calling application type [SOAP: Type; HTTP: CallingType]

    Partners need to provide the P value for the partner application for this attribute.

  • Calling component [SOAP: Component; HTTP: CallingComponent]

    During the partner certification process, a specific software component version ID (a 20 digit number, for example 01200328610900001734) is provided by SAP to the partners for each software component in a certain version calling SAP Enterprise Services. This ID must be provided in the “calling component” attribute.

    The attribute content is automatically truncated to 40 characters.

  • Calling company [SOAP: Company; HTTP: CallingCompany]

    The name or ID of the company where the partner application is used. This company may or may not be an SAP customer.

    This attribute is not meant to contain the application developer company name. The field content is automatically truncated to 40 characters.

  • Calling system [SOAP: Sys; HTTP: CallingSys]

    The name or ID of the system from which the SAP Enterprise Service is called.

    The attribute content is automatically truncated to 20 characters.

Note Note

Partners have to ensure that they do not provoke violations of data protection laws by the customers of their applications.

End of the note.
Metering Data Transportation

The metering data can be added to the service call in the SOAP header or in the HTTP header. SAP strongly recommends adding the service metering data on SOAP level for the following reasons:

  • We consider adding the data on SOAP level easier.

  • By having the data in the SOAP header, the data is less likely to get lost on the way from the service consumer system to the service provider system in case of mediated communication.

The two sections below provide examples of how the metering data can be included in the header part of the corresponding transportation protocol.

SOAP Header

The service metering data in a SOAP header shall have the following format (service metering tags in bold):

Example Example

<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">

<soap-env:Header>

.

.

<m:CallerInformation xmlns:m="http://www.sap.com/webas/712/soap/features/runtime/metering/">

<m:App>partner_application_xyz</m:App>

<m:Type>P</m:Type>

<m:Component>application_component_abc</m:Component>

<m:Company>4711</m:Company>

<m:Sys>Y7C_000</m:Sys>

</m:CallerInformation>

.

.

</soap-env:Header>

<soap-env:Body>

.

.

</soap-env:Body>

</soap-env:Envelope>

End of the example.

Syntax Syntax

  1. <soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
End of the code.
HTTP Header

The service metering data in an HTTP header shall have the following format (service metering headers in bold):

Example Example

POST /sap/bc/srt/... HTTP/1.1

Content-Type: text/xml; charset=utf-8

Content-Length: 2024

.

.

CallingApp: partner_application_xyz

CallingType: P

CallingComponent: application_component_abc

CallingCompany: Quicksilver Messenger Service

CallingSys: 10.18.234.213

.

.

<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"><soap ... ></soap-env:Body></soap-env:Envelope>

End of the example.