
Popis jednotlivých xml
======================

.. _`package.xml`:

package.xml
----------------------

    Obsahuje identifikátory a verzi balíčku.

    .. code-block:: xml

        <package>
          <code>KOD_BALICKU</code>
          <name>Název balíčku</name>
          <version>1</version>
          <description>Popis balíčku</description>
        </package>



    <package>
        Základní značka balíčku

    <code>
        Strojově zpracovatelný kód balíčku

    <name>
        Název balíčku zobrazovaný v seznamu importovaných balíčků

    <version>
        Verze balíčku

    <description>
        Popis balíčku (např. obsah, funkce atp.)


.. _`rul_item_spec.xml`:

rul_item_spec.xml
-------------------------

    Obsahuje definice hodnot prvků popisu pravidel.

    .. code-block:: xml

        <item-specs>
            <item-spec code="KOD_HODNOTY" item-type="KOD_PRVKU_POPISU">
                <name>Soubor</name>
                <description>Soubor</description>
                <shortcut>Soubor</shortcut>
                <view-order>1</view-order>
            </item-spec>
            <item-spec code="code" item-type="type">
                ....Lze definovat vícekrát....
            </item-spec>
        </item-specs>

    <item-specs> - POVINNÉ
        Značka obalující definice hodnot

    <item-spec>
        Značka definice hodnoty.

        code=" "
            Strojově zpracovatelný kód pro identifikaci hodnoty

        item-type=" "
            Kód prvku popisu pod kterým se tato hodnota zobrazí.

    <name>
        Název hondoty

    <description>
        Popis hodnoty

    <shortcut>
        Zkratka hodnoty

    <view-order>
        Pořadí v seznamu

.. _`rul_item_type.xml`:

rul_item_type.xml
---------------------------

    Obsahuje definice prvků popisu pravidel.

    .. code-block:: xml

        <item-types>
            <item-type code="KOD_PRVKU_POPISU" data-type="ENUM">
                <name>Způsob pořádání</name>
                <shortcut>Způsob pořádání</shortcut>
                <description>Popis</description>
                <is-value-unique>false</is-value-unique>
                <can-be-ordered>false</can-be-ordered>
                <use-specification>true</use-specification>
                <view-order>0</view-order>
            </item-type>
            <item-type code="KOD_PRVKU_POPISU_2" data-type="TEXT">
                ....Lze definovat vícekrát....
            </item-type>
        </item-types>

    <item-types> - POVINNÉ
        Značka obalující definice prvků popisu

    <item-type>
        Značka definice prvku popisu.

        code=""
            Strojově zpracovatelný kód pro identifikaci prvku popisu

        data-type=""
            Datový typ prvku popisu. Určuje jaký prvek popisu se zobrazí.

    <name>
        Název prvku popisu

    <shortcut>
        Zkratka prvku popisu

    <description>
        Popis prvku popisu

    <is-value-unique>
        ...

    <can-be-ordered>
        ...

    <use-specification>
        ...

    <view-order>
        Pořadí prvku v seznamu

.. _`rul_output_type.xml`:

rul_output_type.xml
---------------------------

    Obsahuje definice typů výstupů.

    .. code-block:: xml

        <output-types>
            <output-type code="AP_FULL">
                <name>Celý výpis archivního souboru</name>
            </output-type>
            <output-type code="OUTPUT">
                ....Lze definovat vícekrát....
            </output-type>
        </output-types>

    <output-types> - POVINNÉ
        Značka obalující definice typů výstupů

    <output-type>
        Značka definice typu výstupu

        code=""
            Strojově zpracovatelný kód pro identifikaci typu výstupu

    <name>
        Název typu výstupu

.. _`rul_package_actions.xml`:

rul_package_actions.xml
-------------------------------

    Obsahuje definice hromadných akcí.

    .. code-block:: xml

        <package-actions>
            <package-action filename="GENERATOR_UNIT_ID_ZP2015.yaml">
                <action-recommendeds>
                    <action-recommended output-type="AP_INVENTORY" />
                    <action-recommended output-type="INVENTORY" />
                </action-recommendeds>
                <action-item-types>
                    <action-item-type item-type="ZP2015_STATISTICS" />
                    <action-item-type item-type="ZP2015_IMPRINT_COUNT" />
                </action-item-types>
            </package-action>
            <package-action filename="GENERATOR_UNIT_ID_ZP2015.yaml">
                ....Lze definovat vícekrát....
            </package-action>
            <package-action filename="GENERATOR_UNIT_ID_ZP2015.yaml"/>
        </package-actions>

    <package-actions> - POVINNÉ
        Značka obalující definice hromadných akcí

    <package-action>
        Značka definice hromadné akce

        filename=""
            cesta k souboru s akcí relativní k adresáři ``bulk_actions`` v kořenovém adresáři balíčku

    <action-recommendeds> - VOLITELNÉ
        Značka obalující definice typů výstupů, pro které je tato akce doporučená

    <action-recommended>
        Definice typu výstupu, pro který je akce doporučená

        output-type=""
            kód typu výstupu, pro který je doporučená. Odpovídá atributu ``code`` u značek ``output-type`` v souboru ``rul_output_type.xml``

    <action-item-types> - VOLITELNÉ
        Značka obalující definice prvků, které jsou akcí upravovány

    <action-item-type>
         Definice prvku, který je upravován akcí. Odpovídá atributu ``code`` u značek ``item-type`` v souboru ``rul_item_type.xml``

.. _`rul_package_rules.xml`:

rul_package_rules.xml
-----------------------------

    Obsahuje definice pravidel.

    .. code-block:: xml

        <package-rules>
            <package-rule filename="rules.drl" rule-set="RULES">
                <rule-type>CONFORMITY_INFO</rule-type>
                <priority>1</priority>
            </package-rule>
            <package-rule filename="rules.drl" rule-set="RULES">
                ....Lze definovat vícekrát....
            </package-rule>
        </package-rules>

    <package-rules> - POVINNÉ
        Značka obalující definice pravidel

    <package-rule>
        Definice pravidel

        filename=""
            Cesta k souboru pravidel ``.drl``. Je relativní vůči adresáři ``rules`` umístěném v kořenovém adresáři balíčku.

        rule-set=""
            ...

    <rule-type>
        ...

    <priority>
        ...

.. _`rul_packet_type.xml`:

rul_packet_type.xml
------------------------------

    Obsahuje definice obalů.

    .. code-block:: xml

        <packet-types>
            <packet-type code="BOX">
                <name>Karton</name>
                <shortcut>kar</shortcut>
            </packet-type>
        </packet-types>

    <packet-types> - POVINNÉ
        Značka obalující definice obalů

    <packet-type>
        Definice obalu

        code=" "
            Strojově zpracovatelný identifikátor obalu

    <name>
        Název obalu

    <shortcut>
        Zkratka

.. _`rul_policy_type.xml`:

rul_policy_type.xml
-------------------------------

    .. code-block:: xml

        <policy-types>
            <policy-type code="BASIC" rule-set="ZP2015">
                <name>Základní</name>
            </policy-type>
        </policy-types>

        <policy-types> - POVINNÉ
            ...

        <policy-type>
            ...

        <name>
            Název ...

.. _`rul_rule_set.xml`:

rul_rule_set.xml
-------------------------

    .. code-block:: xml

        <rule-sets>
            <rule-set code="ZP2015">
                <name>Základní pravidla 2015</name>
                <default-item-types>
                    <item-type code="ZP2015_LEVEL_TYPE" />
                    <item-type code="ZP2015_SERIAL_NUMBER" />
                    <item-type code="ZP2015_TITLE" />
                </default-item-types>
            </rule-set>
        </rule-sets>

    <rule-sets>
        ...

    <rule-set>
        ...

    <name>
        ...

    <default-item-types>
        ...

    <item-type>
        ...

        code=""
            ...

.. _`rul_template.xml`:

rul_template.xml
-------------------------

    .. code-block:: xml

        <templates>
            <template code="TEMPLATE" output-type="AP_INVENTORY" mime-type="text/csv" extension="csv">
                <name>AP inventář FREEMARKER</name>
                <engine>FREEMARKER</engine>
                <directory>freemarker</directory>
            </template>
        </templates>

    <templates> - POVINNÉ
        ...

    <template>
        Definice šablony pro výstupy

        code=""
            Strojově zpracovatelný indentifikátor

        output-type=""
            Typ výstupu, pro který je tato šablona určená

        mime-type=""
            MIME type výstupu

        extension=""
            Koncovka výsledného souboru výstupu

    <name>
        Název šablony

    <engine>
        Definice zpracovávače výstupů

    <directory>
        Adresář, ve kterém je uložena šablona. Cesta je relativní k adresáři "templates" v kořenovém adresáři balíčku
