Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Anzeigen und Aufträge können angelegt und geändert werden. Änderungen werden dabei bei Anzeigen mit bestimmter Bedingung in PRINT NGEN abgefragt und gespeichert. Zusätzlich werden Buchungsdaten abgefragt und der Produktionsstatus kann zurückgegeben werden.

...

Änderungen an einem Auftrag oder an Anzeigen werden als Event in der Tabelle “dauftrag_changed_event” gespeichert. Zudem werden produktionsrelevante Änderungen an Anzeigen mit der Eigenschaft “DAnzProduktionsArt=api” in der Tabelle “dauftrag_production_event” gespeichert. Jedes Event erhält eine fortlaufende ChangeID und wird zusammen mit der CID (= Cluster ID) des DAuftrag “DAuftrag” gespeichert. Bei den Abfragen werden nur Anzeigen berücksichtigt, die die Bedingung “DAnzeigeZugeladen!=ja” erfüllen.

In der Tabelle “dauftrag_changed_event” werden auch Änderungen an Beilagen und den übergeordneten Aufträgen gespeichert. Zur Unterscheidung von Anzeigen- und Beilagen-Events wird der Auftragstyp (“AN” = Anzeige, “BE” = Beilage) an jedem Event in der Tabelle gespeichert.

Bei der Abfrage geänderter Anzeigen werden nur Events mit Auftragstyp “AN” berücksichtigt.

Aufruf: {{baseURL}}/adapi/v1/ads/events

...

  • eventName: Entscheidet über die Art der Abfrage. Folgende Werte sind möglich:

    • changed: Alle Änderungen an Aufträgen und Anzeigen werden berücksichtigt

    • production: Nur produktionsrelevante Änderungen an Anzeigen mit “DAnzProduktionsArt=api” werden berücksichtigt

  • offset: Gibt die letzte ChangeID “ChangeID” an. Alle nachfolgenden ChangeIDs “ChangeIDs” in der Tabelle “dauftrag_production_event” werden beim nächsten Aufruf berücksichtigt. Zurückgegeben wird die im Aufruf höchste berücksichtigte ChangeID“ChangeID”. Der Wert ist beim ersten Aufruf leer. Bei weiteren Aufrufen wird der Wert des jeweils vorherigen Aufrufs zurückgegeben.

  • limit: Gibt an, wie viele Datensätze bei jedem Aufruf ausgegeben werden sollen.

Token-Variable unter “Authorization” eintragen:

...

Rückgabewerte

  • offset: Die im Aufruf höchste berücksichtigte

...

  • “ChangeID”.

  • data: Auftrags- und

...

  • Anzeigen.-Nummern ab dem angegebenen offset. Es werden maximal

...

  • so viele Datensätze ausgegeben, wie im

...

  • Limit definiert

...

  • sind.

Mit den bei /ads/events events” erhaltenen Nummern können die Daten der zugehörigen Elemente abgefragt werden.

Mögliche Ausnahmeregelungen bei Aufträgen

Events bei bestimmten Aufträgen verhindern

Es ist möglich, Ausnahmen zu definieren, bei welchen bestimmte Angaben an Aufträgen nicht zur Speicherung eines Events führen.

Beispiel:

Es ist beispielsweise  möglichist möglich, es so einzurichten, dass für Aufträge der  Verrechnungsarten der Verrechnungsarten “NurZurVerrechnung”  und “AuftraggeberGutschrift” kein Event gespeichert wird. Anzeigen von Aufträgen dieser Verrechnungsarten werden somit nicht übertragen. 

Zu beachten ist dabei, dass erst nach Auswahl dieser Verrechnungsart keine Events mehr erzeugt werden. Wird der Auftrag ohne Angabe der Verrechnungsart angelegt, wird ein Event gespeichert und Änderungen an den Anzeigen von externen Systemen als solche erkannt. Wird nachträglich die Verrechnungsart “NurZurVerrechnung” oder “AuftraggeberGutschrift” gewählt, wird diese Änderung nicht übertragen, da ab diesem Zeitpunkt aufgrund der Ausnahmeregelung keine Events mehr gespeichert werden.

Production-Events bei Statusänderungen

Production-Events werden bei produktionsrelevanten Änderungen an einer Anzeige erzeugt. Einige Statuswechsel an einem Auftrag führen nicht zu produktionsrelevanten Änderungen an Anzeigen. Der Auftrags-Statuswechsel selbst ist jedoch als produktionsrelevant einzuordnen. Zum Beispiel der Wechsel von “AngebotMitMotiv” zu “Buchung”. Diese Statuswechsel erzeugen Production-Events für den Auftrag. Das sind folgende Status-Wechsel:

Erfassung

PreisPrüfung

Buchung

BuchhaltungPrüfen

Fakturierungsstop

Fakturiert

Storniert

Gestoppt

AngebotMitMotiv

AngebotOhneMotiv

Erfassung

 

-

X

-

-

-

X

X

X

-

PreisPrüfung

X

 

X

-

-

-

X

-

X

-

Buchung

X

-

 

-

-

-

X

X

X

-

BuchhaltungPrüfen

X

-

X

 

-

-

X

X

X

-

Fakturierungsstop

-

-

-

-

 

-

X

-

-

-

Fakturiert

-

-

-

-

-

 

X

-

-

-

Storniert

X

-

X

-

-

-

 

-

X

-

Gestoppt

X

-

X

-

-

-

X

 

X

-

AngebotMitMotiv

X

-

X

-

-

-

X

X

 

-

AngebotOhneMotiv

X

-

X

-

-

-

X

-

X

 

Buchungsdaten

Abfrage Auftragsdaten

...

Status
colourBlue
titleget
{{baseURL}}/adapi/v1/orders/{{Auftragsnummer}}

Abfrage Anzeigendaten

...

Status
colourBlue
titleget
{{baseURL}}/adapi/v1/ads/{{Anzeigennummer}}

...

Rückmeldung Produktionsstatus

...

Status
colourYellow
titleput
{{baseURL}}/adapi/v1/ads/{{Anzeigennummer}}

...

Prüfungen

Motivprüfung

Bei jedem Put oder Post

Status
colourYellow
titleput
oder
Status
colourGreen
titlepost
einer Anzeige wird in der Abbildung “AdAPISettings” die dem Eintrag “MotivPrüfen” zugeordnete Suchbedingung durchlaufen, die feststellt, ob die Anzeigenprüfung durchzuführen ist. (Rückgabewert 2). Ist die Bedingung erfüllt, wird die in Rückgabewert 1 angegebene komplexe Aktion ausgeführt. In dieser komplexen Aktion ist das ActiveX#AnzeigenImport aufzurufen, damit der Anzeigenvergleich ausgeführt oder das Motiv verworfen und die Anzeige in den Status “Geplant” zurückgesetzt wird.

...

Prüfung Timestamp

Bei jedem PUT oder POST

Status
colourYellow
titleput
oder
Status
colourGreen
titlepost
einer Anzeige wird in der Abbildung “AdAPISettings” die dem Eintrag “TimestampPrüfen” zugeordnete Suchbedingung durchlaufen, die feststellt, ob die Prüfung des Timestamps durchzuführen ist. Ist die Suchbedingung erfüllt, wird geprüft, ob der übergebene Timestamp dem zuletzt gespeicherten Event in der Tabelle “dauftrag_production_event” entspricht.

...

Falls mindestens eine Prüfung zum Fehler führt, gibt es im Response Body des POST- oder PUT

Status
colourGreen
titlepost
- oder
Status
colourYellow
titleput
-Requests die "validations"-Property, bei der nur die Properties enthalten sind, bei denen ein Fehler auftrat. Der Inhalt der Property ist jeweils eine entsprechende Fehlermeldung.

...

Anzeigenmotiv abrufen

Aufrufe:GET

Status
colourBlue
titleget
{{baseURL}}/adapi/v1/ads/images/10009404-1/HighResGET

Status
colourBlue
titleget
{{baseURL}}/adapi/v1/ads/images/10009104-1/Thumbnail

 

Anzeigenmotiv aktualisieren

Aufruf:PUT

Status
colourYellow
titleput
{{baseURL}}/adapi/v1/ads/images/10009404-1?filename=Test1.pdf

...

In der komplexen Aktion “AdAPI_Motiv_Prüfen”findet der Anzeigenvergleich statt. Es werden Größen und Farben überprüft. Passt das überstellte Motiv zu den Buchungsdaten der Anzeige, erhält die Anzeige den im Variablenkontext festgelegten “OK”-Status. Andernfalls erhält die Anzeige den Status “Fehler” und in “DAnzeigeFehlerInfo” werden die Fehler vermerkt. Zusätzlich wird in der komplexen Aktion nach Anzeigen mit derselben Anzeigennummer und “DAnzeigeZugeladen=ja” gesucht und es werden die Bilddaten sowie der Status der Original-Anzeigen zu den zugeladenen Anzeigen übernommen. Damit wird sichergestellt, dass Motivupdates bei allen Anzeigen mit der angegebenen Anzeigennummer ausgeführt werden.

Aufträge

Ändern von Aufträgen:

...

Status
colourYellow
titleput
orders

Falls der Auftrag in einem Status gespeichert werden soll, der nicht mindestens gebucht ist (FestdefinierteWerte "DAuftrag", "Status", "AtLeastBooked")
wird geprüft, ob dies “OK” ist: Es darf keine Leistung verrechnet sein, auch beim Hauptauftrag darf keine Leistung verrechnet sein. Außerdem darf keine Anzeige einen Anstrich haben.

...

Code Block
{
    "error": "Order status 'Erfassung' is not allowed: At least one benefit is already invoiced."
}

In der Abbildung “BuchungLoeschen” wird definiert, in welchen Statusstufen eines Auftrags die zugehörigen Anzeigen ohne Buchungen gespeichert werden (z. B. Status “Erfassung”). Wird ein Auftrag in eine dieser Statusstufen gestuft, werden die Buchungen an den Anzeigen gelöscht. Die Erscheinungsweise ist weiterhin gespeichert, sodass beim erneuten Stufen in einen planungsrelevanten Auftragsstatus die Buchungen an den Anzeigen wiederhergestellt werden können.

...

Beim Hinzufügen/Entfernen von Abschüssen zu einem Auftrag muss der Abschluss aktuell gehalten werden, d. h. der Erfüllungsgrad wird neu berechnet.

Bei PUT und POST

Status
colourYellow
titleput
und
Status
colourGreen
titlepost
einer Anzeige oder eines Auftrags wird möglicherweise die Preisberechnung durchgeführt, wodurch auch Abschlüsse ausgecheckt und verändert werden. Möglicherweise werden auch Abschlüsse vom Auftrag entfernt.

...

Include Page
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation

Nur für PEIQ-Mitarbeiter:

/wiki/spaces/CORE/pages/1193410566