The RayFlow plug-in deals with functionality required to establish communication between the RaySuite components RayQC and RayFlow.
Function Summary
Function Details
AddComment
Adds a comment to a RayFlow package (task). Returns Yes if the comment has been added successfully.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
RayFlow Package ID |
string |
The ID of a RayFlow package (task).
Example: 123e4567-e89b-12d3-a456-426655440000 |
Comment |
string |
A text that will be written as a comment.
Example: This is a comment from RayQC. |
GetComments
Gets comments from a RayFlow package (task).
Usable in combination with elements of type Data Field.
Input parameters |
||
Name |
Type |
Description & Examples |
RayFlow Package ID |
string |
The ID of a RayFlow package (task).
Example: 123e4567-e89b-12d3-a456-426655440000 |
GetConnectionInfo
Requests one of the parameter values from the current RayFlow connection settings.
Usable in combination with elements of type Data Field.
Input parameters |
||
Name |
Type |
Description & Examples |
Connection Information |
formatted string |
The specific property of the connection credentials that has to be retrieved.
Options: •User •URL •Package ID •Project ID |
GetField
Request a value from the RayFlow data object referenced by the current connection and therefore requires an active connection to the RayFlow database server.
Usable in combination with elements of type Data Field and Multi-Option.
Input parameters |
||
Name |
Type |
Description & Examples |
RayFlowField |
string |
The name of the RayFlow data field that has to be retrieved.
Example: Manufacturer |
RayFlowPackageID |
string |
The ID of the RayFlow package, usually delivered with the GetPackage plug-in.
Example: c32715f5-186d-49c7-b998-30f5d50v95fb |
GetFile
Downloads the specified file from RayFlow server. Returns the full path to the downloaded file.
Usable in combination with elements of type Data Field.
Input parameters |
||
Name |
Type |
Description & Examples |
RayFlow Package ID |
string |
The name of the RayFlow data field that has to be retrieved.
Example: Manufacturer |
Download file |
boolean default: true |
Indicates whether a file should be downloaded or only the existence of this file should be verified. •Enabled = the file will be downloaded. •Disabled = the file will verified on RayFlow server. If the file will be found the file name is returned, otherwise false is displayed. |
Output directory |
string optional |
The full path to the output directory, where file will be downloaded. If the path is not set, the file will be saved in the %TEMP% folder.
Example: C:\Downloads |
File name |
string |
The exact name of the file OR the regular expression that should be used to find requested file.
Example: FileZilla_1.0.0.mst |
Match name as regular expression |
boolean default: false |
Indicates whether the File name parameter uses a regular expression. •Enabled = regular expression specified in File name parameter will be used to fetch the correct file to download. •Disabled = regular expression will not be used when fetching the file name. |
RayFlow data field ID/name |
string optional |
The name of ID of a data field that stores a name of a file to download.
Example: MsiTransform |
Use field ID instead of field name |
boolean default: true |
Indicates whether the RayFlow data field ID/name parameter should use the field ID instead of field name.
•Enabled = use data field ID •Disabled = use data field name |
Request a package ID from RayFlow and therefore requires an active connection to the RayFlow database server.
Usable in combination with elements of type Data Field.
This function does not accept parameters.
GetTaskProperty
Request a value for a property from the RayFlow data object referenced by the current connection and therefore requires an active connection to the RayFlow database server.
Usable in combination with elements of type Data Field and Multi-Option.
Input parameters |
||
Name |
Type |
Description & Examples |
Property Name |
string |
The name of the Property that has to be retrieved.
Example: EntryDate |
RayFlow Task ID |
string |
The ID of the RayFlow task, usually delivered with the GetPackage plug-in.
Example: 123e4567-e89b-12d3-a456-426655440000 |
SetField
Updates a value of the RayFlow data object referenced by the current connection, and therefore requires an active connection to the RayFlow database server.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
RayFlowField |
string |
The name of the RayFlow data field that has to be updated.
Example: Manufacturer |
Value |
string |
The value that will be written into the field defined above.
Example: Raynet GmbH |
RayFlowPackageID |
string |
The ID of the RayFlow package, usually delivered with the GetPackage plug-in.
Example: c32715f5-186d-49c7-b998-30f5d50v95fb |
UploadFile
Uploads a file to RayFlow. This affects the RayFlow data object referenced by the current connection, and therefore requires an active connection to the RayFlow database server.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
File |
formatted string |
The path to the file that has to be uploaded.
Example: C:\Temp\Sample.pdf |
RayFlowPackageID |
string |
The ID of the RayFlow package, usually delivered with the GetPackage plug-in.
Example: c32715f5-186d-49c7-b998-30f5d50v95fb |