Show full documentation

 Show full documentation

Definition

An interface to migrate phone call activity data from a source system or file.

Business Context and Use

The web service interface Manage Phone Call Activity In enables you to connect external applications to your SAP system and to create and edit phone call activities in your system. The web service interface Manage Phone Call Activity In is relevant if your company wants to access and manage activity data from external applications.

The web service interface Manage Phone Call Activity In offers the operations MaintainBundle and CheckMaintainBundle.

Here is an example of a simple web service request:

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000102dcade9bcb0aa000c68</ID>
 </BasicMessageHeader>
 <PhoneCallActivity actionCode="01">

 <Name> A2X Create PhoneCall with Parties, Text, Date, etc. </Name>

  <PriorityCode>1</PriorityCode>
  <InitiatorCode>3</InitiatorCode>
  <InformationSensitivityCode>2</InformationSensitivityCode>
  <GroupCode>0009</GroupCode>
  <DataOriginTypeCode>4</DataOriginTypeCode>
  <LifeCycleStatusCode>2</LifeCycleStatusCode>
 
  
  <MainActivityParty>
   <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
  </MainActivityParty>
  <CommunicationParty>
   <ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
   <BusinessPartnerInternalID>MCPB9785</BusinessPartnerInternalID>
   <MainIndicator></MainIndicator>
  </CommunicationParty>
  <EmployeeResponsibleParty>
   <BusinessPartnerInternalID>MC2471</BusinessPartnerInternalID>
  </EmployeeResponsibleParty>
  <ActivityUnitParty>
   <OrganisationalCentreID>MC10000</OrganisationalCentreID>
  </ActivityUnitParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP9785</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP9786</BusinessPartnerInternalID>
  </ReferenceParty>
    
  <StartDateTime timeZoneCode="CET">2012-06-28T12:00:00.1234567Z</StartDateTime> 
  <EndDateTime timeZoneCode="CET">2012-06-28T12:30:00.1234567Z</EndDateTime> 

  
  <Text actionCode="01">
   <TextTypeCode>10002</TextTypeCode>
   <ContentText>A2X Example for text type "Body Text"</ContentText>
  </Text>

  <Text actionCode="01">
   <TextTypeCode>10011</TextTypeCode>
   <ContentText>A2X Example for text type "Internal Comment"</ContentText>
  </Text>  
   
 </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

Prerequisites

Existence of referenced business data:

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

Parties:

• Business partners and related projections like customers, employees, and so on

• Organizational centers

Constraints and Integrity Conditions

General Rules for Using this Web Service

Check Maintain Bundle vs. Maintain Bundle

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

• Return system messages similar to corresponding maintain bundle operations

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

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

• Do not change business documents

Action Code

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

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

Default action code: 04 (Save).

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

List Processing

The processing of node elements with cardinality > 1 (for example a list of parties with a certain party role) 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 transmitted completely. 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.

Empty and Missing Elements

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

Communication Timeout

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

Message Header

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

Change State ID

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

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

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

Object Node Sender Technical Identifier

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

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

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

Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements 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.

Example

Request:

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

Response:

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

Response Message

The structure of the response message consists of two parts:

• A business document-specific part containing information about IDs and UUIDs of the created 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

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation.

Scenarios

Possible scenarios include the following:

• Create Phone Call Activity

The MaintainBundle operation is used to create activities.

• Update Phone Call Activity

The MaintainBundle operation is used to update activities.

Scnario Create

Example to create a phone call activity:

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000102dcade9bcb0aa000c68</ID>
 </BasicMessageHeader>
 <PhoneCallActivity actionCode="01">

<Name>A2X Create PhoneCall with Parties, Text, Date, etc. </Name>

  <PriorityCode>1</PriorityCode>
  <InitiatorCode>3</InitiatorCode>
  <InformationSensitivityCode>2</InformationSensitivityCode>
  <GroupCode>0009</GroupCode>
  <DataOriginTypeCode>4</DataOriginTypeCode>
  <LifeCycleStatusCode>2</LifeCycleStatusCode>
 
  
  <MainActivityParty>
   <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
  </MainActivityParty>
  <CommunicationParty>
   <ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
   <BusinessPartnerInternalID>MCPB9785</BusinessPartnerInternalID>
   <MainIndicator></MainIndicator>
  </CommunicationParty>
  <EmployeeResponsibleParty>
   <BusinessPartnerInternalID>MC2471</BusinessPartnerInternalID>
  </EmployeeResponsibleParty>
  <ActivityUnitParty>
   <OrganisationalCentreID>MC10000</OrganisationalCentreID>
  </ActivityUnitParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP6049</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCPB9785</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCPC9785</BusinessPartnerInternalID>
  </ReferenceParty>
  
  <StartDateTime timeZoneCode="CET">2012-06-28T12:00:00.1234567Z</StartDateTime> 
  <EndDateTime timeZoneCode="CET">2012-07-01T13:00:00.1234567Z</EndDateTime>
  
  <Text actionCode="01">
   <TextTypeCode>10002</TextTypeCode>
   <ContentText>A2X Example for text type "Body Text"</ContentText>
  </Text>

  <Text actionCode="01">
   <TextTypeCode>10011</TextTypeCode>
   <ContentText>A2X Example for text type "Internal Comment"</ContentText>
  </Text>  
   
 </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

Scenario Update

Example to update a phone call activity:

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000102dcade9bcb0aa000c68</ID>
 </BasicMessageHeader>

 <PhoneCallActivity actionCode="02">

  <Name>A2X Update PhoneCall with Party, etc. </Name>

  <ID>288</ID>

  <Name languageCode="EN"> A2X Update PhoneCall w. Parties 001</Name>

  <GroupCode>0012</GroupCode>
   
 </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

Example to update a party that has 1:n cardinality

Attention: The party ID and party role are not unique keys for a party instance. Thus, for parties with 1:n cardinality, in case of updates (change and delete) the ListCompleteTransmissionIndicator needs to be set and the whole list of updated parties that should replace the existing list of parties has to be provided.

Example data for ReferenceParty:

List of existing ReferenceParty to be changed:

• MCP6049

• MCPB9785

• MCPC9785

What do we want to achieve?

• Delete party MCP6049

• Keep party MCPB9785

• Change party MCPC9785 -> MCP17101

• Add party MCP17102

• Add party MDECP9786

Due to the fact that no unique identification of a party instance is possible using party ID and party role, the ReferencePartyListCompleteTransimissionIndicator is to be set to "true". Therefore, the behavior will be as follows: The list of parties is completely transmitted. Hence, all parties that are not transmitted are removed. If no party is transmitted, the complete list is removed.

In the following the desired list of parties is to be provided:

• MCPB9785

• MCP17101

• MCP17102

• MDECP9786

The respective XML document to achieve this looks like the following:

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000102dcade9bcb0aa000c68</ID>
 </BasicMessageHeader>
 <PhoneCallActivity actionCode="02" referencePartyListCompleteTransimissionIndicator="true">

  <ID>325</ID>
  
  <ReferenceParty>
   <BusinessPartnerInternalID>MCPB9785</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP17101</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP17102</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MDECP9786</BusinessPartnerInternalID>
  </ReferenceParty>
  
 </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

In case a new party instance has to be appended to the existing list of parties, it can be achieved by just providing the new party and setting the ListCompleteTransimissionIndicator to "false".

Example data:

List of existing parties:

• MCP6049

• MCPB9785

• MCPC9785

What do we want to achieve?

• Keep MCP6049

• Keep MCPB9785

• Keep MCPC9785

• Add MCP8300

• Add MCP60500

In the following just the list of new parties has to be provided:

• MCP8300

• MCP60500

The respective XML document to achieve this looks like the following:

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000102dcade9bcb0aa000c68</ID>
 </BasicMessageHeader>
 <PhoneCallActivity actionCode="02" referencePartyListCompleteTransimissionIndicator="false">

  <!-- append new party instances with LCTI = "false" -->
 
  <ID>325</ID>
  
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP8300</BusinessPartnerInternalID>
  </ReferenceParty>

  <ReferenceParty>
   <BusinessPartnerInternalID>MCP60500</BusinessPartnerInternalID>
  </ReferenceParty>
  
 </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

Example to identify a party by email:

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000102dcade9bcb0aa000c68</ID>
 </BasicMessageHeader>
 <PhoneCallActivity actionCode="01">
<Name>A2X Create PhoneCall with Parties, Text, Date, etc. </Name>
  <PriorityCode>1</PriorityCode>
  <InitiatorCode>3</InitiatorCode>
  <InformationSensitivityCode>2</InformationSensitivityCode>
  <GroupCode>0009</GroupCode>
  <DataOriginTypeCode>4</DataOriginTypeCode>
  <LifeCycleStatusCode>2</LifeCycleStatusCode>
  <MainActivityParty>
   <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
  </MainActivityParty>
  <CommunicationParty>
   <ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
   <BusinessPartnerInternalID>MCPB9785</BusinessPartnerInternalID>
   <MainIndicator></MainIndicator>
  </CommunicationParty>
    <EmployeeResponsibleParty>

      <BusinessPartnerInternalID></BusinessPartnerInternalID>
      <EmailURI>kate.jacob@akron1.com</EmailURI>

      <EmployeeID></EmployeeID>
    </EmployeeResponsibleParty>
  <ActivityUnitParty>
   <OrganisationalCentreID>MC10000</OrganisationalCentreID>
  </ActivityUnitParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCP6049</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCPB9785</BusinessPartnerInternalID>
  </ReferenceParty>
  <ReferenceParty>
   <BusinessPartnerInternalID>MCPC9785</BusinessPartnerInternalID>
  </ReferenceParty>
  
  <StartDateTime timeZoneCode="CET">2012-06-28T12:00:00.1234567Z</StartDateTime> 
  <EndDateTime timeZoneCode="CET">2012-07-01T13:00:00.1234567Z</EndDateTime>
  
  <Text actionCode="01">
   <TextTypeCode>10002</TextTypeCode>
   <ContentText>A2X Example for text type "Body Text"</ContentText>
  </Text>

  <Text actionCode="01">
   <TextTypeCode>10011</TextTypeCode>
   <ContentText>A2X Example for text type "Internal Comment"</ContentText>
  </Text>  
   
 </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

Example to create a phone call activity by other party

<n0:PhoneCallActivityBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
  <BasicMessageHeader>
    <ID>00000000000102dcade9bcb0aa000c68</ID>
  </BasicMessageHeader>
  <PhoneCallActivity actionCode="01">
    <Name>A2X Create PhoneCall with Parties, Text, Date, etc. </Name>
    <PriorityCode>1</PriorityCode>
    <InitiatorCode>3</InitiatorCode>
    <InformationSensitivityCode>2</InformationSensitivityCode>
    <GroupCode>0009</GroupCode>
    <DataOriginTypeCode>4</DataOriginTypeCode>
    <LifeCycleStatusCode>2</LifeCycleStatusCode>
    <EmployeeResponsibleParty>
      <BusinessPartnerInternalID></BusinessPartnerInternalID>
      <EmailURI>kate.jacob@akron1.com</EmailURI>
      <EmployeeID></EmployeeID>
    </EmployeeResponsibleParty>
    <OtherParty actionCode="01" partyContactPartyListCompleteTransmissionIndicator="true">
      <PartyKey>
        <PartyTypeCode></PartyTypeCode>
        <PartyID>mc6049</PartyID>
      </PartyKey>
      <RoleCode>34</RoleCode> <!-- 34 Account -->
      <ContactParty actionCode="01">
        <PartyKey>
          <PartyTypeCode></PartyTypeCode>
          <PartyID>MCPB9785</PartyID>
        </PartyKey>
        <MainIndicator></MainIndicator>
      </ContactParty>
      <ContactParty actionCode="01">
        <PartyKey>
          <PartyTypeCode>147</PartyTypeCode>
          <PartyID>1002462</PartyID>
        </PartyKey>
        <MainIndicator>true</MainIndicator>
      </ContactParty>
      <MainIndicator>true</MainIndicator>
    </OtherParty>
    <OtherParty actionCode="01"
      partyContactPartyListCompleteTransmissionIndicator="true">
      <PartyKey>
        <PartyTypeCode></PartyTypeCode>
        <PartyID>mc6049</PartyID>
      </PartyKey>
      <RoleCode>41</RoleCode> <!-- 41 Activity Contact -->
      <ContactParty actionCode="01">
        <PartyKey>
          <PartyTypeCode></PartyTypeCode>
          <PartyID>MCPB9785</PartyID>
        </PartyKey>
        <MainIndicator>true</MainIndicator>
      </ContactParty>
      <ContactParty actionCode="01">
        <PartyKey>
          <PartyTypeCode></PartyTypeCode>
          <PartyID>1002462</PartyID>
        </PartyKey>
        <MainIndicator></MainIndicator>
      </ContactParty>
      <MainIndicator></MainIndicator>
    </OtherParty>
    <OtherParty actionCode="01"
      partyContactPartyListCompleteTransmissionIndicator="true">
      <PartyKey>
        <PartyTypeCode></PartyTypeCode>
        <PartyID>mc6049</PartyID>
      </PartyKey>
      <RoleCode>45</RoleCode>  <!-- 45 Call Participant -->
      <ContactParty actionCode="01">
        <PartyKey>
          <PartyTypeCode></PartyTypeCode>
          <PartyID>MCPB9785</PartyID>
        </PartyKey>
        <MainIndicator></MainIndicator>
      </ContactParty>
      <ContactParty actionCode="01">
        <PartyKey>
          <PartyTypeCode></PartyTypeCode>
          <PartyID>1002462</PartyID>
        </PartyKey>
        <MainIndicator>true</MainIndicator>
      </ContactParty>
      <MainIndicator></MainIndicator>
    </OtherParty>
    <StartDateTime timeZoneCode="CET">2012-06-28T12:00:00.1234567Z</StartDateTime>
    <EndDateTime timeZoneCode="CET">2012-07-01T13:00:00.1234567Z</EndDateTime>
  </PhoneCallActivity>
</n0:PhoneCallActivityBundleMaintainRequest_sync_V1>

 Show full documentation

 Show full documentation

Definition

To create one or more phone call activities using imported structured data.

Business Context and Use

The Manage Phone Call Activity In Maintain as Bundle inbound operation maintains one or more phone call activities based on phone call activity data. This data is replicated or migrated from a source, for example, a system or a file, to a target system.

The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a phone call activity node element that contains the phone call activity data to be created. The detailed structure of the phone call activity node will be explained in the following sub-chapters. The phone call activity node can occur multiple times in the request message – this means that multiple phone call activities can be created through a single web service request.

The response message type of the operation Maintain_Bundle contains log items, processing information and a Phone call activity-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Phone call activity UUID.

Structure

ManagePhoneCallActivityIn

Phone Call Activity

The Phone Call Activity node element contains all general Phone Call Activity information such as UUID, Name, ID and other identifications.

Priority Code

The PriorityCode node element is used to specify the phone call activity's priority, it contains the below values.

Code	Value
1	Immediate
2	Urgent
3	Normal
7	Low

Initiator Code

The PriorityCode node element is used to specify the phone call activity's direction, it contains the below values.

Code	Value
1	Not Specified
2	Inbound
3	Outbound

Life Cycle Status Code

The LifeCycleStatusCode node element is used to specify the phone call activity's status, it contains the below values.

Code	Value
1	Open
2	In Process
3	Completed
4	Cancelled

Group Code

The GroupCode node element is used to specify the phone call activity's Group, it contains the below values.

Code	Value
0002	Telephone call
0009	Marketing
0012	Sales call
0013	Customer complaint
0014	Customer request

Role Code

The RoleCode node element in OtherParty is used to specify the phone call activity's role code, it contains the below values.

Code	Value
34	Account
41	Activity Contact
45	Call Participant

Attachment Folder

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

Data for this node can be found on the account UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:

Category code	Description
2	Document
3	Link

The different types of attachments are differentiated by the TypeCode:

Type code	Description
10001	Standard attachment
10016	Business partner image
10017	Business card

To create link attachments, document elements must be as follows:

Element	Value
VisibleIndicator	true
CategoryCode	3
TypeCode	<none>
AlternativeName	<Document Title>
ExternalLinkWebURI	<link URI>
Description	<Comment>

To create file attachments, document elements must be as follows:

Element	Value
VisibleIndicator	true
CategoryCode	2
TypeCode	<none>
Name	<Document Title>
AlternativeName	<Document Title>
Description	<Comment>

 Show full documentation

 Show full documentation

Definition

To check whether one or more phone call activities can be created using imported structured data.

The web service request and response message types of the CheckMaintainBundle operation are the same as those of the MaintainBundle operation. The explanations given can therefore also be applied to the CheckMaintainBundle operation.