Beverage Deposits
==============================================================================

This customization adds a two level (container type, container volume) and
summary deposit for beverage containers.

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Contents:

   testing

.. contents:: Contents
   :depth: 2

Installation
------------------------------------------------------------------------------

The customization is installed using `Customization Manager`_.  The 
short name for the customization is :guilabel:`poplar_bvgdep`. Check out the
instructions for downloading Customization Manager and managing
customizations in the `documentation`_.

.. _Customization Manager: https://customization-manager.readthedocs.io/
.. _documentation: https://customization-manager.readthedocs.io/en/latest/howtos.html

Environment Setup
------------------------------------------------------------------------------

The customization depends on the override optional field being configured in 
Common Services and assigned to the O/E Header.  When it is installed, the
customization will create the optional field in Common Services, but it 
must be manually mapped to the O/E Header.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_bvgdep/common_services_depoverride.png
    
    The optional field should be created in Common Services by default.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_bvgdep/oe_optf_depoverride.png
    
    It must be manually assigned to the O/E Header.

Configuration and Usage
-------------------------------------------------------------------------------

The customization has two configuration tables.  The first is used to store
the summary items for each deposit level.  To configure them:

1. Navigate to :guilabel:`Extender --> Setup --> Custom Table Edtor`.
2. Load the :guilabel:`Bottle Deposit Configuration` table.
3. Set the :guilabel:`Configuration ID` to ``1``.
4. Using the finder, select the first and second level summary deposits.
5. :guilabel:`Add` the record.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_bvgdep/summary_item_config.png

    Summary item configuration with E1-900/0 for the first level and E2-900/0 
    for the second.

The second table stores the per-item deposits.  To configure the first and 
second level deposits for an item:

1. Navigate to :guilabel:`Extender --> Setup --> Custom Table Edtor`.
2. Load the :guilabel:`Bottle Deposits` table.
3. Set the :guilabel:`Beverage Item`, :guilabel:`First Deposit` and :guilabel:`Second Deposit`.
4. Using the finder, select the first and second level summary deposits.
5. :guilabel:`Add` the record.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_bvgdep/ideposit_config.png

    Configuring the deposits for B1-001/0 a large plastic bottle of Cola.

Debugging
-------------------------------------------------------------------------------

Debugging can be enabled for the customization if troubleshooting needs to be
done.  The enable debug:

1. Create an empty file at ``%SHAREDDATA%\COMPANY\<org>\ppbvgdep.debug``.
2. Close and re-open the O/E Order Entry screen.

Additional information will be displayed in message boxes and will be saved to
the file ``%SHAREDDATA%\COMPANY\<org>\ppbvgdep.log``.

To disable debugging, delete the ``ppbvgdep.debug`` file and re-open the 
screen.