Other File Operations Activities
- Silvia Neag (Unlicensed)
- wiki
Activities
- Copy File
- Copy File As Different User
- Create Folder
- Deactivate Directory Inheritance
- Delete Folder
- File Compare
- File Download
- Files Search
- Folder Set Rights
- Folder Search
- Get File by Time
- Import File Content String
- Import File Rows
- Import File Stream Objects
- Import from Stream
- Monitor File
- Monitor Folder
- Move File
- Move Folder
- PGP Decrypt File
- PGP Encrypt File
- Print File
- Remove File
- Rename File
- Rename Folder
- Unzip File
- Write File
- Zip Folder
- FileINIWriter
- FileINIReader
- Directory Rights
- Remove Directory Rights
Copy File
This activity copies a file.
Activity Parameters
The Copy File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Destination File (text box editor type) (type: string): the destination file name. For example, "FlowsterAdministrator", which means that the activity will copy the content of the Source File into this file.
- Destination Folder (text box editor type) (type: string): the destination folder for the file.
- Overwrite File (combo box control) (type: string): option for overwriting if another file with the same name exists.
- Source File (text box editor type) (type: string): the source file full path.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: boolean): outputs True or False if the execution was successful or not.
Copy File As Different User
This activity copies a file as a different user.
Activity Parameters
The Copy File As Different User activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Destination File (text box editor type) (type: string): the destination file name, including the file extension. For example, "Flowster.key", which means that the activity will copy the content of the Source File into this file.
- Destination Folder (text box editor type) (type: string): the destination folder for the file.
- Overwrite File (combo box control) (type: string): option for overwriting if another file with the same name exists.
- Password (password editor type) (type: string): the password for the username provided in Username parameter.
- Password Binding (text box editor type) (type: string): Bind to a variable containing the encrypted password for the username provided in Username parameter. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).
- Source File (text box editor type) (type: string): the source file full path.
- Username (text box editor type) (type: string): the username in format domain\username for domain users or machinename\localuser for local users (local users may also be used in the short format e.g. 'demouser'). E.g. localmachine\localuser, domainname\user. Please note that the user must have permissions to both locations, destination and source folders for a successful execution.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: boolean): outputs True or False if the execution was successful or not.
Create Folder
This activity creates a folder at a specified path.
Activity Parameters
The Create Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Folder Name (text box editor type) (type: string): the name of the folder to be created.
- Path (text box editor type) (type: string): the path on which the folder should be created. The path should not include the folder name because that is specified in the FolderName parameter.
The Read Only Output variable are the possible output values that the activity will provide:
- Execution Result (type: string): outputs the execution result of this activity. A successful execution will yield value "Folder Created".
- Path of the Created Folder (type: string): outputs the path of the created folder.
Execution: the activity will create a folder with the given name in the given location:
Deactivate Directory Inheritance
This activity deactivates directory inheritance and deletes all Security Settings.
Activity Parameters
The Deactivate Directory Inheritance activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- DirectoryPath (text box editor type) (type: string): the directory path to which you want to diable inheritance and remove rights.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: boolean): outputs the operation result.
Execution:
Delete Folder
This activity deletes a folder from a specified path.
Activity Parameters
The Delete Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Delete If Not Empty (text box editor type) (type: string): set this to true if you wish to delete the folder (and it's contents) even if the folder is not empty. A value of False means the delete operation is aborted if the source folder is not empty.
- Path (text box editor type) (type: string): the folder's full path.
The Read Only Output variable are the possible output values that the activity will provide:
- Execution Result (type: string): outputs the execution result. If the execution was succesfull the Execution result parameter should yield "Folder deleted".
Execution: the activity will remove the given folder from the computer.
File Compare
This activity compare two files line by line. and can return the difference, if the compared files are textbased files.
The activity compare file 1 against file 2 and return the differents of file 2.
Activity Parameters
The File Compare activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File 1 (text box editor type) (type: string): Filepath of the first file.
- File 2 (text box editor type) (type: string): Filepath of the second file.
The Read Only Output variable are the possible output values that the activity will provide:
- Output ASCII Compare (type: boolean): return true, if the two file are identically based on ASCII compare methode,
- Output Byte Compare (type: boolean): return true, if the two file are identically based on Byte compare methode, This output allow to compare all kind of filestypes.
- Output Text Compare (type: string): return as string as list with [Line, content of file 1 => content of file 2] . The line count starts at 0.
- example output:
[10, k => l]
[11, l => m]
- example output:
- Output Text Compare as Dictionary (type: Dictionary<int32,string>): return as Dictionary <Line, content of file 1 => content of file 2> . The line count starts at 0.
The content can be accessed by a foreach loop of type KeyVlauePair<int32,string> or by direct access var(Line)
File Download
Download a file from web without authentication.
Activity Parameters
The File Download activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Download URL (text box editor type) (type: string): Downloadlink.
- Target Path (text box editor type) (type: string): Download Target folder.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (text box editor type) (type: string): Fullpath of the download.
Files Search
This activity searches for files that match a given name rule and a specified path.
Activity Parameters
The Files Search activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Path (text box editor type) (type: string): the search path, example: "C:\Program Files\Flowster Solutions".
- Search Filter (text box editor type) (type: string): search rule, example: "*Administrator*.exe" <*> variable number of characters, "Flowster???.*" one character.
- Search Subfolders (combo box control) (type: string): search in selected path only or search in selected path and subfolders.
The Read Only Output variable are the possible output values that the activity will provide:
- Output Count (type: string): outputs the number of found files according to the searching rule and specified path.
- Output Files (type: collection<string>):outputs a collection of found file names.
- Output Full Paths (type: collection<string>):outputs a collection of found files full paths.
Execution: the activity will search inside the given location for files with "Administrator" in their names:
Using For Each to extract the files names or files paths:
Using Get Element From Collection to extract the files names or files paths:
Folder Set Rights
This activity sets rights for an Active Directory user on a given folder.
Activity Parameters
The Folder Set Rights activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- AD Connection (text box editor type) (type: string): Active Directory Connection. The output parameter from Connect To Active Directory activity should be used as Input here.
- Check Entry By (combo box control) (type: string): the Active Directory attribute after which the user will be searched; default value is set to 'sAMAccountName'.
- Deny (text box editor type) (type: string): set this to yes if you wish to remove the specified rights instead of granting them.
- Path (text box editor type) (type: string): the path of the folder you want to set rights on.
- Rights (combo box control) (type: string): what rights you wish to grant. (If "Deny" parameter is set to true, these rights will be removed instead). Flowster Studio provides Read, Write, Modify and Full Control as options.
- Value (text box editor type) (type: string): the value for the selected AD attribute. In this case, "demouser", which is the sAMAccountName for the AD user.
Execution: the activity will check on Active Directory for the given user's sAMAccountName and if found, it will grant/deny access to the given folder.
The permissions can be seen on the folder's Security options:
Folder Search
This activity searches for folders that match a given name rule and outputs a collection of found folders names.
Activity Parameters
The Folder Search activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Mask (text box editor type) (type: string): the Search rule. For example: "*Flowster*" <*> variable number of characters, "Flowster???.*" one character.
- Path (text box editor type) (type: string): the path of the folder from which to start the search. In our example, the search will be made inside the "C:\Program Files\Flowster Solutions" folder.
- Recursive (combo box control) (type: string): choose Yes if you wish the search to be recursive.
The Read Only Output variable are the possible output values that the activity will provide:
- Output Count (type: int32): outputs the number of found folders according to the searching rule and specified path.
- Output Folders (type: collection<string>):outputs a collection of found folders names. For Each and/or Get Element from Collection activities can be used in order to extract the values from the collection (folder names).
- Output Full Paths (type: collection<string>):outputs a collection of found folders full paths. For Each and/or Get Element From Collection activities can be used in order to extract the values from the collection (folder paths).
Execution: the activity will search inside the given location for folders with "Flowster" in their names and it will also retrieve all folders located in the found folders:
Using For Each to extract the folder names or folder paths:
Using Get Element From Collection to extract the folder names or folder paths:
Get File by Time
This activity get the file path of the oldest (or latest) file at a given folder path. The attribute being checked is Creation Date.
Activity Parameters
The Get File by Time activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Retrieve Options (text box editor type) (type: string): specify if there will be retrieved the latest or the oldest file. Insert "Latest" or "Oldest" as values.
- Source Path (text box editor type) (type: string): the path of the folder (or a variable binding) in which you wish to search for the oldest/latest file. For example, "C:\Program Files\Flowster Solutions\ Flowster Studio\Administrator".
The Read Only Output variable are the possible output values that the activity will provide:
- File Path (type: string): retrieves the file path for the file corresponding to the Retrieve Options parameter's value.
Import File Content String
This activity imports the content of a given file as a string.
Activity Parameters
The Import File Content String activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File (text box editor type) (type: string): the full path (including the file name) of the file to be imported. For example, "C:\FlowsterFolder\Data.ini".
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the file content as a string.
Import File Rows
This activity imports Stream Object from file. Data is read row by row..
Activity Parameters
The Import File Rows activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File (text box editor type) (type: string): the full path (including the file name and extension) of the file to be imported.
The Read Only Output variable are the possible output values that the activity will provide:
- File Content (type: collection<string>): outputs a Collection object, each element representing a line from the file. For Each or Get Element From Collection activities can be used in order to extract the rows values.
Execution: the activity will read the given file row by row, outputting the rows into a collection type variable:
Using For Each activity for extracting the rows:
Using Get Element From Collection for extracting the rows:
Import File Stream Object
This activity imports Stream Object from a given file.
Activity Parameters
The Import File Stream Object activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File (text box editor type) (type: string): the full path (including the file name) of the file to be imported.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: object): outputs the Stream object.
Import from Stream
This activity imports from a stream and returns a string.
Activity Parameters
The Import from Stream activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Separator (text box editor type) (type: string): enter a character to be used as separator(Ex. : ";").
- Stream (text box editor type) (type: object): enter a stream to import from. This parameter can be bound to an output variable from the Import File Stream Object activity.
The Read Only Output variable are the possible output values that the activity will provide:
- Output Count (type: int32): outputs an integer equal to the collection count.
- Output String Collection (type: collection<string>):outputs a string collection imported from the initial stream.To use the elements of the collection, use Get Element From Collection activity.
Monitor File
This activity tracks the changes of a file that you specify.
Activity Parameters
The Monitor File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File Path (text box editor type) (type: string): the path to the file that you are monitoring or browse for it.
- Time Out (text box editor type) (type: string): the timeout value in format 'HH:mm:ss'. For example 00:01:00, which means that the workflow will keep executing for 1 minute.
Execution: the activity will start monitoring the given file, outputting logs if the file is changed:
Monitor Folder
This activity tracks the changes of the files that you specify in folders and sub-folders.
Activity Parameters
The Monitor Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Filter File Type (text box editor type) (type: string): the extension type of the files that you want to filter. E.g. 'txt'. This field can be left empty if there is desired to monitor all files located within the given folder.
- Folder Path (text box editor type) (type: string): the path to the file that you are monitoring or browse for it. For example 00:01:00, which means that the workflow will keep executing for 1 minute.
- Time Out (text box editor type) (type: string): the timeout value in format 'HH:mm:ss'.
Execution: the activity will start monitoring the given folder, outputting logs if a file is changed:
Move File
This activity moves or renames a file.
Activity Parameters
The Move File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Destination File (text box editor type) (type: string): the final name of the file. The original file content will be moved into a new file with the name provided in this field.
- Destination Folder (text box editor type) (type: string): the destination folder for the moved file (optional).
- Overwrite File (combo box control) (type: string): option for overwriting if another file with the same name exists.
- Source File (text box editor type) (type: string): the initial file.
The Read Only Output variable are the possible output values that the activity will provide:
- Execution Result (type: string): outputs the result of execution. Possible values: 'File Moved', 'File Overidden', 'File Not Overidden'.
Move Folder
This activity moves a folder from a given path to destination path.
Activity Parameters
The Move Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Move If Not Empty (combo box control) (type: string): set this to true if you wish to move the folder (and it's contents) even if the folder is not empty. A value of False means the move is aborted if the source folder is not empty.
- Destination Path (text box editor type) (type: string): the destination path for the folder.
- Source Path (text box editor type) (type: string): the original path of the folder you want to move.
The Read Only Output variable are the possible output values that the activity will provide:
- Path of the Moved Folder (type: string): outputs the new path of the moved folder.
PGP Decrypt File
This activity decrypts files that were encrypted using PGP. Pretty Good Privacy (PGP) is a data encryption and decryption computer program that provides cryptographicprivacy and authentication for data communication. PGP is often used for signing, encrypting, and decrypting texts, e-mails, files, directories, and whole disk partitions and to increase the security of e-mail communications
Activity Parameters
The PGP Decrypt File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Password (password box editor type) (type: string): the password for the pgp file. (This parameter is used only when a 'Private Key File Path' is specified).
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).
- Decrypted File Name (text box editor type) (type: string): the name of the decrypted file.
- Destination Folder Path (text box editor type) (type: string): the path where the decrypted file will be created (if left empty it will create it to the parent folder of the file).
- File Path (text box editor type) (type: string): path of the file that you want to decrypt.
- Private Key File Path (text box editor type) (type: string): the path of the file that contains the private key for the decryption (if left empty it will use the default file).
The Read Only Output variable are the possible output values that the activity will provide:
- Output Status (type: boolean): a bool value indicating if the decryption was successfully done.
PGP Encrypt File
This activity encrypts a file or an entire folder tree using a PGP key file that you have created.
Activity Parameters
The PGP Encrypt File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Destination Folder Path (text box editor type) (type: string): the path where the encrypted file will be created (if left empty it will create it to the parent folder of the file).
- Encrypted File Name (text box editor type) (type: string): the name of the encrypted file (This parameter will be used only when the 'File Path' parameter is specified, otherwise it will set the same name as the original file name with 'Encrypted' added to the end).
- File Path (text box editor type) (type: string): the path of the file that you want to encrypt. If this parameter is used, the 'Folder Path' parameter will be ignored.
- Folder Path (text box editor type) (type: string): the path of the folder that contains the files you want to encrypt.
- Include Sub-directories (combo box control) (type: string): select this option to find all the files from the sub-folders of the folder that you specified in the path.
- Public Key File Path (text box editor type) (type: string): the path of the file that contains the public key for the encryption (if left empty it will use the default file).
The Read Only Output variable are the possible output values that the activity will provide:
- Output Status (type: boolean): a bool value indicating if the encryption was successfully done.
Print File
This activity prints the given file.
Activity Parameters
The Print File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File Path (text box editor type) (type: string): the file full path.
The Read Only Output variable are the possible output values that the activity will provide:
- Output Status (type: boolean): outputs the result of the execution: True if the execution was successful or False otherwise.
Remove File
This activity removes a file.
Activity Parameters
The Remove File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File Name (text box editor type) (type: string): the file full path.
The Read Only Output variable are the possible output values that the activity will provide:
- Execution Result (type: boolean): outputs the result of execution: True if the execution was successful or False otherwise.
Rename File
This activity renames a file from a specified path.
Activity Parameters
The Rename File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File New Name (text box editor type) (type: string): the new file name.
- Path (text box editor type) (type: string): the file path of the file which will be renamed.
The Read Only Output variable are the possible output values that the activity will provide:
- Path of the Renamed File (type: string): outputs the path of the renamed file.
Rename Folder
This activity renames a folder from a specified path.
Activity Parameters
The Rename Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Folder New Name (text box editor type) (type: string): the folder new name.
- Path (text box editor type) (type: string): the full path of the folder which will be renamed.
The Read Only Output variable are the possible output values that the activity will provide:
- Path of the Renamed Folder (type: string): outputs the path of the renamed folder.
Unzip File
This activity unzips file to a specified path.
Activity Parameters
The Unzip File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Extract To (combo box control) (type: string): the extraction method. Flowster Studio provides Here, Same Folder and New Folder Name as options.
- New Folder Full Name (text box editor type) (type: string): the path with the NewFolderName for the unzipped files. It is optional, only if user chooses extract to new folder. E.g. C:/Folder/NewFolderName.
- Zip File Path (text box editor type) (type: string): the full path of the zip file.
The Read Only Output variable are the possible output values that the activity will provide:
- Path of the Unzipped Contents (type: string): outputs path of the unzipped contents.
Write File
This activity writes given content to a file.
Activity Parameters
The Write File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File Path (text box editor type) (type: string): the file full path.
- Input String (text box editor type) (type: string): the content to be written in the file.
- Options (combo box control) (type: string): choose to append or to replace the actual content of the file with Input String value.
- Script (text box editor type) (type: string): the input content to be written in the file if a binding to a variable is used ($using). If set and if the $using:variable syntax is used, this parameter will take precedence over the Input String parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable and will write it in the given file.
The Read Only Output variable are the possible output values that the activity will provide:
- Execution Result (type: boolean): outputs the result of the execution: True if the execution was successful or False otherwise.
Execution: the activity will write the new string into the given file. If append was given as option, it will add the string to the file. If replace was given as option, it will replace the file's content with the new string:
The new string can be seen in the file:
Zip Folder
This activity zips folder from a specified path.
Activity Parameters
The Zip Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Folder Path (text box editor type) (type: string): the path of the folder which will be archived.
- Destination Path (text box editor type) (type: string): the destination Path for the Zipped Folder (Optional). If not set it will automatically save the zip in the parent folder.
- Zip Name (text box editor type) (type: string): the name for the zipped file (Optional) If not set it will name the Zip File as the name of the chosen folder.
The Read Only Output variable are the possible output values that the activity will provide:
- Path of the Zipped Folder (type: string): outputs the full path of the zipped folder.
FileINIReader
This activity returns attribute values from a ini type file.
Activity Parameters
The FileINIReader activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File (file browser editor type) (type: string): the path of the ini file. This parameter takes precedence over the Input parameter.
- Input (inline editor type) (type: string): the content of the ini file. For example:
- Section (text box editor type) (type: string): the name of the section from which the attributes with their matching values will be returned.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: dictionary<string,string>): outputs the attributes and their values. To use the elements of the dictionary, use GetKeyValuePair activity based on attribute index. (E.g use Index "0" to return the first attribute).
Execution: the activity will read in the INI file or in the Input value the section (given in the Section field) and will output the found data:
FileINIWriter
This activity appends attribute values in an ini file.
Activity Parameters
The FileINIWriter activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- File (file browser editor type) (type: string): the path of the ini file.
- INI Attributes (collection editor type) (type: string): the attributes and their values to be appended to the ini file. For example, "CCEmail" with "demo1@fmrp.intern" as value.
- Section (text box editor type) (type: string): the name of the section to append the attributes or the name of a new section to add the attributes. For example, "[Mail]".
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs True/False write operation result.
Execution: the activity will append the new values (specified in the INI Attributes collection editor) into the INI file, in the given section:
The new value can be seen in the INI file:
Directory Rights
This activity changes permissions and add access to specified user.
Activity Parameters
The Directory Rights activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Access Control (combo box control) (type: string): select this option to choose the access control for the specified account.
- Account (text box editor type) (type: string): enter here the account to which you want to give permissions. The format you need to add is "domain\accountName". For example, "fmrp\demouser".
- Directory path (text box editor type) (type: string): enter here the directory path to which you want to set rights. For example, "C:\FlowsterFolder".
- Rights (combo box control) (type: string): select this option to choose the rights for the specified account.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs 0 if the operation succeeded, if not and you don't have selected "Stop on error" it return -1.
Execution: the activity will append the new right (specified in the Rights Attributes combo box control) into the folder ( specified in the DirectoryPath Attribute), in the given section:
The new right can be seen in the the folder permission ( Folder properties > Security) :
Remove Directory Rights
This activity removes permissions and add access from a specified user.
Activity Parameters
The Remove Directory Rights activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Access Control (combo box control) (type: string): select this option to choose the access control for the specified account.
- Account (text box editor type) (type: string): enter here the account to which you want to remove permissions. The format you need to add is "domain\accountName". For example, "fmrp\demouser".
- Directory path (text box editor type) (type: string): enter here the directory path to which you want to remove rights. For example, "C:\FlowsterFolder".
- Rights (combo box control) (type: string): select this option to choose the rights for the specified account.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs 0 if the operation succeeded, if not and you don't have selected "Stop on error" it return -1.
Execution: the activity will remove the selected right (specified in the Rights Attributes combo box control) from the folder ( specified in the DirectoryPath Attribute), in the given section:
