Template:OrderDetails: Difference between revisions
From CTLTMS
(Added - v0.00.01.25) |
(Minor formatting change) |
||
| (24 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
In this case, you select the field to be filtered from a drop-down list of all fields, then the operator, and then the value. | In this case, you select the field to be filtered from a drop-down list of all fields, then the operator, and then the value. | ||
{{#ifeq:{{{Type|}}}||<gallery widths=600px heights=340px perrow=1> | |||
Image:CTLTMS_Orders1.png|''Orders - list'' | |||
Image:CTLTMS_Orders2.png|''Orders - status, references, type, instructions'' | |||
Image:CTLTMS_Orders3.png|''Orders - locations'' | |||
Image:CTLTMS_Orders4.png|''Orders - scheduling, requirements, transport units'' | |||
Image:CTLTMS_Orders5.png|''Orders - parameters, audit'' | |||
</gallery>|}}{{#ifeq:{{{Type|}}}|Enquiry|<gallery widths=600px heights=340px perrow=1> | |||
Image:CTLTMS_Order_Enquiry.png|''Orders enquiry'' | |||
</gallery>|}} | |||
The list of fields are: | The list of fields are: | ||
| Line 45: | Line 57: | ||
* ''Total Weight (KG)''. | * ''Total Weight (KG)''. | ||
* ''Total BaseUE''. | * ''Total BaseUE''. | ||
* ''Revenue''. | |||
* ''Cost''. | |||
* ''Margin''. | |||
* ''Active''. | * ''Active''. | ||
* ''Created By''. | * ''Created By''. | ||
| Line 116: | Line 131: | ||
* ''Total Weight (KG)''. | * ''Total Weight (KG)''. | ||
* ''Total BaseUE''. | * ''Total BaseUE''. | ||
* ''Revenue''. | |||
* ''Cost''. | |||
* ''Margin''. | |||
* ''Active''. | * ''Active''. | ||
* ''Created By''. | * ''Created By''. | ||
| Line 126: | Line 144: | ||
* ''Update Counter''. | * ''Update Counter''. | ||
{{#ifeq:{{{Type|}}}||The results table will colour the rows based on the order status. You can control the colours of each order status displayed using the [[Order Status]] screen.|}} | |||
{{#ifeq:{{{ | |||
The screen has the following additional actions on the screen header: | |||
{{#ifeq:{{{Type|}}}||* {{Button|Booking}} - you can enter booking information once you have selected an order. | |||
* {{Button|Consolidate}} - you can choose to consolidate multiple orders together by selecting multiple orders and then clicking this button. | |||
|}}{{#ifeq:{{{Type|}}}|Template|* {{Button|Booking}} - you can enter booking information once you have selected an order template. | |||
* {{Button|Consolidate}} - you can choose to consolidate multiple orders together by selecting multiple orders and then clicking this button. | |||
|}}{{#ifeq:{{{Type|}}}|Enquiry|* {{Button|Print}} - you can print the order with this button.|}} | |||
{{# | {{#ifeq:{{{Type|}}}|Enquiry|| | ||
== Consolidating {{#ifeq: {{{Type|}}}|Template|Order Templates|Orders}} == | |||
You can select multiple {{#ifeq: {{{Type|}}}|Template|order templates|orders}} by clicking when using the shift and/or control keys. | |||
{{#ifeq: {{{Type|}}}|Template||{{Note}} The orders you select must be UNPLANNED and have the same delivery and collect locations.}} | |||
Once you have selected multiple {{#ifeq: {{{Type|}}}|Template|order templates|orders}}, you can click the {{Button|Consolidate}} button in the screen header. The screen will display a pop-up window showing a summary of all of the {{#ifeq: {{{Type|}}}|Template|order templates|orders}}. | |||
You can confirm the consolidation by clicking the '''Consolidate Records''' button, or cancel the consolidation by closing the window. | |||
{{# | |||
{{#ifeq: {{{Type|}}}|Template||== Booking an Order == | |||
When you click this button, the screen will display a pop-up window to enter booking information. | When you click this button, the screen will display a pop-up window to enter booking information. | ||
| Line 150: | Line 172: | ||
* ''Collect''/''Deliver'' - a option to select whether the booking information applies to the collection or the delivery of the order. | * ''Collect''/''Deliver'' - a option to select whether the booking information applies to the collection or the delivery of the order. | ||
* ''Booking Ref'' - a booking reference as provided to you. | * ''Booking Ref'' - a booking reference as provided to you. | ||
* ''Booking Date'' - the date of the booking. You can enter the date directly or use the | * ''Booking Date'' - the date of the booking. You can enter the date directly or use the {{Button|Calendar}} button provided. | ||
* ''Booking From'' - the start time of the booking window. | * ''Booking From'' - the start time of the booking window. | ||
* ''Booking To'' - the end time of the booking window. | * ''Booking To'' - the end time of the booking window. | ||
| Line 156: | Line 178: | ||
|}} | |}} | ||
== Adding or Editing an {{# | == Adding or Editing an {{#ifeq: {{{Type|}}}|Template|Order Template|Order}} == | ||
The following actions are available on the Details panel: | The following actions are available on the Details panel: | ||
* | * {{Button|New}} - create a new record. | ||
* | * {{Button|Save}} - save a new record or changes to an existing record. | ||
* | * {{Button|Delete}} - delete an existing record. | ||
* | * {{Button|Help}} - help on this screen. | ||
* | * {{Button|Undo}} - undo change made since last save. | ||
* | * {{Button|Clear}} - clear all fields. | ||
* | * {{Button|Template}} - create an {{#ifeq: {{{Type|}}}|Template|order template|order}} from a template. | ||
* | * {{Button|Cancel}} - cancel an {{#ifeq: {{{Type|}}}|Template|order template|order}}. | ||
* | * {{Button|Split}} - Split an {{#ifeq: {{{Type|}}}|Template|order template|order}}. | ||
* | * {{Button|Copy}} - Copy an existing {{#ifeq: {{{Type|}}}|Template|order template|order}}. | ||
* | * {{Button|Toggle}} - toggle display of all accordion headers. | ||
== Order Template == | == Order Template == | ||
You can create an {{# | You can create an {{#ifeq: {{{Type|}}}|Template|order template|order}} from a saved order template. {{#ifeq: {{{Type|}}}|Template||You can create these in the [[Order Templates]] screen.}} | ||
When you click this button, the screen will display a list of all order templates created in the system: | When you click this button, the screen will display a list of all order templates created in the system: | ||
| Line 180: | Line 202: | ||
* ''Deliver To Name''. | * ''Deliver To Name''. | ||
To create a new {{# | To create a new {{#ifeq: {{{Type|}}}|Template|order template|order}}, select the template from the list and click the '''Submit''' button. a new {{#ifeq: {{{Type|}}}|Template|order template|order}} will be created, with the fields populated from the template, ready for you to amend and save like normal. Note that all details are copied, including lines and items. | ||
{{# | {{#ifeq: {{{Type|}}}|Template||== Cancel an Order == | ||
You can cancel an order by clicking the | You can cancel an order by clicking the {{Button|Cancel}} button. The order's status will be set to cancelled and the order re-displayed with this status. | ||
|}} | |}} | ||
== Split an {{# | == Split an {{#ifeq: {{{Type|}}}|Template|Order Template|Order}} == | ||
You can split an {{# | You can split an {{#ifeq: {{{Type|}}}|Template|order template|order}} into multiple additional {{#ifeq: {{{Type|}}}|Template|order templates|orders}}. | ||
When you find the {{# | When you find the {{#ifeq: {{{Type|}}}|Template|order template|order}} you want to copy, click the {{Button|Split}} button. The screen will display a list of all the order lines. | ||
* ''TUnit'' - Transport Unit Code. | * ''TUnit'' - Transport Unit Code. | ||
* ''Product'' - Product Type Code. | * ''Product'' - Product Type Code. | ||
| Line 205: | Line 227: | ||
* ''Include'' - a tick box to indicate that this order line is included in the split. | * ''Include'' - a tick box to indicate that this order line is included in the split. | ||
You can then indicate how many {{# | You can then indicate how many {{#ifeq: {{{Type|}}}|Template|order templates|orders}} to split this into - the default is 2. You can split the order lines selected into new {{#ifeq: {{{Type|}}}|Template|order templates|orders}} using the '''Split''' button, or cancel the split with the '''Cancel''' button or by closing the window. | ||
== Copy an {{# | == Copy an {{#ifeq: {{{Type|}}}|Template|Order Template|Order}} == | ||
You can copy an existing {{# | You can copy an existing {{#ifeq: {{{Type|}}}|Template|order template|order}} to create a new {{#ifeq: {{{Type|}}}|Template|order template|order}}. | ||
When you find the {{# | When you find the {{#ifeq: {{{Type|}}}|Template|order template|order}} you want to copy, click the {{Button|Copy}} button. This will create a copy of the {{#ifeq: {{{Type|}}}|Template|order template|order}} with a new reference, ready for you to amend and save like normal. Note that all details are copied, including lines and items. | ||
== Order section == | == Order section == | ||
The header will display the status of the {{# | The header will display the status of the {{#ifeq: {{{Type|}}}|Template|order template|order}}. This includes: | ||
* The TMS reference number. | |||
* The order status. | |||
* The execution status. | |||
* Totals: | |||
** Weight. | |||
** Volume. | |||
** BUE. | |||
* ''Order Entry Date'' | The section includes the following core order fields: | ||
* ''Group''. | * ''Order Entry Date'' and time. | ||
* ''Organisation''. | * ''Group'' - a drop-down list of all customer groups created in the system. You can maintain these in the [[Customer Groups]] screen. | ||
* ''Customer Code''. | * ''Organisation'' - a drop-down list of all organisations created in the system. You can maintain these in the [[Organisation]] screen. | ||
* ''Service Level Code''. | * ''Customer Code'' - the customer code for the {{#ifeq: {{{Type|}}}|Template|order template|order}}. You can maintain these in the [[Customer]] screen. You can look up the available customer codes using the {{Button|Lookup}} button to the right of the value entry. The screen will display a pop-up window listing the available values. You can filter the values on the list by typing in the provided filter box and clicking the '''Filter''' button. You can select a value from the list, or cancel the look up by closing the window. | ||
* ''Service Level Code'' - a drop-down list of the service levels for the {{#ifeq: {{{Type|}}}|Template|order template|order}}. You can maintain these in the [[Service Level]] screen. | |||
| Line 233: | Line 263: | ||
== Instructions section == | == Instructions section == | ||
You can enter general order instructions for the execution of | You can enter general order instructions for the execution of {{#ifeq: {{{Type|}}}|Template|orders created from this order template|the order}} here. | ||
== Location section == | == Location section == | ||
You can enter the details of the order addresses here. | You can enter the details of the {{#ifeq: {{{Type|}}}|Template|order template|order}} addresses here. | ||
The section allows you to enter: | The section allows you to enter: | ||
* ''Collect From'' - the address from which you will pick up the goods on the order. | * ''Collect From'' - the address from which you will pick up the goods on {{#ifeq: {{{Type|}}}|Template|orders created from this template|the order}}. | ||
* ''Deliver To'' - the address to which you will deliver the goods on the order. | * ''Deliver To'' - the address to which you will deliver the goods on {{#ifeq: {{{Type|}}}|Template|orders created from this template|the order}}. | ||
Each address section allows you to enter the following information: | Each address section allows you to enter the following information: | ||
* ''Code'' - the location code. You can maintain locations in the [[Locations]] screen, or you can use the '''View Details''' button provided if you have entered a location, which will open a new tab showing the location information. You can enter a location code directly or use the | * ''Code'' - the location code. You can maintain locations in the [[Locations]] screen, or you can use the '''View Details''' button provided if you have entered a location, which will open a new tab showing the location information. You can enter a location code directly or use the {{Button|Lookup}} button to the right of the value entry. The screen will display a pop-up window showing all locations configured in the system. You can select a location by clicking on the row or cancel entry by closing the window. You can refresh the order location details from the location code by pressing the {{Button|Refresh}} button. | ||
* ''Name''. | * ''Name''. | ||
* ''Address''. | * ''Address''. | ||
| Line 254: | Line 284: | ||
* ''Country''. | * ''Country''. | ||
* ''Instructions'' - specific instructions for execution when at this address. | * ''Instructions'' - specific instructions for execution when at this address. | ||
The screen will display the location on a map beneath the address. | The screen will display the location on a map beneath the address. As the address is entered or modified, the Latitude and Longitude of the address will be calculated and displayed. | ||
When both addresses are entered, the screen will display the following information below the delivery address: | When both addresses are entered, the screen will display the following information below the delivery address: | ||
| Line 265: | Line 295: | ||
== Scheduling section == | == Scheduling section == | ||
* ''Collection Times'' - you can enter the collection window using the date and times provided. You can enter the date directly or use the | * ''Collection Times'' - you can enter the collection window using the date and times provided. You can enter the date directly or use the {{Button|Calendar}} button provided. | ||
* ''Delivery | * ''Delivery Times'' - you can enter the collection window using the date and times provided. You can enter the date directly or use the {{Button|Calendar}} button provided. | ||
If the system has any schedule rules configured, the screen will use the organisation, service level and/or customer and zones of the from and to locations to find a compatible schedule rule. If one is found, the system will automatically default the collection and delivery windows for the order based on the rule. | |||
== Requirements section == | == Requirements section == | ||
* ''Temperature Type Code'' - a drop-down list of all temperature types configured in the system. You can maintain these in the [[Temperature Type]] screen. | * ''Temperature Type Code'' - a drop-down list of all temperature types configured in the system. You can maintain these in the [[Temperature Type]] screen. | ||
* ''Vehicle Type'' | * ''Vehicle Type'' - a drop-down list of all vehicle types configured in the system. You can maintain these in the [[Vehicle Types]] screen. | ||
* ''Specified Carrier'' | * ''Specified Carrier'' - the specific carrier that is required for this {{#ifeq: {{{Type|}}}|Template|order template|order}}. You can maintain these in the [[Carriers]] screen. You can look up the available carrier codes using the {{Button|Lookup}} button to the right of the value entry. The screen will display a pop-up window listing the available values. You can filter the values on the list by typing in the provided filter box and clicking the '''Filter''' button. You can select a value from the list, or cancel the look up by closing the window. | ||
Here you can also indicate any special requirements that have been configured for orders in the system. You can configure Order Requirements in the [[Requirements]] screen. | Here you can also indicate any special requirements that have been configured for orders in the system. You can configure Order Requirements in the [[Requirements]] screen. | ||
| Line 291: | Line 323: | ||
== Transport Unit section == | == Transport Unit section == | ||
You can enter the transport units, products or individual items transported on this order in this section. | You can enter the transport units, products or individual items transported on {{#ifeq: {{{Type|}}}|Template|orders created from this template|this order}} in this section. | ||
You can add a quantity of transport units by clicking the | You can add a quantity of transport units by clicking the {{Button|New}} button in the section header. | ||
You can edit an existing transport unit by selecting the row in the table and then clicking the | You can edit an existing transport unit by selecting the row in the table and then clicking the {{Button|Edit}} button in the section header. | ||
Note that, when you select an existing transport unit, if there are any products or items to deliver, these will be shown in a number of tables below the transport units table: | Note that, when you select an existing transport unit, if there are any products or items to deliver, these will be shown in a number of tables below the transport units table: | ||
| Line 303: | Line 335: | ||
The screen will display a pop-up window to allow you to identify the following information: | The screen will display a pop-up window to allow you to identify the following information: | ||
* ''Customer Order Reference'' - an optional references against the ordered line. | |||
* ''Transport Unit Code'' - a drop-down list of the transport unit types configured in the system. You can maintain these in the [[Transport Units]] screen. | * ''Transport Unit Code'' - a drop-down list of the transport unit types configured in the system. You can maintain these in the [[Transport Units]] screen. | ||
* ''Product Type'' - | * ''Product Type'' - The product type contained by the transport unit. You can maintain these in the [[Product Types]] screen. You can look up the available product types using the {{Button|Lookup}} button under the value entry. The screen will display a pop-up window listing the available values. You can filter the values on the list by typing in the provided filter box and clicking the '''Filter''' button. You can select a value from the list, or cancel the look up by closing the window. | ||
* ''Description''. | * ''Description 1''. | ||
* ''Description 2''. | |||
* ''Pack Quantity'' - the pack quantity of the product. | |||
* ''Quantity''. | * ''Quantity''. | ||
* ''Width'' - defaulted from the transport unit type after you enter the quantity. You can change this here if required. | * ''Width'' - defaulted from the transport unit type after you enter the quantity. You can change this here if required. | ||
| Line 318: | Line 353: | ||
You can save the transport unit quantity by clicking the '''Save''' button or cancel entry by closing the window. | You can save the transport unit quantity by clicking the '''Save''' button or cancel entry by closing the window. | ||
You can delete an existing transport unit by selecting the row in the table and then clicking the | You can delete an existing transport unit by selecting the row in the table and then clicking the {{Button|Delete}} button in the section header. | ||
You can add specific products to a transport unit by selecting the row in the table and then clicking the '''New Product''' button in the section header. | You can add specific products to a transport unit by selecting the row in the table and then clicking the '''New Product''' button in the section header. | ||
You can edit an existing product by selecting the row in the table and then clicking the | You can edit an existing product by selecting the row in the table and then clicking the {{Button|Edit}} button above the "Products For Selected Transport Unit" table. | ||
The screen will display a pop-up window to allow you to identify the following information: | The screen will display a pop-up window to allow you to identify the following information: | ||
| Line 338: | Line 373: | ||
You can save the product by clicking the '''Save''' button or cancel entry by closing the window. | You can save the product by clicking the '''Save''' button or cancel entry by closing the window. | ||
You can delete an existing product by selecting the row in the table and then clicking the | You can delete an existing product by selecting the row in the table and then clicking the {{Button|Delete}} button above the "Products For Selected Transport Unit" table. | ||
You can add specific assets/identified items to a transport unit by selecting the row in the table and then clicking the '''New Asset''' button in the section header. | You can add specific assets/identified items to a transport unit by selecting the row in the table and then clicking the '''New Asset''' button in the section header. | ||
You can edit an existing asset by selecting the row in the table and then clicking the | You can edit an existing asset by selecting the row in the table and then clicking the {{Button|Edit}} button above the "Assets For Selected Transport Unit" table. | ||
The screen will display a pop-up window to allow you to identify the following information: | The screen will display a pop-up window to allow you to identify the following information: | ||
| Line 352: | Line 387: | ||
You can save the asset by clicking the '''Save''' button or cancel entry by closing the window. | You can save the asset by clicking the '''Save''' button or cancel entry by closing the window. | ||
You can delete an existing asset by selecting the row in the table and then clicking the | You can delete an existing asset by selecting the row in the table and then clicking the {{Button|Delete}} button above the "Assets For Selected Transport Unit" table. | ||
You can add specific products to an asset by selecting the row in the table and then clicking the '''New Product''' above the "Assets For Selected Transport Unit" table. | You can add specific products to an asset by selecting the row in the table and then clicking the '''New Product''' above the "Assets For Selected Transport Unit" table. | ||
You can edit an existing product by selecting the row in the table and then clicking the | You can edit an existing product by selecting the row in the table and then clicking the {{Button|Edit}} button above the "Assets For Selected Transport Unit" table. | ||
The screen will display a pop-up window to allow you to identify the following information: | The screen will display a pop-up window to allow you to identify the following information: | ||
| Line 372: | Line 407: | ||
You can save the product by clicking the '''Save''' button or cancel entry by closing the window. | You can save the product by clicking the '''Save''' button or cancel entry by closing the window. | ||
You can delete an existing product by selecting the row in the table and then clicking the | You can delete an existing product by selecting the row in the table and then clicking the {{Button|Delete}} button above the "Assets For Selected Transport Unit" table. | ||
== Finance section == | |||
This sections shows a summary of the revenue, cost and margin for the order. | |||
{{#ifeq: {{{Type|}}}|Template| | |||
| | |||
This section also allows you to maintain additional order charges associated to the order, which will generate revenue to the order. | |||
You can add an order charge by clicking the {{Button|New}} button in the section header. | |||
You can edit an existing order charge by selecting the row in the table and then clicking the {{Button|Edit}} button in the section header. | |||
The screen will display a pop-up window to allow you to identify the following information: | |||
* ''Description'' - the description of the charge or service. | |||
* ''Quantity'' - the quantity of this chargeable item or service. | |||
* ''Price'' - the price of this chargeable item or service. | |||
* ''Value'' - the screen calculates this from the quantity and price. | |||
You can save the charge quantity by clicking the '''Save''' button or cancel entry by closing the window. | |||
You can delete an order charge by selecting the row in the table and then clicking the {{Button|Delete}} button in the section header. | |||
== Trips section == | |||
If this order is planned onto any trips, the screen will display the trips onto which it has been planned here. | |||
The screen will display: | |||
* ''Trip Ref'' - the trip reference. | |||
* ''Trip Name'' - the trip name. This may also be the route code, if the trip was generated from a fixed route template. | |||
* ''Trunk Trip'' - a check-box, indicating whether the trip is a trunk trip. | |||
* ''Trip Status'' - the trip status. | |||
* ''Trip Start'' - the location at which the trip starts. | |||
* ''Load'' - the location at which the order is loaded. | |||
* ''Unload'' - the location at which the order is unloaded. | |||
}} | |||
| Line 381: | Line 452: | ||
The following parameters are currently available: | The following parameters are currently available: | ||
<table class="wikitable" border="1"> | |||
<tr bgcolor="silver"> | |||
<th>Label </th><th>Description </th><th>Long Description </th><th>Type </th><th>Values | |||
</th></tr> | |||
<tr><td>Load Location </td><td>Load Location </td><td>Load Location </td><td>TextBox </td><td>String</td></tr> | |||
<tr><td>Order Comment ID </td><td>Order Comment ID </td><td>Order Comment ID </td><td>TextBox </td><td>String</td></tr> | |||
<tr><td>Order Creation Date </td><td>Order Creation Date </td><td>Order Creation Date </td><td>TextBox </td><td>String</td></tr> | |||
<tr><td>Route </td><td> </td><td>Route </td><td>Route </td><td>TextBox </td><td>String</td></tr> | |||
<tr><td>Salesperson </td><td>Salesperson </td><td>Salesperson </td><td>TextBox </td><td>String</td></tr> | |||
<tr><td>Transport Unit Colour </td><td>Transport Unit Colour </td><td>Transport Unit Colour </td><td>DropDownList </td><td>Red,Blue,Green,Yellow</td></tr> | |||
</table> | |||
{{AuditTrailSection}} | |||
}} | |||
</includeonly><noinclude> | |||
Usage: | |||
</ | <nowiki>{{OrderDetails}}</nowiki> | ||
<nowiki>{{OrderDetails|Template}}</nowiki> | |||
{{OrderDetails|Enquiry}} | <nowiki>{{OrderDetails|Enquiry}}</nowiki> | ||
[[Category:Templates]]</noinclude> | [[Category:Templates]]</noinclude> | ||
Latest revision as of 14:47, 18 August 2020
Usage:
{{OrderDetails}}
{{OrderDetails|Template}}
{{OrderDetails|Enquiry}}
