Custom Table UIs
==============================================================================

This customization allows you to generate stand alone UIs for any custom table.
Coupled with `Screen Permissions`_, access to the custom table can be 
controlled at the screen or field level.

Throw in a `Custom Table Column`_ and the data collected in your table is
dynamically displayed, and editable, right alongside related data in native
Sage screens.

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


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

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

The customization short name is `poplar_customtableui`

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

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

The customization requires that at least one Custom Table has been created to
store data. Create new Custom Tables using the 
:guilabel:`Extender --> Setup --> Custom Table Editor`.

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

The customization works by dynamically generating a small script that can 
generate a UI for any Custom Table.  The script is registered in
:guilabel:`Extender --> Setup --> Scripts`.  Once registered the script
can be run through that panel.

To register a new script for a table, create a new entry in the Custom Table
UI configuration:

1. Open :guilabel:`Extender --> Setup --> Custom Table Editor`.
2. :guilabel:`Load` the :guilabel:`Custom Table UI` table.
3. Configure a new entry:

   - Script Name: the name of the script as it should appears in the 
     :guilabel:`Scripts` panel
   - Table Name: the Custom table to generate a screen for
   - Permission Screen: the permission screen code for this screen, must start
     with "VI" and requires that `Screen Permissions`_ be installed to take 
     effect.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_customtableui/define_new_ui.png

   Define a new UI for any table, even the configuration table for this 
   customization.

4. Save the entry. A new script is generated and installed.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_customtableui/success_message.png
   :width: 450px

   A new script has been installed for the configuration table, 
   `Screen Permissions`_ is installed and access can be controlled
   with permissions on the ``VICTUI`` screen.

A UI is now available for the custom table by running the 
:guilabel:`Script Name` from :guilabel:`Extender --> Setup --> Scripts`.

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_customtableui/scripts_panel.png

   The new TestCustomTableUI script is now available through the scripts
   panel.

Highlight the script and click :guilabel:`Run` to start the UI.  

.. figure:: https://s3.amazonaws.com/dev.expi/content/poplar_customtableui/custom_table_ui.png

   The new UI for the configuration is dynamically generated and displayed.

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>\ppcustui.debug``.
2. Restart the desktop and peform any testing required.

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

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

.. _Screen Permissions: https://poplars.dev/customizations/poplar_screenperms.html
.. _Custom Table Column: https://poplars.dev/customizations/poplar_columns.html