Die Auftragsdaten können Wahlweise über einen XML Import (Hotfolder) oder über einen REST Webservice als JSON Struktur übergeben werden.

XML Import und -format

Importkonfiguration

Der XML Import wird in der application.yml konfiguriert. Folgende Konfigurationseinträge sind verfügbar:

Schalter	Optional	Bedeutung/Wert	Anmerkung
hup.one.eworxx.imports.importer-enabled	N	true/false	De-/Aktivierung des Importers
hup.one.eworxx.imports.update-trigger-state-reset-on	N	Liste von Auftragsattributen, die zu einer Statusänderung führen z.B. [height,width,cmyk,blackwhite,spotcolors]	Der Wertevorrat ist in der Default-Konfiguration dokumentiert
hup.one.eworxx.imports.update-orders-with-new-motif-number	J	false	Auftrag mit gleicher Nummer und Position, aber mit neuer Motivnummer aktualisiert einen bestehenden (true) oder erstellt einen neuen Auftrag (false)
hup.one.eworxx.imports.priorities-2-ignore	J	[ ]	Liste von Prioritäten (Integer), die beim Import ignoriert (d.h. als null-Wert importiert) werden sollen
hup.one.eworxx.imports.import-points[0].name	N	'Auftragsbearbeitung'	Der Name für den Importpoint
hup.one.eworxx.imports.import-points[0].component-name	N	DesignOrderImportModule	Klassenname des Importmoduls
hup.one.eworxx.imports.import-points[0].initial-delay	J	15	Wartezeit in Sekunden bevor der erste Import startet
hup.one.eworxx.imports.import-points[0].interval	J	20	Poll-Abstand in Sekunden
hup.one.eworxx.imports.import-points[0].parameters.input-directory	N	\\les-file1\gestaltung\eworxx\studioimport\input	Eingangs-/Poll-Verzeichnis für Gestaltungsaufträge (*.xml)
hup.one.eworxx.imports.import-points[0].parameters.error-directory	N	\\les-file1\gestaltung\eworxx\studioimport\error	Fehlerverzeichnis
hup.one.eworxx.imports.import-points[0].parameters.archive-directory	N	\\les-file1\gestaltung\eworxx\studioimport\archiv	Archivverzeichnis
hup.one.eworxx.imports.import-points[0].parameters.xsl-transformation	J		Transformationsvorschrift (.xsl) vom Eingangsformat zum Importformat
hup.one.eworxx.imports.preparation-state	J	['Teststudio', 'Satzstudio1', 'Satzstudio2']	Satzstudios, für welche der Vorbereitungsstatus automatisch vergeben wird
hup.one.eworxx.imports.orderno-regex-4-old-motif	J	\d{5}	Regulärer Ausdruck für die Funktionalität "Vorheriges Motiv übernehmen", siehe PSEWX-184 - Abrufen der Vorgangsdetails... STATUS
Datenmigration
hup.one.eworxx.imports.data-migration.service-enabled	N	true \| false	De-/Aktivierung des Datenmigrationsservice (Default = false)
hup.one.eworxx.imports.data-migration.max-batch-size	N	20	Max. Anzahl von Aufträgen, die in einem Migrationszyklus abgearbeitet werden (Default = 20)
hup.one.eworxx.imports.data-migration.import-check-delay	N	PT3S	Pollrate
Plugin advantage aktiv, wenn design-file-directory und template-file-directory konfiguriert und erreichbar
hup.one.eworxx.imports.data-migration.advantage.design-file-directory	J	\\les-file1\gestaltung\eWorxx\advantage\Kunden	Wurzelverzeichnisverzeichnis für die Gestaltungsdatei Kindpfade werden wie folgt ermittelt: Ersten 3 Stellen der Kundennummer + 000\ Ersten 4 Stellen der Kundennummer + 00\ wobei gilt: 000-199 = 000, 200-399 = 200 usw. -> es gibt also nur die Ordner xxx000, xxx200, xxx400, xxx600, xxx800 Kundennummer\ Motivname.*
hup.one.eworxx.imports.data-migration.advantage.template-file-directory	J	\\les-file1\gestaltung\eWorxx\advantage\JobTasche_KUNDEN	Wurzelverzeichnisverzeichnis für die Teilvorlagen Kindpfade werden wie folgt ermittelt: Ersten 3 Stellen der Kundennummer + 000\ Ersten 4 Stellen der Kundennummer + 00\ wobei gilt: 000-199 = 000, 200-399 = 200 usw. -> es gibt also nur die Ordner xxx000, xxx200, xxx400, xxx600, xxx800 Kundennummer\ Auftragsnummer aus orderno-regex\*
hup.one.eworxx.imports.data-migration.advantage.delete-source-after-import	J	true \| false (Default)	Löschen der Quelldatei nach erfolgreicher Übernahme
hup.one.eworxx.imports.data-migration.advantage.orderno-regex	J	\d{8}	Regulärer Ausdruck zur Ermittlung der tatsächlichen externen Auftragsnummer aus der DesignOrder.OrderNo; für Bestimmung der Verzeichnisse/Dateien z.B. 528604_11029770001_442 → \d{8} → 11029770
Plugin vl aktiv, wenn die unter studio-name-2-external-directory konfigurierten Verzeichnisse erreichbar sind
hup.one.eworxx.imports.data-migration.vl.recursive	N	true \| false (Default)	Gibt true an, dass der gesamte Verzeichnis-Inhalt (auch Unterverzeichnisse) nach eWorxx importiert wird
hup.one.eworxx.imports.data-migration.vl.delete-source-after-import	N	true \| false (Default)	Löschen der Quelldatei nach erfolgreicher Übernahme
hup.one.eworxx.imports.data-migration.vl.prefix-4-original-motif-file	N	Präfix (Default: leer)	Präfix (Dateinamen-konform), der an die originale Motivdatei vorangestellt wird; wenn leer, erfolgt kein Motivdatei-Import
hup.one.eworxx.imports.data-migration.vl.studio-name-2-external-directory[0].studio-name		Studioname	Studioname des Auftrags, für die die VL-Datenübernahme durchgeführt wird
hup.one.eworxx.imports.data-migration.vl.studio-name-2-external-directory[0].external-directory		Wurzel-Verzeichnis zur externen Auftragstasche	Aus diesem Verzeichnis werden alle Dateien (recursive beachten) aufgesammelt und ggf. importiert.

Beispielhafte Konfiguration

hup:
  one:
    eworxx:
      imports:
        # Aktivierung des Importes
        importer-enabled: false
        # Attribute, die eine relevante Änderung am Auftrag bewirken; Wertevorrat:
        # customerno,customername,customeraddress,contactpersonofcustomer,customertelno,customeremail,postaladdress,
        # height,width,cmyk,blackwhite,spotcolors,designstudioid,priority,finishingdate,publicationdate,edition,
        # rubric,contactpersonofpublisher,ordergroup,externalmotifname,acceptancetext,resubmission,reactiondeadline,
        # designordernote,correctionnote,emails,ccemails,bccemails,faxNumbers,tags
        update-trigger-state-reset-on: [height,width,cmyk,blackwhite,spotcolors]
        # Satzstudios, für welche der Vorbereitungsstatus automatisch vergeben wird
        preparation-state: ['Teststudio', 'Satzstudio1', 'Satzstudio2']
        # Bestehenden Auftrag mit neuer Motivnummer aktualsieren (true) oder neu anlegen (false)
        update-orders-with-new-motif-number: false

        data-migration:
          # Aktivierung des Migrationsservices
          service-enabled: true
          # Max. Anzahl zu verarbeitender Aufträge pro Zyklus
          max-batch-size: 20
          # Pollrate
          import-check-delay: PT3S

          advantage:
            # Root-Pfad zu den Gestaltungsdateien
            design-file-directory: \\les-file1\gestaltung\eworxx\advantage\Kunden
            # Root-Pfad zu den Teilvorlagen
            template-file-directory: \\les-file1\gestaltung\eworxx\advantage\JobTasche_KUNDEN
            # Quelldateien nach Import löschen (Default = false)
            delete-source-after-import: false             
            # Regulärer Ausdruck zur Ermittlung der tatsächlichen externen Auftragsnummer aus der DesignOrder.OrderNo
            # z.B. die ersten 8 zusammenhängenden Ziffern
            orderno-regex: \d{8}

          vl:
            # Rekursive Auftragstaschen-Übernahme (Default = false)
            recursive: true
            # Dateitransfer als Verschiebeaktion (Default = false)
            delete-source-after-import: false
            # Präfix (Dateinamen-konform), der an die originale Motivdatei vorangestellt wird
            # wenn leer, erfolgt kein Motivdatei-Import
            prefix-4-original-motif-file: 'Vorlage_'
             # Zuordnung Satzstudio zu Satzdatenverzeichnis
            studio-name-2-external-directory:
              -
                studio-name: 'Studio1'
                external-directory: \\les-file1\gestaltung\vlddvt1\Studio1
              -
                studio-name: 'Satzzentrale (Gestaltung)'
                external-directory: \\les-file1\gestaltung\vlddvt1\StudioZentrale

        import-points:
          -
            name: 'Auftragsbearbeitung'
            # Aktivierung des Pollingpoints
            enabled: true
            component-name: DesignOrderImportModule
            initial-delay: 15
            interval: 20
            parameters:
              input-directory: \\les-file1\gestaltung\eworxx\studioimport\input
              error-directory: \\les-file1\gestaltung\eworxx\studioimport\error
              archive-directory: \\les-file1\gestaltung\eworxx\studioimport\archiv
              # Transformationsdatei (XSL)
              xsl-transformation: \\les-file1\gestaltung\eworxx\studioimport\copy.xslt

XML-Dateiformat

Je nach Inhalt können noch Teilvorlagen als Bilddateien übergeben werden. Teilvorlagen sind gestaltete Elemente (wie z.B. Logos oder Fotos), die in der Anzeige berücksichtigt werden müssen. Ggf. wird hier direkt auf das CMS (Alfresco) referenziert.

Name	Datentyp	Pflicht	Beschreibung
Customer.Name	String	ja	Kundenname; max. 256 Zeichen; Freitext
Customer.Number	String	nein	Kundennummer; max. 64 Zeichen
Customer.Address	String	nein	Kundenadresse; max. 512 Zeichen; Freitext
Customer.ContactPerson	String	nein	Kontaktperson des Kunden; max. 256 Zeichen; Freitext
Customer.PhoneNumber	String	nein	Telefonnummer(n) des Kunden; max. 64 Zeichen
Customer.Email	String	nein	Emailadresse(n) des Kunden; max. 256 Zeichen
Customer.PostalAddress	String	nein	Formatierte Postadresse des Kunden; Freitext; CData-Section für Mehrzeiligkeit oder Html-codiert mit ` ` (siehe Beispiel)
Layout.Height	Integer	ja	Soll-Höhe des Motivs in Mikrometer
Layout.Width	Integer	ja	Soll-Breite des Motivs in Mikrometer
Layout.Columns	Integer	nein	Spaltigkeit
Layout.MotifHeight	Integer	nein	Ist-Höhe des Motivs in Mikrometer (wird nur beim Export verwendet!)
Layout.MotifWidth	Integer	nein	Ist-Breite des Motivs in Mikrometer (wird nur beim Export verwendet!)
Layout.CMYK	Byte/Boolean	nein	CMYK-Motiv; 0/1; default = 1
Layout.BlackWhite	Byte/Boolean	nein	Graustufen-Motiv; 0/1; default = 0 Zwischen CMYK und BlackWhite existiert keine entweder/oder-Abhängigkeit. Bei CMYK UND BlackWhite = 0 resultiert SW, sind beide = 1 resultiert 4C.
Layout.SpotColors[].SpotColor name	String	nein	Spotfarbnamen; zusammen max. 512 Zeichen
Order.StudioName	String	ja	Studioname; max. 256 Zeichen
Order.Number	String	ja	Auftragsnummer; max. 32 Zeichen
Order.Position	Integer	ja	Auftragsposition
Order.MotifNumber	String	nein	Motivnummer max. 256 Zeichen
Order.Priority	Integer	nein	Priorität; 1-N (1 = hoch)
Order.PlainText	String	nein	Anzeigenrohtext Freitext; CData-Section für Mehrzeiligkeit oder Html-codiert mit ` ` (siehe Beispiel)
Order.FinishingDateTime	DateTime	ja	Erstes bzw. Nächstes Fertigstellungsdatum zu dem die Gestaltung beendet sein muss (z.B. Rubrikenschluss, Satzschlusszeit); YYYY-MM-DDTHH:MM:SS, alternativ ist eine Übergabe am EdtionDate möglich.
Order.PublicationDate	Date	nein	Erstes bzw. Nächstes Erscheindatum; YYYY-MM-DD
Order.Edition	String	nein	Ausgabe; max. 256 Zeichen; Freitext
Order.Rubric	String	nein	Rubrik(en) (z.B. R1 > R2 > ... RN); max. 256 Zeichen; Freitext
Order.ContactPerson	String	nein	Kontaktperson des Verlags (Name, Email, Telnr.); max. 256 Zeichen
Order.OrderGroup	String	nein	Gruppierung von Gestaltungsaufrägen (z.B. Kollektiv-Kennung); max 32 Zeichen
Order.Tags[].Tag.name	String	nein	Stichworte; max. 255 Zeichen
Order.StateInfo.Key	String	nein	Status-Schlüssel (wird nur beim Export verwendet!)
Order.StateInfo.Text	String	nein	Status-Bezeichnung (wird nur beim Export verwendet!)
Order.EditionDates[].EditionDate		nein	Sequenz vom EditionDate (Tupel aus Edition,PublicationDate und FinishingDateTime ) z.B.: <EditionDate> <Edition>Edition1</Edition> <PublicationDate>2022-07-11</PublicationDate> <FinishingDateTime>2022-07-10T18:00:00</FinishingDateTime> </EditionDate> (wird verwendet, wenn für einen Auftrag mehrere Ausgabe-Erscheintermin-FertigBis-Kombinationen übertragen werden sollen)
DesignOrderNote	String	nein	Gestaltungshinweis; max. 512 Zeichen
CorrectionNote	String	nein	Korrekturhinweis; max. 512 Zeichen
TemplateFileNames[].FileName name	String	nein	Dateinamen der Gestaltungsvorlagen (Logos, Texte, Schriften)
ExternalMotifFileName	String	ja	Motiv-Dateiname für den Export; max. 256 Zeichen
User	String	nein	Benutzer (des Anzeigensystems) - zur Anzeige in Historie
Acceptance.Text	String	nein	Abnahmetext (für Korrekturworkflow); max. 512 Zeichen
Acceptance.Resubmission	Byte/Boolean	nein	Wiedervorlagekennzeichen; 0/1; default = 0
Acceptance.ReactionDeadline	DateTime	ja	Späteste Reaktionszeit (für Kundenkorrektur); YYYY-MM-DDTHH:MM:SS
Acceptance.Emails[].Email address	String	nein	Emailadresse( n ) für den Korrektur-Workflow (TO/CC/BCC); max. 256 Zeichen je Adresse
Acceptance.CCEmails[].Email address	String	nein
Acceptance.BCCEmails[].Email address	String	nein
Acceptance.FaxNumbers[].Fax number	String	nein	Faxnummer( n ) für den Korrektur-Workflow; max. 32 Zeichen eWorxx versendet automatisch ein Fax, wenn Resubmission=1 ist, und keine Email-Adressen vorhanden sind.

Die Schemadefinition XSL hat die folgende Form:

Schemadefinition

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="DesignOrder">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Customer">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Name" type="xs:string" />
              <xs:element name="Number" type="xs:string" minOccurs="0"/>
              <xs:element name="Address" type="xs:string" />
              <xs:element name="ContactPerson" type="xs:string" minOccurs="0"/>
              <xs:element name="PhoneNumber" type="xs:string" minOccurs="0"/>
              <xs:element name="Email" type="xs:string" minOccurs="0"/>
              <xs:element name="PostalAddress" type="xs:string" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="Layout">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Height" type="xs:unsignedInt" />
              <xs:element name="Width" type="xs:unsignedInt" />
              <xs:element name="Columns" type="xs:unsignedInt" minOccurs="0"/> 
              <xs:element name="MotifHeight" type="xs:unsignedInt" minOccurs="0"/>
              <xs:element name="MotifWidth" type="xs:unsignedInt" minOccurs="0"/>
              <xs:element name="CMYK" type="xs:unsignedByte" minOccurs="0"/>
              <xs:element name="BlackWhite" type="xs:unsignedByte" minOccurs="0"/>
              <xs:element name="SpotColors" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="SpotColor">
                      <xs:complexType>
                        <xs:attribute name="name" type="xs:string" use="required" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="Order">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="StudioName" type="xs:string" />
              <xs:element name="Number" type="xs:unsignedInt" />
              <xs:element name="Position" type="xs:unsignedByte" />
              <xs:element name="MotifNumber" type="xs:string" minOccurs="0" />
              <xs:element name="PlainText" type="xs:string" minOccurs="0"/>
              <xs:element name="Priority" type="xs:unsignedByte" minOccurs="0"/>
              <xs:element name="FinishingDateTime" type="xs:dateTime" />
              <xs:element name="PublicationDate" type="xs:date" minOccurs="0" />
              <xs:element name="Edition" type="xs:string" minOccurs="0" />
              <xs:element name="Rubric" type="xs:string" minOccurs="0" />
              <xs:element name="ContactPerson" type="xs:string" minOccurs="0" />
              <xs:element name="OrderGroup" type="xs:string" minOccurs="0" />
              <xs:element name="Tags" minOccurs="0" >
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="Tag">
                      <xs:complexType>
                        <xs:attribute name="name" type="xs:string" use="required" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="EditionDates" minOccurs="0" >
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="EditionDate">
                      <xs:complexType>
                        <xs:element name="PublicationDate" type="xs:date" minOccurs="0" />
                        <xs:element name="Edition" type="xs:string" minOccurs="0" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
             </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="DesignOrderNote" type="xs:string" minOccurs="0" />
        <xs:element name="CorrectionNote" type="xs:string" minOccurs="0" />
        <xs:element name="TemplateFileNames" minOccurs="0" >
          <xs:complexType>
            <xs:sequence>
              <xs:element maxOccurs="unbounded" name="FileName">
                <xs:complexType>
                  <xs:attribute name="name" type="xs:string" use="required" />
                </xs:complexType>
              </xs:element>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="ExternalMotifFileName" type="xs:string" />
        <xs:element name="Acceptance" minOccurs="0" >
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Text" type="xs:string" minOccurs="0" />
              <xs:element name="Resubmission" type="xs:unsignedByte" minOccurs="0" />
              <xs:element name="ReactionDeadline" type="xs:dateTime" />
              <xs:element name="Emails" minOccurs="0" >
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="Email">
                      <xs:complexType>
                        <xs:attribute name="address" type="xs:string" use="required" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="CCEmails" minOccurs="0" >
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="Email">
                      <xs:complexType>
                        <xs:attribute name="address" type="xs:string" use="required" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="BCCEmails" minOccurs="0" >
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="Email">
                      <xs:complexType>
                        <xs:attribute name="address" type="xs:string" use="required" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="FaxNumbers" minOccurs="0" >
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="Fax">
                      <xs:complexType>
                        <xs:attribute name="number" type="xs:string" use="required" />
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="User" type="xs:string" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Das zu importierende XML muss die folgende Struktur aufweisen:

Beispielhafte XML Datei

<?xml version="1.0" encoding="utf-8"?>
<DesignOrder>
	<Customer>
		<Name>Max Mustermann</Name>
		<Number>CUST-99-2500</Number>
		<Address>12345 Irgendwo</Address>
		<ContactPerson>Hugo Müller</ContactPerson>
		<PhoneNumber>0345/1234567</PhoneNumber>
		<Email>Max.Mustermann@email.com</Email>
        <PostalAddress><![CDATA[Max Mustermann
Friedhofsstraße 42
12345 Irgendwo]]></PostalAddress>
    </Customer>

	<Layout>
		<Height>120000</Height>
		<Width>45000</Width>
 		<Columns>3</Columns> 
        <CMYK>1</CMYK>
		<BlackWhite>0</BlackWhite>
		<SpotColors>
			<SpotColor name="HKS13"/>
			<SpotColor name="HKS57"/>
		</SpotColors>
	</Layout>

	<Order>
		<StudioName>Studio1</StudioName>
		<Number>9900001</Number>
		<Position>1</Position>
        <MotifNumber>abc12345</MotifNumber> 
        <Priority>2</Priority>
        <PlainText>Zeile 1 &#10;Zeile2 &#10;Zeile 3</PlainText>   
        <FinishingDateTime>2020-12-03T10:15:30</FinishingDateTime>
		<PublicationDate>2020-12-06</PublicationDate>
		<Edition>Ausgabe</Edition>
		<Rubric>Rubrik</Rubric>
		<ContactPerson>Sekretariat Anzeigenverkauf</ContactPerson>
		<OrderGroup>Eigenanzeigen</OrderGroup>
 		<Tags>
			<Tag name="GEST"/>
			<Tag name="ID"/>
			<Tag name="INET Internet"/>
		</Tags>
        <StateInfo>
            <Key>resubmissionCustomer</Key>
            <Text>In Abnahme (Kunde)</Text>
        </StateInfo>
		<EditionDates>
		    <EditionDate> 
		        <Edition>OBJECT1</Edition>
		        <PublicationDate>2022-07-11</PublicationDate>
                <FinishingDateTime>2022-07-10T18:00:00</FinishingDateTime> 
            </EditionDate> 
   		    <EditionDate> 
		        <Edition>OBJECT2</Edition>
		        <PublicationDate>2022-08-31</PublicationDate>
                <FinishingDateTime>2022-08-30T18:00:00</FinishingDateTime>       
           </EditionDate> 
		</EditionDates>
    </Order>

	<DesignOrderNote>Bitte in schwarz/weiß</DesignOrderNote>
	<CorrectionNote>Keine weiße Schriftfarbe verwenden</CorrectionNote>

	<TemplateFileNames>
		<FileName name="Vorlage.txt"/>
		<FileName name="Logo.jpg"/>
	</TemplateFileNames>

	<ExternalMotifFileName>9900001_1.pdf</ExternalMotifFileName>


	<Acceptance>
		<Text>Abnahmetext</Text>
		<Resubmission>0</Resubmission>
		<ReactionDeadline>2020-12-02T10:15:30</ReactionDeadline>
		<Emails>
			<Email address="max.mustermann@email.de"/>
			<Email address="kaiser.karl@post.com"/>
		</Emails>
		<CCEmails>
			<Email address="maxi.musterfrau@email.de"/>
		</CCEmails>
		<BCCEmails>
			<Email address="post@versand.de"/>
		</BCCEmails>
		<FaxNumbers>
			<Fax number="053128181111"/>
		</FaxNumbers>
	</Acceptance>

	<User>Beate Musterfrau</User>
</DesignOrder>

Webservice Konfiguration und JSON Format (Import)

Die REST-Schnittstelle ist unter Hostname:Port/service/public/designorder/import verfügbar und erhält eine JSON-Struktur und optional Satzdateien.

Die Dokumentation des JSON-Objekts ist mit Swagger verfügbar unter Host:Port/swagger-ui/#/design-order-public-controller/designOrderDto4RestImportDocumentationUsingPOST

Beispiel siehe: Swagger zur Model-Dokumentation

Es steht auch eine REST-Schnittstelle zum Ermitteln der gültigen Designstudio-Namen zur Verfügung.

Beispiel siehe: Swagger zur Ermittlung der Designstudio-Namen

Name	Datentyp	Pflicht	Beschreibung
customerNo	String	nein	Kundennummer; max. 64 Zeichen; Freitext
customerName	String	ja	Kundenname; max. 256 Zeichen; Freitext
customerAddress	String	nein	Kundenadresse; max. 512 Zeichen; Freitext
contactPersonOfCustomer	String	nein	Kontaktperson des Kunden; max. 256 Zeichen; Freitext
customerTelNo	String	nein	Telefonnummer(n) des Kunden; max. 64 Zeichen
customerEmail	String	nein	Emailadresse(n) des Kunden; max. 256 Zeichen
postalAddress	String	nein	Formatierte Postadresse; Freitext; Mehrzeiligkeit durch \n
height	Integer	ja	Höhe des Motivs in Mikrometer; größer 0
width	Integer	ja	Breite des Motivs in Mikrometer; größer 0
columns	Integer	nein	Spaltigkeit
cmyk	Boolean	nein	CMYK-Motiv; false/true; default = true
blackwhite	Boolean	nein	Graustufen-Motiv; false/true; default = false Zwischen cmyk und blackwhite existiert keine entweder/oder-Abhängigkeit. Bei cmyk UND blackwhite = false resultiert SW, sind beide = true resultiert 4C.
spotColors	Array	nein	Spotfarbnamen; keine leeren Listeneintraege
designOrderNote	String	nein	Gestaltungshinweis; max. 512 Zeichen
correctionNote	String	nein	Korrekturhinweis; max. 512 Zeichen
designStudio	String	ja	Studioname; max. 256 Zeichen
orderNo	String	ja	Auftragsnummer bzw. Motivnummer; max. 32 Zeichen
orderPosition	Integer	ja	Auftragsposition; größer 0
motifNumber	String	nein	Motivnummer, max. 256 Zeichen Ein Motiv kann immer nur an einem Auftrag hängen, kann aber ggfs. auch an einen Anderen Auftrag "übernommen" werden. Dh. Der erste Auftrag, der mit einer Motivnummer M0001 kommt, legt dieses Motiv an, der nächste Auftrag, der M0001 verwendet, übernimmt dieses Motiv von seinem Vorgänger (inkl. Satzdaten usw.)
priority	Integer	nein	Priorität; 1-N (1 = hoch)
plainText	String	nein	Anzeigenrohtext (Zeilenwechsel durch \n)
finishingDate	Date	ja	Fertigstellungsdatum zu dem die Gestaltung beendet sein muss (z.B. Rubrikenschluss, Satzschlusszeit), kann alternativ am EdtionDate angegeben werden.
publicationDate	Date	nein	Erscheindatum
edition	String	nein	Ausgabe; max. 256 Zeichen; Freitext
editionDates	Array	nein	Array vom EditionDate (Tupel aus edition, publicationDate und finishingDate) (wird verwendet, wenn für einen Auftrag mehrere Ausgabe-Erscheintermin-FertigBis-Kombinationen übertragen werden sollen)
rubric	String	nein	Rubrik(en) (z.B. R1 > R2 > ... RN); max. 256 Zeichen; Freitext
contactPersonOfPublisher	String	nein	Kontaktperson des Verlags (Name, Email, Telnr.); max. 256 Zeichen
orderGroup	String	nein	Auftragsgruppe; max. 32 Zeichen
externalMotifName	String	ja	Motiv-Dateiname für den Export; max. 256 Zeichen
user	String	nein	Benutzer (des Anzeigensystems) - zur Anzeige in Historie
acceptanceText	String	nein	Abnahmetext (für Korrekturworkflow); max. 512 Zeichen
resubmission	Boolean	nein	Wiedervorlagekennzeichen; false/true; default = false
reactionDeadline	Date	ja	Späteste Reaktionszeit (für Kundenkorrektur), erforderlich wenn resubmission
emails	Array	nein	Emailadressen für den Korrektur-Workflow (TO/CC/BCC); max. 256 Zeichen je Adresse
ccEmails	Array	nein
bccEamils	Array	nein
faxNumbers	Array	nein	Faxnummern für den Korrektur-Workflow; max. 32 Zeichen je Nummer
tags	Array	nein	Stichworte; max. 255 Zeichen je Stichwort (Leerzeichen erlaubt)

Das zu übergebende JSON Objekt muss die folgende Struktur aufweisen:

Beispielhafte JSON Struktur

{
    "acceptanceText": "string",
    "bccEmails": ["string"],
    "blackwhite": true,
    "ccEmails": ["string"],
    "cmyk": true,
    "contactPersonOfCustomer": "string",
    "contactPersonOfPublisher": "string",
    "correctionNote": "string",
    "customerAddress": "string",
    "customerEmail": "string",
    "customerName": "string",
    "customerNo": "string",
    "customerTelNo": "string",
    "designOrderNote": "string",
    "designStudio": "string",
    "edition": "string",
    "emails": ["string"],
    "externalMotifName": "string",
    "finishingDate": "2020-10-02T10:03:29.526Z",
    "faxNumbers": ["string"],
    "height": 0,
    "orderGroup": "string",
    "orderNo": "string", 
    "orderPosition": 0,
	"motifNumber":"string",
    "plainText": "string",
	"postalAddress": "string",
    "priority": 0,
    "publicationDate": "2020-10-02T10:03:29.526Z",
    "reactionDeadline": "2020-10-02T10:03:29.526Z",
    "resubmission": true,
    "rubric": "string",
    "spotColors": ["string"],
    "tags": ["string"],
    "editionDates": [
	    {
	       "edition": "string",
	       "publicationDate": "2022-09-08",
           "finishingDate":"2022-09-08T14:00:00Z"
        },
	    {
	      "edition": "string",
	      "publicationDate": "2022-09-09",
          "finishingDate":"2022-09-08T14:00:00Z"
        }
    ],
    "width": 0,
    "columns":3,
    "user": "string"
}

Webservice Konfiguration (Storno)

Die REST-Schnittstelle ist unter Hostname:Port/service/public/designorder/cancel-order verfügbar.

Parameter	Datentyp	Pflicht	Beschreibung
orderno	String	ja	Auftragsnummer bzw. Motivname (vgl. Importschnittstelle)
orderpos	Integer	ja	Auftragsposition
motifno	String	nein	Motivnummer
reason	String	nein	Stornogrund

Webservice Konfiguration (Auftragsstatus)

Die REST-Schnittstelle ist unter Hostname:Port/service/public/designorder/order-state verfügbar.

Parameter	Datentyp	Pflicht	Beschreibung
orderno	String	ja	Auftragsnummer bzw. Motivname (vgl. Importschnittstelle)
orderpos	Integer	ja	Auftragsposition
motifno	String	nein	Motivnummer

Als Ergebnis kommt ein JSON mit Status-Key, Status-Text und (optional) Fehlertext.

{
	"key":"designing",
	"text":"In Arbeit",
	"correctionNote":"21-11-10 13-23-31: Aktion: Abbruch, Grund: Priorität geändert, Text: Prio 3"
}

Datenübergabe an PS.eWorxx