Zum Inhalt

ArchiveReport (Opus Funktion)

Inhaltsverzeichnis

Beschreibung

Diese Funktion archiviert die Auswertung ReportID für die angegebene Liste von Elementen und die Signatur SignatureID.

Executes a report and archives the result. Returns an object describing the archived documents with their IDs, types, names and reference information.

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.

DatasetID

string

Name der Tabelle, auf welche sich die IDList bezieht

SignatureID

integer

SignatureID

SignaturePicture

integer

(optional) SignaturePicture (SSE_DatasetPictureID)

SignatureLanguage

integer

(optional) SignatureLanguage (SSE_LanguageID)

LetterDate

datetime

(optional, default = aktuelles Datum) Briefdatum

AllowUserInteraction

integer

(optional, Default = 0, für spätere Erweiterung) Benutzerinteraktion erlauben

Wird dieses Argument gewählt ist das folgende zwingend auch zu setzen.

ExecuteAsThread

integer

(optional, Default = 0, für spätere Erweiterung) 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)

Rückgabewert ArchiveReportsDetails Object

Archivierte RTF oder Excel Reports (XML) in einem Objekt mit folgenden Arrays:

  • [integer] IDs: Record IDs der zugeordneten Datensätze
  • [string] Types: Datensatztypen der zugeordneten Datensätze
  • [string] Names: Namen der archivierten Dokumente
  • [string] Reports: Inhalt der archivierten Dokumente
  • [integer] InfoTypeIDs
  • [string] ReferenceDatasets
  • [integer] ReferenceRecord1IDs
  • [integer] ReferenceRecord2IDs
  • [integer] ReferenceRecord3IDs
  • [string] ReportData: Zusätzliche Daten zum generieren des Reports
  • [string] Metadata: Metadaten zu den generierten Reports

Beispiel

Lo_Archive = ArchiveReport(35,IDList,"SSF_Invoice",0);

Siehe auch