pixi
Ask AI
What's an 'Ideas Portal'?
DE

pixi Connector

The desktop application pixi Connector is the interface between web and desktop and will perform the following tasks:

  • Passing the local computer name (host name) to pixi Web

  • Overview and display of all printers set up locally or connected in the network

    • to forward print jobs to the selected printer(s)

    • to print item (EAN) labels from the Web - Item Management

    • to print item (EAN) labels from the Web - Goods Receipt

    • to print delivery notes for a single package (usual scan-in or ship-out process) from the Web

    • to print shipping labels for one-package shipments from the web (usual scan-in or ship-out process)

    • to print the delivery notes as documents for the package for multi-package shipments from the web

    • to print shipping labels for the multi-package shipments from web
      (extended scan-in or ship-out process)

  • saving polling files on the desktop/computer

  • Logging of connection establishment between desktop application and web application

  • Reading and processing of Tracking and Return Tracking IDs


Installation/Set up

pixi Connector is part of the full desktop installer for download in pixi Web > Administration > Downloads.

Note: For the login to pixi Connector, the activation of pixi messaging is required.
If this is not yet actived, please contact pixi support.


After downloading and installing the application, you can use your database credentials for login as usual, each employee can login with his username and password. There is no separate user administration or role assignment in the Control Center for using the pixi Connector.

  • URL: https://web-ams.pixi.eu/ or https://web.pixi.eu/

  • Database: XXX

  • Username: [your username]

  • Password: [your password]


Attention: If the Connector is running continuously on a PC or server that is never shut down, a new login must be performed at least every 5 days. If this login does not occur, the Connector can no longer authenticate in the background and will stop functioning. There is no visible notification for the user in this case. The Connector should be restarted manually.



The installer will automatically create a shortcut in the following directories:

  • C:\ProgramData\Microsoft\Windows\Start Menu\Programs\pixi (Windows 11).

  • C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp (Windows 11)

They will link to the directory (C:\pixi\pixiConnector.exe). If you want to change the autostart options for pixi Connector, you can find further information on this Microsoft page (Changing which apps run automatically at startup in Windows).

During testing, after uninstalling and reinstalling pixi Connector, the status in the autostart options was maintained (if autostart was disabled before uninstalling = autostart remained disabled after reinstalling).



After you log in to the application, it runs in the system tray:


Right click on the pixi Connector icon:

  • About: shows you the currently used version, the logged in user (User) and the computer name (Computer).

  • Furthermore, all printers set up/connected at this workstation/computer are displayed, which you can select afterwards in the web application for printing item labels, shipping labels or delivery bills.

  • The information at Printing shows you if a connection to pixi Messaging (Rabbit MQ) could be established (Enabled/Disabled).


  • Rediscover printers: searches and reloads the locally connected printers into the pixi database and also logs them in the log file (see Connection Logging) (bpsw. relevant if a printer is deleted or added at a later time).

  • When (re)starting pixi Connector, all currently available printers are always loaded.

:{"@t":"2020-09-04T13:09:23.6168393Z","@mt":"Discovered printers: Adobe PDF, ZDesigner GC420d, SLO_RICOH_MP_C2004ex, OneNote for Windows 10, Print barcode to file_ZDesigner GK420d (EPL), OneNote (Desktop), Microsoft XPS Document Writer, Microsoft Print to PDF, KONICA MINOLTA bizhub 20 PCL (10.8.157.199) UPD, Fax, \\\\CPINF01\\SI-SNR-RICOH, \\\\CPINF01\\SI-SNR-GEN-Konica Minolta Bizhub 20.","Username":""}

  • Exit: terminates the application.

Back to top

Saving Print Jobs

  • Documents such as delivery notes are saved temporarily (as .pdf) until they can be printed.

  • Documents such as shipping labels are saved temporarily (as .) until they can be printed.

  • The files are saved in the following directory:

    • C:\Users\{%User%}\AppData\Local\pixi\pixiConnector\savedPrintJobs

    • e.g. C:\Users\{%User%}\AppData\Local\pixi\pixiConnector\savedPrintJobs

  • The directory will be completely emptied as soon as the size of 1GB is exceeded.


Connection Logging

The connection setup between desktop application and web application as well as the respective print jobs are logged locally in the following directory:

  • C:\Users\{%User%}\AppData\Local\pixi\pixiConnector\

Please always send us the log files of the respective workstation for further analysis or troubleshooting.

Log Rotation:

  • First, the log file pixiConnector.log is created as soon as the size of 33 MB is exceeded, a new file is created in the following format: pixiConnector_001.log
    Further files are created analogously: pixiConnector_002.log.

  • The maximum size of the directory does not exceed the 100 MB mark, provided that pixiConnector_004.log file has been written, the oldest file e.g. pixiConnector_001.log is removed.

Back to top

Printing of item labels from Goods Receipts

You can print item labels from Goods Receipts.

Note: Printing item labels from Goods Receipts requires prior activation of pixi Messaging, please contact our support (servicedesk@descartes.com). They will assist you with the setup of pixi Messaging.

Back to top

Reading and processing Tracking and Returns Tracking IDs

Until now, tracking information could not be imported automatically via pixi to the respective package or invoice. The data therefore either had to be imported to the invoice, could be generated by the system via the Control Center in the case of Returns Tracking IDs, and transmitted to the end customers via the Order Sent e-mails (with tracking link only works if all packages were shipped with the same shipping vendor).

If tracking information about the package should be imported, this currently has to be done via the existing API call pixiUpdateInvoicePackage.
In this case, the new e-mail type "Package Information" can be used without restrictions.

The import of Tracking and Returns tracking IDs is controlled by pixiToolboxSettings.json configuration file.

The configuration file is located under:
C:\Users\{%User%}\AppData\Local\pixi\pixiConnector\

Any number of profiles can be stored in the configuration file and thus files from other directories can be considered and processed.

If the file is not located in the described path, you can create it using a text editor. Save it as
pixiToolboxSettings.json.

Currently, tracking files can only be processed in *.csv|*.xml|*.out format.

Variable

Explanation

ResetClientNotified

When the new setting ResetClientNotified is set to True, the import of a new tracking number for a package/invoice via pixi Connector prepares only the included items for export to the shop

PixiDatabase

This setting determines which database pixi Connector connects to by default.

If a value is provided, the Database field does not need to be filled in when logging into Connector.

The setting is intended for On premise customers.

PixiWebURL

Defines which URL is used for the connection with pixi Connector.

By default, https://web.pixi.eu should be set.

Note: On premise customers must include this setting in their file.

TrackingIdImportChunkSize

The number of lines that will be imported in a "block". Recommended value: 200.

SavedDocumentsPath

File path in which the documents are to be saved.

CreateSubfoldersForEachMonth

False: Documents will be saved in the folder specified by SavedDocumentsPath.

True: Files are saved to subfolders based on the DocumentDate.

Example: "DocumentDate": "2022-01-07T10:05:52.8885751Z" = subfolder "01 - 2022".

ProfileName

Profile Name (e.g. DHL SP|DHL MP)

ParsingMethod

0 = csv / 1 = xml

ShipVendorFolder

File path for reading the tracking information

FileFilter

File name and file format e.g. ELSendEx*.csv

ProcessedFilePath

ProcessedFileType

File path to store successfully processed files
File extension after processing

ErrorFilePath
ErrorFileType

File path to store files processed with errors
File extension after processing

IgnoreHeader

If the header information in the file should be ignored

  • true = enabled

  • false = disabled

Separator

;

TrackingIDIndex

Position of the tracking ID within the file

ReturnTrackingIDIndex

Position of the return tracking ID within the file

PackageIDIndex

Position of the package ID within the file (if available). When importing tracking IDs of single packages (i.e. no multi-package shipments), this parameter should be removed or omitted.

InvoiceNumber

Invoice number

InvoiceNumberIndex

Position of the invoice number within the file

InvoiceNumberSeparator

Sets the separator within the InvoiceNumber field (e.g. -).

InvoiceNumberFormat

Defines the format within the InvoiceNumber field. Placeholders are used to define where InvoiceNumber and PackageID are located.

Example:

InvoiceNumberSeparator: |, InvoiceNumberFormat: boxnr|invoicenr|packageid

The separator is |. The second value contains the Invoice Number and the third value contains the PackageID.

AutomaticLogin

Specifies whether the pixi Connector should log in automatically or require manual authentication.
This behavior is controlled via the “automaticLogin” setting in the “pixiToolboxSettings.json” file under the “General Settings” section:

  • True: The Connector logs in automatically without requiring user input. This is the default value if “automaticLogin” is not specified.

  • False: A login window appears, and the user must enter their credentials manually.

Example: If you have TrackingID in second position in the CSV file, you should set the corresponding value for TrackingIDIndex in pixiToolboxSettings.json CSV profile to 1.
The same applies to ReturnTrackingIDIndex, PackageIDIndex, InvoiceNumberIndex.
The value can also be left empty, but in that case, nothing will be imported for this parameter.

*.csv Profil DHL

  • DHL SP = DHL Single Package Ship-Out

    • For reading and processing Tracking and Returns Tracking IDs for single package shipments, the PackageIDIndex parameter must be removed or omitted.

  • DHL MP = DHL Multiple Packages Ship-Out

    • For reading and processing Tracking and Return Tracking IDs for multi-package shipments the parameter PackageIDIndex must be set (bpsw. "PackageIDIndex": 0,).


{
"GeneralSettings": {
"TrackingIdImportChunkSize": 200,                    "PixiWebURL": "https://web.pixi.eu",                    "PixiDatabase": "ABC",                    "ResetClientNotified": true
},    "SaveDocumentSettings": {
"SavedDocumentsPath": "C:\\pixi\\SavedDocuments",
"CreateSubfoldersForEachMonth": true,
"AutomaticLogin": false
},
"Profiles": [
{
"ProfileName": "DHL CSV Profile SP",
"ParsingMethod": 0,
"ShipVendorFolder": "C:\\pixi\\DHL\\TrackingIds\\",
"FileFilter": "*.csv",
"ProcessedFilePath": "C:\\pixi\\DHL\\TrackingIds\\",
"ProcessedFileType": ".done",
"ErrorFilePath": "C:\\pixi\\DHL\\TrackingIds\\",
"ErrorFileType": ".error",
"IgnoreHeader": true,
"Separator": ";",
"TrackingIDIndex": 1,
"ReturnTrackingIDIndex": 66,
"InvoiceNumberIndex": 22
},
{
"ProfileName": "DHL CSV Profile MP",
"ParsingMethod": 0,
"ShipVendorFolder": "C:\\pixi\\DHL\\TrackingIdsSubfolders\\",
"FileFilter": "*.csv",
"ProcessedFilePath": "C:\\pixi\\DHL\\TrackingIdsSubfolders\\Processed\\",
"ProcessedFileType": ".done",
"ErrorFilePath": "C:\\pixi\\DHL\\TrackingIdsSubfolders\\Error\\",
"ErrorFileType": ".error",
"IgnoreHeader": true,
"Separator": ";",
"TrackingIDIndex": 1,
"ReturnTrackingIDIndex": 66,
"PackageIDIndex": 0,
"InvoiceNumberIndex": 22
}
]
}

*.csv Profile DPD

{
  "Profiles": [
    {
        "ProfileName": "DPD CSV Profile SP",
        "ParsingMethod": 0,
        "ShipVendorFolder": "C:\\pixi\\DPD\\Tracking\\",
        "FileFilter": "*.csv",
        "ProcessedFilePath": "C:\\pixi\\DPD\\Tracking\\DONE\\",
        "ProcessedFileType": ".done",
        "ErrorFilePath": "C:\\pixi\\DPD\\Tracking\\ERROR\\",
        "ErrorFileType": ".error",
        "IgnoreHeader": true,
        "Separator": ";",
        "TrackingIDIndex": 0,
        "InvoiceNumberIndex": 3
    }
  ]
}


*.xml Profile UPS

{
  "Profiles": [
    {
        "ProfileName": "UPS XML profile SP",
        "ParsingMethod": 1,
        "ShipVendorFolder": "C:\\pixi\\UPS\\Polling\\",
        "FileFilter": "*.Out",
        "ProcessedFilePath": "C:\\pixi\\UPS\\Polling\\Success",
        "ProcessedFileType": ".success",
        "ErrorFilePath": "C:\\pixi\\UPS\\Polling\\Error",
        "ErrorFileType": ".error",
        "TrackingIDPath": "OpenShipments/OpenShipment/ProcessMessage/TrackingNumbers/TrackingNumber",
        "InvoiceNumberPath": "OpenShipments/OpenShipment/ShipmentInformation/Reference1"
    },
    {
        "ProfileName": "UPS XML profile MP",
        "ParsingMethod": 1,
        "ShipVendorFolder": "C:\\pixi\\UPS\\Polling_MP\\",
        "FileFilter": "*.Out",
        "ProcessedFilePath": "C:\\pixi\\UPS\\Polling_MP\\Success",
        "ProcessedFileType": ".success",
        "ErrorFilePath": "C:\\pixi\\UPS\\Polling_MP\\Error",
        "ErrorFileType": ".error",
        "TrackingIDPath": "OpenShipments/OpenShipment/ProcessMessage/TrackingNumbers/TrackingNumber",
        "PackageIDPath": "OpenShipments/OpenShipment/ShipmentInformation/Reference2",
        "InvoiceNumberPath": "OpenShipments/OpenShipment/ShipmentInformation/Reference1"
    }
  ]
}

*.xml Profil VLOG

{
  "Profiles": [
    {
      "ProfileName": "VLOG XML profile",
      "ParsingMethod": 1,
      "ShipVendorFolder": "C:\\pixi\\XMLImportTesting",
      "FileFilter": "*.xml",
      "ProcessedFilePath": "C:\\pixi\\XMLImportTesting\\Success",
      "ProcessedFileType": ".success.xml",
      "ErrorFilePath": "C:\\pixi\\XMLImportTesting\\Error",
      "ErrorFileType": ".error.xml",
      "Separator": ";",
      "TrackingIDPath": "MHP_STRUKTUR/SHIPMENT/SHIPMENT_DETAILS/PACKAGE/PACKAGE_HEADER/SEND_ID",
      "ReturnTrackingIDPath": "MHP_STRUKTUR/SHIPMENT/SHIPMENT_DETAILS/PACKAGE/PACKAGE_HEADER/SEND_GEWICHTEINZEL",
      "PackageIDPath": "MHP_STRUKTUR/SHIPMENT/SHIPMENT_DETAILS/PACKAGE/PACKAGE_HEADER/SEND_2N_PRODCODE",
      "InvoiceNumberPath": "MHP_STRUKTUR/SHIPMENT/SHIPMENT_HEADER/SEND_REFERENZNR_01"
    }
  ]
}

Back to top