Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Sonstiges

DeleteExternalFile()

Diese Funktion löscht eine externe Datei aus dem Dateisystem.

Parameter

Datentyp

Beschreibung

1*

Text

vollständiger Pfad der Datei im Dateisystem

Beispiele

DeleteExternalFile("c:/test.txt") löscht die angegebene Datei, sofern diese Datei existiert.

Pause()

Dieses Pseudo-Makro dient dem künstlichen Pausieren der Makroausführung an der betreffenden Stelle für Testzwecke. Diese Makrofunktion liefert kein Ergebnis zurück, sondern belässt ein Zielfeld auf dem aktuellen Wert.

Parameter

Datentyp

Beschreibung

1*

Number

Anzahl Sekunden, für die die Verarbeitung angehalten wird

Beispiele

Pause(10) pausiert die Makroverarbeitung für 10 Sekunden.

QueryDbRecord(), QueryDbRecords()

Diese Funktionen führen eine Anfrage an eine externe Datenquelle durch und weisen die gelesenen Werte des ersten gefundenen Datensatzes den gewünschten Zielfeldern zu.

Die Funktion QueryDbRecord() verarbeitet nur den ersten gefundenen Datensatz verarbeitet und weist dessen Inhalt typischerweise Kopfdatenfeldern zu. Die Funktion QueryDbRecords() liest alle oder eine vorgegebene Anzahl von Sätzen ein. Als Ziel können hier ausschließlich Positionsdatenfelder dienen. Aus jedem gelesenen Datensatz wird eine neue Positionsdatenzeile erzeugt und an die bestehende Zieltabelle angefügt.

Parameter

Datentyp

Beschreibung

1*

Text

Name der Eigenschaft General.Database[], in der Verbindungs­parameter und Datenbank-Kommando definiert sind

Das Kommando muss eine SELECT-Anfrage sein. Bei Verwendung einer OLEDB- oder nativen SQL-Server-Verbindung sollten typisierte Feldvariablen in der Form @Variablenname in die Anfrage eingebunden werden. Ansonsten beschränkt sich die Nutzung von Variablen auf einen Textersetzung mit %Variablenname%. Der Ersetzungstext muss die Syntax haben, die für das jeweilige Datenbanksystem erforderlich ist.

2*

Text oder Array

Name eines einzelnen Zielfeldes oder Array mehrerer Zielfelder, denen die Werte in der Reihenfolge zugewiesen werden, wie sie im gefundenen Datensatz enthalten sind

Um Werte aus dem Datensatz zu ignorieren, können Elemente in der Zielfeldauflistung auch leer bleiben. Mit ['Field1',  , 'Field2'] wird beispielsweise der erste Wert Field1 zugewiesen, der zweite Wert wird ignoriert und der dritte Wert wird Field2 zugewiesen.

Bei der Funktion QueryDbRecords() müssen die Zielfelder Positionsdatenfelder sein. Die Namen des Felder müssen vollständig so angegeben werden, wie diese im Feldkatalog definiert sind, d.h. {Tabellenname}.{Spaltenname}. Innerhalb eines Funktionsaufrufs dürfen nur Felder derselben Zieltabelle angesprochen werden. Wenn nicht für alle Felder der betreffenden Tabelle ein Wert aus der Datenbank gelesen wird, behalten die übrigen Felder den Initialwert.

Untertabellen können ebenfalls adressiert werden. In diesem Fall muss für die übergeordnete Tabelle die Nummer einer konkreten, bereits existierenden Zeile angegeben werden:

{Tabellenname}[{Zeilennummer}].{Untertabellenname}.{Spaltenname}.

3

Bool

Wahrheitswert, ob ein Wert NULL aus dem Quelldatensatz als solcher erhalten bleibt (Standardwert: FALSE)

Standardmäßig unterstützt der Makrointerpreter den Wert NULL nicht direkt. Stattdessen werden leere Werte in Abhängigkeit vom Datentyp verwendet, z. B. ein leerer String "" für einen leeren Textwert.

NULL-Werte aus der Datenbank werden standardmäßig in einen Leerwert gewandelt, der zum Quelldatentyp passt. Wenn stattdessen der NULL-Wert erhalten werden soll, sollte bei der Weiterverarbeitung das Makro IsNull() zur expliziten Prüfung auf diesen Wert genutzt werden.

4

Number

maximale Anzahl von Datensätzen, die bei QueryDbRecords() ausgelesen werden soll

Standardmäßig ist die Anzahl nicht beschränkt.

Beispiele

QueryDbRecord("DBSelect1", ["Field1", "Field2"]) führt eine Datenbankabfrage aus, die unter dem Namen DBSelect1 konfiguriert ist. Diese Abfrage kann z. B. den Befehl SELECT [Column1], [Column2] FROM [Table1] WHERE [Column3] = @Field3 nutzen, um auf Datensätze mit dem Wert von Field3 zu filtern. Die Werte von Column1 und Column2 des ersten gefundenen Datensatzes werden den Feldern Field1 und Field2 zugewiesen. Wenn kein Datensatz gefunden wird, bleiben die Zielfelder unverändert.

QueryDbRecords("DBSelect1", ["Items.Field1", "Items.Field2"]) erzeugt bei identischer Datenbankabfrage wie im vorherigen Beispiel eine neue Zeile in der Tabelle Items für jeden gefundenen Datensatz und weist die Werte von Column1 und Column2 jeweils den Tabellenfeldern Field1 und Field2 zu.

SetDocMetaData()

Diese Funktion setzt ein Metadatum des aktuellen Dokumentes auf einen gegebenen Wert. Wenn ein leerer Wert angegeben wird, wird das bestehende Metadatum gelöscht.

Parameter

Datentyp

Beschreibung

1*

Text

Name des Metadatums

2

Text

Wert des Metadatums

Beispiele

SetDocMetaData("DocMeta1", "Value1") setzt den Wert des Metadatums DocMeta1.

SetFileMetaData()

Diese Funktion setzt ein Metadatum einer Dateianlage, die einem bestimmten Namensmuster entspricht, auf einen gegebenen Wert. Bei Angabe eines leeren Wertes wird ggf. ein bestehendes Metadatum gelöscht.

Parameter

Datentyp

Beschreibung

1

Text

Namensfilter für die Dateianlage, wobei nur die erste gefundene Anlage berücksichtigt wird

Standardwert: *

2

Text

optionale Einschränkung der Suche auf Dateianlagen eines bestimmten Typs (Standardwert: alle Anlagen):

  • Original: Originaldateien aus dem Eingabesystem

  • Processed: vom Programm durch Extraktion oder Konvertierung hinzugefügte Dateien

3*

Text

Name des Metadatums

4

Text

Wert des Metadatums

Beispiele

SetFileMetaData("*.pdf", , "FileMeta1", "Value1") setzt den Wert des Metadatums FileMeta1 einer PDF-Dateianlage.

WriteExternalFile()

Diese Funktion schreibt den Inhalt von Dateianlagen in externe Dateien im Dateisystem.

Parameter

Datentyp

Beschreibung

1

Text

Namensfilter für die Dateianlagen, wobei alle gefundenen Anlagen verarbeitet werden

Standardwert: *

2

Text

optionale Einschränkung der Suche auf Dateianlagen eines bestimmten Typs (Standardwert: alle Anlagen):

  • Original: Originaldateien aus dem Eingabesystem

  • Processed: vom Programm durch Extraktion oder Konvertierung hinzugefügte Dateien

3*

Text

Pfad des Zielordners im Dateisystem

Ordner und Unterordner, die noch nicht existieren, werden automatisch angelegt.

4

Text

Name der Zieldatei im Dateisystem

Der Name kann dynamisch anhand von Dateivariablen generiert werden kann. Wenn unter dem betreffenden Namen bereits Dateien im Dateisystem vorhanden sind, werden diese Dateien überschrieben.

Standardwert: %FileName% (bestehender Name der Dateianlage)

Beispiele

WriteExternalFile("*.txt", , "c:/test", "%FileBaseName%.export.%FileExt%") schreibt alle Textdateianlagen unter dem vorhandenen Namen, ergänzt um den Suffix .export, ins Dateisystem.

WriteExternalFileFromField()

Diese Funktion schreibt den Inhalt eines Dokumentenfeldes in eine externe Datei im Dateisystem. Feldinhalte, die nicht vom Datentyp "Text" sind, werden in eine Textdarstellung in programminterner String-Notation überführt.

Parameter

Datentyp

Beschreibung

1*

Text

Name des Feldes aus dem Feldkatalog, dessen Inhalt in die Datei geschrieben wird

2*

Text

Pfad des Zielordners im Dateisystem

Ordner und Unterordner, die noch nicht existieren, werden automatisch angelegt.

3

Text

Name der Zieldatei im Dateisystem

Wenn unter dem Namen bereits eine Datei vorhanden ist, wird die vorhandene Datei überschrieben.

4

Text

Zeichenkodierung der Zieldatei:

  • Ascii

  • Ansi

  • Utf8 (Standardwert)

  • Utf16

Beispiele

WriteExternalFileFromField("Field1", "c:/test", "export.txt") schreibt den Inhalt des Feldes Field1 als Textdatei export.txt ins Dateisystem.

DeleteFromCustomStore()

Diese Funktion löscht ein Schlüssel-/Wert-Paar, das zuvor über die Dokumentmakrofunktion WriteToCustomStore() persistiert wurde, wieder aus der Datenbank.

Parameter

Datentyp

Beschreibung

1(*)

Text

optionale Kontextinformation zu dem folgenden Schlüssel, wenn dieser allein nicht sprechend genug oder eindeutig ist

Um alle Einträge zu einem gemeinsamen Kontext in einem Aufruf zu löschen, können die Kontextinformationen auch ohne Schlüssel angegeben werden.

2(*)

Text

Schlüssel, unter dem der Wert gespeichert ist

Beispiele

DeleteFromCustomStore( , "CustomKey1") löscht den Eintrag mit dem Schlüssel CustomKey1, sofern der Schlüssel existiert.

WriteToCustomStore()

Diese Funktion schreibt einen Wert in eine interne Datenbanktabelle, die zum Persistieren benutzerdefinierter Daten dient, unabhängig von den vom Programm generierten Verwaltungsdaten. Dazu wird aber dieselbe Datenbank genutzt, sodass diese Funktionalität nicht im datenbanklosen Betrieb verfügbar ist.

Parameter

Datentyp

Beschreibung

1

Text

optionale Kontextinformation zu dem folgenden Schlüssel, wenn dieser allein nicht sprechend genug oder eindeutig ist

2*

Text

Schlüssel, unter dem der Wert gespeichert ist

Wenn ein Eintrag mit diesem Schlüssel (und ggf. Kontext) bereits vorhanden ist, wird dieser überschrieben. Wenn noch kein Eintrag mit diesem Schlüssel vorhanden ist, wird ein neuer Eintrag angelegt.

3*

(variabel)

zu speichernder Wert

Beispiele

WriteToCustomStore( , "CustomKey1", "Value1") schreibt einen Wert unter dem Schlüssel CustomKey1 in die Datenbank.

In diesem Abschnitt: