RayFlow Plug-in

<< Click to Display Table of Contents >>

RayQC > 2026.3 > User Guide > Plug-ins > Internal Plug-ins 

RayFlow Plug-in

Das RayFlow-Plug-in bietet die erforderliche Funktionalität zur Kommunikation zwischen den RaySuite-Komponenten RayQC und RayFlow.

 

Funktionsübersicht

AddComment

GetComments

GetConnectionInfo

GetField

GetFile

GetPackage

GetTaskProperty

SetField

UploadFile

 

Funktionsdetails

AddCommentCheckpoint

Fügt einem RayFlow-Paket (Aufgabe) einen Kommentar hinzu. Gibt Ja zurück, wenn der Kommentar erfolgreich hinzugefügt wurde.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

RayFlow Package ID

Zeichenfolge

 
 

Die ID eines RayFlow-Pakets (Aufgabe).

 

Beispiel:

123e4567-e89b-12d3-a456-426655440000

Kommentar

Zeichenfolge

Ein Text, der als Kommentar geschrieben wird.

 

Beispiel:

This is a comment from RayQC.

 

GetCommentsData Field

Ruft Kommentare aus einem RayFlow-Paket (Aufgabe) ab.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

RayFlow Package ID

Zeichenfolge

Die ID eines RayFlow-Pakets (Aufgabe).

 

Beispiel:

123e4567-e89b-12d3-a456-426655440000

 

GetConnectionInfoData Field

Ruft einen der Parameterwerte aus den aktuellen RayFlow-Verbindungseinstellungen ab.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Verbindungsinformationen

Formatierter String

 
 

Die spezifische Eigenschaft der Verbindungsanmeldedaten, die abgerufen werden soll.

 

Optionen:

User

URL

Package ID

Project ID

 

GetFieldMulti-OptionData Field

Ruft einen Wert aus dem RayFlow-Datenobjekt ab, das durch die aktuelle Verbindung referenziert wird, und erfordert daher eine aktive Verbindung zum RayFlow-Datenbankserver.

Verwendbar in Kombination mit Elementen vom Typ Data Field und Multi-Option.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

RayFlowField

Zeichenfolge

 
 

Der Name des RayFlow-Datenfelds, das abgerufen werden soll.

 

Beispiel:

Manufacturer

RayFlowPackageID

Zeichenfolge

Die ID des RayFlow-Pakets, normalerweise bereitgestellt durch das GetPackage Plug-in.

 

Beispiel:

c32715f5-186d-49c7-b998-30f5d50v95fb

 

GetFileData Field

Lädt die angegebene Datei vom RayFlow-Server herunter. Gibt den vollständigen Pfad zur heruntergeladenen Datei zurück.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

RayFlow Package ID

Zeichenfolge

 
 

Der Name des RayFlow-Datenfelds, das abgerufen werden soll.

 

Beispiel:

Manufacturer

Datei herunterladen

Boolean

Standard: true

Gibt an, ob eine Datei heruntergeladen oder nur das Vorhandensein der Datei überprüft werden soll.

Aktiviert = die Datei wird heruntergeladen.

Deaktiviert = die Datei wird auf dem RayFlow-Server überprüft. Wenn die Datei gefunden wird, wird der Dateiname zurückgegeben, andernfalls wird false angezeigt.

Ausgabeverzeichnis

Zeichenfolge

optional

Der vollständige Pfad zum Ausgabeverzeichnis, in das die Datei heruntergeladen wird. Wenn der Pfad nicht festgelegt ist, wird die Datei im %TEMP% Ordner gespeichert.

 

Beispiel:

C:\Downloads

Dateiname

Zeichenfolge

Der genaue Name der Datei ODER der reguläre Ausdruck, der zur Suche nach der angeforderten Datei verwendet werden soll.

 

Beispiel:

FileZilla_1.0.0.mst

Name als regulären Ausdruck abgleichen

Boolean

Standard: false

Gibt an, ob der Dateiname-Parameter einen regulären Ausdruck verwendet.

Aktiviert = der im Dateiname-Parameter angegebene reguläre Ausdruck wird verwendet, um die zu herunterladende Datei zu ermitteln.

Deaktiviert = beim Abrufen des Dateinamens wird kein regulärer Ausdruck verwendet.

RayFlow data field ID/name

Zeichenfolge

optional

Der Name oder die ID eines Datenfelds, das den Namen einer herunterzuladenden Datei speichert.

 

Beispiel:

MsiTransform

Feld-ID statt Feldname verwenden

Boolean

Standard: true

Gibt an, ob der RayFlow data field ID/name-Parameter die Feld-ID statt des Feldnamens verwenden soll.

 

Aktiviert = Datenfeld-ID verwenden

Deaktiviert = Datenfeldname verwenden

 

GetPackageData Field

Ruft eine Paket-ID von RayFlow ab und erfordert daher eine aktive Verbindung zum RayFlow-Datenbankserver.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Diese Funktion akzeptiert keine Parameter.

 

GetTaskPropertyMulti-OptionData Field

Ruft einen Wert für eine Eigenschaft aus dem RayFlow-Datenobjekt ab, das durch die aktuelle Verbindung referenziert wird, und erfordert daher eine aktive Verbindung zum RayFlow-Datenbankserver.

Verwendbar in Kombination mit Elementen vom Typ Data Field und Multi-Option.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Eigenschaftsname

Zeichenfolge

 
 

Der Name der Eigenschaft, die abgerufen werden soll.

 

Beispiel:

EntryDate

RayFlow Task ID

Zeichenfolge

Die ID der RayFlow-Aufgabe, normalerweise bereitgestellt durch das GetPackage Plug-in.

 

Beispiel:

123e4567-e89b-12d3-a456-426655440000

 

SetFieldCheckpoint

Aktualisiert einen Wert des RayFlow-Datenobjekts, das durch die aktuelle Verbindung referenziert wird, und erfordert daher eine aktive Verbindung zum RayFlow-Datenbankserver.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

RayFlowField

Zeichenfolge

 
 

Der Name des RayFlow-Datenfelds, das aktualisiert werden soll.

 

Beispiel:

Manufacturer

Wert

Zeichenfolge

Der Wert, der in das oben definierte Feld geschrieben wird.

 

Beispiel:

Raynet GmbH

RayFlowPackageID

Zeichenfolge

Die ID des RayFlow-Pakets, normalerweise bereitgestellt durch das GetPackage Plug-in.

 

Beispiel:

c32715f5-186d-49c7-b998-30f5d50v95fb

 

 

UploadFileCheckpoint

Lädt eine Datei zu RayFlow hoch. Dies wirkt sich auf das RayFlow-Datenobjekt aus, das durch die aktuelle Verbindung referenziert wird, und erfordert daher eine aktive Verbindung zum RayFlow-Datenbankserver.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String

 
 

Der Pfad zur Datei, die hochgeladen werden soll.

 

Beispiel:

C:\Temp\Sample.pdf

RayFlowPackageID

Zeichenfolge

Die ID des RayFlow-Pakets, normalerweise bereitgestellt durch das GetPackage Plug-in.

 

Beispiel:

c32715f5-186d-49c7-b998-30f5d50v95fb