BTP SAP Integration Suite

https://sapintegrationhub.com/sap-integration-suite
Admin
BTP SAP Integration Suite provides articles and guides on various aspects of SAP Business Technology...
Tokens:8,690
Snippets:104
Trust Score:8.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Incoming XML Message for Order Data

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

This is an example of an XML message representing sales order information. It includes header, customer, shipping, item, and totals details, which can be validated against a corresponding XSD schema.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<SalesOrder>
    <!-- ===== Order Header ===== -->
    <Header>
        <CustomerID>VINET</CustomerID>
        <OrderDate>1996-07-04T00:00:00Z</OrderDate>
        <ShippedDate>1996-07-16T00:00:00Z</ShippedDate>
        <DocumentCurrency>EUR</DocumentCurrency>
        <PurchaseOrderNumber>PO-458922</PurchaseOrderNumber>
        <OrderStatus>Confirmed</OrderStatus>
    </Header>
    <!-- ===== Customer Information ===== -->
    <CustomerDetails>
        <CustomerName>Vins et alcools Chevalier</CustomerName>
        <ContactPerson>Jean Dupont</ContactPerson>
        <Email>contact@vins-chevalier.fr</Email>
        <Phone>+33-320-556-789</Phone>
        <BillingAddress>
            <AddressLine1>59 rue de l\'Abbaye</AddressLine1>
            <City>Reims</City>
            <PostalCode>51100</PostalCode>
            <Country>France</Country>
        </BillingAddress>
    </CustomerDetails>

    <!-- ===== Shipping Information ===== -->
    <ShippingDetails>
        <ShipMethod>Express</ShipMethod>
        <ShipVia>3</ShipVia>
        <Freight>32.38</Freight>
        <ShipTo>
            <ShipName>Vins et alcools Chevalier</ShipName>
            <ShipAddress>59 rue de l\'Abbaye</ShipAddress>
            <ShipCity>Reims</ShipCity>
            <ShipRegion></ShipRegion>
            <ShipPostalCode>51100</ShipPostalCode>
            <ShipCountry>France</ShipCountry>
        </ShipTo>
    </ShippingDetails>

    <!-- ===== Item/Order Lines ===== -->
    <Items>
        <Item>
            <LineNumber>1</LineNumber>
            <MaterialID>SKU-1001</MaterialID>
            <Description>Red Wine Premium</Description>
            <Quantity>50</Quantity>
            <Unit>EA</Unit>
            <UnitPrice>15.00</UnitPrice>
            <Discount>0.10</Discount>
            <NetAmount>675.00</NetAmount>
        </Item>

        <Item>
            <LineNumber>2</LineNumber>
            <MaterialID>SKU-2450</MaterialID>
            <Description>Champagne Brut</Description>
            <Quantity>20</Quantity>
            <Unit>EA</Unit>
            <UnitPrice>35.00</UnitPrice>
            <Discount>0.00</Discount>
            <NetAmount>700.00</NetAmount>
        </Item>
    </Items>

    <!-- ===== Order Summary ===== -->
    <Totals>
        <SubTotal>1375.00</SubTotal>
        <Tax>206.25</Tax>
        <ShippingCharges>32.38</ShippingCharges>
        <GrandTotal>1613.63</GrandTotal>
    </Totals>
</SalesOrder>

```

--------------------------------

### Valid XML Payload for Order Header

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

An example of a valid XML payload for an order header, including all mandatory elements and some optional ones.

```XML
    <!-- ===== Order Header ===== -->
    <Header>
        <OrderID>0001</OrderID>
        <CustomerID>VINET</CustomerID>
        <OrderDate>1996-07-04T00:00:00Z</OrderDate>
        <DocumentCurrency>EUR</DocumentCurrency>
        <PurchaseOrderNumber>PO-458922</PurchaseOrderNumber>
        <OrderStatus>Confirmed</OrderStatus>
    </Header>
```

--------------------------------

### Valid XML Payload Omitting Optional Elements

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

An example of a valid XML payload for an order header where optional elements like ShippedDate and RequiredDate are omitted.

```XML
    <!-- ===== Order Header ===== -->
    <Header>
       <CustomerID>VINET</CustomerID>
        <OrderDate>1996-07-04T00:00:00Z</OrderDate>
        <DocumentCurrency>EUR</DocumentCurrency>
        <PurchaseOrderNumber>PO-458922</PurchaseOrderNumber>
        <OrderStatus>Confirmed</OrderStatus>
    </Header>
```

--------------------------------

### XSD Schema for Order Header with Optional Elements

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

Defines the structure of an order header, specifying mandatory elements like OrderID and optional elements like RequiredDate and ShippedDate using minOccurs.

```XML
    <!-- ========= Header Segment ========= -->
    <xs:complexType name="HeaderType">
        <xs:sequence>
            <xs:element name="OrderID" type="xs:string"/>
            <xs:element name="CustomerID" type="xs:string"/>
            <xs:element name="OrderDate" type="xs:dateTime"/>
            <xs:element name="RequiredDate" type="xs:dateTime" minOccurs="0"/>
            <xs:element name="ShippedDate" type="xs:dateTime" minOccurs="0"/>
            <xs:element name="DocumentCurrency" type="xs:string"/>
            <xs:element name="PurchaseOrderNumber" type="xs:string" minOccurs="0"/>
            <xs:element name="OrderStatus" type="xs:string" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>
```

--------------------------------

### XSD Schema for Message Structure with Sequence

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

Defines the structure of a SalesOrder, enforcing a specific sequence for its child elements: Header, CustomerDetails, ShippingDetails, Items, and Totals.

```XML
<xs:element name="SalesOrder">
<xs:complexType>
<xs:sequence>
<xs:element name="Header" type="HeaderType"/>
<xs:element name="CustomerDetails" type="CustomerDetailsType"/>
<xs:element name="ShippingDetails" type="ShippingDetailsType"/>
<xs:element name="Items" type="ItemsType"/>
<xs:element name="Totals" type="TotalsType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
```

--------------------------------

### Sales Order XSD Schema

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

This XSD schema defines the structure for an XML message representing a sales order, including header, customer details, shipping information, line items, and totals. Use this schema to validate incoming XML data before processing.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           elementFormDefault="qualified">

    <!-- ========= Root Element ========= -->
    <xs:element name="SalesOrder">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Header" type="HeaderType"/>
                <xs:element name="CustomerDetails" type="CustomerDetailsType"/>
                <xs:element name="ShippingDetails" type="ShippingDetailsType"/>
                <xs:element name="Items" type="ItemsType"/>
                <xs:element name="Totals" type="TotalsType"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <!-- ========= Header Segment ========= -->
    <xs:complexType name="HeaderType">
        <xs:sequence>
            <xs:element name="OrderID" type="xs:string"/>
            <xs:element name="CustomerID" type="xs:string"/>
            <xs:element name="OrderDate" type="xs:dateTime"/>
            <xs:element name="RequiredDate" type="xs:dateTime" minOccurs="0"/>
            <xs:element name="ShippedDate" type="xs:dateTime" minOccurs="0"/>
            <xs:element name="DocumentCurrency" type="xs:string"/>
            <xs:element name="PurchaseOrderNumber" type="xs:string" minOccurs="0"/>
            <xs:element name="OrderStatus" type="xs:string" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>

    <!-- ========= Customer Info ========= -->
    <xs:complexType name="CustomerDetailsType">
        <xs:sequence>
            <xs:element name="CustomerName" type="xs:string"/>
            <xs:element name="ContactPerson" type="xs:string" minOccurs="0"/>
            <xs:element name="Email" type="xs:string" minOccurs="0"/>
            <xs:element name="Phone" type="xs:string" minOccurs="0"/>
            <xs:element name="BillingAddress" type="BillingAddressType"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="BillingAddressType">
        <xs:sequence>
            <xs:element name="AddressLine1" type="xs:string"/>
            <xs:element name="City" type="xs:string"/>
            <xs:element name="PostalCode" type="xs:string"/>
            <xs:element name="Country" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>

    <!-- ========= Shipping Details ========= -->
    <xs:complexType name="ShippingDetailsType">
        <xs:sequence>
            <xs:element name="ShipMethod" type="xs:string" minOccurs="0"/>
            <xs:element name="ShipVia" type="xs:int"/>
            <xs:element name="Freight" type="xs:decimal" minOccurs="0"/>
            <xs:element name="ShipTo" type="ShipToType"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="ShipToType">
        <xs:sequence>
            <xs:element name="ShipName" type="xs:string"/>
            <xs:element name="ShipAddress" type="xs:string"/>
            <xs:element name="ShipCity" type="xs:string"/>
            <xs:element name="ShipRegion" type="xs:string" minOccurs="0"/>
            <xs:element name="ShipPostalCode" type="xs:string"/>
            <xs:element name="ShipCountry" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>

    <!-- ========= Line Items ========= -->
    <xs:complexType name="ItemsType">
        <xs:sequence>
            <xs:element name="Item" type="ItemType" minOccurs="1" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="ItemType">
        <xs:sequence>
            <xs:element name="LineNumber" type="xs:int"/>
            <xs:element name="MaterialID" type="xs:string"/>
            <xs:element name="Description" type="xs:string"/>
            <xs:element name="Quantity" type="xs:decimal"/>
            <xs:element name="Unit" type="xs:string"/>
            <xs:element name="UnitPrice" type="xs:decimal"/>
            <xs:element name="Discount" type="xs:decimal" minOccurs="0"/>
            <xs:element name="NetAmount" type="xs:decimal"/>
        </xs:sequence>
    </xs:complexType>

    <!-- ========= Totals ========= -->
    <xs:complexType name="TotalsType">
        <xs:sequence>
            <xs:element name="SubTotal" type="xs:decimal"/>
            <xs:element name="Tax" type="xs:decimal"/>
            <xs:element name="ShippingCharges" type="xs:decimal" minOccurs="0"/>
            <xs:element name="GrandTotal" type="xs:decimal"/>
        </xs:sequence>
    </xs:complexType>

</xs:schema>
```

--------------------------------

### Incoming Sales Order Message Format

Source: https://sapintegrationhub.com/sap-integration-suite/idempotent-process-call-btp-sap-integration-suite

This XML structure represents the incoming sales order message. The OrderID field serves as the unique identifier for ensuring idempotency.

```xml
<?xml version="1.0" encoding="UTF-8" ?>
 <Order>
     <OrderID>10250</OrderID>
     <CustomerID>VINET</CustomerID>
     <EmployeeID>5</EmployeeID>
     <OrderDate>1996-07-04T00:00:00Z</OrderDate>
     <RequiredDate>1996-08-01T00:00:00Z</RequiredDate>
     <ShippedDate>1996-07-16T00:00:00Z</ShippedDate>
     <ShipVia>3</ShipVia>
     <Freight>32.38</Freight>
     <ShipName>Vins et alcools Chevalier</ShipName>
     <ShipAddress>59 rue de l\'Abbaye</ShipAddress>
     <ShipCity>Reims</ShipCity>
     <ShipRegion></ShipRegion>
     <ShipPostalCode>51100</ShipPostalCode>
     <ShipCountry>France</ShipCountry>
 </Order>
```

--------------------------------

### Define Allowed Order Statuses with Enumeration

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

This XSD snippet defines a simple type 'OrderStatusEnum' that restricts the 'OrderStatus' element to a predefined list of valid string values. Use this to ensure only specific statuses are accepted.

```XML
<xs:simpleType name="OrderStatusEnum">
    <xs:restriction base="xs:string">
        <xs:enumeration value="New"/>
        <xs:enumeration value="Pending"/>
        <xs:enumeration value="Processing"/>
        <xs:enumeration value="Shipped"/>
        <xs:enumeration value="Delivered"/>
        <xs:enumeration value="Cancelled"/>
        <xs:enumeration value="Returned"/>
        <xs:enumeration value="On Hold"/>
    </xs:restriction>
</xs:simpleType>

<!-- ========= Header Segment ========= -->
<xs:complexType name="HeaderType">
    <xs:sequence>
        <xs:element name="OrderID" type="xs:string"/>
        <xs:element name="CustomerID" type="xs:string"/>
        <xs:element name="OrderDate" type="xs:dateTime"/>
        <xs:element name="RequiredDate" type="xs:dateTime" minOccurs="0"/>
        <xs:element name="ShippedDate" type="xs:dateTime" minOccurs="0"/>
        <xs:element name="DocumentCurrency" type="xs:string"/>
        <xs:element name="PurchaseOrderNumber" type="xs:string" minOccurs="0"/>
        <xs:element name="OrderStatus" type="OrderStatusEnum" minOccurs="0"/>
    </xs:sequence>
</xs:complexType>
```

--------------------------------

### XSD Pattern for Email Validation

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

Defines a simple type for an Email element using a restriction with a pattern to validate email address format.

```XML
<xs:element name="Email" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
```

--------------------------------

### Validate Numeric Range for Quantity

Source: https://sapintegrationhub.com/sap-integration-suite/validate-incoming-messages-xml-validator-sap-integration-suite

This XSD snippet defines a simple type for the 'Quantity' element, restricting its decimal value to be between 1 and 1000, inclusive. Use this to enforce valid numeric ranges for quantities.

```XML
<xs:element name="Quantity">
    <xs:simpleType>
        <xs:restriction base="xs:decimal">
            <xs:minInclusive value="1"/>
            <xs:maxInclusive value="1000"/>
        </xs:restriction>
    </xs:simpleType>
</xs:element>
```
Tokens:
Raw