Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

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



Elemente in der Konfigurationsgruppe

Konfigurationsgruppe und Pfad für die erweiterte Konfigurationsdatei

Element

Werte

Beschreibung

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 ist der Pfad anzugeben, wo die erweiterte Konfigurationsdatei liegt.

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.

licenseLizenzschlüssel
templatesFolder
Hier muss der Pfad hinterlegt werden, wo sich die PDF-Vorlagen befinden.


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.

pdfOptions

embedAddress

Damit kann entschieden werden, ob vor dem Absenden eines Dokumentes der Endnutzer, noch die Postleitzahl und das Länderkennzeichen erfassen muss.

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.



Beispiele

Codeblock
languagexml
titleXML
<?xml version="1.0" encoding="UTF-8"?>
<config version="1.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <configGroups description="Konfigurationsgruppe" displayName="Dokumentenart">

    
Codeblock
languagexml
titleXML
<?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="RechnungMahnung">
      <addressPosition      <addressPosition x="2015" y="5545" width="85" height="4045"/>
      <url>http://localhost:62616/oms/upload</url>
			<pdfOptions embedAddress="false"/>
			<url>spooler1:9093</url>
			<url>spooler1:9091</url>
            <variable key="SpoolerVarMarkeOderWorkflow" value="buecher_demahnung"/>
      <variable       <variable key="key1" value="val1"/>
        </configGroup>
		
		<configGroup displayName="Rechnung">
            <additionalConfigGroup<addressPosition hrefx="25"<Pfad wo die Datei liegt>/>

  </configGroups>
</config>
Codeblock
languagexml
titleaktueller 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>y="60" width="76" height="30"/>
			<pdfOptions embedAddress="true"/>
            <url>http://localhost:62616/oms/upload</url>
            <variable key="SpoolerVarMarkeOderWorkflow" value="weltbild_de"/>
        </configGroup>
      <xs:sequence>  
        <xs:element<additionalConfigGroups namehref="configGroups" minOccurs="1" maxOccurs="1"<Pfad wo die Datei liegt>"/>
          <xs:complexType>
    </configGroups>
    
	<license></license>
	<templatesFolder>Pfad wo die Datei liegt>
	
</config>
Codeblock
languagexml
titleaktueller baseConfigSchema.xsd
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema <xs:sequence>
              <xs:element name="configGroup" minOccurs="1" maxOccurs="unbounded">
    <xs:element name="config">
      <xs:complexType>
      <xs:complexType>sequence>
        <xs:element name="configGroups" minOccurs="1" maxOccurs="1">
          <xs:sequence>complexType>
            <xs:sequence>
              <xs:element name="addressPositionconfigGroup" minOccurs="01" maxOccurs="1unbounded">
                <xs:complexType>
      <xs:complexType>
            <xs:sequence>
                    <xs:attributeelement name="xaddressPosition" typeminOccurs="xs:integer0" usemaxOccurs="required1"/>
                        <xs:attribute name="y" type="xs:integer" use="required"/>complexType>
                        <xs:attribute name="widthx" type="xs:integer" use="required"/>
                        <xs:attribute name="heighty" type="xs:integer" use="required"/>
                      </xs:complexType>
                  <xs:attribute name="width" type="xs:integer" use="required"/>
    </xs:element>
                    <xs:elementattribute name="addressXPathheight" minOccurstype="0xs:integer" maxOccursuse="1required"/>
                      <xs</xs:complexType>
                    </xs:element>
                    <xs:attributeelement name="pdfOptions" minOccurs="zip0" usemaxOccurs="required1">
                          <xs:simpleType>complexType>
                            <xs:restriction baseattribute name="embedAddress" type="xs:stringboolean">
                              <xs:minLength value="1 use="required"/>
                            </xs:restriction>complexType>
                          </xs:simpleType>element>
                        </xs:attribute>
    <xs:element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>
                    <xs:attributeelement name="variable" minOccurs="country0" usemaxOccurs="requiredunbounded">
                          <xs:simpleType>complexType>
                            <xs:restriction baseattribute name="key" type="xs:string" use="required"/>
                        <xs:attribute      <xs:minLength value="1name="value" type="xs:string" use="required"/>
                            </xs:restriction>
      complexType>
                    </xs:simpleType>element>
                        </xs:attribute>sequence>
                  <xs:attribute    </xs:complexType>name="displayName" use="required">
                    </xs<xs:element>simpleType>
                      <xs:element name="url" typerestriction base="xs:anyURIstring" minOccurs="1" maxOccurs="unbounded"/>
>
                        <xs:elementmaxLength namevalue="variable64" minOccurs="0" maxOccurs="unbounded">
/>
                      </xs:restriction>
    <xs:complexType>
                </xs:simpleType>
        <xs:attribute name="key" type="xs:string" use="required"/>
        </xs:attribute>
                <xs:attribute name="value" type="xs:string" use="required"/>
</xs:complexType>
              </xs:element>
              </xs:complexType>
   <xs:element name="additionalConfigGroups" minOccurs="0" maxOccurs="unbounded">
                 </xs:element><xs:complexType>
                  </xs:sequence>
                  <xs:attribute name="displayNamehref" type="xs:string" use="required"/>
                </xs:complexType>
    <xs:simpleType>
          </xs:element>
            <xs:restriction base="xs:string">
</xs:sequence>
            <xs:attribute name="description" type="xs:string" use="required"/>
            <xs:maxLength valueattribute name="displayName" use="64required"/>
                      </xs:restriction><xs:simpleType>
                    </xs:simpleType>
<xs:restriction base="xs:string">
                   </xs:attribute><xs:maxLength value="16"/>
                </xs:complexType>restriction>
              </xs:element>simpleType>
              <xs:element name="additionalConfigGroups" minOccurs="0" maxOccurs="unbounded">
</xs:attribute>
          </xs:complexType>
         <xs:complexType></xs:element>
        <xs:element name="license"/>
         <xs:attributeelement name="hreftemplatesFolder" typeminOccurs="xs:string1" usemaxOccurs="required1" />
        <xs:element name="showAddressRectangles" minOccurs="0">
      </xs:complexType>    <xs:simpleType>
              </xs:element>
<xs:restriction base="xs:boolean"/>
          </xs:simpleType>
        </xs:sequence>element>
      </xs:sequence>
      <xs:attribute name="descriptionversion" type="xs:string" use="required"/>
            <xs:attribute name="displayName" use="required">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="16"/</xs:complexType>
  </xs:element>
</xs:schema>
Codeblock
languagexml
titleaktueller additionalConfigSchema.xsd
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
  xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="additionalConfigGroups">
    <xs:complexType>
            </xs:restriction><xs:sequence>
              </xs:simpleType><xs:element name="configGroup" maxOccurs="unbounded">
          <xs:complexType>
  </xs:attribute>
          </xs<xs:complexType>sequence>
        </xs:element>
      </xs:sequence>
      <xs:attributeelement name="versionaddressPosition" typeminOccurs="xs:string0" usemaxOccurs="required1"/>
           </xs     <xs:complexType>
                  </xs:element>
</xs:schema>
Codeblock
languagexml
titleaktueller additionalConfigSchema.xsd
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
  xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="additionalConfigGroups">
    <xs:complexType>
<xs:attribute name="x" type="xs:integer" use="required"/>
             <xs:sequence>
        <xs:elementattribute name="y" type="configGroupxs:integer" maxOccursuse="unboundedrequired"/>
          <xs:complexType>
        <xs:attribute name="width" type="xs:integer" use="required"/>
    <xs:sequence>
              <xs:elementattribute name="addressPositionheight" minOccurstype="0xs:integer" maxOccursuse="1required"/>
                <xs</xs:complexType>
              </xs:element>
		      <xs:attributeelement name="xpdfOptions" typeminOccurs="xs:integer0" usemaxOccurs="required1"/>
                  <xs:				  <xs:complexType>
					<xs:attribute name="yembedAddress" type="xs:integerboolean" use="required"/>
				  </xs:complexType>
			  </xs:element>
              <xs:attributeelement name="widthurl" type="xs:integeranyURI" minOccurs="1" usemaxOccurs="requiredunbounded"/>
                  <xs:attributeelement name="heightvariable" typeminOccurs="xs:integer0" usemaxOccurs="requiredunbounded"/>
                </xs<xs:complexType>
                   </xs:element>
<xs:attribute name="key" type="xs:string" use="required"/>
                  <xs:elementattribute name="addressXPathvalue" minOccurstype="0xs:string" maxOccursuse="1required"/>
                <xs</xs:complexType>
                  <xs:attribute name="zip" use="required"></xs:element>
                    <xs:simpleType>
          </xs:sequence>
            <xs:restriction baseattribute name="displayName" type="xs:string" use="required"/>
          </xs:complexType>
              <xs:minLength value="1"/>
                </xs:element>
      </xs:restriction>sequence>
                    </xs:simpleType>complexType>
                  </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 der Konfigurationsgruppe

Konfigurationsgruppe und Pfad für die erweiterte Konfigurationsdatei

...

Element

...

Werte

...

Beschreibung

...

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 ist der Pfad anzugeben, wo die erweiterte Konfigurationsdatei liegt.

...

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.

...

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.

...

pdfOptions

...

embedAddress

...

Damit kann entschieden werden, ob vor dem Absenden eines Dokumentes der Endnutzer, noch die Postleitzahl und das Länderkennzeichen erfassen muss.

...

url

...

Es muss mind. 1 URL pro Konfigurationsitem angegeben werden.

...

variable

...

key, value

...

element>
</xs:schema>