Aufbau Konfigurationsdatei

Elementen der verschiedenen XML’s

Es gibt zwei verschiedene Arten von XML’s. Dabei wird unterschieden zwischen der Konfigurationsdatei (config.xml) und der erweiterten Konfigurationsdatei (additional_config.xml).
In der config.xml können Konfigurationsgruppen und der Pfad zur erweiterten Konfigurationsdatei angegeben werden. Bei der erweiterten Konfigurationsdatei ist es nur möglich mehrere Konfigurationsitems anzugeben.

Beispiele

XML

<?xml version="1.0" encoding="UTF-8"?>
<config version="1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="../../Docxworld_Chain/Resources/baseConfigSchema.xsd">

  <configGroups description="Kofigurationsgruppe" displayName="Dokumenttyp">

    <configGroup displayName="Mahnung">
      <addressPosition x="100" y="100" width="400" height="200"/>
      <zip pdfXpath="zip"/>
      <country pdfXpath="country"/>
      <url>http://spooler:9091</url>
      <variable key="SpoolerVarMarkeOderWorkflow" value="buecher_de"/>
      <variable key="key1" value="val1"/>
    </configGroup>

    <configGroup displayName="Rechnung">
      <addressPosition x="20" y="55" width="85" height="40"/>
      <url>http://localhost:62616/oms/upload</url>
      <variable key="SpoolerVarMarkeOderWorkflow" value="buecher_de"/>
      <variable key="key1" value="val1"/>
    </configGroup>

    <additionalConfigGroup href="<Pfad wo die Datei liegt>/>

  </configGroups>
</config>

aktueller baseConfigSchema.xsd

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="config">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="configGroups" minOccurs="1" maxOccurs="1">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="configGroup" minOccurs="1" maxOccurs="unbounded">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="addressPosition" minOccurs="0" maxOccurs="1">
                      <xs:complexType>
                        <xs:attribute name="x" type="xs:integer" use="required"/>
                        <xs:attribute name="y" type="xs:integer" use="required"/>
                        <xs:attribute name="width" type="xs:integer" use="required"/>
                        <xs:attribute name="height" type="xs:integer" use="required"/>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="addressXPath" minOccurs="0" maxOccurs="1">
                      <xs:complexType>
                        <xs:attribute name="zip" use="required">
                          <xs:simpleType>
                            <xs:restriction base="xs:string">
                              <xs:minLength value="1"/>
                            </xs:restriction>
                          </xs:simpleType>
                        </xs:attribute>
                        <xs:attribute name="country" use="required">
                          <xs:simpleType>
                            <xs:restriction base="xs:string">
                              <xs:minLength value="1"/>
                            </xs:restriction>
                          </xs:simpleType>
                        </xs:attribute>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>
                    <xs:element name="variable" minOccurs="0" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:attribute name="key" type="xs:string" use="required"/>
                        <xs:attribute name="value" type="xs:string" use="required"/>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                  <xs:attribute name="displayName" use="required">
                    <xs:simpleType>
                      <xs:restriction base="xs:string">
                        <xs:maxLength value="64"/>
                      </xs:restriction>
                    </xs:simpleType>
                  </xs:attribute>
                </xs:complexType>
              </xs:element>
              <xs:element name="additionalConfigGroups" minOccurs="0" maxOccurs="unbounded">
                <xs:complexType>
                  <xs:attribute name="href" type="xs:string" use="required" />
                </xs:complexType>
              </xs:element>
            </xs:sequence>
            <xs:attribute name="description" type="xs:string" use="required"/>
            <xs:attribute name="displayName" use="required">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="16"/>
                </xs:restriction>
              </xs:simpleType>
            </xs:attribute>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
      <xs:attribute name="version" type="xs:string" use="required"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

aktueller additionalConfigSchema.xsd

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
  xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="additionalConfigGroups">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="configGroup" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="addressPosition" minOccurs="0" maxOccurs="1">
                <xs:complexType>
                  <xs:attribute name="x" type="xs:integer" use="required"/>
                  <xs:attribute name="y" type="xs:integer" use="required"/>
                  <xs:attribute name="width" type="xs:integer" use="required"/>
                  <xs:attribute name="height" type="xs:integer" use="required"/>
                </xs:complexType>
              </xs:element>
              <xs:element name="addressXPath" minOccurs="0" maxOccurs="1">
                <xs:complexType>
                  <xs:attribute name="zip" use="required">
                    <xs:simpleType>
                      <xs:restriction base="xs:string">
                        <xs:minLength value="1"/>
                      </xs:restriction>
                    </xs:simpleType>
                  </xs:attribute>
                  <xs:attribute name="country" use="required">
                    <xs:simpleType>
                      <xs:restriction base="xs:string">
                        <xs:minLength value="1"/>
                      </xs:restriction>
                    </xs:simpleType>
                  </xs:attribute>
                </xs:complexType>
              </xs:element>
              <xs:element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>
              <xs:element name="variable" minOccurs="0" maxOccurs="unbounded">
                <xs:complexType>
                  <xs:attribute name="key" type="xs:string" use="required"/>
                  <xs:attribute name="value" type="xs:string" use="required"/>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
            <xs:attribute name="displayName" type="xs:string" use="required"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Elemente in Konfigurationsgruppe

Konfigurationsgruppe und Pfad für die erweiterte Konfigurationsdatei

Element	Werte	Beschreibung
configGroups	description, displayName	In der Konfigurationsgruppe <configGroups> kann man eine Beschreibung <description> und den Anzeigenamen <displayName> für die UI angeben. Der Anzeigename darf maximal 16 Zeichen lang sein. Innerhalb einer Konfigurationsgruppe können mehrere Konfigurationsitem <configGroup>mit einem Anzeigename <displayName> festgelegt werden. Der Anzeigename eines Konfigurationsitems darf maximal 64 Zeichen lang sein.
additionalConfigGroups	href	Innerhalb einer Konfigurationsgruppe kann man eine erweiterte Konfigurationsdatei angeben. Dafür muss man das Element additionalConfigGroups mit dem Wert href hinzufügen. Beim Wert href muss der Pfad angegeben werden, wo die erweiterte Konfigurationsdatei liegt.

Konfigurationsitem

Element	Werte	Beschreibung
addressPosition	x, y, width, height	Bei der Adressenposition muss man den Startpunkt x und y angeben, ausgerichtet an der oberen, linken Ecke. Zusätzlich muss die Breite und Höhe angegeben werden, in welchem Bereich die Adresse auf dem Dokument erwartet wird.
url		Es muss mind. 1 URL pro Konfigurationsitem angegeben werden.
variable	key, value	Bei einer Variablen muss es einen Schlüssel mit einem Wert geben. Diese beiden Angaben, werden dann mit an den Spooler gesendet.

Seitenhierarchie

Aufbau Konfigurationsdatei