8/30/2024

Enterprise Services in SAP Customer

Relationship Management
Generated on: 2024-08-30 15:59:03 GMT+0000

SAP Customer Relationship Management | 7.0 EHP4 SP22

PUBLIC

Original content:
https://help.sap.com/docs/SAP_CUSTOMER_RELATIONSHIP_MANAGEMENT/62fb3bfc9f124f598f6e911e17321a3c?locale=en-
US&state=PRODUCTION&version=7.0.4.22

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the https://help.sap.com/docs/disclaimer.

This is custom documentation. For more information, please visit the SAP Help Portal 1
 8/30/2024

Trade Promotion Management

De nition
The management of trade promotions, that is marketing activities in cooperation with retailers, to achieve a corporate
marketing and sales strategy. Trade promotions enable increases in brand capital, name recognition, market share and sales
volume, as well as an improvement in the placement of new products on the market.

Technical Data

Entity Type Process Component

Software Component Version ESM CRM 7.02

Technical Name TradePromotionManagement

Namespace http://sap.com/xi/ESM/CRM

Business Context and Use

Trade Promotion Management services allow you to do the following:

Create a new trade promotion in the SAP CRM back-end system from an external application

Update trade promotions in the SAP CRM back-end system from an external application

Send noti cation of new and updated SAP CRM trade promotions to external applications

Read SAP CRM trade promotions from an external planning application by passing an SAP CRM trade promotion
identi er

The Trade Promotion Management process component allows sales personnel to coordinate marketing activities in cooperation
with retailers, to achieve a corporate marketing and sales strategy. Trade promotions are types of marketing activities that
enable increases in brand capital, name recognition, market share and sales volume, as well as an improvement in the
placement of new products on the market.

Use Case

A Key Account Manager (KAM) for a processed food manufacturer uses a planning application to create trade promotion plan
building blocks to next year's volume plan for the company’s product category with a leading retail customer. The KAM uses
the planning application to create high level trade promotion shells, understand impact of planned promotions on total volume,
revenue and margin targets, and simulate scenarios to create a trade promotion plan for next year.

To begin planning, the KAM needs to transfer last year’s trade promotions to the planning application ( Read Trade Promotion
service operation). The KAM selects top promotions from last year and copies the promotions to next year’s plan. The KAM
then changes the dates, estimated uplift, and estimated spends on the planning application and visualizes impact on revenue,
volume, and margin targets.

Once the impact is simulated and approved by the customer, the KAM uses the trade promotion shells entered in the planning
application to transfer high level trade promotions to the SAP CRM back-end system

( Create Trade Promotion service operation).

This is custom documentation. For more information, please visit the SAP Help Portal 2
 8/30/2024
Once the trade promotion is transferred, the KAM is noti ed that the trade promotion was successfully created in the SAP CRM
back-end system

( Con rm Trade Promotion service operation).

The KAM then logs into the SAP CRM back-end system as TPM Professional and updates the transferred trade promotions by
entering additional date types, associated funds, and changing the trade promotion status to released.

In addition, the KAM can transfer more than one high level trade promotion from the planning application to the SAP CRM back-
end system

( Create Trade Promotion as Bulk service operation).

During execution, the KAM needs to change individuatl trade promotions due to last minute changes with the key account. The
KAM updates the trade promotion in the planning application and updates the SAP CRM back-end system.( Change Trade
Promotion service operation)

(Alternatively, the KAM can change the trade promotion in the SAP CRM back-end system and automatically send updates to
the planning application.

( Notify of Trade Promotion service operation))

Again the KAM is noti ed that the trade promotion was changed successfully and receives a copy of the updates.( Con rm
Trade Promotion service operation)

Terminology

The following lists a services term followed by the corresponding back-end term in parentheses.

PeriodTerms (Additional Dates)

TradePromotionPeriodRoleCode (Date ID)

BusinessPartnerGroupID Account (Hierarchy ID)

Party (Parties Involved or Partners)

UpliftIndicator (Signi cant Uplift)

MarketingProjectPlanningProductBasisCode (Product Planning Basis)

SalesMeasureUnit (Unit of Measure)

AdSpecCharacteristicsCode (Feature Add)

TradeSpendTypeCode (Spend Type)

TradeSpendCategoryCode (Spend Category)

TradeSpendMethodCode (Spend Method)

TradePromotionDiscountTypeCode (Discount Method)

TradeSpendPriceAmount (Spend Value in amount)

TradeSpendPricePercentage (Spend Value in percentage)

RoleCode (Partner Function)

Further business context is provided in the documentation for the Trade Promotion business object.

This is custom documentation. For more information, please visit the SAP Help Portal 3
 8/30/2024
Related Process Components

The Trade Promotion Agreement Management process component allows applications to be provided that enable the
management of trade promotion agreements.

PeriodTerms (Additional Dates)

TradePromotionPeriodRoleCode (Date ID)

BusinessPartnerGroupID Account (Hierarchy ID)

Party (Parties Involved or Partners)

UpliftIndicator (Signi cant Uplift)

MarketingProjectPlanningProductBasisCode (Product Planning Basis)

SalesMeasureUnit (Unit of Measure)

AdSpecCharacteristicsCode (Feature Add)

TradeSpendTypeCode (Spend Type)

TradeSpendCategoryCode (Spend Category)

TradeSpendMethodCode (Spend Method)

TradePromotionDiscountTypeCode (Discount Method)

TradeSpendPriceAmount (Spend Value in amount)

TradeSpendPricePercentage (Spend Value in percentage)

RoleCode (Partner Function)

Related Process Components

The Trade Promotion Agreement Management process component allows applications to be provided that enable the
management of trade promotion agreements.

Constraints
Product Segment Trade promotions containing product segments cannot be read, created, changed, or trigger a
noti cation. (No data is returned at all for a trade promotion containing product segments).

Display Pallet Promotion Trade promotions of the type Display Pallet cannot be read, created, changed, or trigger a
noti cation. (No data is returned at all for a trade promotion containing the type Display Pallet).

Target Groups Trade promotions and trade promotion agreements planned at the Target Group level cannot be read,
created, changed, or trigger a noti cation. (No data is returned at all for trade promotions or trade promotion
agreements that are planned at the Target Group level).

Indirect Promotion The Indirect Indicator cannot be set when a trade promotion is created or changed. (Trade promotion
data can be created or changed, and these events trigger a noti cation. All the data is returned except for Indirect
Promotion data).

Funds Management Integration Funds Management Integration cannot be set when a trade promotion is created or
changed. (Trade promotion data can be created or changed, and these events trigger a noti cation. All the data is
returned except for Funds Management Integration data).

Product Effective Dates Product Effective Dates cannot be set when a trade promotion is created or changed. (Trade
promotion data can be created or changed, and these events trigger a noti cation. All the data is returned except for

This is custom documentation. For more information, please visit the SAP Help Portal 4
 8/30/2024
Product Effective Dates data).

Notes on SAP Implementation

A2A related information The back-end systems involved are an SAP CRM back-end system with a third party planning tool.

Con guration

To use the operations in the Trade Promotion Management process component, the SAP CRM back-end system must be
con gured and running so that trade promotion records can be created. For information about the con guration of Trade
Promotion Management, see SAP Solution Manager under SAP CRM -> Con guration Structures -> Basic Settings for
Marketing -> TPM: Speci c Settings.

More Information
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Trade Promotion

De nition
A marketing activity with a speci ed period of time to drive consumer behavior, particularly to build demand. A trade promotion
is paid for by manufacturers of consumer goods to retailers for merchandising support.

Technical Data

Entity Type Business Object

Software Component Version ESM CRM 7.02

Technical Name TradePromotion

Object Category Business Process Object

Business Context and Use

The Trade Promotion business object is used to manage trade promotions for a key account. A trade promotion is targeted
with speci c objectives such as to increase sales volume or launch a new product. A trade promotion is usually created and
managed by a Key Account Manager (KAM) and can be linked to a trade promotion agreement.

Further business context is provided in the documentation for the Trade Promotion Management process component.

Related Business Objects

The Trade Promotion Agreement business object in the Trade Promotion Agreement Management process component is
used to plan trade promotions at a key account.

More Information

This is custom documentation. For more information, please visit the SAP Help Portal 5
 8/30/2024
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Query Trade Promotion In

De nition
An interface to retrieve trade promotion data.

Technical Data

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Query Trade Promotion In inbound service interface contains an operation that retrieves trade promotion data.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Interfaces

The Trade Promotion In inbound service interface groups service operations that manage trade promotions.

The Trade Promotion Out outbound service interface groups service operations that manage trade promotion
con rmations.

More Information
For more information about Trade Promotion Management, see SAP Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Read Trade Promotion

De nition
To read speci ed trade promotions.

Technical Data
This is custom documentation. For more information, please visit the SAP Help Portal 6
 8/30/2024

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMByIDQueryResponse_In

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Web Service De nition (Back End) TradePromotionCRMByIDQueryResp

Category SAP A2A

Direction inbound

Mode synchronous

Idempotency no

P2P Communication Enabled true

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotions.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

The Create Trade Promotion inbound service operation creates a trade promotion.

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

The Change Trade Promotion inbound service operation changes a trade promotion.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many
trade promotions were created successfully or not.

The Notify of Trade Promotion outbound service operation noti es subscribed parties of trade promotion events
triggered by a change in system status.

Features
The Read Trade Promotion synchronous service operation reads the data from one or many speci ed trade promotions.

To read a trade promotion the following information is required.

An identi er of the trade promotion (TradePromotionID data element).

This is custom documentation. For more information, please visit the SAP Help Portal 7
 8/30/2024
Note that multiple trade promotions can be speci ed in a single request.

Error Handling
For every error from validation, mapping and API Adaptor phases, an appropriate error message that often helps to understand
and correct the error is sent to the GDT Log . This is returned as part of the response message.

Typical errors include the following.

No TradePromotionID given in the query message

No trade promotion corresponds to the ID of the query message

Message Types
TradePromotionCRMByIDQuery_sync

TradePromotionCRMByIDResponse_sync

Notes on SAP Implementation

Con guration

The mass read of trade promotions can be optimized by using parallel processing. The parallel processing increases the
efficiency of mass processing jobs in dividing the list of trade promotions into different buckets. Each bucket is then associated
onto a speci c thread to be processed individually and asynchronously on different servers. The efficiency of the parallel
processing depends on the available capacity of the dedicated hardware.

The parallel processing customizing has to be set to increase the efficiency of mass processing jobs. This customizing contains
the bucket size and the available server group. The customizing is project-speci c and depends on the available system
resources. If no customizing is set, trade promotion agreements are read serially on the local server.

Note: It is strongly recommended that you perform a stress test to determine the settings that would be best suited to your
installation.

For more information see Customizing, Customer Relationship Management underTrade Promotion Management -> Trade
Promotions -> SOA Services -> Parallel Processing -> De ne Settings for Bulk Read Service

By default, the Read Trade Promotion synchronous service operation returns the non-zero values of all key gures of the
associated Master Planning Pro le. This can inadvertently affect performance if the number of key gures pertaining to the
master layout is high. To reduce the impact, carefully select which key gures are included. To do this, create a new layout in BI
with the speci c set of key gures that are required, and then add it to the Planning Pro le Group in Customizing:

SAP Customizing Implementation Guide -> Customer Relationship Management -> Trade Promotion Management -> Key
Figure Planning -> De ne Planning Pro le Groups

The Plan Type of the new Pro le that is added to the Planning Pro le group is selectable. Use the drop down menu to select
“External application interface”.

Enhancements

The Business Add-In (BAdI) de nition CRM_SE_CRMTPM_BYIDQR_IN can be used to change the standard inbound and
outbound mapping or pre- and post-processing for the synchronous Read Trade Promotion service operation. This BAdI offers
the BAdI interface IF_CRM_SE_CRMTPM_BYIDQR_IN with the methods INBOUND_PROCESSING and
OUTBOUND_PROCESSING.
This is custom documentation. For more information, please visit the SAP Help Portal 8
 8/30/2024
INBOUND_PROCESSING is called during inbound data mapping and can be used to overwrite the existing mapping or to
map additional data if new elements were added to the message. The internal communication structure
CRMT_MKTPL_EAI_EXTID is used as structure of the changing parameter of the INBOUND_PROCESSING method and
can be enhanced by new elds in a customer SAP CRM back-end system.

OUTBOUND_PROCESSING is called during outbound data mapping and can be used to overwrite the existing mapping or
to map additional data if new elements were added to the message. The internal communication structure
CRMS_MKTPL_SE_TPM_BYIDQR_OUT is used as structure of the importing parameter of the OUTBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Trade Promotion In

De nition
An interface to manage trade promotions.

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction inbound

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Trade Promotion In inbound service interface groups service operations that manage trade promotions.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Interfaces

The Trade Promotion Out outbound service interface groups service operations that manage trade promotion
con rmations.

More Information
The Query Trade Promotion In inbound service interface contains an operation that retrieves trade promotion data.

This is custom documentation. For more information, please visit the SAP Help Portal 9
 8/30/2024
For more information about Trade Promotion Management, see SAP Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Change Trade Promotion

De nition
To change a trade promotion.

Technical Data

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMChangeRequest_In

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Web Service De nition (Back End) TradePromotionCRMChangeRequest

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Change Trade Promotion inbound service operation changes a trade promotion.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

The Create Trade Promotion inbound service operation creates a trade promotion.

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

This is custom documentation. For more information, please visit the SAP Help Portal 10
 8/30/2024
The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many
trade promotions were created successfully or not.

The Notify of Trade Promotion outbound service operation noti es subscribed parties of trade promotion events
triggered by a change in system status.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotion.

Features
The Change Trade Promotion inbound service changes a speci ed trade promotion.

To change a trade promotion the following information is mandatory.

An identi er for the trade promotion (TradePromotionID data element)

The following data is optional but commonly speci ed depending on the use case scenario.

An identi er for a trade promotion agreement (TradePromotionAgreementID data element).

Date ranges (StartDate and EndDate data element).

Descriptive text on of the trade promotion (Description data element).

Product data such as the ProductID and ProductTypeCode data elements, key gure data and causal factor data.

Products category data such as the ProductCategoryID data element, key gure data and causal factor data.

Product group data such as the SalesSpeci cationProductGroupCode data element, key gure data and causal factor
data.

Trade spend data such as TypeCode, CategoryCode and MethodCode data elements.

Partner information (PartyID and PartyRoleCode data elements).

Asynchronous Service Operations

A change to a trade promotion using the Change Trade Promotion inbound service operation triggers the asynchronous
Con rm Trade Promotion outbound service operation.

When con gured as delivered, the Notify of Trade Promotion outbound service is triggered by a change to a trade
promotion that gives it a system status of one of the noti ed values such as Approved.

The Notify of Trade Promotion service operation is triggered whether the change is made using the Change Trade
Promotion service operation or made using the SAP CRM back-end system.

Error Handling
The Change Trade Promotion service operation supports Forward Error Handling (FEH). The following error categories are
used.

DCE: Determination & ConversionErrors in this category normally indicate that the information sent is not in the correct
format or not within acceptable ranges, for example as follows.- The request passes alphanumeric characters for a data
element that takes only numeric values- The request passes a value of 8 for a data element that has a value range of 1-7

PRE: Processing ErrorErrors in this category indicate errors in business logic processing for example as follows.- The
request is to change a trade promotion that does not exist.

This is custom documentation. For more information, please visit the SAP Help Portal 11
 8/30/2024

Message Types
TradePromotionCRMChangeRequest

Prerequisites
To use the Change Trade Promotion service operation, a trade promotion with the provided identi er must already exist
in the SAP CRM back-end system.

The Change Trade Promotion service operation can only change a speci ed trade promotion if can be set to edit mode. If
it is for example locked by another process then no change is possible.

The user must have the proper authorization to make a change.

The rules that apply to status management of the UI also apply for the Change Trade Promotion service operation.

Constraints
Constraints for Header data:

It is possible to change a description only when the language is also provided

In Planning Account, only provide one entry <CustomerInternalID> or <BusinessPartnerGroupID> not both

It is not possible to change the Systems status and the User status at the same time

Only one system status or one user status can be provided per change request

Constraints for Dates:

Key eld(s) must be provided: <TradePromotionPeriodRoleCode>

Constraints for Products:

Key eld(s) must be provided: <ID>

For duplicate Product IDs, beside the Product ID, the payload needs the Product Type, the Logical System and/or the
Object Family. Any of these elds that would contribute to make the Product ID unique becomes mandatory

Constraints for Product Categories:

Key eld(s) must be provided: <ID>

Constraints for Product Groups:

Key eld(s) must be provided: <SalesSpeci cationProductGroupCode>

Constraints for Key Figures:

In the planning information of a created or changed product, product category and product group, there cannot be
different key gure values within a calendar period (for example, if the calendar unit is a week, you cannot de ne that a
discount would be 1 USD for the rst 3 days and 2 USD for the last 4 days of a week).

A key gure value cannot be changed in a trade promotion if more than one trade spend with different dates are
associated to this key gure.

Constraints for Causals:

This is custom documentation. For more information, please visit the SAP Help Portal 12
 8/30/2024
Key eld(s) must be provided: Product <ID> or Product category <ID> or Product group
<SalesSpeci cationProductGroupCode>

Since a causal shares its action code with the product dimension it is associated to, it is not possible to delete only a
causal without deleting also its product dimension. Instead, to delete a causal the external application has to do the
following:o use action code 02 for “Change” or action code 04 for “Save”o specify the causal key elds (product
dimension ID)o clear all the causal elds

Constraints for Partners:

Key eld(s) must be provided: <ID> and <RoleCode>

Constraints for Trade Spends:

Key eld <UUID> must be provided to change an existing trade spend. <UUID> remains empty for new trade spends.

Constraints for Causal Trade Spends:

Complete Transmission Indicators must always be set to “true”o If the change request is for Product Causal Trade
Spends, productCausalFactorListCompleteTransmissionIndicator="true"o If the change request is for Product Category
Causal Trade Spends,productCategoryCausalFactorListCompleteTransmissionIndicator="true"o If the change request is
for Product Group Causal Trade Spends,productGroupCausalFactorListCompleteTransmissionIndicator="true"

Key eld(s) must be provided:o If the change request is for Product Causal Trade Spends,<ProductID> and
<CausalFactorTypeCode>o If the change request is for Product Category Causal Trade Spends,<ProductCategoryID>
and <CausalFactorTypeCode>o If the change request is for Product Group Causal Trade Spends,
<SalesSpeci cationProductGroupCode> and <CausalFactorTypeCode>

Only Action code 01 is allowed

Additional Information regarding Planning data (Key Figures and Product dimensions):

Note: when the term "product" is mentioned in the texts below, it means "product, product category and product group".

When a product is added to an existing trade promotion, the trade spends are automatically applied to this product (a
xed rebate would be re-distributed to all products of the trade promotion). The key gures that do not have associated
trade spends (the uplift for example) would be set to zero if no key gure data values are de ned in the planning
information of the product. It is recommended to specify the planning information of all key gures when assigning a new
product to a trade promotion.

When a trade spend is added, it is recommended that all products of the trade promotion also have their planning
information updated. Key gure values must be speci ed for the trade spend's associated key gure.

When a product is deleted from a trade promotion, the xed rebates and total uplift are re-distributed to the remaining
products.

Notes on SAP Implementation

Enhancements

The Business Add-In (BAdI) de nition CRM_SE_CRMTPM_CHGRQ_IN can be used to change the standard inbound mapping or
pre-processing of the asynchronous Change Trade Promotion service operation. This BAdI offers the BAdI interface
IF_CRM_SE_CRMTPM_CHGRQ_IN with the methods INBOUND_PROCESSING and OUTBOUND_PROCESSING.

INBOUND_PROCESSING is called during inbound data mapping and can be used to overwrite the existing mapping or to
map additional data if new elements were added to the message. The internal communication structure

This is custom documentation. For more information, please visit the SAP Help Portal 13
 8/30/2024
CRMS_MKTPL_SE_TPM_CHGRQ_IN is used as structure of the changing parameter of the INBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

OUTBOUND_PROCESSING is called during the outbound data mapping and can be used to overwrite the existing
mapping or to map additional data if new elements were added to the message. The internal communication structure
CRMS_MKTPL_SE_TPM_CO_OUT is used as structure of the importing parameter of the OUTBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Create Trade Promotion

De nition
To create a trade promotion.

Technical Data

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMCreateRequest_In

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Web Service De nition (Back End) TradePromotionCRMCreateRequest

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Create Trade Promotion inbound service operation creates a trade promotion.

This is custom documentation. For more information, please visit the SAP Help Portal 14
 8/30/2024
Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

The Change Trade Promotion inbound service operation changes a trade promotion.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many
trade promotions were created successfully or not.

The Notify of Trade Promotion outbound service operation noti es subscribed parties of trade promotion events
triggered by a change in system status.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotion.

Features
The Create Trade Promotion service operation creates a trade promotion.

To create and to save a trade promotion, no speci c information is required. If no trade promotion identi er (TradePromotionID
data element) is supplied, a trade promotion identi er is generated by the CRM back-end system and returned together with
default data (such as planning product basis, person responsible).

The following data is optional but commonly speci ed depending on the use case scenario.

An identi er for a trade promotion agreement (TradePromotionAgreementID data element).

Date ranges (StartDate and EndDate data element).

Descriptive text on of the trade promotion (Description data element).

Product data such as the ProductID and ProductTypeCode data elements, key gure data and causal factor data.

Products category data such as the ProductCategoryID data element, key gure data and causal factor data.

Product group data such as the SalesSpeci cationProductGroupCode data element, key gure data and causal factor
data.

Trade spend data such as TypeCode, CategoryCode and MethodCode data elements.

Partner information (PartyID and PartyRoleCode data elements).

The following points describe the minimum required elds to add certain assignments during the creation of a trade promotion.
Note that there are no minimum required elds to create a trade promotion itself, the following are meant for speci c
objects/items that are part of the trade promotion.

To successfully add descriptions during the creation of a trade promotion the following information is mandatory:

o Description Language Code/ Tag attribute: languageCode = “??”o Description / Tag: <Description>

Tag: <PeriodTerm>

To successfully add dates (period term) during the creation of a trade promotion the following information is
mandatory:o Period Role Code / Tag: <TradePromotionPeriodRoleCode>o Start Date / Tag: <StartDate>o End Date /
Tag: <EndDate>

This is custom documentation. For more information, please visit the SAP Help Portal 15
 8/30/2024
Tag: <Product>Remarks:o Located under the tag <PlanningInformation>o If the CRM system nds a duplicate product then the
following elds can be used to determine its uniqueness

Product Type / Tag: <TypeCode>Logical System / Tag: <OriginBusinessSystemID>Object Family / Tag: <FamilyCode>

o Note that the trade promotion product planning basis should support this product dimension. Tag:
<MarketingProjectPlanningProductBasisCode>

Tag: <ProductCategory>Remarks:o Located under the tag <PlanningInformation>o Note that the trade promotion product
planning basis should support this product dimension. Tag: <MarketingProjectPlanningProductBasisCode>

Tag: <ProductGroup>Remarks:o Located under the tag <PlanningInformation>o Note that the trade promotion product
planning basis should support this product dimension. Tag: <MarketingProjectPlanningProductBasisCode>

Remarks: Located under the tag <KeyFigure> under the tags for<Product><ProductCategory><Product Group>

Tag: <TradeSpend>

Tag: <ProductCausalFactor>Remarks: Located under the tag <TradeSpend>

Tag: <ProductCategoryCausalFactor>Remarks: Located under the tag <TradeSpend>

Tag: <ProductGroupCausalFactor>Remarks: Located under the tag <TradeSpend>

Tag: <Party>

To successfully add a product during the creation of a trade promotion the following information is mandatory:o Product
ID / Tag: <ID>

To successfully add a product category during the creation of a trade promotion the following information is mandatory:o
Product Category ID / Tag: <ID>

To successfully add a product group during the creation of a trade promotion the following information is mandatory:o
Product Group ID / Tag: <SalesSpeci cationProductGroupCode>

To successfully add a key gure value during the creation of a trade promotion the following information is mandatory:o
Key Figure Name / Tag: <ID>o Key Figure Value / Tag: <Value>o Year / Tag: <Year>o Calendar Week / Tag:
<CalendarPeriodOrdinalNumberValue>o Note that the Planning Pro le Group and the BI Planning Layout period should
also be provided (<PlanningPro leGroupCode and <CalendarUnitCode>).

To successfully add a trade spend during the creation of a trade promotion the following information is mandatory:o Cost
Type / Tag: <TypeCode>o Cost Category / Tag: <CategoryCode>o Spend Method / Tag: <MethodCode>

To successfully add a product causal factor (causal trade spend) during the creation of a trade promotion the following
information is mandatory:o Product ID / Tag: <ProductId>

To successfully add a product category causal factor (causal trade spend) during the creation of a trade promotion the
following information is mandatory:o Product Category ID / Tag: <ProductCategoryID>

To successfully add a product group causal factor (causal trade spend) during the creation of a trade promotion the
following information is mandatory:o Product Group ID / Tag: <SalesSpeci cationProductGroupCode>

To successfully add a partner (Party / Parties Involved) during the creation of a trade promotion, the following
information is mandatory:o Partner ID / Tag: <ID>o Partner Function / Tag: <RoleCode>

Status

A trade promotion created by this service has a system status ʻCreated’.

This is custom documentation. For more information, please visit the SAP Help Portal 16
 8/30/2024
User status is optional. If used, its initial status is assigned as in the User Status Pro le.

Asynchronous service operations The execution of this asynchronous service operation triggers a con rmation message from
the Con rm Trade Promotion service operation. This contains information on whether the creation of trade promotion was
successful or not.

Error Handling
The Create Trade Promotion service operation supports Forward Error Handling (FEH). The following error categories are used.

DCE: Determination & Conversion

Errors in this category normally indicate that the information sent is not in the correct format or not within acceptable ranges,
for example as follows.

The request passes alphanumeric characters for a data element that takes only numeric values

The request passes a value of 8 for a data element that has a value range of 1-7

PRE: Processing ErrorErrors in this category indicate errors in business logic processing for example as follows.

Message Types
TradePromotionCRMCreateRequest

Constraints
In the planning information of a product, product category or product group, there cannot be different key gure values within a
calendar period. For example, if the calendar unit is a week, rather than de ne a discount of 1 USD for the rst 3 days and 2 USD
for the last 4 days of a week, you must de ne one discount for the entire week.

Notes on SAP Implementation

Con guration

Before using this operation, disable trade spend defaulting for trade promotions in the SAP CRM back-end system. For
information on how to do this, see Customizing under Customer Relationship Management -> Trade Promotion Management->
Trade Promotions-> Trade Spends-> De ne Trade Spends for Values.

In the node Spend Method, take rate, Off Invoice Cap , uncheck the column Prepopun for all valid spends.

Enhancements

The Business Add-In (BAdI) de nition CRM_SE_CRMTPM_CRTRQ_IN can be used to change the standard inbound and outbound
mapping or pre- and post- processing of the asynchronous Create Trade Promotion service operation. This BAdI offers the BAdI
interface IF_CRM_SE_CRMTPM_CRTRQ_IN with the methods INBOUND_PROCESSING and OUTBOUND_PROCESSING.

INBOUND_PROCESSING is called during inbound data mapping and can be used to overwrite the existing mapping or to
map additional data if new elements were added to the message. The internal communication structure
CRMS_MKTPL_SE_TPM_CRTRQ_IN is used as structure of the changing parameter of the INBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

OUTBOUND_PROCESSING is called during the outbound data mapping and can be used to overwrite the existing
mapping or to map additional data if new elements were added to the message. The internal communication structure

This is custom documentation. For more information, please visit the SAP Help Portal 17
 8/30/2024
CRMS_MKTPL_SE_TPM_CO_OUT is used as structure of the importing parameter of the OUTBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Create Trade Promotion as Bulk

De nition
To create one or many trade promotions.

Technical Data

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMBulkCreateRequest_In

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Web Service De nition (Back End) TradePromotionCRMBulkCreateReq

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

This is custom documentation. For more information, please visit the SAP Help Portal 18
 8/30/2024
The Create Trade Promotion inbound service operation creates a trade promotion.

The Change Trade Promotion inbound service operation changes a trade promotion.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many
trade promotions were created successfully or not.

The Notify of Trade Promotion outbound service operation noti es subscribed parties of trade promotion events
triggered by a change in system status.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotion.

Features
The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions based on the speci ed
data.

To create and to save a trade promotion, no speci c information is required. If no trade promotion identi er (TradePromotionID
data element) is supplied then for each speci ed trade promotion, a trade promotion identi er is generated by the CRM back-
end system and returned together with default data (such as planning product basis and person responsible).

The following data is optional but commonly speci ed depending on the use case.

An identi er for a trade promotion agreement (TradePromotionAgreementID data element).

Date ranges (StartDate and EndDate data element).

Descriptive text on of the trade promotion (Description data element).

Product data such as the ProductID and ProductTypeCode data elements, key gure data and causal factor data.

Products category data such as the ProductCategoryID data element, key gure data and causal factor data.

Product group data such as the SalesSpeci cationProductGroupCode data element, key gure data and causal factor
data.

Trade spend data such as TypeCode, CategoryCode and MethodCode data elements.

Partner information (PartyID and PartyRoleCode data elements).

Note that coding excerpts are available in the documentation for Create Trade Promotion service operation.

Status

All trade promotions created by this service have a system status ʻCreated’.

User status is optional. If used, its initial status is assigned as in the User Status Pro le.

The outbound message for this service operation uses the TradePromotionCRMBulkCon rmation_Out service to broadcast all
the trade promotions newly created.

Asynchronous Service Operations

The execution of this asynchronous service operation triggers a con rmation message from Con rm Trade Promotion as Bulk
service operation. This contains information on whether the creation of each individual trade promotion was successful or not.

This is custom documentation. For more information, please visit the SAP Help Portal 19
 8/30/2024

Error Handling
The Create Trade Promotion as Bulk service operation supports Forward Error Handling (FEH). The following error categories
are used.

DCE: Determination & ConversionErrors in this category normally indicate that the information sent is not in the correct
format or not within acceptable ranges, for example as follows.- The request passes alphanumeric characters for a data
element that takes only numeric values- The request passes a value of 8 for a data element that has a value range of 1-7

PRE: Processing ErrorErrors in this category indicate errors in business logic processing for example as follows.- The
request is to create a trade promotion that already exists.

Message Types
TradePromotionCRMBulkCreateRequest

Constraints
In the planning information of a product, product category or product group, there cannot be different key gure values within a
calendar period. For example, if the calendar unit is a week, rather than de ne a discount of 1 USD for the rst 3 days and 2 USD
for the last 4 days of a week, you must de ne one discount for the entire week.

Notes on SAP Implementation

Con guration

Before using this operation, disable trade spend defaulting for trade promotions in the SAP CRM back-end system.For
information on how to do this, see Customizing under Customer Relationship Management -> Trade Promotion Management->
Trade Promotions-> Trade Spends-> De ne Trade Spends for Values.

In the node Spend Method, take rate, Off Invoice Cap , uncheck the column Prepopun for all valid spends.

Parallel Processing

The bulk creation of trade promotions can be optimized by using parallel processing. The parallel processing increases the
efficiency of mass processing jobs in dividing the list of trade promotions into different buckets. Each bucket is then associated
onto a speci c thread to be processed individually and asynchronously on different servers. The efficiency of the parallel
processing depends on the available capacity of the dedicated hardware.

The customizing is project-speci c and depends on the available system resources. If no customizing is set, trade promotion
agreements are created serially on the local server.Note: It is strongly recommended that you perform a stress test to
determine the settings that would be best suited to your installation.

For more information, see Customizing under Customer Relationship Management.Trade Promotion Management -> Trade
Promotions -> SOA Services -> Parallel Processing -> De ne Settings for Bulk Create Service

Enhancements

The Business Add-In (BAdI) de nition CRM_SE_CRMTPM_BLKCRTRQ_IN can be used to change the standard inbound or pre-
processing of the Create Trade Promotion as Bulk service operation.

This BAdI offers the BAdI interface IF_CRM_SE_CRMTPM_BLKCRTRQ_IN with the methods INBOUND_PROCESSING and
OUTBOUND_PROCESSING.

This is custom documentation. For more information, please visit the SAP Help Portal 20
 8/30/2024
INBOUND_PROCESSING is called during inbound data mapping and can be used to overwrite the existing mapping or to
map additional data if new elements were added to the message. The internal communication structure
CRMT_MKTPL_SE_TPM_BLKCRTRQ_IN is used as structure of the changing parameter of the INBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

OUTBOUND_PROCESSING is called during the outbound data mapping and can be used to overwrite the existing
mapping or to map additional data if new elements were added to the message. The internal communication structure
CRMS_MKTPL_SE_TPM_BLKCO_OUT is used as structure of the importing parameter of the OUTBOUND_PROCESSING
method and can be enhanced by new elds in a customer SAP CRM back-end system.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Trade Promotion Out

De nition
An interface to manage trade promotion con rmations.

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction outbound

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Trade Promotion Out outbound service interface groups service operations that manage trade promotion con rmations.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Interfaces

The Trade Promotion In inbound service interface groups service operations that manage trade promotions.

The Query Trade Promotion In inbound service interface contains an operation that retrieves trade promotion data.

More Information

This is custom documentation. For more information, please visit the SAP Help Portal 21
 8/30/2024
For more information about Trade Promotion Management, see SAP Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Con rm Trade Promotion

De nition
To con rm whether a create or change of a trade promotion was successful or not.

Technical Data

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMCon rmation_Out

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

The Create Trade Promotion inbound service operation creates a trade promotion.

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

The Change Trade Promotion inbound service operation changes a trade promotion.

The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many
trade promotions were created successfully or not.

This is custom documentation. For more information, please visit the SAP Help Portal 22
 8/30/2024
The Notify of Trade Promotion outbound service operation noti es subscribed parties of trade promotion events
triggered by a change in system status.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotion.

Features
The Con rm Trade Promotion asynchronous outbound service operation sends a message con rming whether a trade
promotion was created or changed successfully or not. This con rmation message is triggered by either the Create Trade
Promotion or the Change Trade Promotion inbound service operation and is returned to the original requestor of these create
or change services.

The outbound message contains the Message Header (BusinessDocumentMessageHeader type) that contains information
about the sender and the inbound message. It also contains the following information.

The identi er of the trade promotion (TradePromotionID data element)

The message log containing the processing result code, the maximum severity code and items in the log.

Error Handling
A con rmation is sent after the error handling.

Message Types
TradePromotionCRMCon rmation

Prerequisites
This service operation is triggered by the completion of a call to either the Create Trade Promotion or Change Trade Promotion
service operation.

Notes on SAP Implementation

Enhancements

The following Business Add-In (BAdI) de nitions can be used to change the standard outbound mapping or post-processing of
the asynchronous Con rm Trade Promotion service operation.

CRM_SE_CRMTPM_CRTRQ_IN of the service operation Create Trade Promotion or

CRM_SE_CRMTPM_CHGRQ_IN of the service operation Change Trade Promotion

The triggering event determines which of the two BAdIs is executed.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

This is custom documentation. For more information, please visit the SAP Help Portal 23
 8/30/2024

Con rm Trade Promotion as Bulk

De nition
To con rm whether one or many trade promotions were created successfully or not.

Technical Data

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMBulkCon rmation_Out

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many trade
promotions were created successfully or not.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

The Create Trade Promotion inbound service operation creates a trade promotion.

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

The Change Trade Promotion inbound service operation changes a trade promotion.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

The Notify of Trade Promotion outbound service operation noti es subscribed parties of trade promotion events
triggered by a change in system status.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotion.

This is custom documentation. For more information, please visit the SAP Help Portal 24
 8/30/2024

Features
The Con rm Trade Promotion as Bulk asynchronous outbound service operation sends a message con rming whether one or
many trade promotions were created successfully or not. This con rmation message is triggered by the Create Trade
Promotion as Bulk inbound service operation and is returned to the original requestor of this bulk create service. It contains a
number of single con rmation packages corresponding to the number of requests in the original bulk request. In turn, each
package contains the corresponding result, that is whether the trade promotion was successfully created or not.

The outbound message contains the Message Header (BusinessDocumentMessageHeader type) that contains information
about the sender and the inbound message as well as a generic message log. The outbound message also contains a number of
packages each containing the following information.

An identi er of the trade promotion (TradePromotionID data element)

The corresponding message log containing the processing result code, the maximum severity code and items in the log

Error Handling
A con rmation is sent after the error handling.

Message Types
TradePromotionCRMBulkCon rmation

Prerequisites
This service operation is triggered by the completion of a call to the Create Trade Promotion as Bulk service operation.

Notes on SAP Implementation

Enhancements

The Business Add-In (BAdI) de nition CRM_SE_TPMBLKCO can be used to change the standard outbound mapping or post-
processing of the asynchronous Con rm Trade Promotion as Bulk service operation.

This BAdI offers the BAdI interface IF_EX_CRM_OUT_SE_TPMBLKCO with the method OUTBOUND_PROCESSING. This method
is called during outbound data mapping and can be used to overwrite the existing mapping or to map additional data if new
elements were added to the message. The internal communication table CRMT_MKTPL_SE_TPM_BLKCO_OUT is used as
structure of the importing parameter of the OUTBOUND_PROCESSING method and can be enhanced by new elds in a
customer SAP CRM back-end system.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

Notify of Trade Promotion

This is custom documentation. For more information, please visit the SAP Help Portal 25
 8/30/2024

De nition
To notify subscribers of an event triggered by a change to a trade promotion.

Technical Data

Entity Type Service Operation

Software Component Version SAP CRM ABAP 7.02

Release State released

Technical Name TradePromotionCRMNoti cation_Out

Namespace http://sap.com/xi/CRM/Global2

Application Component CRM-MKT-MPL-TPM-SRV

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

In a typical trade promotion lifecycle, once a trade promotion is created, it is developed and details such as prices, volumes and
timescales are agreed. When trade promotion development is completed, optionally it can be revised or marked as being in
process, but it must be approved and released before it is published. It can then be nished or archived. At any point the trade
promotion can be locked or made inactive.

The Notify of Trade Promotion outbound service operation noti es subscribed parties of an event triggered by a change to a
trade promotion.

Further business context is provided in the documentation for the Trade Promotion Management process component and the
Trade Promotion business object.

Related Service Operations

The Create Trade Promotion inbound service operation creates a trade promotion.

The Create Trade Promotion as Bulk inbound service operation creates one or many trade promotions.

The Change Trade Promotion inbound service operation changes a trade promotion.

The Con rm Trade Promotion outbound service operation con rms whether a create or change of a trade promotion was
successful or not.

The Con rm Trade Promotion as Bulk outbound service operation sends a message con rming whether one or many
trade promotions were created successfully or not.

The Read Trade Promotion inbound service operation reads the data from one or many speci ed trade promotion.

Features

This is custom documentation. For more information, please visit the SAP Help Portal 26
 8/30/2024
The Notify of Trade Promotion service sends a noti cation message informing subscribers of a trade promotion event. An event
is triggered by a successful save of a trade promotion that has a system status value on the list of noti ed values.

With the customization as delivered, the list of noti ed values for system status is as follows.

Approved

Released

Published

In Simulation

Revised

Note that with the customization as delivered, no noti cation message is sent when a change is made to a trade promotion
that has a system status of Created.

For information on changing the delivered customizing and the list of possible values see the Notes on SAP Implementation
keyblock under Con guration .

The noti cation message consists of the entire data from the affected trade promotion and an action code. The action code
indicates the action that triggered the noti cation as follows.

01 – Trade Promotion Created

02 – Trade Promotion Changed

03 – Trade Promotion Deleted

In addition the noti cation message includes a message log.

Notes

This service operation sends a noti cation whether the trade promotion event is triggered using a service or directly in
the SAP CRM back-end system.

When the trade promotion event is triggered more than once by a single request to a bulk service, multiple noti cation
messages are sent, one for each event.

Error Handling
Since noti cations are sent only when a trade promotion event occurs, there are no error situations.

Message Types
TradePromotionCRMNoti cation

Prerequisites
To receive noti cations from the Notify of Trade Promotion service operation, an external party must be already subscribed to
the service operation.

There are two ways to subscribe.

This is custom documentation. For more information, please visit the SAP Help Portal 27
 8/30/2024
XI system As part of con guring the XI system to send messages to the CRM back-end system, con gure it to receive
the noti cations.

Web services Create a logical port through transaction SOAMANAGER. All noti cations are then sent to that logical port.

Notes on SAP Implementation

Con guration

To change the values of system status that trigger a noti cation message, use the Business Activity ENOT in Customizing. The
possible values are listed using the following format. The values that trigger a noti cation with the delivered customization have
the status "Allowed".

The items in the following list are shown in the order: System Status (Abbreviation) Number, Status

Created (CRTE) I1001, No in uence

In Process (EXEC) I1123, No in uence

Approved (APPR) I1122, Allowed

Released (REL) I1004, Allowed

Finished (FSHD) I1008, No in uence

Rejected (CNC) I1124, No in uence

Locked (LCK) I1121, No in uence

Object Moving Locked (SCLC) I1320, No in uence

Can be archived (ARCR) I1100, No in uence

Archived (DELA) I1101, No in uence

Obsolete (COBS) I1324, No in uence

Published (CPUB) I1323, Allowed

Inactive (CINA) I1321, No in uence

In Simulation (CSIM) I1327, Allowed

Simulation Rejected (CSIR) I1328, No in uence

Revised (RVST) I2950, Allowed

By default, the Notify of Trade Promotion asynchronous service operation returns the non-zero values of all key gures of the
associated Master Planning Pro le. This can inadvertently affect performance if the number of key gures pertaining to the
master layout is high. To reduce the impact, carefully select which key gures are included. To do this, create a new layout in BI
with the speci c set of key gures that are required, and then add it to the Planning Pro le Group in Customizing:SAP
Customizing Implementation Guide -> Customer Relationship Management -> Trade Promotion Management -> Key Figure
Planning -> De ne Planning Pro le Groups

The Plan Type of the new Pro le that is added to the Planning Pro le group is selectable. Use the drop down menu to select
“External application interface”.

Enhancements

The Business Add-In (BAdI) de nition CRM_SE_CRMTPM_NOTIF_EVENT can be used to change the standard outbound mapping
or post-processing of the asynchronous Notify of Trade Promotion service operation.
This is custom documentation. For more information, please visit the SAP Help Portal 28
 8/30/2024
This BAdI offers the BAdI interface IF_CRM_SE_CRMTPM_NOTIF_EVENT with the method MAP_EXECUTE_ASYNCHRONOUS.
This method is called during outbound data mapping and can be used to overwrite the existing mapping or to map additional
data if new elements were added to the message. The internal communication structure CRMTPM_NOTIF_MESSAGE_TYPE is
used as structure of the importing parameter of the MAP_EXECUTE_ASYNCHRONOUS method and can be enhanced by new
elds in a customer SAP CRM back-end system.

No service mapping tool is available for this service operation.

More Information
For more information about Trade Promotion Management, see SAP Help Library underSAP Business Suite -> SAP Customer
Relationship Management -> Marketing -> Objects and Functions for Business Scenarios in Marketing -> Trade Promotion
Management

This is custom documentation. For more information, please visit the SAP Help Portal 29