/ API
Obecné Jak začít PAMICA POHODA
Kontakty

Restrikce dat pro XML export


Základní vlastností XML komunikace pro export dat je, že exportuje všechny dostupné údaje (parametry) ze záznamu v programu POHODA do XML.

Výsledkem je robustní, strukturovaný XML dokument, který věrně replikuje data z programu POHODA.

To umožňuje využít vyexportovaná data k založení stejného záznamu v jiném systému.

Pokud některý z nepovinných parametrů ze záznamu nemá v programu POHODA nastavenou hodnotu, není tento parametr zahrnut do výstupního XML.


Možnosti restrikce dat pro export

V rámci XML požadavku na export je možné zapnout restrikce, které omezí množství dat exportovaných do výstupního XML.

Pro nastavení restrikcí je nutné v XML požadavku použít blok: restrictionData


Definice restrikcí v XML

Restrikce pro výběr dat z programu POHODA jsou definovány ve schématech:

Tato schémata obsahují definice předdefinovaných restrikcí pro jednotlivé agendy, jako jsou Adresář, Zásoby, Faktury, Objednávky atd.

Každá agenda má vlastní seznam předdefinovaných restrikcí pro výběr dat.


element restrictionData
      xsd:element name="restrictionData" type="lst:restrictionDocParamType"
        xsd:annotation
           xsd:documentationOmezení exportu dat dokladů./xsd:documentation
        /xsd:annotation
      /xsd:element

Omezení možností restrikce

XML komunikace programu POHODA neumožňuje definovat vlastní výběr parametrů, které mají být exportovány do XML.

Pokud potřebujete místo strukturovaného XML vytvořit jednodušší XML dokument, je nutné použít XSLT transformaci, která upraví výstupní data podle vašich potřeb.


Kombinace filtrů, restrikcí a stránkování

V XML požadavku na export dat z programu POHODA je možné kombinovat:

  • filtry
  • restrikce
  • stránkování

Tím lze přesněji definovat, která data budou exportována a v jaké podobě.


seznam restrikcí pro doklady
      xsd:complexType name="restrictionDocParamType"
        xsd:all
           xsd:element name="documents"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky "Doklady"./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="attachments"  type="typ:boolean" default="false" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky "Dokumenty"./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="parameters"  type="typ:boolean" default="false" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat volitelné parametry./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="liquidations"  type="typ:boolean" default="false" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky "Likvidace"./xsd:documentation
             /xsd:annotation
           /xsd:element
        /xsd:all
      /xsd:complexType

seznam restrikcí pro Adresář
      xsd:complexType name="restrictionDataType"
        xsd:all
           xsd:element name="attachments"  type="typ:boolean" default="false" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky "Dokumenty"./xsd:documentation
             /xsd:annotation
           /xsd:element
        /xsd:all
      /xsd:complexType

seznam restrikcí pro Zásoby
      xsd:complexType name="restrictionDataType"
        xsd:all
           xsd:element name="relatedFiles"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky Související soubory./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="relatedLinks"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky Související odkazy./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="pictures"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky Obrázky./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="categories"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky Kategorie./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="relatedStocks"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky související zboží./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="alternativeStocks"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky Alternativní zboží./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="intParameters"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky Parametry./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="stockItem"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat položky zásoby./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="stockAttach"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat svázané zásoby./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="stockSerialNumber"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat evidenční čísla./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="stockPriceItem"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat prodejní ceny./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="stockParameters"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat volitelné parametry./xsd:documentation
             /xsd:annotation
           /xsd:element
           xsd:element name="attachments"  type="typ:boolean" default="true" minOccurs="0"
             xsd:annotation
               xsd:documentationExportovat záznamy ze záložky "Doklady"./xsd:documentation
             /xsd:annotation
           /xsd:element
        /xsd:all
      /xsd:complexType

Ukázka využití restrikcí pro export zásob
      lStk:listStockRequest
        lStk:requestStock
          ftr:filter
          -- export všech zásob --
          /ftr:filter
        /lStk:requestStock
        
        -- restrikce na data zásoby --
        lStk:restrictionData
          lStk:relatedFilesfalse/lStk:relatedFiles            -- neexportovat Související soubory --
          lStk:relatedLinksfalse/lStk:relatedLinks            -- neexportovat Související odkazy --
          lStk:picturesfalse/lStk:pictures                    -- neexportovat Obrázky --
          lStk:categoriesfalse/lStk:categories                -- neexportovat Kategorie --
          lStk:relatedStocksfalselStk:relatedStocks           -- neexportovat související zboží --
          lStk:alternativeStocksfalse/lStk:alternativeStocks  -- neexportovat Alternativní zboží --
          lStk:intParametersfalse/lStk:intParameters          -- neexportovat Parametry --
          lStk:stockItemfalse/lStk:stockItem                  -- neexportovat položky zásoby --
          lStk:stockAttachfalse/lStk:stockAttach              -- neexportovat svázané zásoby --
          lStk:stockSerialNumberfalse/lStk:stockSerialNumber  -- neexportovat evidenční čísla --
          lStk:stockPriceItemfalse/lStk:stockPriceItem        -- neexportovat prodejní ceny --
          lStk:stockParametersfalse/lStk:stockParameters      -- neexportovat volitelné parametry --
          lStk:attachmentsfalse/lStk:attachments              -- neexportovat záložku "Doklady" --
        /lStk:restrictionData
      /lStk:listStockRequest

Ukázka využití restrikcí pro export dokladů (vydaných faktur)
      lst:listInvoiceRequest
        lst:requestInvoice
          ftr:filter
          -- export všech vydaných faktur --
          /ftr:filter
        /lst:requestInvoice
        
        -- restrikce na data faktury --
        lst:restrictionData
          lst:documentsfalse/lst:documents          -- neexportovat záložku "Doklady" --
          lst:attachmentsfalse/lst:attachments      -- neexportovat záložku "Dokumenty" --
          lst:parametersfalse/lst:parameters        -- neexportovat volitelné parametry --
          lst:liquidationsfalse/lst:liquidations    -- neexportovat záložku "Likvidace" --
        /lst:restrictionData
      /lst:listInvoiceRequest