Show full documentation

 Show full documentation

Definition

An interface to manage a bundle of entitlement products from an external application.

Business Context and Use

The web service interface Manage Entitlement Product In enables you to connect external applications to your SAP Business ByDesign system and to create and edit entitlement products in your system. The web service interface Manage Entitlement Product In is relevant if your company wants to access and manage entitlement data from external applications.

The web service interface Manage Entitlement Product In offers the operations MaintainBundle and CheckMaintainBundle.

Example of a simple web service request:

<n0:EntitlementProductBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>1234567890ABCDEF0123456789ABCDEF</ID>
</BasicMessageHeader>
<EntitlementProduct actionCode="01">
<InternalID>E100020</InternalID>
<ProductCategoryID>200</ProductCategoryID>
<BaseMeasureUnitCode>EA</BaseMeasureUnitCode>
<Description actionCode="01">
<Description languageCode="EN">English description</Description>
</Description>
</EntitlementProduct>
</n0:EntitlementProductBundleMaintainRequest_sync>

Prerequisites

Existence of referenced business documents:

The following business documents are only referenced and will not be created by the service operations. They must already exist in the system at the time the web service is called:

• Product Category Hierarchies

• Organizational Management Data

• Material Valuation Data

Constraints and Integrity Conditions

General Rules for Using this Web Service

Check Maintain Bundle vs. Maintain Bundle

Maintain Bundle operations enable external applications to create and change business document data. Check Maintain Bundle operations enable external applications to simulate maintain bundle requests without changing business document data. In particular, Check Maintain Bundle operations have the following functions:

• Return system messages similar to corresponding maintain bundle operations

• Provide the same message type as the corresponding operation Maintain Bundle

• Do not assign internal numbers from a productive number range interval (number range status are not increased)

• Do not change business documents

Action Code

Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.

Action Code	Description
01	Create; the system returns an error message if the node element already exists.
02	Update; the system returns an error message if the node element does not exist.
03	Delete; the system returns an error message if the node element does not exist.
04	Save; the system creates or changes the node element data.
05	Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message.
06	No Action; the system does not change the node element.

Default action code: '04' (Save).

Note: Action code „04‟ (Save) creates business documents if the system could not identify a matching target business document. This applies in particular if no business document ID or UUID is provided by the web service consumer. The web service consumer (external application) is responsible for providing correct business document IDs or UUIDs and for avoiding accidental creation of duplicate business documents.

List Processing

The processing of node elements with cardinality > 1 (for example, a list of descriptions in different languages or a list of telephone numbers) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).

LCTI	Description
false	The list of node elements is not transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements of the list can be identified uniquely, the system processes the node elements according the action code. If transmitted node elements of the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document.
true	The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed.

Default list complete transmission indicator: “false”.

Note: The LCTI refers to the completeness of the list of node elements and does not state completeness of sub-elements.

Example

A new description with language code DE (German) is created while an existing description with language code EN (English) is updated. Moreover, an existing description with language code FR (French) remains unchanged and any other description (with language code ES (Spanish), for example) is deleted. An error is raised if there is already a German description or if the English or French description does not exist.

<Root actionCode="04" descriptionListCompleteTransmissionIndicator="true" >

<Description actionCode="01">

<Description languageCode="DE">neuer deutscher Text</Description>

</Description>

<Description actionCode="02">

<Description languageCode="EN">changed english text</Description>

</Description>

<Description actionCode="06">

<Description languageCode="FR"></Description>

</Description>

</Root>

Empty and Missing Elements

Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.

Example

In updating a postal address, the request updates the city name, street postal code, street name, and house ID. The country code remains unchanged, as the element CountryCode is not contained in the XML document (commented out).

<PostalAddress actionCode="02">

<-- <CountryCode>DE</CountryCode> -->

<CityName>Heidelberg</CityName>

<StreetPostalCode>69117</StreetPostalCode>

<StreetName>Hauptstrasse</StreetName>

<HouseID></HouseID>

</PostalAddress>

Note: The request deletes house ID or updates the house ID with its initial value.

Communication Timeout

Maintain bundle and check maintain bundle operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes for mass operations.

Message Header

Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer must provide unique values for the elements ID or UUID of the BasicMessageHeader node element.

Change State ID

Using change state identifier (element name ChangeStateID) external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.

The change state ID is an uninterpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.

The web service consumer (external application) is responsible for preventing accidental changes to business documents.

Object Node Sender Technical Identifier

Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.

The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.

If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.

Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements only for a single call. The web service consumer is not required to specify them or to use the same values for different calls. Also, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the proper ReferenceObjectNodeSenderTechnicalID elements.

Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.

Example

Request:

<Root>
  <Child>
    <ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID>
    <Content>
    Child A: Some correct content
    </Content>
  </Child>
  <Child>
    <ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID>
    <Content>
    Child B: Some erroneous content
    </Content>
  </Child>

Response:

<Log>
  <Item> 
    <ReferenceObjectNodeSenderTechnicalID>999_B
    </ReferenceObjectNodeSenderTechnicalID>
    <Note>Error message for Child B</Note>
  </Item>
</Log>

Response Message

The structure of the response message consists of two parts:

• A business document-specific part containing information about IDs and UUIDs of the created/changed business documents

• Log items containing system messages including errors, warnings and information messages raised by the system during processing of the web service request

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.

Scenarios

Possible scenarios include the following:

• Create Entitlement Products

The MaintainBundle operation is used to create entitlement products.

• Update Entitlement Products

The MaintainBundle Operation is used to update existing entitlement products.

Here is an example web service request:

<n0:EntitlementProductBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">

<BasicMessageHeader>
  <ID>1234567890ABCDEF0123456789ABCDEF</ID>
  <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
</BasicMessageHeader>

<!--Create new entitlement product-->
  <EntitlementProduct actionCode="01" descriptionListCompleteTransmissionIndicator="true" detailListCompleteTransmissionIndicator="true" quantityConversionListCompleteTransmissionIndicator="true" salesListCompleteTransmissionIndicator="true" deviantTaxClassificationListCompleteTransmissionIndicator="true" valuationListCompleteTransmissionIndicator="true" customerInformationListCompleteTransmissionIndicator="true">

  <ObjectNodeSenderTechnicalID>001</ObjectNodeSenderTechnicalID>
  <!-- ChangeStateID is only relevant for changing
  <ChangeStateID>20101201082957.5189460</ChangeStateID> -->
  <!--The UUID is read-only-->
  <!--<UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>-->
  <InternalID>E100020</InternalID>
  <ProductCategoryID>200</ProductCategoryID>
  <BaseMeasureUnitCode>EA</BaseMeasureUnitCode>
  <ValuationMeasureUnitCode>KGM</ValuationMeasureUnitCode>

  <!-- Create language dependent descriptions -->
  <Description actionCode="01">
   <ObjectNodeSenderTechnicalID>002</ObjectNodeSenderTechnicalID>
   <Description languageCode="EN">English description</Description>
  </Description>

  <!-- Create language dependent detailed descriptions -->
  <Detail actionCode="01">
   <ObjectNodeSenderTechnicalID>003</ObjectNodeSenderTechnicalID>
   <ContentText languageCode="EN">A detailed english description</ContentText>
  </Detail>

  <!-- Specify the equivalent measurement of one unit to another -->
  <QuantityConversion actionCode="01">
   <ObjectNodeSenderTechnicalID>004</ObjectNodeSenderTechnicalID>
   <Quantity unitCode="EA">1</Quantity>
   <CorrespondingQuantity unitCode="KGM">12.50</CorrespondingQuantity>
  </QuantityConversion>

  <!-- Specify information regarding sales processes -->
  <Sales actionCode="01" internalNoteListCompleteTransmissionIndicator="false" salesNoteListCompleteTransmissionIndicator="true">
   <ObjectNodeSenderTechnicalID>005</ObjectNodeSenderTechnicalID>
   <SalesOrganisationID>A1110</SalesOrganisationID>
   <DistributionChannelCode>01</DistributionChannelCode>
   <LifeCycleStatusCode>2</LifeCycleStatusCode>
   <SalesMeasureUnitCode>EA</SalesMeasureUnitCode>
   <MinimumOrderQuantityValue>0</MinimumOrderQuantityValue>
   <ItemGroupCode>NORM</ItemGroupCode>
   <CashDiscountDeductibleIndicator>false  </CashDiscountDeductibleIndicator>
  <ReferencePriceEntitlementInternalID>E-100  </ReferencePriceEntitlementInternalID>
  <InternalNote>
   <ObjectNodeSenderTechnicalID>006</ObjectNodeSenderTechnicalID>
   <ContentText>Internal sales note</ContentText>
  </InternalNote>
<SalesNote actionCode="01">
<ObjectNodeSenderTechnicalID>007</ObjectNodeSenderTechnicalID>
<ContentText languageCode="EN">External sales note</ContentText>
</SalesNote>
</Sales>

<!-- Create tax information which differs from the default taxes -->
<DeviantTaxClassification actionCode="01">
<ObjectNodeSenderTechnicalID>008</ObjectNodeSenderTechnicalID>
<CountryCode>DE</CountryCode>
<RegionCode>08</RegionCode>
<TaxTypeCode listID="">1</TaxTypeCode>
<TaxRateTypeCode listID="">2</TaxRateTypeCode>
<TaxExemptionReasonCode listID="">1</TaxExemptionReasonCode>
<ServicePointTaxableIndicator>false</ServicePointTaxableIndicator>
</DeviantTaxClassification>

<!-- Material valuation can be defined for a specific company/business residence combination -->
<Valuation actionCode="01">
<ObjectNodeSenderTechnicalID>009</ObjectNodeSenderTechnicalID>
<CompanyID>1000</CompanyID>
<BusinessResidenceID>S1130</BusinessResidenceID>
<LifeCycleStatusCode>1</LifeCycleStatusCode>
</Valuation>

<!-- Maintain customer information for the service product-->
<CustomerInformation actionCode="01">
<ObjectNodeSenderTechnicalID>010</ObjectNodeSenderTechnicalID>
<CustomerInternalID>CP100110</CustomerInternalID>
<EntitlementCustomerID>CP100110-E1</EntitlementCustomerID>
</CustomerInformation>

<!-- Maintain material attachments like documents, images, links... -->
<AttachmentFolder DocumentListCompleteTransmissionIndicator="true" ActionCode="01">
<!--Link attachment-->
<Document ActionCode="01">
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode>10001</TypeCode>
<Name>SAP AG</Name>
<AlternativeName>SAP AG Homepage</AlternativeName>
<Description languageCode="EN">Hyperlink to SAP AG</Description>
<ExternalLinkWebURI>http://www.sap.com</ExternalLinkWebURI>
</Document>
<!--File attachment-->
<Document ActionCode="01">
<LinkInternalIndicator>true</LinkInternalIndicator>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>2</CategoryCode>
<TypeCode>10011</TypeCode>
<MIMECode>image/jpg</MIMECode>
<Name>Image</Name>
<AlternativeName>Product Image</AlternativeName>
<Description languageCode="EN">Image of the product</Description>
<FileContent ActionCode="01">
<BinaryObject mimeCode="image/png" characterSetCode="" format="" fileName="" uri="">AQIDBAUGBwgJAA==</BinaryObject>
</FileContent>
</Document>
</AttachmentFolder>

<n1:IndiaServiceTypeCode xmlns:n1="http://sap.com/xi/AP/Globalization">1</n1:IndiaServiceTypeCode>

</EntitlementProduct>
</n0:EntitlementProductBundleMaintainRequest_sync>

 Show full documentation

 Show full documentation

Definition

To check whether entitlement products can be created, updated, or deleted without errors.

Business Context and Use

The web service request and response message types of the CheckMaintainBundle operation are the same as those of the MaintainBundle operation.

The explanations given for the MaintainBundle can therefore also be applied to the CheckMaintainBundle operation.

 Show full documentation

 Show full documentation

Definition

To create, update, or delete entitlement products.

Business Context and Use

The request message of the MaintainBundle operation contains a BasicMessageHeader node element as well as an EntitlementProduct node element that contains the entitlement product data to be created or updated. The detailed structure of the entitlement product node will be explained in the following sub-chapters. The entitlement product node can occur multiple times in the request message meaning that multiple entitlement products can be created and updated by a single web service request.

The response message of the operation MaintainBundle contains log items, processing information, and an entitlement-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as entitlement InternalID and entitlement UUID.

Structure

Entitlement Product

The EntitlementProduct node element contains all basic information about the entitlement product such as internal ID, product category, base unit of measure and valuation measure unit code. These fields can be found in the entitlement UI as General data. The internalID element corresponds to the Entitlement ID on the user interface - the UUID element is not visible on the UI, but can be retrieved via query and read web services.

Note: The entitlement UUID is read-only and cannot be set by external applications when creating entitlements.

Description

A language-dependent description can be maintained with the Description node element.

Example:

<Description actionCode="01">
  <Description languageCode="EN">A sample description</Description>
</Description>

Details

A language-dependent detailed description can be maintained with the Details node.

Example:

<Detail actionCode="01">
  <ContentText languageCode="EN">
    A more detailed description of the entitlement product
  </ContentText>
</Detail>

Quantity Conversion

The entitlement product supports quantity conversion between different units of measure. For example, if the base unit of measure is handled in "Each" but sold as "Boxes" then a conversion rule between these units is needed, as the following example shows.

Note: EA corresponds to Each and XBX to Box.

Example:

<QuantityConversion actionCode="01">
  <Quantity unitCode="EA">10</Quantity>
  <CorrespondingQuantity unitCode="XBX">100</CorrespondingQuantity>
</QuantityConversion>

Valuation

The entitlement product valuation can be defined for a specific company/business residence combination. The financial data cannot be activated unless the material valuation data has been maintained in the system.

Example:

<Valuation actionCode="01">
  <CompanyID>1000</CompanyID>
  <BusinessResidenceID>S1130</BusinessResidenceID>
  <LifeCycleStatusCode>1</LifeCycleStatusCode>
</Valuation>

Sales

The Sales node contains all information regarding sales processes. Each sales process is defined by the SalesOrganisationID and the DistributionChannelCode which can be either Direct sales (01) or Indirect sales (02).

Furthermore, the LifeCycleStatusCode can be either In Preparation (1) or Active (2). The status must be set to Active to use the entitlement product in sales processes.

Sales notes can also be defined for each sales process definition.

The ItemGroupCode can contain the following values:

Item Group Code	Description
ETCS	Entitlement - customer contract sale
ETFC	Entitlement - fixed price
ETFX	Entitlement - fixed price w/o actuals
ETTM	Entitlement - time and material

Example:

<Sales actionCode="01"> 
  <SalesOrganisationID>A1110</SalesOrganisationID>
  <DistributionChannelCode>01</DistributionChannelCode>
  <LifeCycleStatusCode>2</LifeCycleStatusCode>
  <SalesMeasureUnitCode>EA</SalesMeasureUnitCode>
  <MinimumOrderQuantityValue>0</MinimumOrderQuantityValue>
  <ItemGroupCode>NORM</ItemGroupCode>
  <CashDiscountDeductibleIndicator>false</CashDiscountDeductibleIndicator> 
  <ReferencePriceEntitlementInternalID> 
    E-100 
  </ReferencePriceEntitlementInternalID> 
  <InternalNote> 
    <ContentText>Internal sales note</ContentText> 
  </InternalNote> 
  <SalesNote actionCode="01"> 
    <ContentText languageCode="EN">External sales note</ContentText>   
  </SalesNote> 
</Sales>

Deviant Tax Classification

The DeviantTaxClassification node contains tax information that differs from the default taxes. They are used for sales processes and can be found on the UI as Sales.

The listID attribute of the TaxTypeCode and TaxRateTypeCode elements is mandatory. However, the attribute value is not processed and the attribute might be removed in a future release of this web service.

Note: Tax Codes are dependent on the country and region.

Example

<DeviantTaxClassification actionCode="01">
  <CountryCode>DE</CountryCode>
  <RegionCode>03</RegionCode>
  <TaxTypeCode listID="">1</TaxTypeCode>
  <TaxRateTypeCode listID="">2</TaxRateTypeCode>
  <TaxExemptionReasonCode listID="">1</TaxExemptionReasonCode>
</DeviantTaxClassification>

Customer Information

The CustomerInformation node element can be used to create and change customer entitlement numbers.

The CustomerInternalID identifies an account. The EntitlementCustomerID contains the customer entitlement number.

Data for this node can be found as part of the Sales data in the Entitlement view.

Example:

<CustomerInformation actionCode="01">
  <CustomerInternalID>CP100110</CustomerInternalID>
  <EntitlementCustomerID>CP100110-E1</EntitlementCustomerID>
</CustomerInformation>

Attachment Folder

The AttachmentFolder node element can be used to add and remove entitlement attachments.

Data for this node can be found on the entitlement UI as Attachments. On the user interface, Files and Links can be created.

In the web service request, links and files are differentiated through the CategoryCode:

Category code	Description
1	Folder
2	Document
3	Link

The different types of attachments are differentiated through the TypeCode:

Type code	Description
10001	Standard Attachment
10011	Product Image
10015	Technical Drawing
10018	Product Specification
10043	Details for Supplier

Example

<AttachmentFolder ActionCode="01">
  <Document ActionCode="01">
    <VisibleIndicator>true</VisibleIndicator>
    <CategoryCode>3</CategoryCode>
    <TypeCode>10001</TypeCode>
    <Name>SAP AG Link</Name>
    <ExternalLinkWebURI>http://www.sap.com</ExternalLinkWebURI>
    <AlternativeName>SAP AG URL</AlternativeName>
    <Description languageCode="EN">A hyperlink to SAP AG</Description>
  </Document>
</AttachmentFolder>