Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Objectives

1. Improve accuracy and efficiency in the general freight despatching process.

2. Standardize integration output from Customer system.

3. Enable more advanced reporting to enable analysis such as accurate association of freight cost to orders.


How does Order Lookup work?

Complete Message Transmitter Service

  1. The Customer system generates a File with consignment Information on the Customer's Server. The File must be.
    1. CSV/XML Format
    2. Contain the order file Information listed below
    3. Limited to one file per Order
  2. EFM Installs a Windows Service on the Customer's Server to pick up this File and send it to our Message Transmitter Service which transforms this File into a standard Message that OneFlo can interpret.
  3. Customer uses OneFlo Portal to "Look up" the consignment that can now be found within the system.


Custom Message Transmitter Service

  1. The customer system sends an XML Payload of all required data, to a custom API End Point.
    1. This Payload must meet OneFlo information requirements perfectly.
  2. Customer uses OneFlo UI to "Look up" the consignment that can now be found within the system.


Warning
titleWARNING

Custom Services are only available upon evaluation and require internal approval before moving forward.


Performing Order Lookup

System Component Map

Components

  • Customer System

Customer's system used as the source system for order data. Provider order data is exportable into an EDI file that will act as a data feed to the Message Transmitter process

  • Customer Workstation

Customer uses their consigning workstations to access the OneFlo portal to be able to access OneFlo functionality. 

  • OneFlo Portal

OneFlo is a cloud based, multi-carrier, Logistics Management System designed for consigning, manifesting & tracking consignments, tracking carrier performance & enabling logistics-based reports for analyzing supply chain activity. Order Lookup is accessed via the OneFlo Portal.

  • OneFlo Order Integration Service

The Order Integration service is designed to increase the efficiency of the despatch process by identifying and loading order data based on EDI files. The service identifies order EDI files and loads the contents as an order into OneFlo. Once loaded the order is accessible in the OneFlo portal and upon selecting the order all order data is mapped to the consignment creation form. The population of this data reduces data entry required by the despatch teams and increases accuracy of the consignment data.

  • OneFlo Postback Report.

In order to populate consignment number against the original Order in efm a OneFlo Postback data file can be generated on a nightly schedule. This data file will be transferred over to Customer where a efm service will load the file data to update Orders. This function requires Customer to nominate an FTP server that OneFlo can use to place the nightly batch file.

  • OneFlo AutoPrint Service

The AutoPrint service reduces the time required for users to generate labels when creating a consignment. Most web portal present the document in a page and require the user to progress through a print dialog process. This service communicates with the OneFlo portal for the user accounts and recognises when a new consignment is created. OneFlo creates a print job in the cloud and the AutoPrint service recognises a new job and processes the document automatically to generate a printed label.

Information Requirements

Customer order data required may vary depending on the process the Order Lookup integration is intended to achieve.

The following specification defines an XML structure for the Order Detail. When the source system can only produce a CSV, please consult the efm Technical Solutions Contact assigned.

Order

Level

Detail Information

Receiver NameRequiredReceiver 1RequiredSuburbText

Field No.

Field Name

Type

Length

MandatoryRequired

Multiplicity

Description

1Order Reference NumberOrderReferenceNumberText/Numeric30MandatoryRequired1Must be Unique
2Additional ReferenceText/NumericReferences30Not RequiredOptional0*
3ServiceText

30

20Optional0-1Preferred service following the Service Code provided by EFM. Must comply with the code otherwise will be ignored.
4SenderAddressText
Optional

30

0-1Only used when creating return or third party orders when a sender needs to be specified.
5

Receiver

Address 2


TextMandatory30

1

Not Required


6ItemsItem

30

Required

7

State

Text

3

Required

8

Postcode

Text

4

Required

9

Contact Name

Text

20

Recommended

10

Contact Phone

Text

15

Recommended

11

Contact Email

Text

50

Recommended

12
Recommended0-1*
7Authority to LeaveBoolean5RequiredMandatory
true/false/blank
138

Delivery Instructions

Text

60

Recommended

1


149

Special Instructions

Text

60

RecommendedNot Required

1


1510User Field1UserField1Text30Not RequiredOptional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
1611User Field2UserField2Text30Not RequiredOptional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
1712User Field3UserField3Text30Not RequiredOptional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
1813User Field4UserField4Text30Not RequiredOptional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
1914User Field5UserField5Text30Not RequiredOptional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

Anchor
AddressType
AddressType
Address Type Information

Field No.

Field Name

Type

Length

Mandatory

Multiplicity

Description

1NameText30Mandatory1
2Address1Text30Mandatory1
3Address2Text30Optional1
4LocalityText30Mandatory1
5StateText5Mandatory1
6PostcodeText5Mandatory1
7ContactNameText20Optional0-1
8ContactPhoneText15Optional0-1
9ContactEmailText50Recommended0-1
Item Level

Anchor
ItemType
ItemType
Item Type Information

The AutoPrint service reduces the time required for users to generate labels when creating a consignment. Most web portal present the document in a page and require the user to progress through a print dialog process. This service communicates with the OneFlo portal for the user accounts and recognises when a new consignment is created. OneFlo creates a print job in the cloud and the AutoPrint service recognises a new job and processes the document automatically to generate a printed label.
Field No.

Field Name

Type

Length

Required

Mandatory

Multiplicity

Description

1ReferenceText30
Not Required
Recommended1
2CodeText30Recommended1Defined: https://portal.oneflo.com.au/MyProducts/Index
2
3
Code
DescriptionText30
Not Required
Recommended
3
1Description
Text30Not Required
of the package
4ItemsNumeric
5

Recommended
Not Required
1number of items of this type / dims / weight
5LengthNumeric
5

Recommended
Not Required
1in centimetres, must be whole number
6WidthNumeric
5

Recommended
Not Required
1in centimetres, must be whole number
7HeightNumeric
5

Recommended
Not Required
1in centimetres, must be whole number
8WeightNumeric
5

Recommended
Not Required
1in kilograms, can include decimal
9VolumeNumeric
5

Optional
Not Required
1in cubic metres, can include decimal

Components

  • Customer System

Customer's system used as the source system for order data. Provider order data is exportable into an EDI file that will act as a data feed to the Message Transmitter process

MT.Transformer.Installer.msi

  • Customer Workstation

Customer uses their consigning workstations to access the OneFlo portal to be able to access OneFlo functionality. 

  • OneFlo Portal

OneFlo is a cloud based, multi-carrier, Logistics Management System designed for consigning, manifesting & tracking consignments, tracking carrier performance & enabling logistics-based reports for analyzing supply chain activity. Order Lookup is accessed via the OneFlo Portal.

  • OneFlo Order Integration Service

The Order Integration service is designed to increase the efficiency of the despatch process by identifying and loading order data based on EDI files. The service identifies order EDI files and loads the contents as an order into OneFlo. Once loaded the order is accessible in the OneFlo portal and upon selecting the order all order data is mapped to the consignment creation form. The population of this data reduces data entry required by the despatch teams and increases accuracy of the consignment data.

  • OneFlo Postback Report.

In order to populate consignment number against the original Order in efm a OneFlo Postback data file can be generated on a nightly schedule. This data file will be transferred over to Customer where a efm service will load the file data to update Orders. This function requires Customer to nominate an FTP server that OneFlo can use to place the nightly batch file.

  • OneFlo AutoPrint Service

10DGDG
Optional0-*DG information when DG is included in the shipping unit.

Anchor
DGType
DGType
DG Type Information


Field Name

Type

Length

Mandatory

Multiplicity

Description

1UNNumeric4Mandatory1UN Number for the Dangerous Goods
2ClassText10Mandatory1Classification of DG
3SubriskText20Mandatory1Subsidiary hazard code
4GroupText10Mandatory1Packing group (e.g. I , II, III )
5ProperShippingNameText100Mandatory1Identifiable DG name as specified in the code
6CommonnameText100Mandatory1Nickname for the DG
7QtyNumeric
Mandatory1Number of receptacles in the shipment
8AggQtyNumeric
Mandatory1Amount of DG in Unit
9UnitsText10Mandatory1Unit for this good (kg or L)
10ReceptacleText50Mandatory0-*Container for the DG (e.g. can, tank, box)


Example Files

XML

Code Block
languagexml
themeRDark
titleOrderXML
<OrderData xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<OrderDetail>
		<OrderReference>3081973</OrderReference>
		<Service>IPECX</Service>
		<References>
			<Reference>ExtraReference</Reference>
		</References>
		<Receiver>
			<Name>Receiver Name</Name>
			<Address1>89 Koala St</Address1>
			<Locality>Footscray</Locality>
			<State>VIC</State>
			<Postcode>3011</Postcode>
			<ContactName>Receiver Contact</ContactName>
			<ContactPhone>+6134567890</ContactPhone>
		</Receiver>
		<Items>
			<Code>CA25SP</Code>
			<Length>0.280</Length>
			<Width>0.280</Width>
			<Height>0.090</Height>
			<Weight>1.544</Weight>
			<Description>Box of Nails</Description>
			<DGs>
				<DG> <!-- Must follow ADG Code https://www.ntc.gov.au/heavy-vehicles/safety/australian-dangerous-goods-code/  -->
        			<UN>3090</UN>
        			<Class>9</Class>
        			<SubRisk>N/A</SubRisk>
        			<Group>NONE</Group>
        			<ProperShippingName> LITHIUM METAL BATTERIES CONTAINED IN EQUIPMENT</ProperShippingName>
        			<CommonName>LITHIUM BATTERIES</CommonName>
        			<Qty>1</Qty>
        			<AggQty>1</AggQty>
        			<Units>kg</Units>
        			<Receptacle>BOX</Receptacle>
      			</DG>
			</DGs>
		</Items>
	</OrderDetail>
</OrderData>