Skip to main content

Desktop Client Setup

PRINTERS AND SCALES CONFIGURATION

Welcome to the setup guide for printers and scales. This guide will provide you with easy-to-follow instructions to help you set up your shipping workstation with printer(s) and scale configured. Each workstation can be configured to print specific documents to selected printer automatically when a shipment is processed. A scale can be configured to automatically pull the weight and populate in the ship screen in Piyovi TMS. Let's get started!

1. Pre-requisites

Please check the following before you start the installation process:

  • Obtain credentials for UAT or Production Piyovi TMS
  • Login to Piyovi TMS and navigate to Configuration (top menu) → Documents (left menu)
  • Click Download Client Setup icon
  • Save Piyovi Desktop application

image.png

  • Uninstall any previous version(s) of Piyovi Desktop on the workstation
  • Ensure Adobe Reader is installed on the workstation
  • Ensure PDF files are by default opened by Adobe Reader

2. Installation

Here are the steps to installing Piyovi Desktop on a shipping workstation:

  • Right-click on the Piyovi Desktop Setup exe file and select Run as administrator to start the installation process.

image.png

  • A window may pop up asking for permission to run the program, click Yes to continue.
  • Click on Install

image.png

  • Click on Finish

image.png

  • The program should now be installed on your computer and accessible through the Start menu and as a desktop shortcut.

image.png

  • Create a directory (**c:\Piyovi**) if it doesn’t already exist. PDF files will be saved temporarily for printing in this directory. This directory will need to be configured as Storage Path in Printers setup below.

  • Ensure that the workstation user has full control (read/write permissions) to the following:

    • c:\Piyovi directory
    • c:\Program Files\Piyovi LLC\Piyovi Desktop\resources\bin\App_Data\printer.json.config
    • c:\Program Files\Piyovi LLC\Piyovi Desktop\resources\bin\App_Data\scale.json.config
  • Steps to set permissions:

    1. Navigate to the appropriate directory
    2. Right-click on the directory/file and select Properties
    3. Navigate to Security tab and select Users
    4. Click on Edit
    5. Select Users
    6. Click on the checkbox for Full control
    7. Click on Apply
    8. Click on OK
    9. Repeat steps 3 to 8 for printer.json.config and scale.json.config files

image.png

3. Printer Setup

  • Open the Piyovi Desktop application through Start menu or by double-clicking on the desktop shortcut
  • For each document, select the printer to which the document should be automatically printed when a shipment is successfully processed. All printers setup in that workstation will be visible in the drop-down.
  • Ensure that Adobe Path accurately reflects the path on the workstation for Adobe Reader.
  • Ensure that Storage Path accurately reflects an existing directory where PDF files can be saved temporarily for printing.
  • Click Save
  • To clear all selected printer choices and start over, click Trash icon
  • If you made any changes and you would like to reset it back to the last saved configuration, then click Refresh icon

image.png

4. Scale Setup

  • Open the Piyovi Desktop application through Start menu or by double-clicking on the desktop shortcut
  • Click on Scale on the top right corner
  • Based on how the values are received from your scale:
    • Enter dot (e.g., dot if value is 23.43) or comma (e.g., comma if value is 23,43) for Separator
    • Enter multiplication Factor (e.g., 0.01 if value is 2343)

image.png

  • Enter the Product ID and Vendor ID manually (or) click on Search icon to select the appropriate connected USB Device to automatically determine the Product ID and Vendor ID

image.png

  • Click on Test. If the connection is successful, then the Weight value will display
  • Click on Save

5. Verification

  • Log into Piyovi TMS web application from your browser
  • Ensure that the printer icon is green which indicates that direct printing and scale integration are active

image.png

  • If the printer icon is orange, then open the Piyovi Desktop application and refresh the Piyovi TMS web browser window.
  • Appropriate documents will be printed to the configured printers when shipments are processed.
  • Use Alt + w shortcut to retrieve the weight for a packaging unit. Ensure the packaging unit is selected.
  • Alternatively, when the user creates a package by clicking on Pack (Alt + p) or Pack All (Alt + a), the weight will be automatically pulled.

6. Support

If you need any assistance in installing, configuring, and connecting with your printers and scales, please contact support@piyovi.com.