Microsoft
OEM Shipment Transaction
Implementation Guide
RosettaNet
VERSION 1.5
July 1, 2003
1
Table of Contents
1.
INTRODUCTION .......................................................................................................................................................................... 3
1.1.
OVERVIEW ............................................................................................................................................................................... 3
1.2.
BACKGROUND ......................................................................................................................................................................... 3
1.3.
FILE TRANSFER FORMAT AND TRANSPORT.............................................................................................................................. 3
1.3.1 Transport ................................................................................................................................................................................. 3
1.3.2 Format .................................................................................................................................................................................... 3
1.4.
DATA TRANSFER ..................................................................................................................................................................... 3
1.4.1. File Transfer ...................................................................................................................................................................... 3
1.4.2. Data Elements and Controls .............................................................................................................................................. 4
1.4.3. Shipment and Receipt Confirmation .................................................................................................................................. 4
1.4.4. Date Formats: .................................................................................................................................................................... 4
1.4.5. Confirmation File ............................................................................................................................................................... 4
1.4.6. Subsidiary Companies........................................................................................................................................................ 4
1.4.7. Rejected Files ..................................................................................................................................................................... 5
1.4.8. Error Handling.................................................................................................................................................................. 5
1.5.
TIER 1 SUPPORT ....................................................................................................................................................................... 6
1.6.
CONVENTIONS ......................................................................................................................................................................... 6
1.7.
CONTACTS ............................................................................................................................................................................... 6
2.
ARCHITECTURE ......................................................................................................................................................................... 7
3.
TRANSPORT OPTIONS .............................................................................................................................................................. 8
3.1.
HTTPS..................................................................................................................................................................................... 8
3.1.1. Internet access for AR’s and SPV’s .................................................................................................................................... 8
3.2.
EXTRANET DIRECT SHARE ...................................................................................................................................................... 8
3.2.1. Summary ............................................................................................................................................................................ 8
3.2.2. Move Reports ..................................................................................................................................................................... 8
3.2.3. Security .............................................................................................................................................................................. 8
4.
TRANSACTION SPECIFICATIONS .......................................................................................................................................... 9
4.1.
4.2.
5.
TRANSACTION SAMPLES ....................................................................................................................................................... 14
5.1.
5.2.
5.3.
6.
SHIPMENT TRANSACTION ........................................................................................................................................................ 9
APPLICATION CONFIRMATION ............................................................................................................................................... 13
SOAP ENVELOPES................................................................................................................................................................. 14
SHIPMENT TRANSACTION ...................................................................................................................................................... 14
APPLICATION CONFIRMATION ............................................................................................................................................... 19
APPENDIX ................................................................................................................................................................................... 20
6.1.1.
Change Control Updates of the document date on the cover will not be repeatedly noted here. .................................... 20
2
1. Introduction
1.1.
Overview
This transaction is a request for electronic data integration with OEM business partners for the COA tracking system.
This transaction will provide an automated data feed of COA POD system shipment transactions to selected large
multinational OEM manufacturer customers of Microsoft Licensing. The objective is to allow the OEMs to import the
shipment transaction data related to their own recent shipments, in an automated electronic feed, to provide internal
shipment reconciliation with their own systems.
The e*BIS Gateway is a service offering at Microsoft that provides messaging services to internal applications and
external trading partners. Our services include, but are not limited to, data transformation for disparate formats (XML,
EDI, IDOCs, Proprietary Flat Files, etc…), data transport using various communications methods (FTP, HTTPs,
MSMQ, Files Shares, etc…), error handling and notification, tracking, operations support, and more.
The e*BIS gateway does not check for duplicate transactions nor does it guarantee first in first out transaction
processing.
1.2.
Background
The definition of a ‘shipment’ as they will be reflected to the OEM through this b-b exchange, is based on the
architecture of the COA tracking system – which only approximately matches the concept of a shipment as logically
understood. Shipment transactions are received by Microsoft, and forwarded to the OEM, as they are created by the
AR sites’ local COA system. It is important to note that the AR generating the shipping events has considerable
latitude how they package and ships the COAs, and therefore how the shipment transactions are ranged; this will
determine the make up of the COAs within the shipment transactions forwarded to the OEM.
1.3.
File Transfer Format and Transport
All subscribers to this data integration service must use one of the following transports and formats:
1.3.1 Transport
1) 128 Bit HTTPs protocol. (Preferred)
2) VPN (virtual private networking) Extranet share
3) Lease Line Access to VPN (only when approved by MSLI)
1.3.2 Format
Data transfers between OEM and Microsoft will be in XML format using one of the following standards
1) xCBL (XML Common Business Library) (Preferred)
2) RoseettaNet 3B2 v01
See also the e*BIS implementation guides for additional details.
1.4.
Data Transfer
A new internal COA shipment event will be generated (not on a timed subscription basis as previously discussed) by
ICE. Each file will be targeted at a specific OEM. This will be sent to the OEM in near real time and includes
shipments for all of their ship-to sites, giving the OEM the flexibility to rollup site information as they see fit. One file
will be sent to the OEM for each shipment transaction received by Microsoft from the AR. There will be no combining
of shipment transactions for the purposes of this transaction sent to the OEM.
1.4.1. File Transfer
The shipment transaction is structured by the software at the ARs site. The following rules apply to how the
transaction is constructed that will generate the shipment transaction:

The shipment transaction will be sent within 1 hour of receiving the 2700 transaction from the AR.
3

A file may contain one or more orders for the same OEM customer. Although this is facilitated by the data
structures passed to e*BIS, by the implementation date the COA system is expected to have removed
all shipment transactions of this type and only support simple shipment transactions that apply to a
single order and product.

A file may contain all or only part of a physical shipment sharing the same courier tracking number.

There is no footer or control transaction indicating how many files correspond to an order or a shipment.

The common properties of each COA range within each file are the OEM sold to, the Ship to Site and the
Stock type (Physical COA size). And by implementation date, the order number and the part number.

It is expected that there will not be repeating fields within a single shipment transaction; however the
format of the fields below accommodates that format if needed in the future.
1.4.2. Data Elements and Controls
The data to be sent to the OEM’s will be sent out as a single XML file that has a header section that contains
information unique to the file and a detail section. The source for all fields is the COA Database.
Note that this list contains only fields passed to e*BIS. e*BIS will add and format fields into the interface format
selected by the OEM partner. They will also add a date time field specifying the date stamp of the transaction file
generation.
All date fields will be in ISO 8601 format.
1.4.3. Shipment and Receipt Confirmation
When shipments are RECEIVED by the third party installer they may be recorded in MOO as received. Optionally
a subscriber to this feed can select to receive further shipment transactions with the 3 receipt detail fields
completed. The original shipment fields remain unchanged but are still included. Only OEM that participates in the
MOO COA Receipt application can use this feature. It is triggered by a 2750 event. This receipt applies to the
entire shipped COA range, and does not report on the specific COA range received within the range reported
shipped. Rolling Total field will range between zero and the total quantity of the original shipment transaction.
However the last received quantity may be negative if a correction is entered.
1.4.4. Date Formats:
Date formats will be in the following format (ISO 8601 Format minus the local time offset from GMT).
Example: 2000-10-29T10:30:15-08:00 (local time off set is 8 hrs behind GMT)
Note that the UTC to local offset will be based on the location of the AR that shipped and sent the transaction, not
the OEM location.
1.4.5. Confirmation File
The partner OEM will produce a confirmation file and send it back to Microsoft Corporation. This file indicates
positive confirmation that the scheduled outbound file is successfully received at the OEM by the receiving
application (note – this is neither a receiving tool nor a translator confirmation). The OEM will not send a file if the
OEM does not successfully receive the file, or if the file is corrupted to the point that it is unreadable.
The OEM should not withhold the confirmation file if the contents of the shipment file are disputed or otherwise
readable but considered in any other way invalid. Rejections of file and error handling features, other than
described here, are not accommodated by this system. The confirmation file does not accommodate error codes.
No high level validation will be performed on the confirmation file by Microsoft. An invalid confirmation file will be
rejected (no special handling) and ignored. It will not be written to the database. The original shipment notification
will be sent again as a result, and finally the escalation process will be followed for confirmation not received.
Basic validation will be performed that all required fields are present by e*BIS BizTalk instance.
1.4.6. Subsidiary Companies
Where an OEM has subsidiary companies with separate contracts, and therefore distinct SAP Sold To IDs, they
will be set up as a common feed subscription if requested. The companies will share the same extranet point, but
the data will not be co-mingled within the shipment transaction. Separate shipment transaction files will be
generated for each sold to for each shipment transaction.
4
1.4.7. Rejected Files
If an OEM discovers an error in a readable file sent by Microsoft, a manual support process to request correction
of the error and a resend of the file will be implemented by requesting Microsoft production support assistance at
Microsoft Licensing. The mail alias is COAHelp@Microsoft.com.
1.4.8. Error Handling
This grid gives a summary of the error handling that e*BIS and the backend processing will perform:
Error Resolution Grid
Condition
Description
Example
Resolution
Partners Web site
cannot be acessed
(Https implementation)
MSFT attempts to send
XML file to partner web site
without receiving a 202
acknowledgement back
after all the retries have
failed.
The OEM succussfully
received the outbound file
but MSFT doesn’t get a
confirmation file back
e*BIS notifies Tier 2. Tier 2
then contacts the OEM.
Three retires are made.
Confirmation file not
received back from the
OEM within 24 hours.
1.4.8.1
A bach process resends the
outbound file to the OEM.
Three retries are made.
e*BIS Error handling (https transport only)
The following is an excerpt from HTTPS Implementation Guideline from the e*BIS group. It describes
how they will handle transport issues when Microsoft is unable to connect to the OEM’s website.
If a code of "406 Not Acceptable" is returned or a "202 Accepted" is not returned (per the HTTP/s
Requirements above) from the partner's receiving web application, the e*BIS gateway will attempt to send
the data again. Re-sending will occur until a "202 Accepted" code is returned from the partner's web
application, the number of retries may vary from implementation to implementation. We currently will
attempt 8 retries, one every 15 minutes.
If a connection cannot be established with the partner's web site, the appropriate MS contacts by e-mail
will be notified that a transport error has occurred and they will contact the trading partner.
1.4.8.2
Backend Error processing
When e*BIS has successfully sent the file via https, or the file has been delivered to the extranet share
point, but a confirmation file does not come back from the OEM site, the following takes place:

A scheduled database process identifies all files where a confirmation file is not received after 24
hours. This time period is configurable and can be changed by MSLI Tier 2 production support.

The missing file will be resent. A resend will be the stored original transaction.

When a file is resent, a notification e-mail is sent to MSLI Tier 2 and to a support e-mail at the OEM
site.

If the file cannot be sent after 3 attempts, an escalation e-mail goes out to Tier 2 and to the OEM’s
support e-mail address. The issue will then be handled by production support.

In the event that a valid and appropriate order is missing, or cannot be located this application should
generate an error notification e-mail and not send the shipment transaction until the error is resolved.
5
The system will allow for a configurable number of resends at a configurable time for each OEM
subscriber.
1.4.8.3
E-Mail Format
Mail notifications are generated when any of the following occur:
1) The shipment transaction cannot be generated - error
2) The confirmation file is not returned within the specified time period - warning
3) The https transport returns an error code when attempting to transfer the shipment transaction error
4) The shipment transaction resend attempt fail. – Warning.
The mail format should consist of the following:

The date and source of the mail

A subject line indicating error or warning. See above for the severity

The description noted above for the type of error.

That the mail relates to passing the shipment transaction and receipt information to an
OEM subscriber.
The mail alias is COAHelp@Microsoft.com.
1.4.8.4
Frequency and Timing
File transfers will take place for only those OEM’s that have subscribed to this service. The outbound
is sent in near real time, and contains information on a single shipment (shipment as defined by the
COA system).
1.5.
Tier 1 Support
No support beyond basic file transfer mechanics will be provided by Microsoft. When support on their subscription is
requested, such as on the information contained in received files, the Accounting Services Group will be contacted at
the mail alias MSLIMN@Microsoft.com.
No level of support is promised in the document regarding:

Service level agreement

Level of support

The hours support is available
It is expected that weekend and after hours support will not be available.
1.6.



Conventions
In the file specifications in sections 2 an ‘R’ will indicate Required, a ‘O’ will indicate the field is optional but
processed and a ‘blank’ will indicate that the field is not used for the event.
Date formats must be 2000-10-29T10:30:15-nn:nn, which is in ISO 8601 format; which is GMT minus the local
time offset.
Grey shading indicates the beginning of a potential loop.
1.7.
Contacts
Microsoft e*BIS
Peter J. Puccio III
Microsoft - e*BIS Project Manager
ppuccio@microsoft.com
(425) 707-5120
Microsoft Program Manager
Duncan Chalmers
Microsoft - Senior Program Manager
duncanc@microsoft.com
(425)705-9422
6
2. Architecture
This diagram assumes HTTPs:
OEM Shipment View System Dataflow
E*BIS
COA Database
Notify MSMQ
BizTalk
Server
Inbound
MSMQ
ICE Database
OEM Web
Server
XML
Over HTTPs
XML
ASP Page
XML
ICE Inbound
MSMQ
XML
7
E*BIS ASP
Page
XML
Shipping
Confirmation
3. Transport Options
3.1.
HTTPs
The following outline identifies a high level summary of the processing steps necessary to ensure that messages
posted via HTTPS to a web site are consumed and that proper notification is given back to the sending HTTPS server
that the bytes have been received: (obtain complete HTTPs implementation guide for details)
ASP Scripts that process incoming HTTPs posts for XML data should follow these basic steps:
1. Remove all ResponseWrite statements used for debugging or application-level processing.
2. Use BinaryRead from Request object. -----> EntityBody = Request.BinaryRead (Request.TotalBytes)
3. Immediately persist the data (submit to B2B server, write to disk file, send to queue, etc.).
4. If numberOfBytes = 0 or Step 3 fails, return Response.Status = “406 Not Acceptable”, otherwise, return
Response.Status = “202 accepted”.
5. Continue with application-level processing.
It is imperative that no application-level processing be done prior to an HTTPs response. This response is transport
level only – in other words, “We received the bytes you sent”. Any further validation of the data and subsequent error
notification must be handled by the downstream application.
HTTPs transport requires wrapping add transactions in a SOAP envelope. The confirmation must be wrapped in a
SOAP envelope for the direct share transport option as well. (See sample data in appendix)
3.1.1. Internet access for AR’s and SPV’s
In order to exchange data with Microsoft over the Internet you will need to obtain a 128-bit system certificate. This
will enable your system to send and receive transactions securely using SSL (HTTP/s).
3.2.
Extranet Direct Share
3.2.1. Summary
Direct Share provides the ability for trading partners to establish a direct connection to Microsoft’s partner
extranet for the purpose of business data exchange. Traditional EDI, XML and proprietary formats can be
traded. The trading partner will utilize the Internet to access the partner extranet share through either a
PPTP connection or a browser using SSL (obtain complete implementation guide for details).
3.2.2. Move Reports
Microsoft writes a report every few minutes which summarizes what has been sent and received for the
past 7 days (configurable up to 14 days) to enable reconciliation that what has been sent ‘was received in
both directions. This report is written in the ‘reports’ directory and is named ‘MoveRptsTest.csv’ or
‘MoveRptsProd.csv’ appropriately. It is a comma delimited file.
Example Move Reports File:
Filename
TimeZone
Direction
Description
OEMCompany800020011217@173533.xml
FileSize
7583
EBISCode
obi8000
EBISFileTransferTime
12/17/2001 17:35
GMT
FromEBIS
Outbound Transaction
OEMCompany800220011217@173548.xml
5934
obi8002
12/18/2001 17:35
GMT
ToEBIS
Inbound Transaction
It is the responsibility of the OEM to reconcile and verify that what was sent has been received in
both directions.
3.2.3. Security



Trading partners connecting must be using 128-bit encryption.
PPTP also provides an encrypted session between PPTP client (Windows 3.x, Windows 95, Windows
98, Millennium, Windows NT, Windows 2000 and Macintosh) and a PPTP server (Windows 2000
server).
Access privileges for the Direct Share folders are granted only to e*BIS and the respective trading
partner.
8
4. Transaction Specifications
4.1.
Shipment Transaction
According to the RosettaNet PIP 3B2 standards individual xml fields have no maximum length.
The field lengths specified here matches the Microsoft applications requirements.
Note: The RosettaNet standard is to identify entities with DUNs numbers. Therefore we are not mapping the OEM
Sold To Name. The DUNs number for the OEM Sold To are sent and the name can be derived from the ID.
Type /
Size
TAGS NAMES
Pip3B2AdvanceShipmentNotification
MS Field Name
(Comments)
Attribute
or
Element
M
I
n
M
a
x
Usage
(root node)
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
AdvancedShipmentNotification
BuyingPartner
purchasedBy
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
9 num
“DUNs #”
(conversion from OEM Sold
To ID)
OriginatingPartner
shipFrom
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
9 num
“Microsoft’s DUNs #”
E
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
E
R
ContactInformation
E
1
1
R
contactName
E
1
1
R
1
1
FreeFormText
100 char
AR Name
PhysicalAddress
GlobalLocationIdentifier
E
10 num
AR Site ID
SellingPartner
soldBy
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
A
9 num
“Microsoft’s DUNs #”
Shipment
E
20 char
GlobalShippingServiceLevelCode
1
1
R
1
1
R
E
1
1
R
E
1
1
R
E
E
“Regular”
E
E
“1”
CountableAmount
Receiving Partner
Shipto
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
9 num
“DUNs #”
(conv from OEM Sold To ID)
R
E
Courier Name
numberOfShippingContainers
R
E
E
GlobalCarrierCode (SCAC)
R
R
1
1
R
R
R
1
1
E
R
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
E
R
ContactInformation
E
1
1
R
contactName
E
1
1
R
9
FreeFormText
255 char
Ship To Name
PhysicalAddress
addressLine1
FreeFormText
255 char
GlobalLocationIdentifier
Ship to Name Location
Ship To ID
(not a DUNs #)
regionName
FreeFormText
ShipmentIdentifier.ProprietaryReferenceIdentifier
R
1
1
R
36 char
R
E
1
*
R
E
1
1
R
Code=Dock
E
1
*
R
E
1
1
R
E
R
E
R
(begin detail section)
E
1
*
R
E
1
1
R
Event UUID
Beginning COA Number
LotShipReference
E
1
1
R
E
1
*
R
E
R
E
R
O
E
O
O
E
O
TotalRecdQuantity
E
“Group”
E
E
ProprietaryDocumentIdentifier
14 num
ProprietaryDocumentIdentifier
10
O
O
O
O
1
1
O
“LastReceiptQuantity”
E
O
“Beginning”
E
R
E
R
Ending COA Number
E
R
“Ending”
E
“N”
PartnerProductIdentification
*
O
E
ProductIdentification
1
O
E
isContainsHazardousMaterial
AffirmationIndicator
1
TotalRecdQuantity
Delivery
“PurchaseOrder”
Note
GlobalDocumentReferenceTypeCode
1
E
Event Date 2
LotQuantity
ProprietaryLotIdentifier
O
E
E
14 num
1
TotalRecdQuantity
LotShipReference
GlobalProductUnitOfMeasureCode
1
“QuantityReceivedToDate”
E
DT.tz
O
E
shippedLotQuantity
14 num
*
“Group”
E
14 num
1
Event Date 2
LotQuantity
ProprietaryLotIdentifier
R
E
E
DT.tz
R
E
Ship Date
Delivery
“PurchaseOrder”
Note
GlobalProductUnitOfMeasureCode
R
Code=Ship
DocumentSubLineLotShipReference
14 num
1
E
ShippingContainerItem
GlobalDocumentReferenceTypeCode
1
Event Date
shippingContainerIdentifier
LineNumber
E
E
(will only send one detail)
ProductQuantity
R
R
DT.tz
ExpiryDate.DateStamp
R
R
GlobalTransportEventCode
ProductQuantity
1
E
TransportationEvent
ProductQuantity
1
A
A
GlobalTransportEventCode
ExpiryDate.DateStamp
E
Event UUID
scheduledEvent
LineNumber
R
Unique Site ID for OEM site
DT.tz
ProprietarySerialIdentifier
1
36 char
TransportationEvent
ShippingContainer
1
10 num
scheduledEvent
DateStamp
R
E
E
ShipmentTransportationEvent
DateStamp
A
R
1
1
E
R
R
E
1
1
R
E
1
*
R
GlobalPartnerClassificationCode
ProprietaryProductIdentifier
25 char
GlobalPartnerClassificationCode
ProprietaryProductIdentifier
16 char
“Reseller”
E
O
OEMPartNumber
E
O
“Manufacturer”
E
R
MSEndItemPartNumber
E
R
RevisionIdentifier
FreeFormText
E
150 char
ProductTitle
shippedQuantity
ProductQuantity
14 num
traceIdentifier
23 char
PropritaryLotIdentifier
1
1
R
R
E
E
PropritaryLotIdentifier
1
A
E
Quantity
(number of labels in roll)
1
R
R
1
*
R
E
R
23 char
MS:MS Order Number
ML :Microsoft Line Item
Number
E
R
PropritaryLotIdentifier
23 char
AR :AR Order Number
E
R
PropritaryLotIdentifier
33 char
PO :OEM PO Number
E
O
PropritaryLotIdentifier
43 char
UE :User Name
E
O
(end detail section)
E
“Packing Slip Number”
E
O
30 char
Pack Slip Number
E
O
“Carrier Reference Number”
E
R
30 char
Courier Tracking Number
E
R
“Booking Number”
E
R
Order Type
E
TrackingReference
GlobalTrackingReferenceTypeCode
ProprietaryShipmentTrackingIdentifier
GlobalTrackingReferenceTypeCode
ProprietaryShipmentTrackingIdentifier
GlobalTrackingReferenceTypeCode
ProprietaryShipmentTrackingIdentifier
15 char
TransportedBy
BusinessDescription
GlobalBusinessIdentofier
9 num
“Microsoft’s DUNs #”
FromRole
PartnerRoleDescription
ContactInformation
contactName
FreeFormText
EmailAddress
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
“Extranet@Microsoft.com”
E
R
1
1
R
“425-703-7555”
E
“Shipper”
E
1
1
R
E
1
1
R
E
1
1
R
R
“Microsoft’s DUNs #”
E
“Information Technology”
E
“Manufacturer”
E
R
“ASN”
E
R
DT.tz
Event Date
E
R
32 char
Control Number
9 num
GlobalSupplChainCode
GlobalPartnerClassificationCode
GlobalDocumentFunctionCode
thisDocumentIdentifier
ProprietaryDocumentIdentifier
1
R
BusinessDescription
thisDocumentGenerationDateTime.DateTimeStamp
1
E
PartnerDescription
GlobalBusinessIdentifier
R
E
E
GlobalPartnerRoleClassificationCode
*
“Extranet Helpdesk”
telephoneNumber
CommunicationsNumber
1
E
toRole
PartnerRoleDescription
“Receiver”
GlobalPartnerRoleClassificationCode
11
R
1
1
1
1
E
R
R
R
E
1
1
R
E
1
1
R
E
R
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
9 num
GlobalSupplyChainCode
GlobalPartnerClassificationCode
12
E
1
1
R
E
1
1
R
“Customer’s DUNs #”
E
R
“Information Technology”
“Original Equipment
Manufacturer”
E
R
E
1
1
R
4.2.
Application Confirmation
MS Field Name
(Comments)
Attribute
or
Element
M
I
n
M
a
x
Usage
(root node)
E
1
1
R
E
1
1
R
OriginatingPartner
E
1
1
R
purchasedBy
E
1
1
R
E
1
1
R
E
1
1
R
Type /
Size
TAGS NAMES
Pip9Z9Confirmation
Confirmation
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
9 num
“DUNs #”
(from OEM Sold To ID)
ReceivingPartner
purchasedBy
PartnerDescription
BusinessDescription
GlobalBusinessIdentifier
ProprietarySerialIdentifier
DateStamp
R
E
1
1
R
E
1
1
R
E
1
1
R
E
1
1
R
9 num
Microsoft’s DUNs #
”081466849”
E
R
32 num
(Unique Trans ID)
E
R
DT.tz
Event Date
E
R
32 char
Control Number
(to be reconciled)
ConfirmationIdentifiers
ProprietaryDocumentIdentifier
E
E
13
E
1
1
R
R
5. Transaction Samples
5.1.
SOAP Envelopes
<SOAP-ENV:Envelope xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" xmlns:SOAPENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header>
<eps:endpoints SOAP-ENV:mustUnderstand="1" xmlns:biz="http://schemas.biztalk.org/btf-20/address/types" xmlns:eps="http://schemas.biztalk.org/btf-2-0/endpoints">
<eps:to>
<eps:address xsi:type="biz:OrganizationName">Microsoft</eps:address>
</eps:to>
<eps:from>
<eps:address xsi:type="biz:OrganizationName">Company</eps:address>
</eps:from>
</eps:endpoints>
<prop:properties SOAP-ENV:mustUnderstand="1" xmlns:prop="http://schemas.biztalk.org/btf-20/properties">
<prop:identity>123456789</prop:identity>
<prop:sentAt>2001-09-14T06:07:00+00:00</prop:sentAt>
<prop:expiresAt>2002-10-14T06:07:00+00:00</prop:expiresAt>
<prop:topic> root:Pip3B2AdvanceShipmentNotification </prop:topic>
</prop:properties>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
… transaction content …
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
5.2.
Shipment Transaction
<Pip3B2AdvanceShipmentNotification>
<AdvancedShipmentNotification>
<BuyingPartner>
<purchasedBy>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>123456789</GlobalBusinessIdentifier>
</BusinessDescription>
</PartnerDescription>
</purchasedBy>
</BuyingPartner>
<OriginatingPartner>
<shipFrom>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>987654321</GlobalBusinessIdentifier>
</BusinessDescription>
<ContactInformation>
<contactName>
<FreeFormText>SomeName</FreeFormText>
14
</contactName>
<PhysicalAddress>
<GlobalLocationIdentifier>54321</GlobalLocationIdentifier>
</PhysicalAddress>
</ContactInformation>
</PartnerDescription>
</shipFrom>
</OriginatingPartner>
<SellingPartner>
<soldBy>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>987654321</GlobalBusinessIdentifier>
</BusinessDescription>
</PartnerDescription>
</soldBy>
</SellingPartner>
<Shipment>
<GlobalCarrierCode>Translado</GlobalCarrierCode>
<GlobalShippingServiceLevelCode>Regular</GlobalShippingServiceLevelCode>
<numberOfShippingContainers>
<CountableAmount>1</CountableAmount>
</numberOfShippingContainers>
<ReceivingPartner>
<shipto>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>123456789</GlobalBusinessIdentifier>
</BusinessDescription>
<ContactInformation>
<contactName>
<FreeFormText>SomeComapnyFreeFormText>
</contactName>
<PhysicalAddress>
<addressLine1>
<FreeFormText>123 Maple Street</FreeFormText>
</addressLine1>
<GlobalLocationIdentifier>654</GlobalLocationIdentifier>
<regionName>
<FreeFormText>200100</FreeFormText>
</PhysicalAddress>
</ContactInformation>
</PartnerDescription>
</shipto>
</ReceivingPartner>
<shipmentIdentifier>
<ProprietaryReferenceIdentifier>3124A67F-DE01-4FE5-8722109621D80A91</ProprietaryReferenceIdentifier>
</shipmentIdentifier>
<ShipmentTransportationEvent>
<scheduledEvent>
<TransportationEvent>
<DateStamp>2002-02-11T11:30:53-08:00</DateStamp>
15
<GlobalTransportEventCode>Dock</GlobalTransportEventCode>
</TransportationEvent>
</scheduledEvent>
<scheduledEvent>
<TransportationEvent>
<DateStamp>2001-10-01T19:52:20-08:00</DateStamp>
<GlobalTransportEventCode>Ship</GlobalTransportEventCode>
</TransportationEvent>
</scheduledEvent>
</ShipmentTransportationEvent>
<ShippingContainer>
<shippingContainerIdentifier>
<ProprietarySerialIdentifier>3124A67F-DE01-4FE5-8722109621D80A91</ProprietarySerialIdentifier>
</shippingContainerIdentifier>
<ShippingContainerItem>
<DocumentSubLineLotShipReference>
<GlobalDocumentReferenceTypeCode>PurchaseOrder</GlobalDocumentReferenceTypeCo
de>
<LineNumber>43135289187</LineNumber>
<LotShipReference>
<expiryDate>
<DateStamp>2001-10-01T19:52:20-08:00</DateStamp>
</expiryDate>
<GlobalProductUnitOfMeasureCode>Group</GlobalProductUnitOfMeasureCode>
<lotQuantity>
<ProductQuantity>300</ProductQuantity>
</lotQuantity>
<ProprietaryLotIdentifier>QuantityReceivedToDate</ProprietaryLotIdentifier>
<shippedLotQuantity>
<ProductQuantity>300</ProductQuantity>
</shippedLotQuantity>
</LotShipReference>
<LotShipReference>
<expiryDate>
<DateStamp>2001-10-01T19:52:20-08:00</DateStamp>
</expiryDate>
<GlobalProductUnitOfMeasureCode>Group</GlobalProductUnitOfMeasureCode>
<lotQuantity>
<ProductQuantity>100</ProductQuantity>
</lotQuantity>
<ProprietaryLotIdentifier>LastReceiptQuantity</ProprietaryLotIdentifier>
<shippedLotQuantity>
<ProductQuantity>100</ProductQuantity>
</shippedLotQuantity>
</LotShipReference>
<ProprietaryDocumentIdentifier>Beginning</ProprietaryDocumentIdentifier>
</DocumentSubLineLotShipReference>
<DocumentSubLineLotShipReference>
<GlobalDocumentReferenceTypeCode>PurchaseOrder</GlobalDocumentReferenceTypeCo
de>
<LineNumber>43135289572</LineNumber>
<ProprietaryDocumentIdentifier>Ending</ProprietaryDocumentIdentifier>
16
</DocumentSubLineLotShipReference>
<isContainsHazardousMaterial>
<AffirmationIndicator>N</AffirmationIndicator>
</isContainsHazardousMaterial>
<ProductIdentification>
<PartnerProductIdentification>
<GlobalPartnerClassificationCode>Manufacturer</GlobalPartnerClassificationCode>
<ProprietaryProductIdentifier>N01-12345</ProprietaryProductIdentifier>
<revisionIdentifier>
<FreeFormText>Windows XP Home Edition COA ORY OEI PC</FreeFormText>
</revisionIdentifier>
</PartnerProductIdentification>
<PartnerProductIdentification>
<GlobalPartnerClassificationCode>Reseller</GlobalPartnerClassificationCode>
<ProprietaryProductIdentifier>123456-001</ProprietaryProductIdentifier>
<revisionIdentifier>
<FreeFormText />
</revisionIdentifier>
</PartnerProductIdentification>
</ProductIdentification>
<shippedQuantity>
<ProductQuantity>386</ProductQuantity>
</shippedQuantity>
<traceIdentifier>
<ProprietaryLotIdentifier>MS:MS OrderNUmber</ProprietaryLotIdentifier>
</traceIdentifier>
<traceIdentifier>
<ProprietaryLotIdentifier>ML:MSLineItemNumber</ProprietaryLotIdentifier>
</traceIdentifier>
<traceIdentifier>
<ProprietaryLotIdentifier>AR:AROrderNumber</ProprietaryLotIdentifier>
</traceIdentifier>
<traceIdentifier>
<ProprietaryLotIdentifier>PO:OEMPoNumber</ProprietaryLotIdentifier>
</traceIdentifier>
<traceIdentifier>
<ProprietaryLotIdentifier>UE:v-pfowle@microsoft.com</ProprietaryLotIdentifier>
</traceIdentifier>
</ShippingContainerItem>
</ShippingContainer>
<TrackingReference>
<GlobalTrackingReferenceTypeCode>Carrier Reference
Number</GlobalTrackingReferenceTypeCode>
<ProprietaryShipmentTrackingIdentifier>39419</ProprietaryShipmentTrackingIdentifier>
</TrackingReference>
<TrackingReference>
<GlobalTrackingReferenceTypeCode>Booking
Number</GlobalTrackingReferenceTypeCode>
<ProprietaryShipmentTrackingIdentifier>COGS</ProprietaryShipmentTrackingIdentifier>
</TrackingReference>
<transportedBy>
<PartnerDescription>
<BusinessDescription>
17
<GlobalBusinessIdentifier>Translado</GlobalBusinessIdentifier>
</BusinessDescription>
</PartnerDescription>
</transportedBy>
</Shipment>
</AdvancedShipmentNotification>
<fromRole>
<PartnerRoleDescription>
<ContactInformation>
<contactName>
<FreeFormText>Extranet Helpdesk</FreeFormText>
</contactName>
<EmailAddress>Extranet@Microsoft.com</EmailAddress>
<telephoneNumber>
<CommunicationsNumber>425-703-7555</CommunicationsNumber>
</telephoneNumber>
</ContactInformation>
<GlobalPartnerRoleClassificationCode>Shipper</GlobalPartnerRoleClassificationCode>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>987654321</GlobalBusinessIdentifier>
<GlobalSupplyChainCode>Information Technology</GlobalSupplyChainCode>
</BusinessDescription>
<GlobalPartnerClassificationCode>Manufacturer</GlobalPartnerClassificationCode>
</PartnerDescription>
</PartnerRoleDescription>
</fromRole>
<GlobalDocumentFunctionCode>ASN</GlobalDocumentFunctionCode>
<thisDocumentGenerationDateTime>
<DateTimeStamp>2002-02-11T16:48:35-08:00</DateTimeStamp>
</thisDocumentGenerationDateTime>
<thisDocumentIdentifier>
<ProprietaryDocumentIdentifier>223003</ProprietaryDocumentIdentifier>
</thisDocumentIdentifier>
<toRole>
<PartnerRoleDescription>
<GlobalPartnerRoleClassificationCode>Receiver</GlobalPartnerRoleClassificationCode>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>123456789</GlobalBusinessIdentifier>
<GlobalSupplyChainCode>Information Technology</GlobalSupplyChainCode>
</BusinessDescription>
<GlobalPartnerClassificationCode>Original Equipment
Manufacturer</GlobalPartnerClassificationCode>
</PartnerDescription>
</PartnerRoleDescription>
</toRole>
</Pip3B2AdvanceShipmentNotification>
18
5.3.
Application Confirmation
<SOAP-ENV:Envelope xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" xmlns:SOAPENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header>
<eps:endpoints SOAP-ENV:mustUnderstand="1" xmlns:biz="http://schemas.biztalk.org/btf-20/address/types" xmlns:eps="http://schemas.biztalk.org/btf-2-0/endpoints">
<eps:to>
<eps:address xsi:type="biz:OrganizationName">Microsoft</eps:address>
</eps:to>
<eps:from>
<eps:address xsi:type="biz:OrganizationName">Company</eps:address>
</eps:from>
</eps:endpoints>
<prop:properties SOAP-ENV:mustUnderstand="1" xmlns:prop="http://schemas.biztalk.org/btf-20/properties">
<prop:identity>123456789</prop:identity>
<prop:sentAt>2001-09-14T06:07:00+00:00</prop:sentAt>
<prop:expiresAt>2002-10-14T06:07:00+00:00</prop:expiresAt>
<prop:topic>root: Pip9Z9Confirmation</prop:topic>
</prop:properties>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<Pip9Z9Confirmation>
<Confirmation>
<OriginatingPartner>
<purchasedBy>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>123456789</GlobalBusinessIdentifier>
</BusinessDescription>
</PartnerDescription>
</purchasedBy>
</OriginatingPartner>
<ReceivingPartner>
<purchasedBy>
<PartnerDescription>
<BusinessDescription>
<GlobalBusinessIdentifier>987654321</GlobalBusinessIdentifier>
</BusinessDescription>
</PartnerDescription>
</purchasedBy>
</ReceivingPartner>
<ProprietarySerialIdentifier>12345678901234567890</ProprietarySerialIdentifier>
<DateStamp>2001-12-20T09:07:39-08:00</DateStamp>
<ConfirmationIdentifiers>
<ProprietaryDocumentIdentifier>54321</ProprietaryDocumentIdentifier>
</ConfirmationIdentifiers>
</Confirmation>
</Pip9Z9Confirmation>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
19
6. Appendix
6.1.1. Change Control
Updates of the document date on the cover will not be repeatedly noted here.
#
Change Description
1
Correct Control Number max size and format to 32 char
2
Added max length of ‘Microsoft Line Item Number’ as 23 (20 + qualifier)
3
Changed ‘User Name’ max length from 40 to 43 (40 + qualifier)
4
Corrected Confirmation ‘To’ and ‘From’ in SOAP envelop in section 5.2
5
Separated SAOP envelopes in sample data
6
Changed version on cover to 1.2 due to these changes.
7
Correct Confirmation DUNs # order in spec and sample data
8
Change capitalization of field ContactName to contactName in the
example
9
Correct the placement of ContactInformation
10 Change capitalization of fields AddressLine1, AddressLine2, and
AddressLine3 to addressLine1, addressLine2, addressLine3 in the spec
and example.
11 No longer using xml_lang for free form text
12 OriginatingPartner structure the first element changed to shipFrom
instead of purchasedBy
13 SellingPartner structure the first element changed to sold.By instead of
purchasedBy
14 DocumentSubLineReference changed to
DocumentSubLineLotShipReference in spec and example
15 Change mapping from LotReference to LotShipReference
16 Updated sample data
17 Updated the version number to 1.4
18 Refer to use of RosettaNet v01
19 Require SOAP envelope for Confirmation regardless of transport
20 Repeat revison Identifier and FreeFormText for both Manufacturer and
Reseller (page 11)
21 Changed version number to 1.5
22 Added required fields to ‘fromRole’:
Date
12-20-2001
12-20-2001
12-21-2001
12-21-2001
1-9-2002
1-9-2002
1-16-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-1-2002
2-11-2002
2-11-2002
2-11-2002
(contactName, EmailAddress, telephoneNumber, GlobalPartnerRoleClassificationCode,
GlobalSupplyChainCode, GlobalPartnerClassificationCode)
23
Added required fields to ‘toRole’:
2-11-2002
(GlobalPartnerRoleClassificationCode, GlobalSupplyChainCode,
GlobalPartnerClassificationCode)
24
25
26
27
10
Added leased line option to 1.3.1
Changed ‘root’ in Confirmation SOAP envelope to ‘Pip9Z9Confirmation’
Unique trans ID in confirmation must be 32 numeric
Changed ‘PIP’ to ‘Pip’ on the confirmation
Added Unique Site ID for OEM site regionName.FreeFormText
20
2-13-2002
2-13-2002
2-13-2002
2-19-2002
7/1/2003