Versionen im Vergleich

Alte Version 33

changes.mady.by.user Redakteur7

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.

...

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.


docxworld.TOWER konfigurieren in der Konfigurationsdatei

Mit Hilfe des Tag <docxworldTower> wird die docxworld.TOWER-Konfiguration eingeleitet. Innerhalb des Tag müssen die URL und der die Cognito-Client-ID angegeben werden.

Element

Werte

Beschreibung

docxworldTower


Hiermit wird angegeben, dass es eine docxworld.TOWER Konfiguration innerhalb der XML gibt.

url


Es muss eine URL zum docxworld.TOWER angegeben werden.

cognitoClientId


Damit ein User sich später am System anmelden kann, wird dafür eine Cognito ID benötigt.


Scroll Pagebreak

Beispiele

...

Basis-Konfigurationsdatei (config.xml)

Codeblock
languagexml
collapsetrue
<?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"/>
      <pdfOptions embedAddress="false"/>
      <url>http://spooler:9090</url>
      <url>http://spooler:9091</url>
      <url>http://spooler:9092</url>
      <variable key="SpoolerVarMarkeOderWorkflow" value="mahnung"/>
      <variable key="key1" value="val1"/>
    </configGroup>
 
    <configGroup displayName="Rechnung">
      <addressPosition x="25" y="60" width="76" height="30"/>
      <pdfOptions embedAddress="true"/>
      <url>hhttp://spooler:9090</url>
      <variable key="SpoolerVarMarkeOderWorkflow" value="rechnung_de"/>
    </configGroup>
 
    <additionalConfigGroups href="<Pfad wo die Datei liegt>"/>
 
  </configGroups>
  
  <docxworldTower>
      <url></url>
      <cognitoClientId></cognitoClientId>
  </docxworldTower>
 
  <license></license>
 
  <templatesFolder>C:\Users\Username\Documents\Templates</templatesFolder>
 
</config>


Scroll Pagebreak

...

baseConfigSchema.xsd

Codeblock
languagexml
collapsetrue
<?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="0" 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="docxworldTower" minOccurs="0" maxOccurs="1">
			<xs:complexType>
				<xs:sequence>
					<xs:element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="1"/>
					<xs:element name="cognitoClientId" type="xs:string" minOccurs="1" maxOccurs="1"/>
				</xs:sequence>
			</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>


Scroll Pagebreak

...

erweiterte Konfigurationsdatei (additional_config.xml)

Codeblock
languagexml
collapsetrue
<?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

...

additionalConfigSchema.xsd

Codeblock
languagexml
collapsetrue
<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="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" type="xs:string" use="required"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>