==============================
openpyxl-redmine configuration
==============================

Application domain
------------------

The application domain defines which group of Redmine projects a
workflow application can access and is specified by the leading characters of
the application name before the first "-". Thus the application:

pmo-workflow $API_key workflow_extract DP014 playground/test.xlsx

expects to find configuration "definitions" of project DP014 in the "pmo"
domain, where DP022 is the single token project "key" of the targeted Redmine
project.

Currently "domain", "key" and "definitions" values are defined in the
src/config/portfolio.config as the following snippets shows

::

    "pro": {
        "DP014": {
            "url": "https://in.xfel.eu/redmine", "primary_id": 1449,
            "version": "3.3.3", "cfg_file": "pro.config",
            "desc": "DP014 XPD Calorimeter" },
        ...
    "dev": {
        "DP014": {
            "url": "http://localhost:30010/redmine", "primary_id": 1449,
            "version": "5.0.0", "cfg_file": "dev.config",
            "desc": "DP014 XPD Calorimeter" },
        ...

, where

.. note::

    "key" is the single token nickname of the workflow and can appear in
    different domains.

.. note::

    "desc" is appended at the end of the subject of all workflow tasks
    injected into a Redmine project.

.. note::

    "primary_id" identifies uniquely the Redmine project targeted.

.. warning::

    the "desc" field appended to task subjects should not be modified, it's
    used to find the anchor task of the workflow in the Redmine project. This
    allows different workflows to occupy the same Redmine project.