@order codes
Applies to: 4.5 NeoPackProfessional, PackBuilder
This article assumes the reader has a good understanding of ordering in Version 4. It is highly recommended at least the following articles are consulted prior to this one.
Ordering in Version 4
Understanding orders
Offers, products and packages - an overview
@order @package @product
Version 4.5 introduced several variations of the @order tag. Whereas the @order tag will continue to list all packages in all orders for a given subject, the variants take into account order sets and the subjects' current order. This makes the various @order tags ideal for including on packing and proofing slips and labels.
The situation
The various @order tags are perhaps best described by way of example.
Consider the subject John Smith who has four orders for a particular job spread across three different order sets:
Orderkey | OrderSet | Package Codes | Package Descriptions |
XCV43WE5 |
Default set |
pk1 |
Deluxe Package |
2CD7TWK5 |
RetakeDay |
PK2 |
Premium Package |
KLWS32FF |
2019-05-06 |
PK3 PK4 |
Classic Package Traditional Package |
9T4QS5QF |
2019-05-06 |
pk5 |
Basic Package |
Default set |
X |
Note the last package code - X. This 'package' has been ordered but there is no corresponding package code in the offer. Such a code is sometimes used as 'NoBuy' code
@order
Applies to all order sets
The @order tag will list all packages for all orders for a given subject. For John Smith the result will be:
[] /[PK1] / [PK2] / [PK3] / [PK4] / [PK5]
Note 'Package X' since it is not in the offer, does not resolve and therefore does not display.
The @order tag need not be placed on a layout that is 'ordered' via a package code. The layout can simply be selected for a subject in Point and Click Mode or used in an Item in Item Sheets Mode.
@ordercode
Applies to default order set only
The @ordercode tag lists all package codes exactly as they were entered and regardless of whether the codes resolve against an offer.
x//pk1
Note the different format of @ordercode and the fact package codes are displayed exactly as entered with respect to case and whether or not the codes are processed against an offer.
@orderdescription
Applies to default order set only
The @orderdescription tag lists all package descriptions as they were defined for the package in Timestone Administrator in the default set only
Deluxe Package / Package X
Note the unresolved package code, X, is displayed with a generic 'Package X'
@orderscode
Applies to all order sets
The @orderscode tag lists all package codes exactly as they were entered and regardless of whether the codes resolve against an offer.
x//pk1//PK2//PK3//PK4//pk5
Note the different format of @ordercode and the fact package codes are displayed exactly as entered with respect to case and whether or not the codes are processed against an offer.
@ordersdescription
Applies to all order sets
The @ordersdescription tag lists all package descriptions as they were defined for the package in Timestone Administrator.
Deluxe Package / Premium Package / Classic Package / Traditional Package / Basic Package / Package X
Note the unresolved package code, X, is displayed with a generic 'Package X'
@order-defaultset
The @order-defaultset tag will list all packages for all orders in the default orderset only. For John Smith the result will be:
[] [PK1]
The @order-defaultset tag need not be placed on a layout that is 'ordered' via a package code. The layout can simply be selected for a subject in Point and Click Mode or used in an Item in Item Sheets Mode
@order(orderset) where orderset is the name of a specific order set
The @order(orderset) tag will list all packages for all orders in the specified set. For John Smith a tag of @order(RetakeDay) will result in:
[PK2]
Whereas a tag of @order(2015-05-06) will result in:
[PK3] / [PK4] / [PK5]
The @order(orderset) tag need not be placed on a layout that is 'ordered' via a package code. The layout can simply be selected for a subject in Point and Click Mode or used in an item in Item Sheets Mode
@order-thisset
The @order-thisset will list all packages for all orders in the order's set. With the John Smith example above if @order-thisset is used on a product ordered with either PK3, PK4 or PK5 , the result will be:
[PK3] / [PK4] / [PK5]
The @order-thisset tag can only be used on a packlayout that is ordered via a Package Code. As such it will be blank if used directly in Point and Click or Item Sheets Modes.
@order-thisorder
The @order-thisorder will list all packages in the current order only ignoring any other orders. With the John Smith example above if @order-thisorder was used on a product ordered with either PK3, PK4 the result would be:
[PK3] / [PK4]
However if @order-thisorder was used in package PK5 the result would be:
[PK5]
The @order-thisorder tag can only be used on a packlayout that is ordered via a Package Code. As such it will be blank if used directly in Point and Click or Item Sheets Modes.
End of article