Versions Compared

Key

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

Eingabewerte

Bezeichnung

Datentyp

RichtungWord/Email/Excel/Macro

Beschreibung

ID

Diverse ID's

inWord/Email/Excel/Macro

Nur für Einzelauswertungen:
Die ID des aufgerufenen Datenelements.

Die Liste der möglichen Datentypen ist in der folgenden Tabelle aufgeführt.
Siehe folgenden Unterabschnitt für die möglichen Datentypen.IDList

IDList

[Diverse ID's]

inWord/Email/Excel/Macro

Für alle Auswertungen:
Ein Array von ID's der aufgerufenen Datenelemente.

OrigIDDiverse ID'sinWord/Email/Excel/Macro

Nur für Einzelauswertungen:
Die ID des aufgerufenen Datenelements.

Diese Variable sollte nicht verändert werden

OrigIDList[Diverse ID's]inWord/Email/Excel/Macro

Für alle Auswertungen:
Ein Array von ID's der aufgerufenen Datenelemente

. Die Liste der möglichen Datentypen ist in der folgenden Tabelle aufgeführt.
Siehe folgenden Unterabschnitt für die möglichen Datentypen.

.

Diese Variable sollte nicht verändert werden

Skip

integer

outWord/Email/Excel/Macro

Wird mit 0 initialisiert.

Wird dieser Wert auf 1 gesetzt, dann wird die aktuell verarbeitete Auswertung nicht berücksichtigt, also ausgelassen. Falls anschliessend noch weitere Kommentare zu verarbeiten wären, werden diese nicht mehr ausgeführt.
Wird dieser Wert auf -1 gesetzt, dann wird die aktuelle Verarbeitung normal beendet. Anschliessend wird aber noch einmal eine Auswertung mit der selben ID wiederholt. Diese Funktion setzt voraus, dass über geeignete Massnahmen eine Endlosschleife verhindert wird.

Andere Werte als -1, 0 und 1 sind nicht definiert und können zu einem undefinierten Resultat führen.

Beachte auch die Variable Suppress.

SuppressintegeroutWord/Email/Excel/Macro

Wird mit 0 initialisiert.

Wird dieser Wert auf != 0 gesetzt, dann wird das Resultat der aktuellen Einzelauswertung ignoriert. Dies geschieht unabhängig von Skip

SignatureID

SignatureID

DatedatetimeinWord/Email/Excel/MacroAktuelles Datum oder Datum, welches bei CreateReport() übergeben wurde
SignatureTextIDSSD_SignatureTextIDinWord/Email/Excel/MacroID der ausgewählten Signatur in Form von i_SSD_SignatureTextID.. Hat der Report keine Signatur, ist dieser Wert 0.
SignatureTextID
SignatureLanguageID
 
SSD_SignatureLanguageID
 SignatureLanguageID  
inWord/Email/Excel/Macro
 SignaturePictureID  Word/
Sprache der Signatur.. Hat der Report keine Signatur, ist dieser Wert 0.
SignaturePictureIDSSE_DatasetPictureIDinWord/Email/Excel/Macro
 
Unterschriftsbild (i_SSE_DatasetPictureID).. Hat der Report keine Signatur, ist dieser Wert 0.
SignatureDatedatetimeinWord/Email/Excel/MacroAusgewähltes Datum bei der Signaturauswahl.. Hat der Report keine Signatur, ist dieser Wert gleich, wie die Variable Date.
SalutationTypeIDSSP_SalutationTypeIDinWord(Email/Excel/Macro
 
Auf dem Report definierter Anredetyp, zur Verwendung mit GetSignatureTextID (Opus Funktion).
LanguageID
 
SSE_LanguageID
 
inWord/Email/Excel/Macro
  

CompanyIDSSE_CompanyID
 
inWord/Email/Excel/Macro
  

SeminarCenterIDSSE_SeminarCenterID
 
inWord/Email/Excel/Macro
 

OrgUnitID
 
SSE_OrganizationalUnitID
 
inWord/Email/Excel/Macro
  

PlanningPeriodIDSSE_PlanningPeriodID
 
inWord/Email/Excel/Macro
  

ReportIDSSD_ReportID
 
inWord/Email/Excel/Macro
  

UserRoleID
USerRoleID 
SSE_UserRoleIDinWord/Email/Excel/Macro
 

EmailFrom[string]outEmail
 
Rückgabe der Absender Emailadresse im Format ["EmailAdresse","Name des Absenders"]
EmailTo[string]outEmail
 
Rückgabe der "To" Emailadresse(n) im Format ["EmailAdresse1","Name 1", ...]. Das Array muss immer zwei Einträge pro Adresse haben.
EmailCC
 
[string]outEmail
 
Rückgabe der "CC" Emailadresse(n) im Format ["EmailAdresse1","Name 1", ...]. Das Array muss immer zwei Einträge pro Adresse haben.
EmailBCC
 
[string]outEmail
 
Rückgabe der "BCC" Emailadresse(n) im Format ["EmailAdresse1","Name 1", ...]. Das Array muss immer zwei Einträge pro Adresse haben.
EmailReplyTo
 
[string]outEmail
 
Rückgabe der Rücksende-Emailadresse im Format ["EmailAdresse","Name des Absenders"]
EmailServer
 
[string]outEmail
 EmailAttachmentNames 

Serverangaben mit folgendem Inhalt (eine der folgenden Möglichkeiten):

["Exchangeserver"]

["SMTP Servername/Adresse", "Benutzername", "Passwort"]

["SMTP Servername/Adresse", "Benutzername", "Passwort", "Domain"]

EmailAttachmentNames[string]outEmail
 
Array mit Namen der Anhänge.
EmailAttachments
 
[blob]outEmail
 
Array mit binären Inhalten der Anhänge. Ist ein blob leer (Länge 0), dann gilt der entsprechende Eintrag in EmailAttachmentNames als Dateiname interpretiert und diese Datei wird als Anhang geladen.
EmailSubject
 
stringoutEmail
 
Betreff des Emails
EmailPort
  
integerin/outEmail

Zu verwendender Port für den Email Versand.

Default = 25

EmailReadReceiptAddressstringoutEmailWird hier eine Email Adresse eingefüllt, wird eine Lesebestätigung verlangt, welche an die angegebene Adresse gesendet wird. Es ist zu beachten, dass der Email Client diese Benachrichtigung auch unterdrücken kann.
EmailDeliveryReceiptAddressstringoutEmail
DocumentName
Wird hier eine Email Adresse eingefüllt, wird eine Empfangsbestätigung verlangt, welche an die angegebene Adresse gesendet wird. Es ist zu beachten, dass der Email Client diese Benachrichtigung auch unterdrücken kann.
DocumentNamestringin/outWord/Email/Excel/MacroDefault = Name der Auswertung
ArchiveID
 
[integer]outWord/Email/ExcelID des Datensatzes, bei welchem das Dokument abgelegt werden soll
ArchiveType[string]outWord/Email/Excel
/Macro ArchiveType 
Name der Tabelle, welche zur ID gehört
ArchiveReferenceDataset[string]outWord/Email/ExcelHier kann ein String eingetragen werden, welcher z.B. für Fremdsysteme oder Webschnittstellen verwendet werden kann um eine externe Beziehung zu identifizieren,
ArchiveReferenceRecord1ID[integer]outWord/Email/Excel
/Macro ArchiveDocumentName 
Hier kann eine ID eingetragen werden, welche z.B. für Fremdsysteme oder Webschnittstellen verwendet werden kann um eine externe Beziehung zu identifizieren,
ArchiveReferenceRecord2ID[integer]outWord/Email/ExcelHier kann eine ID eingetragen werden, welche z.B. für Fremdsysteme oder Webschnittstellen verwendet werden kann um eine externe Beziehung zu identifizieren,
ArchiveReferenceRecord3ID[integer]outWord/Email/ExcelHier kann eine ID eingetragen werden, welche z.B. für Fremdsysteme oder Webschnittstellen verwendet werden kann um eine externe Beziehung zu identifizieren,
ArchiveDocumentName[string]outWord/Email/ExcelName, mit welchem das Dokument abgelegt werden soll (ohne Extension, diese wird automatisch anhand des Archivierungstyps vergeben)
ArchiveInfoType[integer]outWord/Email/Excel
/Macro PageCode  
Informationstyp ID der zu archivierenden Dokumente
ArchiveReportDataJSONoutWord/Email/EmailInhalt wie der Wert "ReportData" (siehe weiter unten).
PageCodestringin/outWord/Email

RTF Code, der verwendet werden soll zwischen generierten Dokumenten. Default ist "\\sect"

Eine neue Seite "erzwingen" (falls der break nicht gemacht wird:  PageCode = "\\sbkpage ";

PageEndCodestringin/outWord/Email

RTF Code, der verwendet werden soll am Ende von generierten Dokumenten. Default ist "\\pgnstarts1\\pgnrestart"

PageCodes[string]outWord/Email

Default ist ein leeres Array. Hier können verschiedene PageCodes abgelegt werden, welche nacheinander vor die in Result zurückgegebenen vollständigen Dokumente gesetzt werden. Bleibt es leer oder ist es zu klein für alle Dokumente, dann wird der Code aus "PageCode" genommen.

Leere Seite am Anfang vermeiden:     PageCodes := [""];

PageEndCodes[string]outWord/Email
HeaderR

Default ist ein leeres Array. Hier können verschiedene PageEndCodes abgelegt werden, welche nacheinander an das Ende der in Result zurückgegebenen vollständigen Dokumente gesetzt werden. Bleibt es leer oder ist es zu klein für alle Dokumente, dann wird der Code aus "PageEndCode" genommen.

HeaderRstringin/outWord/Email
 
Definition der Kopfzeile für rechte Seiten. Dies wird auch verwendet für alle Seiten, wenn keine unterschiedlichen Kopfzeilen eingestellt sind.
HeaderL
 HeaderF 
stringin/outWord/Email
 Header 
Definition der Kopfzeile für linke Seiten.
HeaderFstringin/outWord/EmailDefinition der Kopfzeile für erste Seiten.
FooterRstringin/outWord/Email
 FooterR in/
Definition der Fusszeile für rechte Seiten. Dies wird auch verwendet für alle Seiten, wenn keine unterschiedlichen Fusszeilen eingestellt sind.
FooterLstringin/outWord/Email
 FooterL 
Definition der Fusszeile für linke Seiten.
FooterFstringin/outWord/EmailDefinition der Fusszeile für erste Seiten.
GlobalDefinitionsstringoutWord/Email
 FooterF 
Diese Variable wird leer erzeugt und kann mit zusätzlich benötigten globalen RTF Definitionen befüllt werden
FontTablestringinWord/EmailSchriftentabelle als RTF Code
Fonts[string]in/outWord/Email
 Footer 
Array mit den einzelnen Schriftdefinitionen in RTF Code. Fonts und FontNumbers müssen immer dieselbe Grösse haben.
FontNumbers[integer]in/outWord/EmailArray mit den Schriftnummern. Fonts und FontNumbers müssen immer dieselbe Grösse haben.
ColorTablestringinWord/Email
 GlobalDefinitions 
Farbtabelle als RTF Code
Colors[string]in/outWord/Email
  
Array mit den Farbdefinitionen in RTF. Colors und ColorNumbers müssen immer dieselbe Grösse haben.
ColorNumbers[integer]in/outWord/Email
 Tags
Array mit den Farbnummern. Colors und ColorNumbers müssen immer dieselbe Grösse haben.
TableWidths[string]inWord/EmailArray mit kommagetrannten Wertereihen. Jeder Wert enthält eine Spaltenbreite. Pro in der Vorlage enthaltene Tabelle ist ein Eintrag im String-Array.
TablePositions[integer]inWord/EmailPro in der Vorlage enthaltene Tabelle ist ein Eintrag mit der Textposition. Dies kann verwendet werden, um die Tabellen zu unterscheiden. Um herauszufinden, welche Tabelle sich z.B. gleich vor dem Makro befindet, kann die Variable MacroPosition nützlich sein.
MacroPositionintegerinWord/EmailPosition des Makros in der Vorlage.
MacroNamestringinWord/EmailName des Makros
MacroCodestringinWord/EmailProgrammcode des Makros
Tags[string]outWord/Email

Namen der Tags, welche am Ende der Verarbeitung ersetzt werden sollen. Dieses Array muss gleich gross sein, wie TagTexts

Es ist zu beachten, dass die Tags im Word als Ganzes ohne Unterbrechnung geschrieben werden müssen, damit sie dann richtig erkannt werden. Das heisst, dass bei Schreibfehlern der ganze Tag neu geschrieben werden sollte.

TagTexts
 
[string]outWord/EmailErsatztexte für die Tags, dieses Array muss gleich gross sein, wie Tags
Result
 
string | [string]outWord/Email

Für Word Auswertungen:
Resultattext(e), welcher an Stelle des Kommentars auf der Auswertung erscheinen soll.

Wird hier eines oder mehrere unmittelbar aufeinander folgende gesamte RTF Dokumente zurückgegeben, dann wird dieses oder werden diese korrekt eingefügt. Ein solches Dokument beginnt mit "{\\rtf1".

Vor diesem oder diesen Dokumenten wird der PageCode eingefügt oder wenn vorhanden nacheinander die Inhalte der Variable PageCodes.

Wird in Result ein Array zurückgegeben werden die Resultate nacheinander auf die selbe Weise behandelt, wobei der Index in PageCodes weiter hochgezählt wird.

Weitere
 

in/out
 

Weitere Variablen werden je nach Auswertungstyp verwendet (Rechnung, Leistungsnachweis)

TableResult

Object ExcelTable

ExcelTableObject

out

ExcelFür Excel Auswertungen: Tabelleninhaltsdefinition für das Excel Worksheet.

StyleResult

Object ExcelStyle

ExcelStyleObject

out

ExcelFür Excel Auswertungen: Definition der verwendeten Styles.
Styles

Tables

[

String

string]

in/out

ExcelFür Excel Auswertungen: Damit können auch mehrere Worksheets auf einmal generiert werden. Dazu müssen die Variablennamen der einzelnen Worksheets (welche vom Typ ExcelTableObject  sein müssen) als String Array zurückgegeben werden. Dieser Array muss gleich gross sein wie „Styles".
Initialwert: [„TableResult"]
Eine Neudefinition des Arrays muss mit dem Operator := erfolgen.
Tables

Styles

[

String

string]

in/out

ExcelFür Excel Auswertungen: Dies ist das Pendant zu „Tables". Damit werden die Styles (welche vom Typ ExcelStyleObject  sein müssen) pro Worksheet definiert. Es darf auch mehrmals der selbe Variablenname vorkommen (z.B. wenn alle Worksheets die selben Styles verwenden). Dieser Array muss gleich gross sein wie „Tables".
Initialwert: [„StyleResult"]
Eine Neudefinition des Arrays muss mit dem Operator := erfolgen.
ReportDataJSONinWord/Email/Excel/Macro

JSON Obejkt mit Daten, welche zum Ausführen des Reports benötigt werden.

Diese Daten werden entweder bei  CreateReport (Opus Funktion) mitgegeben oder im SSE_DatasetDocument gespeichert und von dort übernommen.

Standardfelder sind:

"IDList": Array mit den IDs
"Type": Datentyp der IDs
"SignatureID": ID der zu verwenden Signatur
"SignaturePictureID": ID des Signaturbildes (Typ I_SSE_DatasetPictureID)
"SignatureLanguageID": Sprache der Signatur
"Date": Briefdatum

Die Standardfelder werden ebenfalls in die Eingangsvariablen übernommen und müssen meistens nicht weiter berücksichtigt werden.

Weitere Felder können nach Belieben hinzugefügt werden. 

Einzel- und Listenauswertungen

...

In Word Auswertungen können als Texte auch beliebige (gültige) RTF Strings zurückgegeben werden. Entsprechende Möglichkeiten sind einer Rich-Text Format Dokumentation zu entnehmen.

Rechnungen

Für Rechnungsvorlagen gelten zusätzliche Informationen, Insbesondere der Archivierungsmechanismus ist durch einen Default Mechanismus gesteuert, (nur) wenn keine Archiv-Daten zurückgegeben werden. Siehe dazu die entsprechende Information unter Rechnungen.

Leistungsnachweise

Für Leistungsnachweise gelten zusätzliche Informationen. Siehe dazu Leistungsnachweise.

Excel Auswertungen

Bei Excel Auswertungen muss immer eine vollständige Excel-Datenstruktur zurückgegeben werden. Diese wird dann nach der Ausführung in ein Excel-Workbook (XML Format) umgewandelt.

Weiterleitungen

Wird für eine Auswertung eine Weiterleitungsfunktion geschrieben, dann erhält diese immer eine Variable „IDList" des entsprechenden Eingangstyps, auch wenn die Auswertung eine Einzelauswertung ist. Der Weiterleitungscode muss auch immer eine Variable „IDList" mit dem ID-Typ der Zielauswertung erzeugen. Diese wird dann in der Zielauswertung, welche wiederum eine Weiterleitung sein kann, weiterverwendet.
Diese Regeln für Weiterleitungen gelten sowohl für Word wie auch für Excel Auswertungen.

Eine Mischung zwischen Word und Excel ist nicht möglich

 Siehe: Weiterleitungen & Konvertierungen für Word (Reports)