Load Plan

From UG

(Difference between revisions)
Jump to: navigation, search
(→Intro)
(→Example)
Line 52: Line 52:
</pre>
</pre>
-
== Example ==
+
== Schema ==
-
Structure is based on the following example:
+
See http://mantis.jaguarfreight.com/mantis/file_download.php?file_id=1707&type=bug
-
<pre>
+
== Message structure ==
-
<?xml version="1.0" encoding="utf-8" ?>
+
 
-
- <S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope" xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:Num="Num-namespace-URI" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:ebi="http://www.myvan.descartes.com/ebi/2004/r1" xmlns:dcf="DCF-namespace-URI" xmlns:D2P="D2P-namespace-URI">
+
<S:Envelope>  
-
- <S:Header>
+
  <S:Header>
-
- <wsa:From>
+
    ...
-
  <wsa:Address>urn:duns:123456789</wsa:Address>
+
  </S:Header>
-
  </wsa:From>
+
 
-
  <wsa:To>urn:duns:123456789</wsa:To>
+
  <S:Body>
-
  <wsa:Action>urn:myvan:220</wsa:Action>
+
    <Inbound>
-
- <ebi:Sequence>
+
      <DocLoadPlan ... >
-
  <ebi:MessageNumber>BAT2010-08-3121-18-42Z273</ebi:MessageNumber>
+
        <BillToInformation ... />
-
  </ebi:Sequence>
+
        <CtyLoadAccessorial ... />
-
  </S:Header>
+
        <DocLoadRate> ... </DocLoadRate>  
-
- <S:Body>
+
        <BOLInformation ... >
-
- <Inbound xmlns="Num-namespace-URI">
+
            <ShipFromInformation ... />
-
- <DocLoadPlan BilledAsUOM="200" BilledAsUnitCost="0" BilledAsValue="0" BillingOptionDescription="0" CarContract="JWEL Contract 1" FixedRate="0" Service="1" TotalCharge="172.63" TotalDeclaredValue="0" MasterShipmentNumber="LD000022469" TotalWeight="7" BillingOption="0" Distance="2624.84" WeightUOM="200" DistanceUOM="100" CurrencyCode="USD" TotalStops="2" TransitTime="3" TotalVolume="0" DimensionUOM="400" VolUOM="300" BaseRate="125" OtherCharges="47.63" EquipmentName="VN" CarrierCode="JWEL" CarrierName="Jewels Transportation" Reason="0" TransportMode="TL" ContractModeDesc="TL" TotalLadingQty="1" xmlns="">
+
            <ShipToInformation ... />
-
  <BillToInformation StreetNo="10" Address="Fifth Street - 3rd Floor" City="Valley Stream" State="NY" PostalCode="11581" Country="US" LocationNo="00210000" ContactFName="Jaguar" F="Freight" PhoneNumber="516-239-1900" CompanyName="Jaguar Freight Services" />  
+
            <DocShipment ... />
-
- <DocLoadRate BilledAsValue="3.1751999999999998" BaseRate="125" OtherCharges="47.63" Service="1" ContractName="JWEL Contract 1" TotalCharge="172.63" Discount="0" MinCharge="125" BilledAsUOM="200" BilledAsQty="200" BilledAsUnitCost="0.82142999999999999" MaxCost="0" FixedRate="0" CurrencyCode="USD" TransitTime="3" Reason="0">
+
              <DocShpLineItem ... />
-
  <CtyLoadAccRate Charge="37" AccName="JWEL Contract 1 - Hazardous Material" CurrencyCode="USD" AccCode="HAZF" />  
+
              <DSGReferenceNumbers .../>
-
  <CtyLoadAccRate Charge="10.625" AccName="Monthly LTL %" CurrencyCode="USD" AccCode="FUEL" />
+
        </BOLInformation>
-
  </DocLoadRate>
+
        <DocLoadStop ... />
-
- <BOLInformation BOLNo="BOL000032076" MethodOfPayment="0" WeightUOM="200" VolUOM="300" TotalWeight="7" TotalLadingQty="1">
+
          ....
-
- <ShipFromInformation SeqNo="1" StopTypeCode="1" StartDateTime="2010-08-31T08:00:00" EndDateTime="2010-08-31T17:00:00" StreetNo="100" Address="Main St" City="Newark" State="NJ" PostalCode="12345" Country="US" LocationNo="64534" ContactFName="Bob" ContactLName="Smith" PhoneNumber="123-345-3353" CompanyName="Supplier" AddressType="4">
+
        <DocLoadStop ... />
-
  <AddressType AddressType="3" AddressTypeDesc="Pool Point" />  
+
      </DocLoadPlan>
-
  </ShipFromInformation>
+
    </Inbound>
-
  <ShipToInformation SeqNo="2" StopTypeCode="2" StartDateTime="2010-09-01T11:00:00" EndDateTime="2010-09-01T14:00:00" Address="149 Grand Ave" City="Roanoke" State="VA" PostalCode="76456" Country="US" LocationNo="865765" CompanyName="Manufacturer" />  
+
  </S:Body>
-
- <DocShipment AllocatedCharges="0" CreationDate="2010-08-30T16:01:11.037000000" ShipmentNumber="1097865" EarliestAvailDate="2010-08-31T08:00:00" EarliestDelDate="2010-09-01T11:00:00" LatestAvailDate="2010-08-31T17:00:00" LatestDelDate="2010-09-01T14:00:00" TotalWeight="7" WeightUOM="200" TotalVolume="0" VolUOM="300">
+
 
-
  <DocShpLineItem Hazardous="1" LineCreationDate="" LadingQty="1" Description="Goods" TotalWeight="7" WeightUOM="200" LadingQtyUOM="15" AcntLineItemNo="1" ContainerTypeDescription="Freight" />  
+
<S:Envelope>  
-
  <DSGReferenceNumbers RefNoType="Sample RefNo 1" Value="Sample Value 1" />  
+
 
-
  <DSGReferenceNumbers RefNoType="Sample RefNo 2" Value="Sample Value 2" />
+
== Use Case 1 One Load One CT No Pooling ==
-
  <DSGReferenceNumbers RefNoType="Sample RefNo 3" Value="Sample RefNo 3" />
+
-
  <DSGReferenceNumbers RefNoType="Sample RefNo 4" Value="Sample RefNo 4" />
+
-
  </DocShipment>
+
-
  </BOLInformation>
+
-
- <DocLoadStop SeqNo="1" StopTypeCode="1" StartDateTime="2010-08-31T14:14:00" EndDateTime="2010-08-31T12:01:00">
+
-
- <StopLocation StreetNo="100" Address="Main Street" City="Newark" State="NJ" PostalCode="12345" Country="US" LocationNo="64534" ContactFName="Bob" ContactLName="Smith" PhoneNumber="123-345-3353" CompanyName="Supplier" AddressType="4">
+
-
  <AddressType AddressType="3" AddressTypeDesc="Pool Point" />  
+
-
  </StopLocation>
+
-
  <BOLInformation BOLNo="BOL000032076" WeightUOM="200" VolUOM="300" TotalWeight="7" TotalLadingQty="1" />
+
-
  </DocLoadStop>
+
-
- <DocLoadStop SeqNo="2" StopTypeCode="2" StartDateTime="2010-09-02T12:13:00" EndDateTime="2010-09-02T10:00:00">
+
-
  <StopLocation Address="149 Grand Ave" City="Roanoke" State="VA" PostalCode="76456" Country="US" LocationNo="865765" CompanyName="Manufacturer" />  
+
-
  <BOLInformation BOLNo="BOL000032076" WeightUOM="200" VolUOM="300" TotalWeight="7" TotalLadingQty="1" />
+
-
  </DocLoadStop>
+
-
  </DocLoadPlan>
+
-
  </Inbound>
+
-
  </S:Body>
+
-
  </S:Envelope>
+
-
</pre>
+
== S:Envelope ==
== S:Envelope ==

Revision as of 21:41, 6 October 2010


Contents

Intro

Load Plan is a message transmitted by TMS to CT2 about finalized loads in the form of XML.

CT2 script is to extract some information and update its database. Initially only the following data will be extracted (for every CT#CT Num):

  • CT#Pick Up Trucker // from Inbound.DocLoadPlan.CarrierCode or Inbound.DocLoadPlan.CarrierName

Misc

??? MApping for <xs:attribute name="MasterShipmentNumber" type="xs:string" use="required"/> TBD

Case of AddressTypeDesc is Pool Point

Drop off or pick up are not origin or destination for CT. But this helps to distinguish between CT#Pick Up Trucker (before Pool point) and CT#Delivery Trucker (after)

BOLInformation.BOLNo

  • Will BOLInformation.BOLNo be generated automatically by TMS for every CT#? This can be used to link CT with stop

StopTypeCode 

<xs:attribute name="StopTypeCode">
−
<xs:simpleType>
−
<xs:restriction base="xs:int">
−
<xs:enumeration value="1">
−
<xs:annotation>
<xs:documentation>Pickup</xs:documentation>
</xs:annotation>
</xs:enumeration>
−
<xs:enumeration value="2">
−
<xs:annotation>
<xs:documentation>Dropoff</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

Schema

See http://mantis.jaguarfreight.com/mantis/file_download.php?file_id=1707&type=bug

Message structure 

 
  <S:Header>
   ...
  

  
    <Inbound>
      <DocLoadPlan ... >
        <BillToInformation ... />
        <CtyLoadAccessorial ... />
        <DocLoadRate> ... </DocLoadRate> 
        <BOLInformation ... >
           <ShipFromInformation ... />
           <ShipToInformation ... />
           <DocShipment ... />
              <DocShpLineItem ... />
              <DSGReferenceNumbers .../>
        </BOLInformation>
        <DocLoadStop ... />
          ....
        <DocLoadStop ... />
      </DocLoadPlan>
    </Inbound>

Use Case 1 One Load One CT No Pooling

S:Envelope

S:Header

wsa:From

wsa:To

wsa:Action

ebi:Sequence

S:Body

Inbound

DocLoadPlan

Example: 

<DocLoadPlan BilledAsUOM="200" BilledAsUnitCost="0" BilledAsValue="0" BillingOptionDescription="0" CarContract="JWEL Contract 1" 
 FixedRate="0" Service="1" TotalCharge="172.63" TotalDeclaredValue="0" MasterShipmentNumber="LD000022469" TotalWeight="7" 
 BillingOption="0" Distance="2624.84" WeightUOM="200" DistanceUOM="100" CurrencyCode="USD" TotalStops="2" TransitTime="3" 
 TotalVolume="0" DimensionUOM="400" VolUOM="300" BaseRate="125" OtherCharges="47.63" EquipmentName="VN" CarrierCode="JWEL" 
 CarrierName="Jewels Transportation" Reason="0" TransportMode="TL" ContractModeDesc="TL" TotalLadingQty="1">

Child elements: 

<xs:sequence>
<xs:element ref="BillToInformation" minOccurs="0"/>
<xs:element minOccurs="0" maxOccurs="1" ref="DocLoadRate"/>
<xs:element ref="BOLInformation" maxOccurs="unbounded"/>
<xs:element ref="DocLoadStop" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>

Required and important attributes and mapping:

  • <xs:attribute name="MasterShipmentNumber" type="xs:string" use="required"/> // map to: ???
  • ....
BillToInformation
DocLoadRate
BOLInformation
DocLoadStop

====== DocLoadStop ======

Retrieved from "https://wiki.jaguarfreight.com/Load_Plan"
Personal tools