CreateBinaryReport (Opus Funktion)
Beschreibung¶
Diese Funktion generiert die Auswertung ReportID für die angegebene Liste von Elementen und die Signatur SignatureID.
Die Funktion gibt das daraus resultierende Dokument als Binärdatei zurück. Das Format ist so, wie es auf dem Report konfiguriert wurde.
Argumente¶
| Name | Typ | Beschreibung |
|---|---|---|
| ReportID | integer | ReportID |
| IDList | [integer] | IDList. Liste der IDs, für welche die Auswertung gemacht werden soll. Auch bei einer Einzelnen ID muss diese in einem Array übergeben werden. |
| Type | string | Typenbezeichnung der übergebenen IDList |
| SignatureTextID | integer | SignatureTextID (falls nicht nötig 0 übergeben) |
| SignaturePictureID | integer | (optional, Default = 0) SignaturePicture (i_SSE_DatasetPictureID) nur zusammen mit den folgenden zwei Argumenten Wird dieses Argument gewählt sind die folgenden beiden zwingend auch zu setzen. |
| SignatureLanguageID | integer | (optional, Default = 0) SignatureLanguage (SignatureLanguageID) |
| LetterDate | datetime | (optional, Default = aktuelles Datum) Briefdatum (SignatureLetterDate) |
| AllowUserInteraction | integer | (optional, Default = 0) Wenn dieser Wert auf 0 ist, dann werden keine Dialoge angezeigt und auch die Emailprüfung ist nicht aktiv. 1 = Benutzerinteraktion erlauben. Wird dieses Argument gewählt ist das folgende zwingend auch zu setzen. |
| ExecuteAsThread | integer | (optional, Default = 0) 1 = Als Thread ausführen, nicht auf das Ende warten |
| ReportData | string | (optional) Zusätzliche Daten, die dem Report übergeben werden sollen (typischerweise als JSON String) |
| Metadata | string | (optional) Metadaten, die dem Report übergeben werden sollen (typischerweise als JSON String) |
| TestEmailAnswer | &integer | (optional) Referenz auf eine Variable, welche für den Fall eines Reports vom Typ "Email mit Prüfung" zurückgegeben wird, welches die letzte Aktion des Benutzers war. Es sind folgende Rückgabewerte möglich: RTR_EmailCheckAnswer_None 0 : Keine Aktion (z.B. war die Vorlage nicht vom Typ "Email mit Prüfung") RTR_EmailCheckAnswer_SendSingle 1 : Es wurde ausgewählt, dass das einzelne Email gesendet werden soll RTR_EmailCheckAnswer_SendAll 2 : Es wurde ausgewählt, dass alle weiteren Email direkt gesendet werden sollen RTR_EmailCheckAnswer_SkipSend 3 : Es wurde ausgewählt, dass das einzelne Email nicht gesendet werden soll RTR_EmailCheckAnswer_AbortAll 4 : Es wurde ausgewählt, dass alle weiteren Emails nicht gesendet werden sollen Damit kann entschieden werden, wie allfällige weitere Reports ausgeführt werden sollen. Speziell behandelt werden sollten die Werte 2 (siehe unten) und 4 (dann sollte eventuell kein weiterer Report ausgeführt werden). Die anderen Werte sind rein informativ und haben in der Regel keinen Effekt auf die weitere Verarbeitung. Wird der Wert 2 in der Variable übergeben, dann wird keine Prüfung mehr durchgeführt. So kann die Benutzerauswahl in weitere Reports übernommen werden. Alle anderen Werte werden ignoriert. |
| EmailErrors | &[string] | (optional) Referenz auf ein Array von Strings, welches dann mit den Emailfehlern befüllt wird. Es entsteht ein Eintrag pro Email, welches versendet wurde. Die Einträge bedeutet folgendes: "" (leerer String): Es wurde ein Email ohne Fehler versendet "#": Der User hat bei Email mit Prüfung entschieden dieses Mail nicht zu versenden andere Inhalte: Fehlermeldung beim Emailversand |
Rückgabewert blob¶
Generierter Report als Binärdaten.