There is space to grow your ideas...

Page tree

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.

IDList

[Diverse ID's]

inWord/Email/Excel/Macro

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

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

SignatureTextIDSSD_SignatureTextIDinWord/Email/Excel/MacroID der ausgewählten Signatur in Form von i_SSD_SignatureTextID.
SignatureLanguageIDSSD_SignatureLanguageIDinWord/Email/Excel/MacroSprache der Signatur
SignaturePictureIDSSE_DatasetPictureIDinWord/Email/Excel/MacroUnterschriftsbild (i_SSE_DatasetPictureID)
SignatureDatedatetimeinWord/Email/Excel/MacroAusgewähltes Datum bei der Signaturauswahl
SalutationTypeIDSSP_SalutationTypeIDinWord(Email/Excel/MacroAuf dem Report definierter Anredetyp, zur Verwendung mit GetSignatureTextID (Opus Funktion).
LanguageIDSSE_LanguageIDinWord/Email/Excel/Macro
CompanyIDSSE_CompanyIDinWord/Email/Excel/Macro
SeminarCenterIDSSE_SeminarCenterIDinWord/Email/Excel/Macro
OrgUnitIDSSE_OrganizationalUnitIDinWord/Email/Excel/Macro
PlanningPeriodIDSSE_PlanningPeriodIDinWord/Email/Excel/Macro
ReportIDSSD_ReportIDinWord/Email/Excel/Macro
UserRoleIDSSE_UserRoleIDinWord/Email/Excel/Macro
EmailFrom[string]outEmailRückgabe der Absender Emailadresse im Format ["EmailAdresse","Name des Absenders"]
EmailTo[string]outEmailRückgabe der "To" Emailadresse(n) im Format ["EmailAdresse1","Name 1", ...]. Das Array muss immer zwei Einträge pro Adresse haben.
EmailCC[string]outEmailRückgabe der "CC" Emailadresse(n) im Format ["EmailAdresse1","Name 1", ...]. Das Array muss immer zwei Einträge pro Adresse haben.
EmailBCC[string]outEmailRückgabe der "BCC" Emailadresse(n) im Format ["EmailAdresse1","Name 1", ...]. Das Array muss immer zwei Einträge pro Adresse haben.
EmailReplyTo[string]outEmailRückgabe der Rücksende-Emailadresse im Format ["EmailAdresse","Name des Absenders"]
EmailServer[string]outEmail

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

["Exchangeserver"]

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

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

EmailAttachmentNames[string]outEmailArray mit Namen der Anhänge.
EmailAttachments[blob]outEmailArray 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.
EmailSubjectstringoutEmailBetreff des Emails
EmailPortintegerin/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.
EmailDeliveryReceiptAddressstringoutEmailWird 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/ExcelName 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/ExcelHier 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/ExcelInformationstyp 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

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/EmailDefinition der Kopfzeile für rechte Seiten. Dies wird auch verwendet für alle Seiten, wenn keine unterschiedlichen Kopfzeilen eingestellt sind.
HeaderLstringin/outWord/EmailDefinition der Kopfzeile für linke Seiten.
HeaderFstringin/outWord/EmailDefinition der Kopfzeile für erste Seiten.
FooterRstringin/outWord/EmailDefinition der Fusszeile für rechte Seiten. Dies wird auch verwendet für alle Seiten, wenn keine unterschiedlichen Fusszeilen eingestellt sind.
FooterLstringin/outWord/EmailDefinition der Fusszeile für linke Seiten.
FooterFstringin/outWord/EmailDefinition der Fusszeile für erste Seiten.
GlobalDefinitionsstringoutWord/EmailDiese 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/EmailArray 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/EmailFarbtabelle als RTF Code
Colors[string]in/outWord/EmailArray mit den Farbdefinitionen in RTF. Colors und ColorNumbers müssen immer dieselbe Grösse haben.
ColorNumbers[integer]in/outWord/EmailArray 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
Resultstring | [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

ExcelTable Object

out

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

StyleResult

ExcelStyle Object

out

ExcelFür Excel Auswertungen: Definition der verwendeten Styles.

Tables

[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 ExcelTable Object  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.

Styles

[string]

in/out

ExcelFür Excel Auswertungen: Dies ist das Pendant zu „Tables". Damit werden die Styles (welche vom Typ ExcelStyle Object  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

Die Listenauswertungen werden so aufgerufen, dass eine Variable IDList mit einem Array aus allen ID's definiert wird und die Auswertung genau einmal aufgerufen wird. Diese muss dann ein Dokument erstellen, welches entsprechend der gewünschten Funktion alle ID's berücksichtigt.
Einzelauswertungen werden entsprechend viel mal aufgerufen mit je einer ID (Variable ID). Jedes mal muss die Auswertung für genau eine ID gemacht werden.

Word Auswertungen

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.

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

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