Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Auslesen systeminterner Werte

BatchExists()

Diese Funktion prüft, ob der Stapel, der sich aktuell in Bearbeitung befindet, bereits existiert. Die Prüfung findet standardmäßig anhand des Szenarios und der externen ID des Stapels statt. Der Rückgabewert ist entweder ein Array der internen IDs existierender Stapel oder ein leeres Array.

Hinweis

Diese Funktion ist primär für die Dublettenprüfung über die Eigenschaft Input.CheckDuplicateMacro des "Input"-Schritts vorgesehen.

Parameter

Datentyp

Beschreibung

1

Text

optionale Angabe einer benutzerdefinierten Abfrage gegen die Tabelle "Batches"

Die Abfrage muss syntaktisch in der internen Makrosyntax formuliert werden. Die Syntax wird programmintern in die passende Datenbanksyntax konvertiert.

Beispiel einer Abfrage, die äquivalent zu der Standardabfrage ist:

(@ExternalId == '%BatchExtId%') && 
(@OriginalScenario == '%DocScenario%')

FileCount()

Diese Funktion ermittelt die Anzahl der Dateianlagen des aktuellen Dokumentes, die einem bestimmten Namensfilter entsprechen.

Rückgabetyp: Number

Parameter

Datentyp

Beschreibung

1

Text

Namensfilter für die zu zählenden Dateianlagen

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

Beispiele

FileCount("*.pdf", "Original") ergibt die Anzahl der Originaldateien vom Typ "PDF".

GetDocExtKey(), GetDocMetaData()

Diese Funktionen lesen einen externen Schlüssel (aus Eigenschaft ExternalKeys) oder ein Metadatum (aus Eigenschaft MetaData) des aktuellen Dokumentes.

Rückgabetyp: Text

Parameter

Datentyp

Beschreibung

1*

Text

Name des auszulesenden Schlüssels oder Metadatums

Beispiele

GetDocExtKey("SapRecordNo") ergibt den Schlüsselwert der SAP-Satznummer.

GetDocProperty()

Diese Funktion liest eine interne Eigenschaft des aktuellen Dokumentes.

Der Rückgabetyp variiert.

Parameter

Datentyp

Beschreibung

1*

Text

Name der auszulesenden Eigenschaft:

  • Id: Datenbank-ID des Dokumentes

  • Uuid: UUID des Dokumentes (Eigenschaft "FixedGuid" in der Datenbank)

  • Name : Name des Dokumentes

  • ExtId: Externe ID des Dokumentes

  • Scenario: Verarbeitungsszenario des Dokumentes

  • Number: Laufende Nummer des Dokumentes im Stapel, beginnend bei 1

  • TrackingId: Tracking-ID

  • TrackingKey: Tracking-Schlüssel

  • CustomKey: Benutzerdefinierter Schlüssel

  • BatchId: Datenbank-ID des übergeordneten Stapels

  • BatchName: Name des übergeordneten Stapels

  • BatchExtId: Externe ID des übergeordneten Stapels

Beispiele

GetDocProperty("Number") ergibt die laufende Nummer im Dokument, z. B. 1.

GetFileExtKey(), GetFilesExtKey(), GetFileMetaData(), GetFilesMetaData()

Diese Funktionen lesen einen externen Schlüssel oder ein Metadatum der ersten gefundenen oder aller Dateianlagen, die einem bestimmten Namensmuster entsprechen.

Rückgabetyp: Text

Bei "GetFilesExtKey()" und "GetFilesMetaData()", d.h. bei der Berücksichtigung aller gefundenen Anlagen, werden die multiplen Werte als Array zurückgegeben.

Parameter

Datentyp

Beschreibung

1

Text

Namensfilter für die zu berücksichtigenden Dateianlagen

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 auszulesenden Schlüssels oder Metadatums

Beispiele

GetFileMetaData("*.pdf", , "MetaTest") ergibt den Wert des Metadatums MetaTest der ersten gefundenen PDF-Dateianlage über alle (Original und konvertierten) Anlagen, z. B. "Value1".

GetFilesMetaData("*.pdf", , "MetaTest") ergibt die Werte des Metadatums MetaTest aller gefundenen PDF-Dateianlagen, z. B. ["Value1","Value2"].

GetFileProperty(), GetFilesProperty()

Diese Funktionen lesen eine interne Eigenschaft der ersten gefundenen oder aller Dateianlagen, die einem bestimmten Namensmuster entsprechen.

Der Rückgabetyp variiert.

Bei GetFilesProperty(), d.h. bei der Berücksichtigung aller gefundenen Anlagen, werden die multiplen Werte als Array zurückgegeben.

Parameter

Datentyp

Beschreibung

1

Text

Namensfilter für die zu berücksichtigenden Dateianlagen

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 der auszulesenden Eigenschaft:

  • Id: Datenbank-ID der Dateianlage

  • Uuid: UUID der Dateianlage (Eigenschaft "FixedGuid" in der Datenbank)

  • Name: Dateiname

  • Number: Laufende Nummer im Dokument, beginnend bei 1

  • Type: "Original” oder "Processed” (s.o.)

  • OriginalFile: Pfad oder nur Name der Originaldatei aus dem Eingabesystem

  • Size: Dateigröße in Bytes

  • FileType: Dateiendung

  • Hash: Hash-Wert über Dateiinhalt

Beispiele

GetFileProperty("*.PDF", "Processed", "Size") ergibt die Größe der ersten konvertierten PDF-Dateianlage, z. B. 32768.

GetFilesProperty("*.PDF", "Processed", "Size") ergibt die Größen aller konvertierten PDF-Dateianlagen, z. B. [32768, 65536].