Champ QR setup

Owned by Hauke Gulich
Last updated: Mar 11, 2024 by Bärbel Neitzel
3 min read

 

Contents

 

Function in the order

General technical requirements

  • The eFile must be set up in the TMS.

  • The MW6 Matrix font must be installed.

  • The QRCodeFont.dll must be present in the CargoSoft directory.

  • A firewall release must be set up for the URL "https://community.champ.aero:8443/api/" (port 8443).

If a proxy or similar exists, this must also be considered.

Participant code

As a customer, you must request a participant code from Champ.

Champ saves a fixed URL (webhook) for this participant code, via which the status can be called up.

ADMIN → EDI → EDI PARTNER

The EDI partner CHAMPQR must be available in the basic data.

When the interface is set up, it is automatically created using an SQL script.

ADMIN → EDI → EDI PARTNER → Qualifier tab

The qualifier QRCODE_CLIENT_CODE with your participant code must be created on the Qualifier tab in EDI partner.

Furthermore, there must be two standard entries QRCODE_REQUESTED_PASSWORD and QRCODE_REQUESTED_USERNAME.

Qualifier:

  • QRCODE_CLIENT_CODE = participant code (is assigned by Champ per customer)

  • QRCODE_REQUEST_PASSWORD = v3t+ry

  • QRCODE_REQUEST_USERNAME = cargosoft-prod

image-20240311-132921.png

ADMIN → STATUS TYPES → STATUS EVENTS

When the interface is set up, the provider CHAMPQR is created in the status events.

The following status codes are available here.

The standard status event functions can be used.

image-20240311-132954.png

Info: The status codes received from Champ are too long. The status codes are therefore automatically converted using EDI codes.

Client

EDI partner

Direction

Table

Source code

Destination code

000

CHAMPQR

E

STATUS_CODE

delivered

DLV

000

CHAMPQR

E

STATUS_CODE

discrepancy

DIS

000

CHAMPQR

E

STATUS_CODE

picked up

PUP

ADMIN → URLs

The end points for the Champ system must be stored manually under Urls in ADMIN.

The URL can differ individually.

ADMIN → FORMS → FORM CATEGORIES

In the FORM CATEGORIES, the category QR code must exist (as description) so that it can be saved in the eFile.

The category is created when the interface is set up using an SQL script.

FORM GENERATOR

Integration of the QR code in the FormGen form

In order to be able to print the QR code in the FormGen form, a fixed text must be inserted in the form.

The following expression must then be specified here:

  • gf_qrcode (champ_firstmile, 1) → QR code for the first mile (precarriage)

  • gf_qrcode (champ_lastmile, 1) → QR code for the last mile (oncarriage)

The font needs to be changed to MW6 Matrix.
The text field must be enlarged accordingly so that the QR code is properly displayed there.

Alternatively, there are two new fields in FormGen

  • QR Code first mile tracking and

  • QR code last mile tracking

Here, however, only the URLs would be printed as clear text (no QR code).

Â