Name: Business Partner Relationship SOAP Service - SAP S/4HANA
Uploaded: 2020-8-25
Duration: 674 s
Description: This video will give you an overview of the business partner relationship SOAP service. It will show you the structure of the SOAP service, the mandatory attributes and sample payloads.

Share feedback

<p>Planned maintenance of Practice Systems</p>

Planned maintenance of Practice Systems

Why create an SAP account?

Enhance your learning experience

SAP Learning

Subscribe now

Learn more

Live Sessions

Hands-on Practice

Certification

My Learning

Ready to start learning?

<div><div><div><div>This video will give you an overview of the business partner relationship SOAP service. It will show you the structure of the SOAP service, the mandatory attributes and sample payloads.   </div></div></div></div>

Business Partner Relationship SOAP Service - SAP S/4HANA

Hello and welcome. My name is Pankaj and I work in Business Partner Master Data team. In this micro learning, I will give you an overview of Business Partner Relationship SOAP service. The service is used to replicate Business Partner Relationship data between a S4/HANA system and the client. The client can be another S/4HANA system or support it known S/4HANA system. In the learning, I will go through the structure of SOAP messages, talk about few essential attributes and show you example payloads. There's another service which replicates business partner data. It is covered in a separate micro learning. This learning unit is meant for integration architects, technical and functional consultants who are concerned with replicating business partner relationship data between S4/HANA and clients. The learning would explore the structure of business partner relationship, request and confirmation messages. It will cover both inbound and outbound messages. However, this learning is not about functional description of every field or segmenting payload. I will talk about only important fields and segments present in the Payload. Then we will go through a few sample payloads and understand their composition. Let's go through request messages, BusinessPartnerRelationshipSUITEBulkReplicateRequest_Out is the outbound request message and BusinessPartnerRelationshipSUITEBulkReplicateRequest_In is the inbound request message. The outbound request message replicates business partner relationship data from S4/HANA system to client. The inbound request message, replicates data from client to S4/HANA. Both the request messages are bulk messages. It means that they are capable of carrying multiple request messages in a single payload. Inbound and outbound messages have similar structures. They contain message header and business partner relationship suite replicate request message. Message header contains technical information out of the payload and business partner relationship suite  replicate request message is a collection of individual request messages. Each single request message contains message header and business partner relationship nodes. Message header within single request contains technical information of the particular request message and the business partner relationship node contains the actual functional data that requires application. We will talk about message header later. Let's explore the business partner relationship node first. As we know in business partner relationship, two business partners are involved. The main business partner and related business partner. The business partner relationship node has attributes related to IDs and UUIDs of both business partners. Let's check the fields that are presenting IDs and UUIDs of  main business partner. BusinessPartnerUUID is the UID of  business partner in sender system- And BusinessPartnerInternalID contains the business partner number in sender system. ReceiverBusinessPartnerUUID and ReceiverBusinessPartnerInternalID are the corresponding fields  in recipient system. Coming to fields representing related business partner. RelationshipBusinessPartnerUUID is the business partner UID in sender system and RelationshipBusinessPartnerInternalID is the business partner in the sender system. ReceiverRelationshipBusinessPartnerUUID and ReceiverRelationshipBusinessPartnerInternalID are the corresponding IDs in recipients system. RoleCode contains  relationship category of the relation which is  getting replicated. ValidityPeriod contains  validity of relationships. And the nodes ContactPerson and ShareHolder, replicate contact person and shareholder relationship with specific data. The service supports replication of relations involving any relationship category, but only for contact person and shareholder. There are segments to replicate relationship category specific attributes. Let's talk about confirmation messages. BusinessPartnerRelationshipSUITEBulkReplicateConfirmation_Out is the outbound confirmation message, and BusinessPartnerRelationshipSUITEBulkReplicateConfirmation_In is the inbound confirmation message. The outbound confirmation message informs the clients about the status of replication in S4/HANA system and the inbound confirmation message  informs S4/HANA system about the status of replication in clients. What are bulk messages? That is a single payload can contain multiple confirmations. Confirmation messages are mandatory. They inform the sender about the status  of replication and receiver. In addition, they carry the ID's of objects created in recipient system during inbound processing of request messages. Inbound and outbound confirmation messages have similar structures. The payload has message header and BusinessPartnerRelationship SUITEReplicateConfirmationMessage nodes. BusinessPartnerRelationship SUITEReplicateConfirmationMessage is a collection of individual confirmation messages. Each individual message contains message header, business partner relationship  and log nodes. Business partner relationship and child nodes contain IDs of objects created in recipient system along with IDs from sender system. All the IDs starting with receiver are IDs of objects in receiver system, Other IDs or UUIDs  are IDs from sender system. Let's go through few basic payloads to get an understanding of payload sent during business partner relationship replication. Usually the business partner relationship payloads are sent along with business partner payloads. If a business partner with relationship data is replicated, it triggers SOAP messages for business partner as well as for business partner relationship. The business partner SOAP message will replicate all the business partners involved in replication. That is the main BP, as well as all the related BP's. Let's take an example where a business partner has the Contact Person relationship. If you're triggered replication of this business partner, it will trigger a payload, replicate business partner data, and another payload to replicate business partner relationship data. This screenshot here shows the payload to replicate business partner data. So this bulk message to replicate business partner data contains three individual business partners, who it replicate request messages, One for main business partner and one each for related  Contact Person business partners. Continuing with the same example, where a business partner with two contact person was triggered for application. It triggers replication of business partner relationship message as well. And the bulk payload to replicate business partner relation will contain two single business partner relationships. So it replicates request message. This corresponds to two contact person relations associated with the main business partner. Let's explore the business partner relationship payload in more detail. For business partner payload, you may refer to the micro learning on business partners. Message headers contain technical information like ID and UUID, which uniquely identify the payload are the individual requests. There is one message header and the payload level, which contains attributes common to entire payload. Then there are message headers is specific to each single request message, sender and recipient system information not important or wrong sender system means that confirmation message cannot be sent. And this may lead to error situations. An important field in message header and payload level is ReferenceID. It points to the message header of corresponding business partner payload. Reference ID field helps the processing logic of business partner relationship message to find out the status of corresponding business partner payload execution. It's important that business partner payload has executed successfully before relationship message is processed. Coming to the individual request message, it again contains message header and business partner relationship node. Business partner relationship node contains the actual business data that requires replication. As we discussed already, it contains the IDs and UUIDs of main business partner as well as related business partner in sender and receiver systems. The IDs starting with the receiver are  the IDs in recipients system and other IDs are from sender system. RoleCode BUR001 here indicates that has Contact Person, relationship is getting replicated. This payload replicates contact person relationship. Hence, contact person segment contains relevant details of contact person. This slide shows a snapshot of a business partner relationship confirmation message. The message header in confirmation message has ReferenceID and ReferenceUUID fields, apart from other fields which you already know, These reference fields point to ID and UUID of corresponding business partner relationship request message. And the business partner relationship node contains the IDs and UUIDs of replicated objects in sender and recipient system. It also has logged data or application. So to wrap up, the key takeaways of this session is that now you are familiar with business partner relationships of service. You have a high level understanding of fields and segments which are important for replication. To learn more, check the openSAP platform for other micro learnings on SAP S4/HANA, Master Data Management. The session on Business Partner SOAP Services Overview gives an overview of available services from business partner area. The micro learning application of business partner data explores Business Partner SOAP Service in detail. And there is one more micro learning on Reduced Data Model Handling. Thank you.