This feature superimposes a Scannable QR code on Consignment Customer Invoices.
This feature is to be used in conjunction with Driver Scan Allocation as it allows transport operators to allocate work to a driver by simply scanning the QR code on the invoice.
It can also be used to enable automatically match signed Consignment Notes, so the paperwork can be signed, bought back, and then automatically allocated to the correct Consignment.

How QR Code Overlay Works

The QR Code overlay is performed when the Invoice file is assigned to the invoice. This step modifies the original file and leaves it with just the QR Code Overlaid. This means that the original file (without the QR Code) no longer exists within CartonCloud.
If the QR Code needs to be moved, the settings will need to be modified and then a new file uploaded. 

When the QR Code Overlay is enabled, it only affects new Consignment Customer Invoices. Existing Consignment Customer Invoices will not be affected.

QR Code overlay will modify the original invoice file. After enabling you'll need to run tests by importing new Consignment Customer Invoice files to ensure that the code is being overlaid exactly where you expect. The original file cannot be recovered after the QR Code Overlay process has taken place.

As QR Code overlay is performed as the Consignment Customer Invoice is allocated to a Consignment within CartonCloud. The original (non-overlaid) file is then deleted. 
This results in the following potential issues:

  1. If the position of the QR overlay gets changed, the previous overlay will still show on the invoice.
  2. If the user disables this feature, the Invoices already uploaded will have the QR code, so they will have to be re-uploaded.

Enabling QR Code Overlay for Invoices

1) Go to 'Customers' > {select the customer} > Click Edit at the bottom of the page. 

2) Click on 'Transport Management' tab > Click on 'Default' sub-tab.

3) Check the box that says "Enable Overlaying of QR on Customer Invoice. This will occur on Invoice generation".

4) Set the "QR code position on Customer Invoice". Currently, this must be configured using variables as per the following default code:

Sample Position Json

{
	"page_rotation":0,
	"qr_code_rotation":0,
	"qr_code_width":200,"
	"qr_code_height":200,
	"qr_code_gravity":"",
	"qr_code_y_adjust":155,
	"qr_code_x_adjust":25
}
JS


Parameter descriptions:

ParameterDefault ValueDescription
page_rotation0How much the page should be rotated, typical values 0, 90, -90, 180
qr_code_rotation0How much to rotate the QR Code
qr_code_width200The width of the QR Code
qr_code_height200The height of the QR Code
qr_code_gravityNorthWest

Where the QR code should be positioned from. See: http://www.imagemagick.org/script/command-line-options.php#gravity

PositionGravity
Top Left CornerNorthWest
Top MiddleNorth
Top Right CornerNorthEast
Left MiddleWest
Middle of PageCenter
Right MiddleEast
Bottom LeftSouthWest
Bottom MiddleSouth
Bottom RightSouthEast

Note: If the Gravity is left empty then it defaults to "NorthWest".

qr_code_y_adjust5The y-axis offset from the original location specified by the gravity setting
qr_code_x_adjust5The x-axis offset from the original location specified by the gravity setting

Now whenever a Consignment Customer Invoice gets uploaded, QR code based on Consignments Barcode Number will be attached to it before saving it.

Example QR Code Positions

Top Left CornerTop Right CornerBottom Right Corner

Sample Position Json

{
	"page_rotation":0,
	"qr_code_rotation":0,
	"qr_code_width":200,"
	"qr_code_height":200,
	"qr_code_gravity":"NorthWest",
	"qr_code_y_adjust":5,
	"qr_code_x_adjust":5
}
JS

Sample Position Json

{
	"page_rotation":0,
	"qr_code_rotation":0,
	"qr_code_width":200,"
	"qr_code_height":200,
	"qr_code_gravity":"NorthEast",
	"qr_code_y_adjust":5,
	"qr_code_x_adjust":5
}
JS

Sample Position Json

{
	"page_rotation":0,
	"qr_code_rotation":0,
	"qr_code_width":200,"
	"qr_code_height":200,
	"qr_code_gravity":"SouthWest",
	"qr_code_y_adjust":5,
	"qr_code_x_adjust":5
}
JS