| Description | Manage Target Groups |
| Name | ManageTargetGroupIn |
| Namespace | http://sap.com/xi/AP/CRM/Global |
| Process Component Description | Campaign Management |
| Process Component Name | CampaignManagement |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deployment Unit Description | Customer Relationship Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to replicate target group data from a source system or file to a target system.
The Manage Target Group In inbound service interface groups operations that receive imported structured target group data from a source, such as a system or a file. This data is replicated or migrated to a target system either for a single target group or for several target groups by bundle.
NOTE: This service only supports creation of a Target Group. Update/Delete are not supported.
The web service interface Manage Target Group In offers the operations MaintainBundle and CheckMaintainBundle.
Here is an example of a simple web service request:
Show full documentation
Show full documentation
<ns1:TargetGroupBundleMaintainRequest_sync xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID></ID>
</BasicMessageHeader>
<TargetGroup actionCode="01" memberListCompleteTransmissionIndicator="true">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<ChangeStateID></ChangeStateID>
<Description>TG Uploaded Backend</Description>
<LifeCycleStatusCode>1</LifeCycleStatusCode>
<Member>
<CustomerInternalID>MC9785</CustomerInternalID>
<ContactPersonInternalID>MCP9785</ContactPersonInternalID>
</Member>
<TextCollection>
<Text__1>
<TypeCode>10006</TypeCode>
<Text>Note this is from addin</Text>
</Text__1>
</TextCollection>
</TargetGroup>
</ns1:TargetGroupBundleMaintainRequest_sync>
Existence of referenced master data or business documents:
Account, Contacts, etc. to name Members of the Target Group.
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 statuses are not increased)
Do not change business documents
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.
NOTE : Only action code "01" is relevant for this service.
| 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. |
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 an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
| LCTI | Description |
|---|---|
| false | The list of node elements is not completely transmitted. Hence, all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be uniquely identified, the system processes the node elements according the action code. If transmitted node elements in the list cannot be uniquely identified, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is completely transmitted.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 imply completeness of sub-elements.
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
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 of data for mass operations.
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 has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
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, then 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.
3. 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 for only 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. Instead, the service provider returns them to the web service consumer in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
The structure of the response message consists of two parts:
A business document-specific part containing information about IDs and UUIDs of the created and 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.
The Response message here essentially contains the ID of the Target Group created in the system and the Last Changed Date/Time of the corresponding document.
The response message looks like
<n0:TargetGroupBundleMaintainConfirmation_sync xmlns:n0 ="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:HBM:/1SAI/TAS28F00CD484CB5D582F9C:804"> <TargetGroup> <ID>63</ID> <ChangeStateID>20131004045711.3679140</ChangeStateID> <UUID>00163e04-f509-1ed3-8b96-2d9debfbbc6f</UUID> </TargetGroup> <Log /> </n0:TargetGroupBundleMaintainConfirmation_sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Possible scenarios include the following:
Create Target Groups : A Target Group with n number of Members can be created in the system.
Update/Delete Target Groups : These operations are not supported by this web service.
| Description | Maintain target groups |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To maintain one or more target groups using imported structured data.
The Manage Target Group In Maintain as Bundle inbound operation maintains one or more target groups based on target group data. This data is replicated or migrated from a source, for example, a system or a file, to a target system.
The TargetGroup node element contains all general information like Description, Status and Members of the target group to be created in the system.
The ID is a unique identifier of the appointment. It is typically not shown in the UI, and is automatically generated by the system.
The UUID is a unique identifier of the Target Group. It will be generated by the web service or can be provided by the consumer.
The Name is the Subject of the Target Group as it will be shown in the UI.
The LIFE_CYCLE_STATUS_CODE node element can be used to set he status of the document. It can have three values :
| Life Cycle Status Code | Description |
|---|---|
| 1 | Active |
| 2 | Blocked |
| 3 | Obsolete |
The MEMBER node element can be used to specify all the Accounts/Contacts in the Target Group.
It has four fields which can be used to specify the Accounts/Contacts :
CUSTOMER_UUID : The Account UUID can be passed here.
CUSTOMER_INTERNAL_ID : The Account internal Business Partner ID can be passed here.
CONTACT_PERSON_UUID : The Contact UUID can be passed here.
CONTACT_PERSON_INTERNAL_ID : The Contact internal Business Partner ID can be passed here.
<Member> <CustomerInternalID>MC9785</CustomerInternalID> <ContactPersonInternalID>MCP9785</ContactPersonInternalID> </Member>
The TEXT_COLLECTION node element can be used to specify notes related to the Target Group. It has two fields :
TypeCode : The code passed here is used to determine what kind of note it is. The default value for this is "10006" which refers to "Detailed Description".
Text : The actual text can be passed here as a string.
<TextCollection>
<Text__1>
<TypeCode>10006</TypeCode>
<Text>Note this is from addin</Text>
</Text__1>
</TextCollection>
| Description | Check target groups |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To check whether one or more target groups can be maintained using imported structured data.
The Manage Target Group In Check Maintain as Bundle inbound operation checks whether one or more target groups can be maintained in the target system based on target group data received from a source, for example, a system or a file.