.. Detail Optional Fields documentation master file, created by
   sphinx-quickstart on Sun Dec 13 14:25:18 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Detail Optional Fields
==================================================

This customization adds optional fields to Sage detail objects that do not
have them out of the box.

The customization currently supports the Bank Entry Detail view and Bank Entry
(BK2300) screen.

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

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

The :guilabel:`poplar_doptf` customization is installed using 
`Customization Manager`_.

To install the customization using Customization Manager:

1. Visit `Customization Manager`_ documentation and download the most recent
   version.
2. In Sage 300, log in as admin and navigate to 
   :guilabel:`Extender --> Setup --> Modules`.
3. Click the :guilabel:`Import` button and select the file downloaded in 
   step 1 (``EXPIP.poplar.vi``)
4. Setup your API key by opening 
   :guilabel:`Extender --> Setup --> Custom Table Editor` and loading the
   ``Customization Manager Config`` table.
5. Input your API key, :guilabel:`Add` the record.

Restart the Sage Desktop.

1. Open :guilabel:`Extender --> Setup --> Customization Manager`.
2. The first time Customization Manager loads, it will attempt to 
   upgrade core Python libraries.  You may be prompted twice and 
   the process can take up to two minutes, during which the
   desktop appears unresponsive.
3. Once the environment is ready, the Customization Manager window 
   will appear.
4. Highlight the ``poplar_doptf`` customization and click
   :guilabel:`Install`.
5. Once the customization is successfully installed, close 
   Customization Manager.

Restart the Sage Desktop a final time to register the OCX changes to
the screens.

Done.

.. _Customization Manager: https://customization-manager.readthedocs.io

Configuration
--------------------------------------

The customization relies on the optional field configuration on Common
Services.  To start, define the optional field you want to add to the
detail view.  If validation is enabled for the field, it will be 
enforced.

The optional field will automatically be displayed in the associated
grid.  The optional field description will be used as the column header.

.. image:: images/optional_field_config.png
    :width: 600px

Once the optional field is defined, it must be assigned to the detail view.

1. Open the :guilabel:`Custom Table Editor` and select the 
   :guilabel:`Detail View Optional Field Config` table.
2. Select from a supported detail view, the optional field desired, set
   a default value if desired, and select whether the field should be editable
   in the associated grid.
3. Save the detail view optional field configuration.

.. image:: images/optional_field_assignment.png
    :width: 600px

Usage 
--------------------------------------

For eacho optional field defined, a new column will automatically be added to
the associated grid.

.. image:: images/detail_grid.png
    :width: 600px

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>\ppdoptf.debug``.
2. Close and re-open the A/R Receipts Screen.

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

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



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`