Generelles

Die folgenden Eigenschaften dienen der allgemeinen Definition des Verarbeitungsszenarios.

Eigenschaft	Beschreibung
Constant[]	Konstantendefinitionen (siehe Konstanten)
General.ScenarioName	frei wählbarer Name des Szenarios Dieser Name wird zusätzlich zum technischen Namen dargestellt und im Logging angezeigt. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Name der Konfiguration genutzt.
General.ScenarioDescription	freier Beschreibungstext für das Szenario Dieser Beschreibungstext dient primär der Anzeige im Konfigurationsprogramm.
General.Priority	numerischer Wert, mit dem die Priorität von 1 (höchste) bis n (niedrigste) festgelegt werden kann Mit dieser Priorität werden die Dokumente des Szenarios verarbeitet, die von einer Worker-Instanz aus der Verwaltungsdatenbank selektiert wurden. Diese Eigenschaft ist nur relevant, wenn eine Worker-Instanz nacheinander Daten verschiedener Szenarien verarbeitet. Innerhalb einer Prioritätsstufe erfolgt die Verarbeitung in der Reihenfolge des Einlesezeitpunkts der Dokumente. Standardwert: `5`
General.RetryMax General.RetryDelayMacro(*)	Eigenschaften zur Steuerung automatischer Wiederholungsversuche der Verarbeitung eines Dokumentes im Fehlerfall Dies betrifft nur Dokumente, die erfolgreich in die Datenbank eingelesen wurden, d.h. Dokumente im Schritt "Process" und "Output". Dokumente, die bereits im "Input"-Schritt nicht einlesbar sind, können nur durch manuellen Eingriff neu verarbeitet werden. Diese Funktionalität kann z. B. eingesetzt werden, wenn temporäre Verbindungsprobleme zu einem Ausgabesystem zu erwarten sind. Bei inhaltlichen Fehlern in den Dokumentdaten, die sich auch durch wiederholte Verarbeitungsversuche nicht automatisch beheben lassen, sollte die Funktionalität hingegen nicht genutzt werden. Die numerische Eigenschaft `.RetryMax` legt fest, wie viele Wiederholungsversuche maximal durchgeführt werden, bevor ein Dokument letztlich auf den Fehlerstatus gesetzt wird (Standardwert: `0`, d.h. keine Wiederholungen). Wenn die Funktion aktiv sein soll, muss auch `.RetryDelayMacro` konfiguriert sein. Diese Konfiguration erfolgt dynamisch in Form eines Feldmakroausdrucks, der auch nur ein einzelner konstanter Wert sein kann. Dieses Makro muss eine Zahlenwert zurückliefern, der die Dauer der Wartezeit in Minuten bis zum nächsten Verarbeitungsversuch vorgibt. Über dieses Makro wird auch bestimmt, ob ein neuer Verarbeitungsversuch überhaupt unternommen wird. Wenn das Makro den Wert `0` zurückliefert, finden keine weiteren Versuche statt. Um das bei der Makroausführung dynamisch entscheiden zu können, stehen in diesem Kontext folgende zusätzliche Systemvariablen zur Verfügung. Somit kann die automatische Wiederholung z. B. auf bestimmte Arten von Fehlern beschränkt werden. `ErrorText`: Meldungstext, wie dieser zu dem vorliegenden Fehler auch ins Log geschrieben werden würde `EventId`: Ereignis-ID zur Klassifizierung des Fehlerkontextes (siehe Ereignisklassen) `RetryNo`: Nummer des anstehenden Wiederholungsversuchs (mit der Zählung beginnend bei 1)
General.BatchLogFile	optionaler Pfad einer stapelspezifischen Log-Datei In dieser Log-Datei werden alle Informationen zum Verarbeitungsablauf eines einzelnen Stapels gebündelt. Inhaltlich sind dies die gleichen Einträge wie gemäß globaler Konfiguration in `Logging.File`. Hier sind dies jedoch nur Einträge, die sich auf den jeweiligen Stapel beziehen. Das stapelspezifische Logging setzt erst ein, wenn ein Stapel erfolgreich eingelesen und initial in die Verwaltungsdatenbank übernommen wurde. Einträge, die sich auf den vorangehenden Einlesevorgang beziehen, müssen daher dem globalen Log des zuständigen Input-Workers entnommen werden. Um den Dateipfad der Log-Datei dynamisch zu bilden, sodass nach Stapeln getrennte Dateien entstehen, sind folgende Variablen zur Einbindung in den Pfad nutzbar: Hinweis Analog zum globalen Logging sind auch die Variablen `%Date%` und `%Tenant%` nutzbar. `%FileName%`: Name der Eingabedatei `%FileBaseName%`: Basisname der Eingabedatei (ohne Dateiendung) `%FilePath%`: vollständiger Pfad der Eingabedatei (Verzeichnis und Dateiname) `%FileBasePath%`: vollständiger Basispfad der Eingabedatei (ohne Dateiendung) `%BatchName%`: Name des Stapels `%BatchId%`: Datenbankschlüssel des Stapels `%BatchExtId%`: externe ID des Stapels `%BatchUuid%`: UUID des Stapels Die Variablen `%File*%` beziehen sich auf die Eingabedatei, die vom Eingabesystem gelesen wurde. Diese Variablen sind nur verfügbar, wenn das Eingabesystem ein System ist, das direkt aus dem Dateisystem liest. Für benutzerdefinierte Eingabesysteme vom Typ "Custom" ist derzeit nicht vorgesehen, den Pfad der stapelbezogenen Eingabedatei an das Programm zurückzumelden. Diese Variablen sind für Eingabesysteme von Typ "Custom" daher nicht nutzbar. Die Variablen `%Batch*%` beziehen sich auf Eigenschaften des neu erstellten Stapels und entsprechen den gleichnamigen Dokumentvariablen (siehe Variablen). In der Version 4.x von xSuite Interface wurde bei dateibasierten Eingabesystemen automatisch eine Log-Datei direkt im Eingabeverzeichnis und unter dem Namen der Eingabedatei erstellt. Um dieses Verhalten in dieser Version von xSuite Interface nachzubilden, kann als Pfad `%FilePath%.log` konfiguriert werden. Für Eingabesysteme, die nicht dateibasiert sind, sollten hingegen ein fester Log-Ordner sowie Variablen genutzt werden, die den Bezug zum Stapel herstellen, z. B. `c:\log\[%BatchId%] %BatchName%.log`. Wenn mehrere Worker-Instanzen konfiguriert sind, die parallel an mehreren Dokumenten desselben Stapels arbeiten, schränkt dies die Lesbarkeit des Stapel-Logs ein. Diese parallelläufigen Verarbeitungsinstanzen werden ungeordnet in dieselbe Log-Datei geschrieben. In einem solchen Fall kann das Heranziehen der globalen Logs hilfreich sein, weil diese eine Trennung in separate Dateien pro Instanz ermöglichen.
General.FileMacroOptions.PdfALevel General.FileMacroOptions.JpegQuality General.FileMacroOptions.PngCompression General.FileMacroOptions.FormFeed(#) General.FileMacroOptions.ImageResolution General.FileMacroOptions.ImageBitDepth General.FileMacroOptions.PageMargin General.FileMacroOptions.FitWorksheetToPage General.FileMacroOptions.DefaultFont General.FileMacroOptions.FontsFolder General.FileMacroOptions.ExtractFilesPdfLib	Standardeinstellungen für die Ausführung bestimmter Dateimakros, die innerhalb des Szenarios global gelten Abhängig von der verwendeten Grafikbibliothek und der konkreten Konvertierungsfunktion werden nicht alle Einstellungen unterstützt. Wenn eine Einstellung nicht unterstützt wird, wird implizit ein abweichender Wert genutzt oder ein Fehler ausgelöst, z. B. bei einer nicht unterstützten PDF/A-Version. `.PdfALevel`: Version des PDF/A-Standards bei der Ausgabe von PDF-Dateien im PDF/A-Format: `PDF_A_1a` (PDF/A-1a) `PDF_A_1b` (PDF/A-1b) `PDF_A_2a` (PDF/A-2a) (Standardwert) `PDF_A_2b` (PDF/A-2b) und weitere bis `PDF_A_4f` (PDF/A-4f) `.JpegQuality`: numerische Ausgabequalität von JPEG-Dateien von `1` (schlechteste) bis `100` (beste) (Standardwert: `75`) `.PngCompression`: numerischer Grad der Kompression für auszugebende PNG-Dateien von `0` (keine) bis `10` (maximale) (Standardwert: `6`) `.FormFeed`: Seitenvorschubzeichen bei der Ausgabe mehrseitiger Textdateien (Standardwert: `\f`, d.h. Zeichencode 12) `.ImageResolution`: numerische Auflösung für auszugebende Rasterbilddateien in DPI (Standardwert: `300`) `.ImageBitDepth`: numerische Farbtiefe für auszugebende Rasterbilddateien mit gültigen Ausprägungen `1`, `8` und `24` (Standardwert) `.PageMargin`: explizit zu setzende, numerische Breite des Seitenrandes in Millimetern bei der Konvertierung von Microsoft-Office-Dokumenten, wobei gleichzeitig die Ausgabepapiergröße fest auf DIN A4 festgelegt wird (Standardwert: `-1`, d.h. keine Änderung der Originaleinstellung) `.FitWorksheetToPage`: Wahrheitswert, ob bei der Konvertierung von Microsoft-Excel-Dateien der Inhalt eines Arbeitsblattes auf einer einzelnen Ausgabeseite dargestellt wird (Standardwert: `true`); dies übersteuert die unter `.PageMargin` festgelegte Papiergröße `.DefaultFont`: Name der Standard-Ersetzungsschriftart für ein Microsoft-Word-Dokument, wenn die Originalschriftarten nicht installiert sind (nur relevant bei Nutzung von xSuite Interface unter Linux) `.FontsFolder`: Verzeichnispfad für in einem Microsoft-Word-Dokument zu nutzende Schriftarten, wenn diese nicht im Standardordner des Betriebssystems installiert sind (nur relevant bei Nutzung von xSuite Interface unter Linux) `ExtractFilesPdfLib`: Auswahl der Grafikbibliothek zur Extraktion von Dateianlagen aus einer PDF-Datei: `Aspose` `GdPicture` (Standardwert)
Lookup[].Name Lookup[].Item[]	Definition von Nachschlagelisten Über Makrofunktionen wie `Lookup()` und `LookupLike()` kann auf die Nachschlagelisten zugegriffen werden. Wenn mehrere Listen vorhanden sind, müssen diese über die Eigenschaft `.Name` eindeutig identifizierbar gemacht werden. Die Elemente einer solchen Liste bestehen aus Schlüssel-/Wert-Paaren. Diese Paare müssen in den folgenden 2 Teilparametern angegeben werden: `Key`*: Schlüssel `Value`: Wert
General.Database[].Name General.Database[].ConnectionString(§%) General.Database[].Password(§) General.Database[].Command(%)	separat zu konfigurierende(s) Verbindungsparameter und Kommando für den Zugriff auf eine externe Datenbank in einer Makrofunktion, z. B. `QueryDbField()` Diese Parameter sind in eigenständige Konfigurationseigenschaften ausgelagert, um die Länge der Parameterliste der betreffenden Funktionen zu begrenzen. In den Funktionen werden diese Parameter über die Eigenschaft `.Name` referenziert. Der `.ConnectionString` ist die Verbindungszeichenfolge zur Datenbank. Die unterstützten Systeme sind unter Externe Datenquellen beschrieben. Das Passwort, das in der Verbindungszeichenfolge benötigt wird, kann auch separat in `.Password` definiert werden. Über die Variable `%Password%` kann das Passwort dann in die Zeichenfolge eingebunden werden. Das auszuführende Datenbank-Kommando in `.Command` ist abhängig vom Kontext der Makrofunktion. In den meisten Anwendungsfällen enthält das Kommando eine SELECT-Anweisung.
General.WebService[].Name* General.WebService[].Url*(%) General.WebService[].Method General.WebService[].ProxyServer General.WebService[].AuthMode General.WebService[].User General.WebService[].Password(§) General.WebService[].CertificateName	separat zu konfigurierende Verbindungsparameter zu einem externen Webservice für die Verwendung in einer Makrofunktion, z. B. `CallWebService()` Diese Parameter sind in eigenständige Konfigurationseigenschaften ausgelagert, um die Länge der Parameterliste der betreffenden Funktionen zu begrenzen. Die Parameter werden in den Funktionen über die Eigenschaft `.Name` referenziert. Solche Funktionen ermöglichen den generischen Aufruf einfacher Webservices, sind aber kein vollwertiger Ersatz für die projektspezifische Implementierung spezieller Webservice-Schnittstellen. Diese Funktionen unterstützen weder in der Anfrage noch in der Antwort die Verarbeitung von Multipart-Daten. In `.Url` ist die vollständige URL des aufzurufenden Webservices anzugeben, ggf. inklusive Pfad und Parameter. In `.Method` ist die HTTP-Methode anzugeben (Standardwert: `POST`). Wenn die Kommunikation über einen Proxy-Server laufen soll, kann dieser in `.ProxyServer` definiert werden (Syntax siehe Proxy-Server-Verbindung. Wenn der Webservice eine Authentifizierung erfordert, stehen über den `.AuthMode` die folgenden Modi zur Verfügung: `None`: keine Authentifizierung (Standardwert) `Basic`: Basisauthentifizierung mit Benutzername und Passwort `ApiKey`: API-Schlüssel `Certificate`: Client-Zertifikat In `.User` und `.Password` müssen die Eigenschaften für eine Authentifizierung im Modus `Basic` eingegeben werden. Im Modus `ApiKey` werden diese Eigenschaften für die Angabe des Schlüsselnamens (als `.User`, z. B. `Bearer`“ und des Schlüsselwertes (als `.Password`) genutzt. Das Zertifikat im Modus `Certificate` ist in `.CertificateName` über den Namen des Zertifikats anzugeben. Der Name muss der Eigenschaft `.Name` eines Zertifikats der Art `Certificate[].Usage: "Client"` entsprechen, das global unter `Certificate[]` definiert ist..

Eigenschaft

Beschreibung

Constant[]

Konstantendefinitionen (siehe Konstanten)

General.ScenarioName

frei wählbarer Name des Szenarios

Dieser Name wird zusätzlich zum technischen Namen dargestellt und im Logging angezeigt. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Name der Konfiguration genutzt.

General.ScenarioDescription

freier Beschreibungstext für das Szenario

Dieser Beschreibungstext dient primär der Anzeige im Konfigurationsprogramm.

General.Priority

numerischer Wert, mit dem die Priorität von 1 (höchste) bis n (niedrigste) festgelegt werden kann

Mit dieser Priorität werden die Dokumente des Szenarios verarbeitet, die von einer Worker-Instanz aus der Verwaltungsdatenbank selektiert wurden.

Diese Eigenschaft ist nur relevant, wenn eine Worker-Instanz nacheinander Daten verschiedener Szenarien verarbeitet. Innerhalb einer Prioritätsstufe erfolgt die Verarbeitung in der Reihenfolge des Einlesezeitpunkts der Dokumente.

Standardwert: 5

General.RetryMax

General.RetryDelayMacro(*)

Eigenschaften zur Steuerung automatischer Wiederholungsversuche der Verarbeitung eines Dokumentes im Fehlerfall

Dies betrifft nur Dokumente, die erfolgreich in die Datenbank eingelesen wurden, d.h. Dokumente im Schritt "Process" und "Output". Dokumente, die bereits im "Input"-Schritt nicht einlesbar sind, können nur durch manuellen Eingriff neu verarbeitet werden.

Diese Funktionalität kann z. B. eingesetzt werden, wenn temporäre Verbindungsprobleme zu einem Ausgabesystem zu erwarten sind. Bei inhaltlichen Fehlern in den Dokumentdaten, die sich auch durch wiederholte Verarbeitungsversuche nicht automatisch beheben lassen, sollte die Funktionalität hingegen nicht genutzt werden.

Die numerische Eigenschaft .RetryMax legt fest, wie viele Wiederholungsversuche maximal durchgeführt werden, bevor ein Dokument letztlich auf den Fehlerstatus gesetzt wird (Standardwert: 0, d.h. keine Wiederholungen).

Wenn die Funktion aktiv sein soll, muss auch .RetryDelayMacro konfiguriert sein. Diese Konfiguration erfolgt dynamisch in Form eines Feldmakroausdrucks, der auch nur ein einzelner konstanter Wert sein kann. Dieses Makro muss eine Zahlenwert zurückliefern, der die Dauer der Wartezeit in Minuten bis zum nächsten Verarbeitungsversuch vorgibt.

Über dieses Makro wird auch bestimmt, ob ein neuer Verarbeitungsversuch überhaupt unternommen wird. Wenn das Makro den Wert 0 zurückliefert, finden keine weiteren Versuche statt. Um das bei der Makroausführung dynamisch entscheiden zu können, stehen in diesem Kontext folgende zusätzliche Systemvariablen zur Verfügung. Somit kann die automatische Wiederholung z. B. auf bestimmte Arten von Fehlern beschränkt werden.

ErrorText: Meldungstext, wie dieser zu dem vorliegenden Fehler auch ins Log geschrieben werden würde
EventId: Ereignis-ID zur Klassifizierung des Fehlerkontextes (siehe Ereignisklassen)
RetryNo: Nummer des anstehenden Wiederholungsversuchs (mit der Zählung beginnend bei 1)

General.BatchLogFile

optionaler Pfad einer stapelspezifischen Log-Datei

In dieser Log-Datei werden alle Informationen zum Verarbeitungsablauf eines einzelnen Stapels gebündelt. Inhaltlich sind dies die gleichen Einträge wie gemäß globaler Konfiguration in Logging.File. Hier sind dies jedoch nur Einträge, die sich auf den jeweiligen Stapel beziehen.

Das stapelspezifische Logging setzt erst ein, wenn ein Stapel erfolgreich eingelesen und initial in die Verwaltungsdatenbank übernommen wurde. Einträge, die sich auf den vorangehenden Einlesevorgang beziehen, müssen daher dem globalen Log des zuständigen Input-Workers entnommen werden.

Um den Dateipfad der Log-Datei dynamisch zu bilden, sodass nach Stapeln getrennte Dateien entstehen, sind folgende Variablen zur Einbindung in den Pfad nutzbar:

Hinweis

Analog zum globalen Logging sind auch die Variablen %Date% und %Tenant% nutzbar.

%FileName%: Name der Eingabedatei
%FileBaseName%: Basisname der Eingabedatei (ohne Dateiendung)
%FilePath%: vollständiger Pfad der Eingabedatei (Verzeichnis und Dateiname)
%FileBasePath%: vollständiger Basispfad der Eingabedatei (ohne Dateiendung)
%BatchName%: Name des Stapels
%BatchId%: Datenbankschlüssel des Stapels
%BatchExtId%: externe ID des Stapels
%BatchUuid%: UUID des Stapels

Die Variablen %File***% beziehen sich auf die Eingabedatei, die vom Eingabesystem gelesen wurde. Diese Variablen sind nur verfügbar, wenn das Eingabesystem ein System ist, das direkt aus dem Dateisystem liest. Für benutzerdefinierte Eingabesysteme vom Typ "Custom" ist derzeit nicht vorgesehen, den Pfad der stapelbezogenen Eingabedatei an das Programm zurückzumelden. Diese Variablen sind für Eingabesysteme von Typ "Custom" daher nicht nutzbar.

Die Variablen %Batch***% beziehen sich auf Eigenschaften des neu erstellten Stapels und entsprechen den gleichnamigen Dokumentvariablen (siehe Variablen).

In der Version 4.x von xSuite Interface wurde bei dateibasierten Eingabesystemen automatisch eine Log-Datei direkt im Eingabeverzeichnis und unter dem Namen der Eingabedatei erstellt. Um dieses Verhalten in dieser Version von xSuite Interface nachzubilden, kann als Pfad %FilePath%.log konfiguriert werden. Für Eingabesysteme, die nicht dateibasiert sind, sollten hingegen ein fester Log-Ordner sowie Variablen genutzt werden, die den Bezug zum Stapel herstellen, z. B. c:\log\[%BatchId%] %BatchName%.log.

Wenn mehrere Worker-Instanzen konfiguriert sind, die parallel an mehreren Dokumenten desselben Stapels arbeiten, schränkt dies die Lesbarkeit des Stapel-Logs ein. Diese parallelläufigen Verarbeitungsinstanzen werden ungeordnet in dieselbe Log-Datei geschrieben. In einem solchen Fall kann das Heranziehen der globalen Logs hilfreich sein, weil diese eine Trennung in separate Dateien pro Instanz ermöglichen.

General.FileMacroOptions.PdfALevel

General.FileMacroOptions.JpegQuality

General.FileMacroOptions.PngCompression

General.FileMacroOptions.FormFeed(#)

General.FileMacroOptions.ImageResolution

General.FileMacroOptions.ImageBitDepth

General.FileMacroOptions.PageMargin

General.FileMacroOptions.FitWorksheetToPage

General.FileMacroOptions.DefaultFont

General.FileMacroOptions.FontsFolder

General.FileMacroOptions.ExtractFilesPdfLib

Standardeinstellungen für die Ausführung bestimmter Dateimakros, die innerhalb des Szenarios global gelten

Abhängig von der verwendeten Grafikbibliothek und der konkreten Konvertierungsfunktion werden nicht alle Einstellungen unterstützt. Wenn eine Einstellung nicht unterstützt wird, wird implizit ein abweichender Wert genutzt oder ein Fehler ausgelöst, z. B. bei einer nicht unterstützten PDF/A-Version.

.PdfALevel: Version des PDF/A-Standards bei der Ausgabe von PDF-Dateien im PDF/A-Format:
- PDF_A_1a (PDF/A-1a)
- PDF_A_1b (PDF/A-1b)
- PDF_A_2a (PDF/A-2a) (Standardwert)
- PDF_A_2b (PDF/A-2b)
- und weitere bis PDF_A_4f (PDF/A-4f)
.JpegQuality: numerische Ausgabequalität von JPEG-Dateien von 1 (schlechteste) bis 100 (beste) (Standardwert: 75)
.PngCompression: numerischer Grad der Kompression für auszugebende PNG-Dateien von 0 (keine) bis 10 (maximale) (Standardwert: 6)
.FormFeed: Seitenvorschubzeichen bei der Ausgabe mehrseitiger Textdateien (Standardwert: \f, d.h. Zeichencode 12)
.ImageResolution: numerische Auflösung für auszugebende Rasterbilddateien in DPI (Standardwert: 300)
.ImageBitDepth: numerische Farbtiefe für auszugebende Rasterbilddateien mit gültigen Ausprägungen 1, 8 und 24 (Standardwert)
.PageMargin: explizit zu setzende, numerische Breite des Seitenrandes in Millimetern bei der Konvertierung von Microsoft-Office-Dokumenten, wobei gleichzeitig die Ausgabepapiergröße fest auf DIN A4 festgelegt wird (Standardwert: -1, d.h. keine Änderung der Originaleinstellung)
.FitWorksheetToPage: Wahrheitswert, ob bei der Konvertierung von Microsoft-Excel-Dateien der Inhalt eines Arbeitsblattes auf einer einzelnen Ausgabeseite dargestellt wird (Standardwert: true); dies übersteuert die unter .PageMargin festgelegte Papiergröße
.DefaultFont: Name der Standard-Ersetzungsschriftart für ein Microsoft-Word-Dokument, wenn die Originalschriftarten nicht installiert sind (nur relevant bei Nutzung von xSuite Interface unter Linux)
.FontsFolder: Verzeichnispfad für in einem Microsoft-Word-Dokument zu nutzende Schriftarten, wenn diese nicht im Standardordner des Betriebssystems installiert sind (nur relevant bei Nutzung von xSuite Interface unter Linux)
ExtractFilesPdfLib: Auswahl der Grafikbibliothek zur Extraktion von Dateianlagen aus einer PDF-Datei:
- Aspose
- GdPicture (Standardwert)

Lookup[].Name

Lookup[].Item[]

Definition von Nachschlagelisten

Über Makrofunktionen wie Lookup() und LookupLike() kann auf die Nachschlagelisten zugegriffen werden.

Wenn mehrere Listen vorhanden sind, müssen diese über die Eigenschaft .Name eindeutig identifizierbar gemacht werden. Die Elemente einer solchen Liste bestehen aus Schlüssel-/Wert-Paaren. Diese Paare müssen in den folgenden 2 Teilparametern angegeben werden:

Key*: Schlüssel
Value: Wert

General.Database[].Name

General.Database[].ConnectionString(§%)

General.Database[].Password(§)

General.Database[].Command(%)

separat zu konfigurierende(s) Verbindungsparameter und Kommando für den Zugriff auf eine externe Datenbank in einer Makrofunktion, z. B. QueryDbField()

Diese Parameter sind in eigenständige Konfigurationseigenschaften ausgelagert, um die Länge der Parameterliste der betreffenden Funktionen zu begrenzen. In den Funktionen werden diese Parameter über die Eigenschaft .Name referenziert.

Der .ConnectionString ist die Verbindungszeichenfolge zur Datenbank. Die unterstützten Systeme sind unter Externe Datenquellen beschrieben.

Das Passwort, das in der Verbindungszeichenfolge benötigt wird, kann auch separat in .Password definiert werden. Über die Variable %Password% kann das Passwort dann in die Zeichenfolge eingebunden werden.

Das auszuführende Datenbank-Kommando in .Command ist abhängig vom Kontext der Makrofunktion. In den meisten Anwendungsfällen enthält das Kommando eine SELECT-Anweisung.

General.WebService[].Name*

General.WebService[].Url*(%)

General.WebService[].Method

General.WebService[].ProxyServer

General.WebService[].AuthMode

General.WebService[].User

General.WebService[].Password(§)

General.WebService[].CertificateName

separat zu konfigurierende Verbindungsparameter zu einem externen Webservice für die Verwendung in einer Makrofunktion, z. B. CallWebService()

Diese Parameter sind in eigenständige Konfigurationseigenschaften ausgelagert, um die Länge der Parameterliste der betreffenden Funktionen zu begrenzen. Die Parameter werden in den Funktionen über die Eigenschaft .Name referenziert. Solche Funktionen ermöglichen den generischen Aufruf einfacher Webservices, sind aber kein vollwertiger Ersatz für die projektspezifische Implementierung spezieller Webservice-Schnittstellen. Diese Funktionen unterstützen weder in der Anfrage noch in der Antwort die Verarbeitung von Multipart-Daten.

In .Url ist die vollständige URL des aufzurufenden Webservices anzugeben, ggf. inklusive Pfad und Parameter. In .Method ist die HTTP-Methode anzugeben (Standardwert: POST).

Wenn die Kommunikation über einen Proxy-Server laufen soll, kann dieser in .ProxyServer definiert werden (Syntax siehe Proxy-Server-Verbindung. Wenn der Webservice eine Authentifizierung erfordert, stehen über den .AuthMode die folgenden Modi zur Verfügung:

None: keine Authentifizierung (Standardwert)
Basic: Basisauthentifizierung mit Benutzername und Passwort
ApiKey: API-Schlüssel
Certificate: Client-Zertifikat

In .User und .Password müssen die Eigenschaften für eine Authentifizierung im Modus Basic eingegeben werden. Im Modus ApiKey werden diese Eigenschaften für die Angabe des Schlüsselnamens (als .User, z. B. Bearer“ und des Schlüsselwertes (als .Password) genutzt. Das Zertifikat im Modus Certificate ist in .CertificateName über den Namen des Zertifikats anzugeben. Der Name muss der Eigenschaft .Name eines Zertifikats der Art Certificate[].Usage: "Client" entsprechen, das global unter Certificate[] definiert ist..

In diesem Abschnitt:

xSuite Interface Windows Prism 5.x – Online-Hilfe

Generelles

Hinweis

Suchresultat