Versionen im Vergleich

Alte Version 8

changes.mady.by.user Redakteur1

Gespeichert am

verglichen mit

Neue Version Aktuell

changes.mady.by.user Redakteur7

Gespeichert am

Schlüssel

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

Elemente der Elemente der verschiedenen XML’sKonfigurationsdateien

Die Konfiguration des docxworld.COLLI kann über 2 verschiedene Konfigurationsdateien erfolgen. Hierbei gibt es die Basis-Es gibt zwei verschiedene Arten von XML’s. Dabei wird unterschieden zwischen der Konfigurationsdatei (config.xml) und der erweiterten eine optionale erweiterte Konfigurationsdatei (additional_config.xml).
In der Basis-Konfigurationsdatei (config.xml) können Konfigurationsgruppen und der Pfad zur erweiterten Konfigurationsdatei (additional_config.xml) angegeben werden. Bei der erweiterten Konfigurationsdatei (additional_config.xml) ist es nur möglich mehrere weitere 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 Konfigurationsitems <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.


Scroll Pagebreak

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 Spooler-URL pro Konfigurationsitem angegeben werden. Wenn mehrere Spooler-URL’s angegeben werden, dann werden diese nach dem Failover Ansatz abgearbeitet.

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.


Scroll Pagebreak

Beispiele


Erweitern
titleBasis-Konfigurationsdatei (config.xml)
Codeblock
languagexml
<?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">

    <configGroup displayName="Mahnung">
      <addressPosition x="15" y="45" width="85" height="45
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="Rechnung"> <addressPosition x="20" y="55" width="85" height="40"/> <url>http://localhost:62616/oms/upload</url> <variable key="SpoolerVarMarkeOderWorkflow" value="buecher_de
"/>
<variable
<pdfOptions
key
embedAddress="
key1" value="val1
false"/>
</configGroup> 
  <url>http://spooler:9090</url>
<additionalConfigGroup href="<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"
 <url>http://spooler:9091</url>
      <url>http://spooler:9092</url>
      <variable key="SpoolerVarMarkeOderWorkflow" value="mahnung"/>
      <variable key="key1" value="val1"/>
<xs:complexType>
</configGroup>
<xs:sequence>
<configGroup displayName="Rechnung">
      <addressPosition
<xs:element name
x="25" y="
configGroups
60"
minOccurs
width="
1
76"
maxOccurs
height="
1
30"/>
<xs:complexType>
<pdfOptions embedAddress="true"/>
<xs:sequence>
<url>hhttp://spooler:9090</url>
<xs:element name="configGroup" minOccurs="1" maxOccurs="unbounded"
<variable key="SpoolerVarMarkeOderWorkflow" value="rechnung_de"/>
    </configGroup>

    <additionalConfigGroups href="<Pfad wo die Datei liegt>"/>
<xs:complexType>
</configGroups>

  <license></license>

  <templatesFolder>C:\Users\Username\Documents\Templates</templatesFolder>

</config>


Scroll Pagebreak

Erweitern
titlebaseConfigSchema.xsd
Codeblock
languagexml
<?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:sequence>
        <xs:element name="
addressPosition
configGroups" minOccurs="
0
1" maxOccurs="1">
          <xs:complexType>
            <xs:
complexType>
sequence>
              <xs:element
<xs:attribute name="x" type="xs:integer" use="required"/> 
name="configGroup" minOccurs="1" maxOccurs="unbounded">
                <xs:complexType>
<xs:attribute name="y" type="xs:integer" use="required"/> 
        <xs:sequence>
                    <xs:
attribute
element name="
width
addressPosition"
type
minOccurs="
xs:integer
0"
use
maxOccurs="
required
1"
/
>
                      <xs:complexType>
                        <xs:attribute name="
height
x" type="xs:integer" use="required"/>
</xs:complexType> 
  <xs:attribute name="y" 
type="xs:integer" use="required"/>
</xs:element> 
                    <xs:
element
attribute name="
addressXPath
width"
minOccurs
type="
0
xs:integer"
maxOccurs
use="
1
required"/>
                        <xs:
complexType> 
attribute name="height" type="xs:integer" use="required"/>
<xs:attribute name="zip" use="required">
 </xs:complexType>
<xs:simpleType>
</xs:element>
                    <xs:element name="pdfOptions"
<xs:restriction base="xs:string
minOccurs="0" maxOccurs="1">
<xs:minLength value="1"/>
<xs:complexType>
                        <xs:attribute name="embedAddress"
</xs:restriction> 
type="xs:boolean" use="required"/>
                      
</xs:
simpleType>
complexType>

                    </xs:
attribute>
element>

                    
<xs:
attribute
element name="
country
url" type="xs:anyURI" minOccurs="1"
use
maxOccurs="
required
unbounded"/>

                    <xs:
simpleType> 
element name="variable" minOccurs="0" maxOccurs="unbounded">
                      
<xs:
restriction base="xs:string">
complexType>
<xs:minLength value="1
<xs:attribute name="key" type="xs:string" use="required"/>
                        <xs:attribute name="value"
</xs:restriction>
type="xs:string" use="required"/>
                      
</xs:
simpleType>
complexType>

                    
</xs:
attribute>
element>
</
</xs:
complexType>
sequence>
                  <xs:attribute
</xs:element>
name="displayName" use="required">
                    <xs:
element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/> 
simpleType>
                      
<xs:
element
restriction
name
base="
variable
xs:string">
minOccurs="0"
maxOccurs="unbounded"> 
                      <xs:
complexType>
maxLength value="64"/>
                      </xs:restriction>
<xs:attribute
name="key"
type="xs:string"
use="required"/> 
               </xs:simpleType>
<xs:attribute
name="value"
type="xs:string"
use="required"/> 
      </xs:attribute>
                </xs:complexType>

              
</xs:element>
              <xs:element name="additionalConfigGroups"
</xs:sequence> 
minOccurs="0" maxOccurs="unbounded">
                <xs:
attribute name="displayName
complexType>
                  <xs:attribute name="href" type="xs:string" use="required"/>
                </xs:complexType>
<xs:simpleType> 
          </xs:element>
<xs:restriction base="
</xs:
string">
sequence>
            <xs:attribute name="description" type="xs:string" use="required"/>
            <xs:
maxLength value
attribute name="displayName" use="
64
required"
/
>
              <xs:simpleType>
</
<xs:restriction base="xs:
restriction>
string">
</xs:simpleType> 
<xs:maxLength value="16"/>
                </xs:
attribute> 
restriction>
              </xs:simpleType>
            </xs:
complexType>
attribute>
          </xs:complexType>
        </xs:element>
        <xs:element name="license"/>
        <xs:element name="
additionalConfigGroups
templatesFolder" minOccurs="
0
1" maxOccurs="
unbounded
1"/>
        <xs:element name="showAddressRectangles" minOccurs="0">
<xs:complexType> 
    
<xs:simpleType>
            <xs:
attribute
restriction
name
base="
href" type="
xs:
string" use="required" 
boolean"/>

          
</xs:
complexType>
simpleType>
        </xs:element>
      </xs:
element>
sequence>
</xs:sequence> <xs
<xs:attribute name="
description
version" 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>
</xs:complexType>
  </xs:element>
</xs:schema>


Scroll Pagebreak

Erweitern
titleerweiterte Konfigurationsdatei (additional_config.xml)
Codeblock
languagexml
<?xml version="1.0" encoding="UTF-8"?>

<additionalConfigGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

	<configGroup displayName="Information">
		<addressPosition x="50" y="50" width="300" height="150" />
		<pdfOptions embedAddress="true"/>
		<url>http://spooler:9093</url>
		<url>http://spooler:9094</url>
		<url>http://spooler:9095</url>
		<url>http://spooler:9096</url>
		<variable key="SpoolerVarMarkeOderWorkflow" value="information" />
	</configGroup>

	<configGroup displayName="Abschlagsrechnung">
        <addressPosition x="20" y="55" width="85" height="40"/>
        <url>http://spooler:9093</url>
		<url>http://spooler:9094</url>
        <variable key="SpoolerVarMarkeOderWorkflow" value="abschlagsrechnung"/>
    </configGroup>

</additionalConfigGroups>


Scroll Pagebreak

Erweitern
titleadditionalConfigSchema.xsd
Codeblock
languagexml
<xs:schema attributeFormDefault="
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: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
<xs:element name="pdfOptions" minOccurs="0" maxOccurs="1">

				  
<xs:complexType>

					<xs:attribute name="
zip
embedAddress"
use
type="
required"
xs:boolean" use="required"/>
				  
</xs:complexType>
			  </xs:element>
              <xs:
simpleType> 
element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>
              
<xs:
restriction base="xs:string"> 
element name="variable" minOccurs="0" maxOccurs="unbounded">
                <xs:
minLength value="1"/>
complexType>
                  <xs:attribute name="key"
</xs:restriction>
type="xs:string" use="required"/>
</xs:simpleType> 
<xs:attribute name="value" type="xs:string" use="required"/>
                </xs:
attribute>
complexType>
              </xs:element>
<xs:attribute
name="country"
use="required"> 
      </xs:sequence>
            
<xs:
simpleType> <xs:restriction base
attribute name="displayName" type="xs:string" use="required"/>
          </xs:complexType>
        </xs:element>
<xs:minLength value="1"/>
</xs:sequence>
<
</xs:
restriction> 
complexType>
  </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

...

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>