Archiving2yaml
==============

| The Archiving2yaml tool helps user to get the attribute configuration successfully archived by HDBPP solution in the desired yaml file format required by yaml2archiving tool.

How to use the tool
-------------------

* The tool requires event subscribers and configuration manager details from the user in order to fetch attribute configuration and generate the yaml in desired format.

* Command to utilise the script: 

.. code-block:: python

    #archivers are mandatory argument here.
    #managers are optional, if not provided the generated file will not contain any manager.
    python3 tools/v1/archiving2yaml -a ARCHIVER1 ARCHIVER2 ARCHIVERN -m MANAGER1 MANAGERN


* Example of event subscriber/configuration manager names supported:
    - Use trl ``domain/family/member``, when local facility(current deployed tango host) archiver details are required.Example: ``mid-eda/es/01``.

    - Use trl ``domain/family/*``, when details from multiple archiver instances under same domain/family. Example: ``mid-eda/es/*``.

    - Use trl ``tango://tango_host:port/domain/family/member or tango://tango_host:port/domain/family/*``, when attribute configuration details from different tango facility is required.

    Example: ``tango://tango-host1:10000/mid-eda/es/01 or tango://tango-host1:10000/mid-eda/es/*``

* User can fetch attribute configuration details from any number of archivers from similar/different facilities.

    Example:
    ``python3 tools/v1/archiving2yaml -a mid-eda/es/* tango://tango-host1:10000/mid-eda/es/*``