Eingabewerte
Bezeichnung | Datentyp | Richtung | Word/Email/Excel/Macro | Beschreibung | |||
ID | Diverse ID's | in | Word/Email/Excel/Macro | Nur für Einzelauswertungen: | |||
IDList | [Diverse ID's] | in | Word/Email/Excel/Macro | Für alle Auswertungen: | |||
Skip | integer | out | Word/Email/Excel/Macro | Wird mit 0 initialisiert übergeben. Siehe „Ausgabewerte" für Details. 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. Beachte auch die Variable Suppress. | |||
| Suppress | integer | out | Word/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 | in | Word/Email/Excel/Macro | ID der ausgewählten Signatur. | FileName | string | Wird diese Variable gesetzt, wird die erzeugte Datei unter diesem Filenamen gespeichert. Die Dateiendung wird nicht angegeben, diese wird automatisch gesetzt. |
| SignatureTextID | Word/Email/Excel/Macro | ||||||
| SignatureLanguageID | Word/Email/Excel/Macro | ||||||
| SignaturePictureID | Word/Email/Excel/Macro | ||||||
| LanguageID | Word/Email/Excel/Macro | ||||||
| CompanyID | Word/Email/Excel/Macro | ||||||
| SeminarCenterID | Word/Email/Excel/Macro | ||||||
| OrgUnitID | Word/Email/Excel/Macro | ||||||
| PlanningPeriodID | Word/Email/Excel/Macro | ||||||
| ReportID | Word/Email/Excel/Macro | ||||||
| USerRoleID | Word/Email/Excel/Macro | ||||||
| EmailFrom | [string] | out | |||||
| EmailTo | [string] | out | |||||
| EmailCC | out | ||||||
| EmailBCC | out | ||||||
| EmailReplyTo | out | ||||||
| EmailServer | out | ||||||
| EmailAttachmentNames | out | ||||||
| EmailAttachments | out | ||||||
| EmailSubject | out | ||||||
| EmailPort | in/out | Default = 25 | |||||
| DocumentName | in/out | Word/Email/Excel/Macro | Default = Name der Auswertung | ||||
| ArchiveID | out | Word/Email/Excel/Macro | |||||
| ArchiveType | out | Word/Email/Excel/Macro | |||||
| ArchiveDocumentName | out | Word/Email/Excel/Macro | |||||
| PageCode | in/out | Word/Email | |||||
| HeaderR | in/out | Word/Email | |||||
| HeaderL | in/out | Word/Email | |||||
| HeaderF | in/out | Word/Email | |||||
| Header | in/out | Word/Email | |||||
| FooterR | in/out | Word/Email | |||||
| FooterL | in/out | Word/Email | |||||
| FooterF | in/out | Word/Email | |||||
| Footer | in/out | Word/Email | |||||
| GlobalDefinitions | in/out | Word/Email | |||||
| Tags | |||||||
| TagTexts | |||||||
| Result | |||||||
| Weitere |
Ausgabewerte
Bezeichnung | Datentyp | Beschreibung | ||||||
Result | String | out | Word/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 | out | Word/Email | Ersatztexte für die Tags, dieses Array muss gleich gross sein, wie Tags | |||||
| Result | out | Word/Email | Für Word Auswertungen: Resultattext, welcher an Stelle des Kommentars auf der Auswertung erscheinen soll. | |||||
| Weitere | Integer | 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. | FileName | String | Wird diese Variable gesetzt, wird die erzeugte Datei unter diesem Filenamen gespeichert. Die Dateiendung wird nicht angegeben, diese wird automatisch gesetzt.in/out | Weitere Variablen werden je nach Auswertungstyp verwendet (Rechnung, Leistungsnachweis) | ||
TableResult | Object ExcelTable | out | Excel | Für Excel Auswertungen: Tabelleninhaltsdefinition für das Excel Worksheet. | ||||
StyleResult | Object ExcelStyle | out | Excel | Für Excel Auswertungen: Definition der verwendeten Styles. | ||||
Styles | [String] | in/out | Excel | Für Excel Auswertungen: Damit können auch mehrere Worksheets auf einmal generiert werden. Dazu müssen die Variablennamen der einzelnen Worksheets 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 | [String] | in/out | Excel | Für Excel Auswertungen: Dies ist das Pendant zu „Tables". Damit werden die Styles 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. |
...
...
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
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