| Description | Manage Business Partner Merge |
| Name | ManageBusinessPartnerMergeIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Business Partner Data Management |
| Process Component Name | BusinessPartnerDataManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Deploymnent Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
With this interface customer merge cases can be created and customer merge cases can be started.
The web service II_MANAGE_BUPA_MERGE_IN enables you to create customer merge cases from external systems.
Supported are merge cases for the objects 'Corporate Account' and 'Individual Customer' consisting of two business partners only.
The service offers the two operations 'MaintainBundle' and 'Initiate'.
With the following sample payload a new merge case can be created
<n0:BusinessPartnerMergeBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <ID>00000000000102dcade9bcb0aa000c68</ID> </BasicMessageHeader> <BusinessPartnerMergeRequest actionCode="01"> <Name>Test Merge</Name> <CategoryCode>2</CategoryCode> <MasterBusinessPartnerDetails actionCode="01"> <InternalID>MASERT_INTID</InternalID> </MasterBusinessPartnerDetails> <DuplicateBusinessPartnerDetails actionCode="01"> <InternalID>DUPLICATE_INTID</InternalID> </DuplicateBusinessPartnerDetails> </BusinessPartnerMergeRequest> </n0:BusinessPartnerMergeBundleMaintainRequest_sync>
In this sample payload a merge case for two Corporate Accounts is created (Category Code = 2, 1 would be for Individual customers).
Please note that if you don't specify CategoryCode a merge case for Individual customers is created.
You can specify the partners either with ExternalID or InternalID - so please provide only one of both options.
| Description | MISSING - NOT ASSIGNED (CHECK_MAINTAIN_BUNDLE) |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Not Released |
This operation is not supported
| Description | Maintain merge case |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
An interface to merge business partner data
This web service is used to merge business partner data. We can have scenarios where we have multiple business partners with the same data. This information is redundant and can be removed by using this service. When this service is used, the data from the duplicate business partner is merged into the master business partner based on certain rules. The following operations are provided in the web service.
| Operation | Use |
|---|---|
| MAINTAIN_BUNDLE | To create a merge request |
| INITIATE | To initiate merge of two business partners specified in the merge request |
Technical prerequisites
This web service must be activated within a communication arrangement maintained for the scenario External Business Partner Merge.
Existence of master data:
All master data 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.
In order to merge business partner data using this service interface two tasks have to be performed in the order as mentioned below.
Create merge request: The operation MAINTAIN_BUNDLE is used to create a merge request.
Initiate merge: The operation INITIATE is used to initiate merging of the business partners specified in the merge request.
This documentation describes the operation MAINTAIN_BUNDLE.
The operation MAINTAIN_BUNDLE is used to create a merge request. This is done by specifying a merge request name and business partner details of the master and duplicate business partner. The merge request ID is generated automatically. There are two ways to create a merge request.
Using internal IDs: We can use internal IDs of business partners for creating the merge request.
Using external IDs: We can use external IDs of business partners for creating a merge request. In this case some more information needs to be passed to determine the correct business partner. This additional information is as mentioned below:
External business system ID: This corresponds to the system from which the data has been replicated. In order to find the system we have to go to the respective communication system used in the communication arrangement and use the data stored under the column "IDoc Logical system ID".
External identifier defining scheme code: This information can be found under ID mapping screen under the dropdown "Mapping of" where the mapping between external and internal ID exists. The values corresponding to the texts shown in the UI are as follows:
| Mapping of | Code value |
|---|---|
| Business Partners | 888 |
| External Business Partner | 988 |
| ERP Accounts | 918 |
Please see "Example" section for sample xml templates
Example of creating a merge request using internal IDs is shown below.
<n0:BusinessPartnerMergeBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <BusinessPartnerMergeRequest actionCode="01"> <Name>Merge_Request_Description</Name> <CategoryCode>1</CategoryCode> <MasterBusinessPartnerDetails actionCode="01"> <InternalID>Internal_Business_Partner_ID</InternalID> </MasterBusinessPartnerDetails> <DuplicateBusinessPartnerDetails actionCode="01"> <InternalID>Internal_Business_Partner_ID</InternalID> </DuplicateBusinessPartnerDetails> </BusinessPartnerMergeRequest> </n0:BusinessPartnerMergeBundleMaintainRequest_sync>
Example of creating a merge request using external IDs is shown below.
<n0:BusinessPartnerMergeBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <BusinessPartnerMergeRequest actionCode="01"> <Name>Test_external_bp_merge</Name> <CategoryCode>1</CategoryCode> <MasterBusinessPartnerDetails actionCode="01"> <ExternalID>External_Business_Partner_ID</ExternalID> </MasterBusinessPartnerDetails> <DuplicateBusinessPartnerDetails actionCode="01"> <ExternalID>External_Business_Partner_ID</ExternalID> </DuplicateBusinessPartnerDetails> <RemoteBusinessSystemID>External Business System ID</RemoteBusinessSystemID> <RemoteIdentifierDefiningSchemeCode>External ID scheme code</RemoteIdentifierDefiningSchemeCode> </BusinessPartnerMergeRequest> </n0:BusinessPartnerMergeBundleMaintainRequest_sync>
| Description | Initiate merge |
| Name | Initiate |
| Synchronous | yes |
| Release Status | Deprecated |
An interface to merge business partner data
This web service is used to merge business partner data. We can have scenarios where we have multiple business partners with the same data. This information is redundant and can be removed by using this service. When this service is used, the data from the duplicate business partner is merged into the master business partner based on certain rules. The following operations are provided in the web service.
| Operation | Use |
|---|---|
| MAINTAIN_BUNDLE | To create a merge request |
| INITIATE | To initiate merge of two business partners specified in the merge request |
Technical prerequisites
This web service must be activated within a communication arrangement maintained for the scenario External Business Partner Merge.
Existence of master data:
All master data 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.
In order to merge business partner data using this service interface two tasks have to be performed in the order as mentioned below.
Create merge request: The operation MAINTAIN_BUNDLE is used to create a merge request.
Initiate merge: The operation INITIATE is used to initiate merging of the business partners specified in the merge request.
This documentation describes the operation INITIATE.
The operation INITIATE is used to initiate merge of two business partners specified in the merge request. This is done by specifying the merge request id which has been created after the execution of the operation MAINTAIN_BUNDLE.
Please see "Example" section for sample xml templates
Example of initiating a merge request is shown below:
<n0:BusinessPartnerMergeBundleInitiateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <BusinessPartnerInitiateMerge actionCode="02"> <ID>Merge_request_ID</ID> </BusinessPartnerInitiateMerge> </n0:BusinessPartnerMergeBundleInitiateRequest_sync>
Show full documentation
Show full documentation