Elemente der verschiedenen Konfigurationsdateien
Die Konfiguration des docxworld.COLLI kann über 2 verschiedene Konfigurationsdateien erfolgen. Hierbei gibt es die Basis-Konfigurationsdatei (config.xml) und 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 weitere Konfigurationsitems anzugeben.
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. |
| license | Lizenzschlü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 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. |
Beispiele
<?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="pdfOptions" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:attribute name="embedAddress" type="xs:boolean" use="required"/>
</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:element name="license"/>
<xs:element name="templatesFolder" minOccurs="1" maxOccurs="1"/>
<xs:element name="showAddressRectangles" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:boolean"/>
</xs:simpleType>
</xs:element>
</xs:sequence>
<xs:attribute name="version" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>
Überblick
Inhalte