Hibou Odoo Suite: Tools + Settings Modules: Boxes: PrintBox

Purpose

This documentation covers the installation, configuration, and functionality of Hibou's PrintBox module for Odoo. This module allows you to have numerous printers configured for your Odoo database, and provides the creation of profiles to grant permission for users to access and print to specific printers.

PrintBox requires a preconfigured Raspberri Pi. Please contact us for further details.

Getting Started

The first step is to install the module. To do so, navigate to the Apps application..


Once there, remove the 'Apps' filter, then search for 'PrintBox'. When you're ready, click install.


Good to Know!

The PrintBox module requires the Hibou Box - Base. However, if you do not already have this module installed, Odoo will install it for you during this module's installation. 

Process

To get started, navigate to the Boxes app.


This opens up the Boxes application on the Locations page.

Locations

To create a new Location, click Create. This opens a form where you'll enter the following details:

Location: Enter the name for your location.

Under the Boxes tab, click Add a Line. This opens a new line where you'll enter the following details.

  • Name: Enter a name for your first Raspberry Pi.

  • Endpoint: Enter the endpoint for box with protocol, host, and port (e.g. https://127.0.0.1)

  • External Endpoint: This is the URL Odoo will use to connect. It must include the protocol, host, and port (e.g. https://https://127.0.0.1)

  • Use External Endpoint: Use only when your Odoo database is communicating directly with the box.


Under the User Profiles tab, click Add a Line. This opens a new line where you can configure profiles for each user.

  • Profile: Enter a name for the profile.

  • User: Select the user.

  • Current Profile: Check this box if this is an active profile for this user.

  • Letter Printer: Select the printer that should act as the default letter printer for this user's profile.If you have no printers configured, you may do so in the PRINTERS menu, outlined below.

  • Label Printer: Select the printer that should act as the default label printer for this user's profile. If you have no printers configured, you may do so in the Printers menu, outlined below.


When you're ready, click Save.

Boxes

Each Location can house multiple printers that are managed by one box. To configure a box, go to Boxes. If you've already configured a location, then you've automatically created a Boxes profile in that process. As you can see in our example, 'shipbox1' is the existing Box configuration. Let's click into this record for more details.


From within this configuration, click Edit and we'll review each field.

Name: The name of the box.

Location: The physical location of this box.

Endpoint: The endpoint for box with protocol, host, and port (e.g. https://https://127.0.0.1)

External Endpoint: The URL Odoo will use to connect. It must include the protocol, host, and port (e.g. https://https://127.0.0.1)

Use External Endpoint: Use only when your Odoo database is communicating directly with the box.

Communication Timeout: The number of seconds befor the print process times out. 

Skip SSL Validation: Select when your Odoo database is directly communicating with the Box.

Under the Printers tab click Add a Line. This is where you'll add each printer you'd like to be accessible through this Box configuration. This will open a new line where you'll enter the following:

  • Name: The name of the printer.

  • Queue: Which queue will be printed to this printer.


Repeat this process for each printer. When you're ready, click Save.


User Profiles

We already configured User Profiles via the Locations process, but you can also manage them under the User Profiles menu. To create a new one, click Create. Complete the following fields in the form.

Profile: Enter a name for the profile.

User: Select the user.

Current Profile: Check this box if this is an active profile for this user.

Use Endpoint External: Use only when your Odoo database is communicating directly with the box.

PrintBox

  • Letter Printer: Select the printer that should act as the default letter printer for this user's profile.If you have no printers configured, you may do so in the PRINTERS menu, outlined below.

  • Label Printer: Select the printer that should act as the default label printer for this user's profile. If you have no printers configured, you may do so in the PRINTERS menu, outlined below.


When you're ready, click save.


Activate / Disable Profile

Users may have multiple profiles depending on which location they need to print to. To activate a profile, click the  icon on the top-right of the screen, then click Activate next to the appropriate profile. Note that in order for a profile to be listed in this window, it must be designated a "Current Profile" in the configuration.


To disable the profiile, again click the  icon on the top-right of the screen, then click Disable.



Printers

We already configured Printers via the Locations process, but you can also manage them under the printers menu. To create a new one, click CREATE. Complete the following fields.

Name: Enter the name of the printer.

Queue: Which queue will be printed to this printer.

Box: Select the box to connect this printer to.

Location: This field will auto-populate with the location of the selected box. 


When you're ready, click Save.

This configuration also has several buttons used for testing.

Print Test Letter to print to the local letter printer.

Server Test Letter to print to the network letter printer.

Print Test Label to print to the local label printer.

Server Test Label to print to the network label printer.