3. Bedeutung und Aufbau eines Jobs
Inhalt
Die Übertragungspakete werden im Kontext der Cloud API als Jobs bezeichnet. Ein Job sollte kleiner als 250kB groß sein, darf aber die Größe von 2MB nicht überschreiten. Ein Job beinhaltet, neben den eigentlich zu übertragenden Daten, zusätzliche Metadaten, die in der folgenden Tabelle aufgeführt werden:
Metadaten im CreateJob-Request |
|||
Feld |
Beschreibung |
Mögliche Ausprägungen/Beispiele |
Verwendung |
BatchCount |
Eine Nummer mit der sich ermitteln lässt wie viele Jobs mit der jeweiligen BatchUniqueId hat. |
10 |
Abholung der Daten |
BatchUniqueId |
(Optional )Eine eindeutige ID mit der sich der Batch der Jobs identifizieren lässt. |
"7ecf2d42-105e-4a2f-9f44-cf285d23c0a0" |
Abholung der Daten |
Sequence number |
Laufende Nummer, die die Reihenfolge der Abarbeitung der Jobs vorgibt. Sequenznummer gibt die Reihenfolge an, in der Aufträge vom Empfänger verarbeitet werden sollen. Es kann nicht automatisch von der Bibliothek generiert werden, es muss während der Auftragsgenerierung bereitgestellt werden. |
1 |
alle Prozesse |
Hashed data |
Hashwert, der über die unverschlüsselten Daten und den Licenseindicatorhash gebildet wird. Der Hash sollte immer auf dieselbe Weise gebildet werden, sodass bei Versand gleicher Daten der gleiche Hashwert gebildet wird. Der Hash wird für eine serverseitige Idempotency-Prüfung verwendet, um doppelte Aufträge herauszufiltern, wenn Clients denselben Auftrag (die gleichen Daten) mehrmals versenden. Ein verwendeter Algorithmus spielt keine Rolle. Sie können hier jede Art von Hash verwenden, solange Ihre Eingabe die unverschlüsselten Daten ist und der resultierende Hash für identische 'Daten' identisch ist. |
"C5EEDDADA83CABADC88F2E54258418A068B1600525499B637B848CA769CF4E69DD011" |
Versand der Daten |
Salt |
Zufällige Zeichenkette, die bei der Verschlüsselung der Daten eingesetzt wird. |
9u8h8z8h4j23thhuvjsvhjdruw3w9urk3jk3it4uioivfuj4!Bijisdfifeiurkjfsoiro3osfidogiG%foioVKrioewerk,jslddjksfdjsk5ku584u8fsoufiusdikf,j |
- Versand der Daten und Antworten - Abholung der Daten und Antworten |
Requesttype |
Art der zu übertragenden Daten. Ausprägungen werden von der Cloud API vorgegeben. |
MieterstammdatenRequest RechnungsdatenRequest |
alle Prozesse |
Licenseindicatorhash |
Bei der Lizenzaktivierung zurück erhaltener Hashwert zur Identifikation der Lizenz. |
"abc1dQ57XL61M0jn0PNEanCBYdT8k6qNX2KYqk5f+Xy2" |
- Erstellung des Token - Versand der Daten |
Deleteflag |
Kennzeichnet eine Löschanfrage der übertragenen Entitäten. Wenn das Feld auf "true" gesetzt wird, erfolgt bei der Job-Verarbeitung eine Löschung der Entitäten. Wichtig: Das DeleteFlag wird ausschließlich für Delta-Synchronisierungen benutzt. Bei vollständigen (Full-) Synchronisierungen wird das Flag NICHT verwendet. |
true/false |
- Versand der Daten und Antworten - Abholung der Daten und Antworten |
EntitiesCount |
Anzahl der übertragenen Entitäten pro Typ |
"EntitiesCount": { "MandantEntity": 1, "UnternehmenEntity": 1, "WirtschaftseinheitEntity": 1, "GebaeudeEntity": 1, "HausEntity": 1, "NutzungseinheitEntity": 1, "NutzerEntity": 1, "AdresseEntity": 3 } |
Versand der Daten |
Metadaten in der CreateJob-Response |
|||
Feld |
Beschreibung |
Mögliche Ausprägungen/Beispiele |
Verwendung |
JobId |
Wird von der Cloud API generiert und zur Abholung der Responses verwendet. |
|
- Abholung der Antworten - Bestätigung der Verarbeitung - Versand der Antworten - Bestätigung der Antwort |
Requesttype |
Art der zu übertragenden Daten. Ausprägungen werden von der Cloud API vorgegeben. |
MieterstammdatenRequest Rechnungsdaten-Request |
alle Prozesse |
State |
Status der Verarbeitung des Jobs |
Queued, New, Confirmed, Processed, ResponseRetrieved, Error |
Abholung der Daten und Antworten |
Entities |
Intern genutztes Feld |
|
nur HLRE intern verwendet |
Metadaten im CreateResponse-Request |
|||
Feld |
Beschreibung |
Mögliche Ausprägungen/Beispiele |
Verwendung |
Response |
Antworttext der Gegenstelle (verschlüsselt) |
|
- Versand der Antworten - Abholung der Antworten |
Responsecode |
Antwortcode der Cloud API oder der Gegenstelle |
CloudApiError-PayloadValidation-0001 |
- Versand der Antworten - Abholung der Antworten |
IsResponseOk |
|
true/false |
|
ResponseSalt |
Salt für die Ver-/Ent-schlüsselung der Response |
|
- Versand der Response - Abholung der Response |