.. _winuser:

Console Users
=============

Originally, the configuration generated by :ref:`userdb_config` for the
non-MPTGS users was for an on-host activity generator named winuser.
Winuser has been replaced by :ref:`cu`, which works across
more platforms and can reduce test artifacts.

To produce ConsoleUser configuration files from UserDBConfig then takes
a couple of steps.  First, the set of configuration files for each user
should be extracted from the database.  Second, those need to be
converted to the new format of files, as detailed in :ref:`cu_config`.

Extraction
----------

ConsoleUser provides a tool to pull a user's set of config files out of
the MySQL/MariaDB database populated by :ref:`userdb_config`.  Run

.. code-block:: bash

    python GetConfig.py -k "UserKey" -d "path/to/write/files" -s "dbServer" -n "dbName"

The ``UserKey`` parameter is typically the "hname" field, which may or
may not be the same as the username for that user.

To simplify this process a tool ``get_configs.sh`` is provided.  This
will query the database to find all the configs that should be on the
current controller (in case there are more than one) then extract all
of those files.

.. _winuser_convert:

Conversion
----------

The files that are extracted from the database are actually for a
previous product from Skaion, and so need to be converted to be
suitable for ConsoleUser.  ``convertWinUserConfig.sh`` will process a
directory of files, changing fields and filenames from WinUser to
ConsoleUser formats.

.. code-block:: bash

    ./convertWinUserConfig.sh -d "path/to/configDir"

The ``fetch_cu_config.sh`` script mentioned above will perform this
step in addition to the extraction.