Inbound Service Interface (public)

Description	Maintain Service Confirmations With Reference To A Customer Contract
Name	ExternalServicePerformingAndChargingSystemRequestServiceConfirmationMaintenanceIn
Namespace	http://sap.com/xi/AP/CRM/Global
Process Component Description	Service Confirmation Processing
Process Component Name	ServiceConfirmationProcessing
Process Component Namespace	http://sap.com/xi/AP/CRM/Global
Deployment Unit Description	Customer Relationship Management
Endpoint Activation	By Communication Arrangement
Operations	Create a service confirmation with reference to a customer contract.

Definition

An interface to maintain a service confirmation with reference to a customer contract with data from an external service performing and charging system.

Business Context and Use

This web service is used to maintain a service confirmation with reference to a customer contract with data from an external service performing and charging system.

It has one operation called CreateServiceConfirmation that is used to create a service confirmation with reference to a contract. It can add texts and attachments on header level. On item level, it is used to confirm services entitled by the contract. If required, fulfillment processing can be finished for each item.

Prerequisites

Technical Prerequisites:

This web service must be activated within a communication arrangement maintained for the scenario Customer Contracts - Managed Service Consumption Integration.

If the scenario is not visible, you must activate it in Business Configuration, fine-tuning for Field Service and Repair. If no entry can be seen there, activate the SAP Store add-on solution for the scenario first.

Business Prerequisites:

The contract that is used as a reference exists in the system and is valid. The Confirm Execution button is active for this contract on the UI.

The services used in the items section of the interface can be confirmed for this contract. To check this, click Confirm Execution for the contract on the UI, add a row in the Services and Spare Parts section, and review the list of products shown in value help. The products listed there can be used for confirmations for this contract.

Constraints and Integrity Conditions

General Rules for Using This Web Service

Error situations, especially when calling this web service with invalid data, can result in items to resolve in business task management, or inconsistent service confirmations. For details with examples, see below.

In order to avoid a heavier workload, we highly recommend that all input into a productive system should contain valid data only.

In order to create a service confirmation with reference to a customer contract you should specify:

The parameters necessary for reliable messaging, for example a unique web service addressing message ID in the SOAP header
A valid message header containing:
- Sender business system ID
- Recipient business system ID (_LOCAL_SYSTEM_ALIAS_SAP_INTERNAL_CONSTANT_VALUE_)
- Sending process component (fixed values: business scope type code 3, ID 345):

 <BusinessScope> 
     <TypeCode listAgencyID="310" listID="25201">3</TypeCode> 
     <ID schemeAgencyID="310" schemeID="10555">345</ID> 
 </BusinessScope>

...
- Receiving process component (fixed values: business scope type code 2, ID 8):

<BusinessScope>
    <TypeCode listAgencyID="310" listID="25201">2</TypeCode>
    <ID schemeAgencyID="310" schemeID="10555">8</ID>
</BusinessScope>

...
- In the body at least a valid referenced contract ID

Example XML without items

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">
  <soap:Header>
      <wsa:MessageID>00163E01-14EA-1EE0-BAA4-7B1DE2FDC927</wsa:MessageID>
  </soap:Header>
  <soap:Body>
    <n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
      <MessageHeader>
          <ID/>
          <UUID/>
          <CreationDateTime>2012-12-12T12:12:12.12Z</CreationDateTime>
          <SenderBusinessSystemID>ESPACS</SenderBusinessSystemID>
          <RecipientBusinessSystemID>_LOCAL_SYSTEM_ALIAS_SAP_INTERNAL_CONSTANT_VALUE_ </RecipientBusinessSystemID>
          <BusinessScope>
              <TypeCode listAgencyID="310" listID="25201">2</TypeCode>
              <ID schemeAgencyID="310" schemeID="10555">8</ID>
          </BusinessScope>
          <BusinessScope>
              <TypeCode listAgencyID="310" listID="25201">3</TypeCode>
              <ID schemeAgencyID="310" schemeID="10555">345</ID>
          </BusinessScope>
      </MessageHeader>
      <ExternalServicePerformingAndChargingSystemServiceConfirmation>
          <CustomerContractID>TEST123</CustomerContractID>
          <Name>Test</Name>
      </ExternalServicePerformingAndChargingSystemServiceConfirmation>
    </n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest>
  </soap:Body>
</soap:Envelope>

The following general parameters should be handled in a special way, as described here.

Action Code

Action Code is a coded representation of an instruction to the recipient of a message telling it how to process a transmitted node or element. It is modelled as an attribute (attribute name: actionCode) in structure elements of the message payload.

Action Code	Description
01	Create
02	Change

Since a new service confirmation is created, all subnodes are also created. Therefore, specify action code 01 only.

Example

<TextCollection actionCode="01">
    <Text actionCode="01">
        <TypeCode>10022</TypeCode>
        <CreationDateTime/>
        <ContentText>work description</ContentText>
    </Text>
</TextCollection>

Language Code

Language Code is a coded representation for the language. Specifying a wrong value will lead to errors. Since the parameter is ignored anyway, you can omit it completely. (Example: the description for a service confirmation cannot be created in multiple languages.)

Example

Recommended:

<Name>Test contract </Name>

<TextCollection actionCode="01">
    <Text actionCode="01">
        <TypeCode>10022</TypeCode>
        <CreationDateTime/>
        <ContentText>work description</ContentText>
    </Text>
</TextCollection>

Not recommended:

<Name languageCode="EN">Test contract </Name>

<TextCollection actionCode="01">
    <Text actionCode="01">
        <TypeCode>10022</TypeCode>
        <CreationDateTime/>
        <ContentText languageCode="EN">work description</ContentText>
    </Text>
</TextCollection>

Note that the meaning of Type Code depends on the context and will be explained in the following sections.

More Information

General Information

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

Scenarios

A common business scenario for using this web service is the Customer Contracts - Managed Service Consumption Integration. As a first step, an external service performing and charging system obtains contract data from the Business By Design system, using the service interface Query Customer Contract In.

The system collects and consolidates data of the services performed. From time to time, it creates confirmations with reference to contracts.

Example

Query contract data by account ID
Check confirmation relevance in response message
Confirm service execution with reference to a contract

Examples

1. Query all contracts by account ID for account XC6123, status should be In Process:

 
<n0:CustomerContractByElementsQuery_sync  xmlns:n0"http://sap.com/xi/SAPGlobal20/Global"> 
  <CustomerContractSelectionByElements> 
    <SelectionByItemListCustomerContractLifeCycleStatusCode> 
      <InclusionExclusionCode>I</InclusionExclusionCode>  
      <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> 
      <LowerBoundaryItemListCustomerContractLifeCycleStatusCode>2</LowerBoundaryItemListCustomerContractLifeCycleStatusCode>  
    </SelectionByItemListCustomerContractLifeCycleStatusCode> 
    <SelectionByBuyerPartyID> 
      <InclusionExclusionCode>I</InclusionExclusionCode>  
      <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>  
      <LowerBoundaryID>XC6123</LowerBoundaryID>  
    </SelectionByBuyerPartyID> 
  </CustomerContractSelectionByElements> 
  <ProcessingConditions> 
      <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator>  
  </ProcessingConditions> 
</n0:CustomerContractByElementsQuery_sync>

2. Check response:

 <nm:CustomerContractByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QKA:/1SAI/TAS902E6E0DCCB2ED322598:803"> 
  <CustomerContract> 
    <ID>XY535</ID>  
    <UUID>00163e01-277c-1ed0-b8d6-11f75261e0f0</UUID>  
    <Name languageCode="EN">Software Service Contract</Name>  
    <ServiceConfirmationCreationCode>1</ServiceConfirmationCreationCode>  
    <BuyerParty> 
      <PartyID>XC6123</PartyID>  
      <ContactParty> 
        <PartyID>1000460</PartyID>  
      </ContactParty> 
    </BuyerParty> 
    <ValidityPeriod>
      <StartDateTime timeZoneCode="UTC">2011-08-02T00:00:00Z</StartDateTime>  
      <EndDateTime timeZoneCode="UTC">2012-08-02T00:00:00Z</EndDateTime>  
    </ValidityPeriod> 
    <Status> 
      <ItemListCustomerContractLifeCycleStatusCode>2</ItemListCustomerContractLifeCycleStatusCode>  
      <ItemListValidityStatusCode>2</ItemListValidityStatusCode>  
      <FulfilmentBlockingStatusCode>1</FulfilmentBlockingStatusCode>  
    </Status> 
    <Item> 
      <ID>10</ID>  
      <Description languageCode="EN">System check</Description>  
      <Status> 
        <CustomerContractLifeCycleStatusCode>2</CustomerContractLifeCycleStatusCode>  
        <ValidityStatusCode>2</ValidityStatusCode>  
        <FulfilmentBlockingStatusCode>1</FulfilmentBlockingStatusCode>  
      </Status> 
      <ValidityPeriod> 
        <StartDateTime timeZoneCode="UTC">2011-08-02T00:00:00Z</StartDateTime>  
        <EndDateTime timeZoneCode="UTC">2012-08-02T00:00:00Z</EndDateTime>  
      </ValidityPeriod> 
      <Product> 
        <ProductID>XCE-0412</ProductID>  
        <UnitOfMeasure>EA</UnitOfMeasure>  
        <TypeCode>6</TypeCode>  
      </Product> 
      <ScheduleLine> 
        <Quantity unitCode="EA">1.0</Quantity>  
      </ScheduleLine> 
      <EntitledProduct> 
        <ProductID>XCD-0476</ProductID>  
        <ProductCategoryInternalID>10-40</ProductCategoryInternalID>  
        <Description>Automatic compatibility check</Description>  
        <TypeCode>2</TypeCode>  
      </EntitledProduct> 
    </Item> 
    <Item> 
      <ID>20</ID>  
      <Description languageCode="EN">Remote Diagnostics</Description>  
      <Status> 
        <CustomerContractLifeCycleStatusCode>2</CustomerContractLifeCycleStatusCode>  
        <ValidityStatusCode>2</ValidityStatusCode>  
        <FulfilmentBlockingStatusCode>1</FulfilmentBlockingStatusCode>  
      </Status> 
      <ValidityPeriod> 
        <StartDateTime timeZoneCode="UTC">2011-08-02T00:00:00Z</StartDateTime>  
        <EndDateTime timeZoneCode="UTC">2012-08-02T00:00:00Z</EndDateTime>  
      </ValidityPeriod> 
      <Product> 
        <ProductID>XRD-1</ProductID>  
        <UnitOfMeasure>HUR</UnitOfMeasure>  
        <TypeCode>2</TypeCode>  
      </Product> 
      <ScheduleLine> 
        <Quantity unitCode="HUR">1.0</Quantity>  
      </ScheduleLine> 
      <EntitledProduct> 
        <ProductID> XRD-1</ProductID>  
        <Description>Remote Diagnostics</Description>  
        <TypeCode>2</TypeCode>  
      </EntitledProduct> 
    </Item> 
    <SystemAdministrativeData> 
      <CreationDateTime>2011-09-19T11:15:28.588723Z</CreationDateTime>  
      <CreationIdentityUUID>00163e01-2e13-1ee0-a49f-f7f9f5bae352</CreationIdentityUUID>  
      <LastChangeDateTime>2011-10-27T09:21:31.15226Z</LastChangeDateTime>  
      <LastChangeIdentityUUID>00163e01-277c-1ee0-9ac8-42e53972c9cd</LastChangeIdentityUUID>  
    </SystemAdministrativeData> 
  </CustomerContract>
  <ProcessingConditions> 
    <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>  
    <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>   
    <LastReturnedObjectID>00163E01277C1ED0B8D611F75261E0F0</LastReturnedObjectID>  
  </ProcessingConditions> 
</nm:CustomerContractByElementsResponse_sync>

Since ServiceConfirmationCreationCode equals to 1, service confirmations are possible for the contract. The overall status section shows that the contract indeed is in process, the contract is valid and there is no fulfillment block:

 <ItemListCustomerContractLifeCycleStatusCode>2</ItemListCustomerContractLifeCycleStatusCode>  
 <ItemListValidityStatusCode>2</ItemListValidityStatusCode>  
 <FulfilmentBlockingStatusCode>1</FulfilmentBlockingStatusCode>

The contract allows two products being confirmed: XCD-0476 and XRD-1. Both contract items are in process, valid and not blocked for fulfillment.

3. Confirm service execution for product XRD-1 for 1 hour, 20 minutes, and finish fulfillment processing for the new service confirmation:

  <n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> 
  <MessageHeader> 
    <ID />  
    <UUID />  
    <CreationDateTime />  
    <SenderBusinessSystemID>ESPACS</SenderBusinessSystemID> 
    <RecipientBusinessSystemID>_LOCAL_SYSTEM_ALIAS_SAP_INTERNAL_CONSTANT_VALUE_</RecipientBusinessSystemID>  
    <BusinessScope> 
        <TypeCode listAgencyID="310" listID="25201">2</TypeCode>  
        <ID schemeAgencyID="310" schemeID="10555">8</ID>  
    </BusinessScope> 
    <BusinessScope> 
        <TypeCode listAgencyID="310" listID="25201">3</TypeCode>  
        <ID schemeAgencyID="310" schemeID="10555">345</ID> 
    </BusinessScope> 
  </MessageHeader> 
  <ExternalServicePerformingAndChargingSystemServiceConfirmation> 
    <CustomerContractID>XY535</CustomerContractID>  
      <Name>Confirming Remote Diagnostics</Name>  
      <Item> 
        <CustomerContractItemID>20</CustomerContractItemID>  
        <Description>Test</Description>  
        <Product> 
            <SellerID>XRD-1</SellerID>  
        </Product> 
        <Quantity unitCode="HUR">1</Quantity>
        <ActualFulfilmentPeriod>
            <StartDateTime timeZoneCode="IST">2013-01-12T12:12:12.12Z</StartDateTime>
            <EndDateTime timeZoneCode="IST">2013-01-15T12:12:12.12Z</EndDateTime>
        </ActualFulfilmentPeriod>  
        <!-- ISO format for ConfirmedDuration:-->
        <ConfirmedDuration>PT1H20M</ConfirmedDuration>      
        <ResourceID>XM-TEN001</ResourceID>         
        <FinishFulfilmentProcessingRequestedIndicator>true</FinishFulfilmentProcessingRequestedIndicator>  
      </Item> 
  </ExternalServicePerformingAndChargingSystemServiceConfirmation> 
</n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest>

Description	Create a service confirmation with reference to a customer contract.
Name	CreateServiceConfirmation
Synchronous	no

Definition

To create a service confirmation with reference to a customer contract with data from an external service performing and charging system.

Business Context and Use

This operation is used to create a service confirmation with reference to a contract.

 <n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> 
  <MessageHeader /> 
  <ExternalServicePerformingAndChargingSystemServiceConfirmation> 
      <CustomerContractID />  
      <Name />  
      <TextCollection actionCode="01" /> 
      <AttachmentFolder actionCode="01" /> 
      <Item /> 
  </ExternalServicePerformingAndChargingSystemServiceConfirmation> 
</n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest>

Structure

The mandatory attribute CustomerContractID identifies the referenced contract.

Example

 <CustomerContractID>123</CustomerContractID>

Without a valid contract ID, no service confirmation can be created. Instead, a business task is created.

The Name attribute corresponds to the Description field on the UI. If omitted, the contract description will be copied to the confirmation.

Example

 <Name>XYZ</Name>

The work description and the internal description of a service confirmation can be added via the TextCollection node described below.

The AttachmentFolder node below serves as a means to add attachments to the service confirmation.

Item can occur multiple times and contains the services along with their confirmation information.

Item

The item node contains confirmation data with a mandatory reference to a contract item. The reference is handled by specifying the (service) product. In order to do so, fill the SellerID attribute.

Example

 <Product> 
       <SellerID>XYD-0476</SellerID>  
</Product>

If the confirmed product is contained only in one item of the referenced contract, it is sufficient. If not, the item ID (CustomerContractItemID) must be transmitted in addition.

Example

<CustomerContractItemID>30</CustomerContractItemID>
<Product> 
       <SellerID>XYD-0476</SellerID>  
</Product>

Note: You can observe the UI behavior in the item of a new service confirmation. When the contract item reference is added automatically after selecting a product, the product is unique (Product ID is sufficient). Otherwise, the system displays the message : “Item 10: Multiple contract items determined for confirmation item; select one”, and a unique item reference must be selected in a second step.

Recommendation: To be on the safe side, always specify Product and CustomerContractItemID.

Since a product ID is not unique, the Product Type Code must be specified in addition, at least when the same ID is used for more than one product type.

The following product type codes can exist:

Type Code	Description
1	Material
2	Service
3	Individual Material
4	Warranty
6	Entitlement Product

In a service confirmation item, only product type codes 1 and 2 may be used.

Example

<CustomerContractItemID>30</CustomerContractItemID> 
<Product> 
    <SellerID>XYD-0476</SellerID>  
    <TypeCode>2</TypeCode> 
</Product>

If specified, the Description element will enter the confirmation item description. If not, it will be copied from the product.

Example

 <Description>... provided by system</Description>

If specified, the Quantity element together with its unitCode attribute is transmitted into the service confirmation. If omitted, the values are taken from the contract item. For the unitCode attribute, refer to the Common Codes specified in UN/CEFACT Recommendation #20. In general, only a small subset will be applicable for confirming the items in question, depending on the product. Examples for time dimension units are:

HUR	Hours
DAY	Day(s)
WEE	Week

The UI value help for a specific product in an item will show the possible range of units. The corresponding codes can be found in Business Configuration, Quantities and Units of Measure.

Example

 <Quantity unitCode="HUR">1</Quantity>

Remark: If the unitCode attribute is not correct, the service confirmation created will be inconsistent.

For cost accounting purposes, either the ServicePerformerParty or the ResourceID must be available for a service item which is fulfilled internally. If not, the service confirmation created is invalid with the error message “Item nn: Labor resource missing”.

Example

<ServicePerformerParty> 
       <SellerID>XY3626</SellerID>  
</ServicePerformerParty>

<ResourceID>R123</ResourceID>

You can process items to be fulfilled externally in two ways:

Without specifying data through this web service: If you maintain a supplier in the contract item, data is copied from the contract item to the service confirmation item automatically. If maintained, an external service performer is copied, too.
You can specify an external service performer in this operation. The corresponding supplier will be determined automatically in the service confirmation item.

The ActualFulfilmentPeriod contains start and end timepoints. For both, input is expected for the timezone and the timestamp in the following representation:

CCYY-MM-DDThh:mm:ss(.sss)Z

The part (.sss) stands for fractions of seconds and is optional.

The time points are provided in UTC.

Example: 10 am EST with daylight saving time

 <StartDateTime timeZoneCode="EST">2011-07-28T14:00:00Z</StartDateTime>

The ConfirmedDuration element is expected according to the extended representation of ISO 8601 format for time periods. The representation is as follows: PnYnMnDTnHnMnS

Example: P12Y12M2DT4H12M40S

It uses the following literals:

P = denotes the duration and must precede every duration value.

n Y = the number prefix ( n ) is the duration in years

n M = the number prefix ( n ) is the duration in months

n D = the number prefix ( n ) is the duration in days

T = is the prefix for the time period in hours, minutes, and seconds. It is not required if no times are represented.

n H = the number prefix ( n ) is the duration in hours

n M = the number prefix ( n ) is the duration in minutes

n S = the number prefix ( n ) is the duration in seconds

Time values that are not required should not be represented.

Example: P12Y1M

When hours, minutes, and/or seconds are represented, "T" must precede the time values.

Example: PT23H12M or P3Y1MT9H

Example

 <ConfirmedDuration>PT2H30M</ConfirmedDuration>

stands for 2 hours and 30 minutes.

The ConfirmedServiceWorkingConditionsCode describes the working conditions under which the service has been carried out. The code list is maintained in Business Configuration.

Example

TypeCode	Description
01	Overtime
02	Holiday
03	Travel Time

Example of a customer-defined code:

 <ConfirmedServiceWorkingConditionsCode>Z1</ConfirmedServiceWorkingConditionsCode>

The text collection node is described below.

You can finish fulfillment processing of the item for the newly created service confirmation by setting the Finish Fulfilment Processing Requested indicator. It can take the values ‘true’ or ‘false’. If not specified, the value is assumed to be ‘false’.

Example

 <FinishFulfilmentProcessingRequestedIndicator>true</FinishFulfilmentProcessingRequestedIndicator>

Example of an Item segment

 <Item> 
       <CustomerContractItemID>10</CustomerContractItemID>  
       <Description/> 
       <Product> 
           <SellerID>XYD-0476</SellerID> 
           <TypeCode>2</TypeCode> 
       </Product> 
       <Quantity unitCode=" HUR ">1</Quantity>     
       <ServicePerformerParty> 
           <SellerID>XY3626</SellerID>  
       </ServicePerformerParty> 
       <ActualFulfilmentPeriod> 
           <StartDateTime timeZoneCode="EST">2011-10-28T14:00:00Z </StartDateTime>
           <EndDateTime timeZoneCode="EST">2011-10-28T16:00:00Z</EndDateTime>  
       </ActualFulfilmentPeriod> 
       <ConfirmedDuration>PT1H30M</ConfirmedDuration>  
       <ConfirmedServiceWorkingConditionsCode>Z1</ConfirmedServiceWorkingConditionsCode>  
       <ResourceID></ResourceID>  
       <FinishFulfilmentProcessingRequestedIndicator>true</FinishFulfilmentProcessingRequestedIndicator>  
</Item>

Text Collection

You can create the Work Description and / or the Internal Note using the web service using the Text Collection node on top level.

On item level, the Customer Information and / or the Internal Comment can be transferred.

TextCollection can occur only once for the header and every single item.

One TextCollection can contain several texts. (However, in this web service, the number is restricted to two different texts).

The addition actionCode is needed to indicate that a text collection and a text should be created (actionCode="01").

Example

 <TextCollection actionCode="01"> 
   <Text actionCode="01"> 
         ... 
   </Text> 
   <Text actionCode="01"> 
         ... 
  </Text> 
</TextCollection>

Text

The Text node contains information on the text to be created as well as the text itself.

The TypeCode element refers to the text type to be created. The following values can be used:

Text Type Code in Service Confirmation Header:

TypeCode	Description
10011	Internal Note
10022	Work Description

Text Type Code in Service Confirmation Item:

TypeCode	Description
10023	Internal Comment
10024	Customer Information

Attention: If you specify a wrong value, the system will not accept the text. However, the service confirmation is created as consistent.

CreationDateTime is optional. If provided, input is expected as UTC timepoint in the representation

yyyy-mm-ddThh:mm:ss(.s+)?Z

The part (.s+)? stands for fractions of seconds and is optional.

The text itself is added as plain text within the ContentText element.

Example

 <TextCollection actionCode="01"> 
       <Text actionCode="01"> 
       <TypeCode>10022</TypeCode>  
       <CreationDateTime>2011-10-27T10:00:00Z</CreationDateTime>  
       <ContentText>Content of Work Description</ContentText>  
   </Text> 
       <Text actionCode="01"> 
       <TypeCode>10011</TypeCode>  
       <CreationDateTime>2011-10-28T12:00:00Z</CreationDateTime>  
       <ContentText>Content of Internal Note</ContentText>  
  </Text> 
</TextCollection>

Attachment Folder

Using the attachment folder node, you can add one or more attachments to the service confirmation, either URL references or file attachments.

AttachmentFolder can occur only once. It can contain several attachments together with their attributes.

The Document node contains the attachment information.

The addition actionCode is needed to specify that an attachment folder and document shall be created (actionCode="01").

Example

<AttachmentFolder actionCode="01"> 
  <Document actionCode="01"> 
 ...
  </Document> 
</AttachmentFolder>

Document

The PathName element contains the complete name of the folder in which the document is stored and the name of the document itself. In this context, its content is ignored. However, transferring PathName is mandatory, so leave it empty. The system automatically determines a path where the document is stored.

Example

 <PathName />

The Name element contains the name under which the document is to be stored internally.

Transferring this element is mandatory.

SystemAdministrativeData contains information on system users and change dates/times. In this context, its content is ignored. The system automatically determines the data. However, transferring at least CreationDateTime is mandatory. Simply transfer the following part:

<SystemAdministrativeData> 
         <CreationDateTime/>  
</SystemAdministrativeData>

The VisibleIndicator element specifies whether or not the document is visible. It is mandatory even though the content is ignored. Transfer an empty tag

 <VisibleIndicator/>

The same holds true for the VersioningEnabledIndicator which specifies whether or not versioning is activated for the document. This cannot be influenced via this interface, so transfer an empty tag

 <VersioningEnabledIndicator/>

The CategoryCode indicates whether a document is a folder, link, or file:

Category Code	Description
1	Folder
2	Document
3	Link

In this context, values 2 (Document) and 3 (Link) can be used. Entries with category code 1 will not be displayed on the UI.

Example

  <CategoryCode>3</CategoryCode>

The AlternativeName is displayed as Document Title on the UI.

  <AlternativeName>My Document Title</AlternativeName>

Do not use the InternalLinkPathName element.

The Description appears as Comment on the UI. Omit the languageCode addition.

Example

 <Description>My Comment</Description>

Do not use the Property section, it is not used in this context.

Some elements become mandatory, dependent on document category. They are described in the following sections.

Document (with File Content)

You can embed file content into the payload using the following tags:

MIMECode describes the medium type of the binary content according the corresponding MIME type recommendations.

Example

 <MIMECode>text/plain</MIMECode>

Remark: The available MIME codes for attachment upload can be restricted by business configuration in the activity Allowed MIME Types for Document Upload. Usage of a MIME type that is not allowed does not become visible immediately. A consistent service confirmation is created, however the attachment does not contain the data. Therefore, we recommend that you check the allowed MIME types first.

FileSizeMeasure can be omitted completely. The file size is determined correctly by the system.

FileContentBinaryObject contains the binary content itself. It must be encoded in Base64 format.

The mimeCode and fileName additions are optional.

Example

 <FileContentBinaryObject mimeCode="text/plain" fileName="test.txt">Q29uZ3JhdHVsYXRpb25zISBXaGVuIHlvdSByZWFkIHRoaXMsIHRoZSB1cGxvYWQgd2FzIH
N1Y2Nlc3NmdWwu</FileContentBinaryObject>

The Attachment tag is not used and can be ignored.

Do not use the FileContentURI tag, it is not used in this context.

Link

Instead of file content, a link can be added. In this case, the ExternalLinkWebURI element must be provided.

Example

  <ExternalLinkWebURI>http://qwertjkl/anyURI</ExternalLinkWebURI>

The first document references a URL, the second contains a plain text file content.

<AttachmentFolder actionCode="01"> 
    <Document actionCode="01"> 
       <PathName />  
       <Name>link name</Name>  
       <SystemAdministrativeData> 
         <CreationDateTime/>  
       </SystemAdministrativeData> 
       <VisibleIndicator/>  
       <VersioningEnabledIndicator/>  
       <CategoryCode>3</CategoryCode>  
       <AlternativeName>link title</AlternativeName>  
       <Description languageCode="EN">link comment</Description>  
       <ExternalLinkWebURI> http://qwertjkl/anyURI</ExternalLinkWebURI>  
    </Document> 
    <Document actionCode="01"> 
       <PathName />  
       <Name>test.txt</Name>  
       <SystemAdministrativeData> 
         <CreationDateTime/>  
       </SystemAdministrativeData> 
       <VisibleIndicator/>  
       <VersioningEnabledIndicator/>  
       <CategoryCode>2</CategoryCode>  
       <MIMECode>text/plain</MIMECode>  
       <AlternativeName>test file</AlternativeName>  
       <Description languageCode="EN">My comment for the test file</Description>
       <FileContentBinaryObject mimeCode="text/plain" fileName="test.txt">Q29uZ3JhdHVsYXRpb25zISBXaGVuIHlvdSByZWFkIHRoaXMsIHRoZSB1cGxvYWQgd2FzIH
N1Y2Nlc3NmdWwu</FileContentBinaryObject> 
    </Document> 
</AttachmentFolder>

Example

Confirm service execution for product XRD-1 for 1 hour, 20 minutes, and finish fulfillment processing for the new service confirmation:

  <n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> 
  <MessageHeader> 
    <ID />  
    <UUID />  
    <CreationDateTime />  
    <SenderBusinessSystemID>ESPACS</SenderBusinessSystemID> 
    <RecipientBusinessSystemID>_LOCAL_SYSTEM_ALIAS_SAP_INTERNAL_CONSTANT_VALUE_</RecipientBusinessSystemID>  
    <BusinessScope> 
        <TypeCode listAgencyID="310" listID="25201">2</TypeCode>  
        <ID schemeAgencyID="310" schemeID="10555">8</ID>  
    </BusinessScope> 
    <BusinessScope> 
        <TypeCode listAgencyID="310" listID="25201">3</TypeCode>  
        <ID schemeAgencyID="310" schemeID="10555">345</ID> 
    </BusinessScope> 
  </MessageHeader> 
  <ExternalServicePerformingAndChargingSystemServiceConfirmation> 
    <CustomerContractID>XY535</CustomerContractID>  
      <Name>Confirming Remote Diagnostics</Name>  
      <Item> 
        <CustomerContractItemID>20</CustomerContractItemID>  
        <Description />  
        <Product> 
            <SellerID>XRD-1</SellerID>  
        </Product> 
        <Quantity unitCode="HUR">1</Quantity>  
        <ConfirmedDuration>PT1H20M</ConfirmedDuration>  
        <ResourceID>XM-TEN001</ResourceID>         
        <FinishFulfilmentProcessingRequestedIndicator>true</FinishFulfilmentProcessingRequestedIndicator>  
      </Item> 
  </ExternalServicePerformingAndChargingSystemServiceConfirmation> 
</n0:ExternalServicePerformingAndChargingSystemServiceConfirmationCreateRequest>

Inbound Service ExternalServicePerformingAndChargingSystemRequestServiceConfirmationMaintenanceIn

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Prerequisites

Constraints and Integrity Conditions

General Rules for Using This Web Service

Action Code

Language Code

More Information

General Information

Scenarios

Operation Create Service Confirmation

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Structure

Item

Text Collection

Text

Attachment Folder

Document

Document (with File Content)

Link

Example