Contents x
File Management Step Glossary
  • 28 Aug 2023
  • 5 Minutes to read
  • Print
  • Dark
    Light
Contents
  This documentation version is deprecated, please click here for the latest version.

File Management Step Glossary

  • Updated on 28 Aug 2023
  • 5 Minutes to read
  • Print
  • Dark
    Light
Article summary

Overview 

The following article details all steps found in the File Management category in the Step Toolbox.


LocationStep NameDescriptionInputs/Outputs
RootCreate FileThe Create File step allows a user to input a file and give it a name.
Inputs:
Data, File Name

Outputs:
None
Delete FileThe Delete File step allows a user to delete the inputted file.
Inputs:
File
Outputs:
None
Create Text File

The Create Text File component takes in a string value and saves a plain text file to the local file system. View documentation for more information. 

Inputs:
Data, File Name

Outputs:
None
Directory Exists

Directory Exists is a pre-configured rule step that accepts a file path and branches to True or False if the given directory exists and is accessible to Decisions. Note: this step will not detect NAS file paths.

Inputs:
Directory Name

Outputs:
None
List File In Directory

This step will output a string list of all Windows files on the Decisions Server, given a windows directory. For example, given C:\ as an input, it will list out all files that are on that directory.

Inputs:
Directory Name

Outputs:
Output
Load All FilesTakes in the name of a file directory (C:\\...) and loads all of the files in both that directory as well as the files stored in the folders living in that directory. The output is a list of FileData. There is no indication on the list of loaded FileData whether the files are direct children of the supplied directory or nested deeper in the folder tree.Inputs:
Directory

Outputs:
Output
Load FileLoads a file into Decisions as a File Data object from a specified file path.  By default this will load files from the application server, but a network path can be used to load files remotely as long as the service account running Decisions has access to the network drive. Inputs:
File Name

Outputs:
Output
Load From File DataThis step can be used to convert FileData into the FileReference type within a workflow. It takes in a single FileData and outputs a single FileReference.
Inputs:
File

Outputs:
Output
Load From Path
This step is used to upload a file from a file path. It takes in a file location and outputs that file as a single FileReference. Inputs:
File Path

Outputs:
Output
Move FileThe Move File step is used to move a file from anywhere to anywhere. You will need to use the absolute file path to the file you want to move. For example, C:\Program Files\Decisions\Decisions Services Manager\filename or C:\users\username\filename. In the "Move To" field paste the absolute file path to the destination you want to save your file. To move a file to a shared drive the IP of the server sharing that drive needs to be used and NOT the DNS name. The flow step is not able to resolve the DNS name. The format for the move to input needs to be as follows: \\IPADDRESS\folder\subfolder\ Another factor to consider is make sure that the service account running service host manager has permissions to access that share drive. Inputs:
File Name, Move To

Outputs:
None
Read Text FileThe Read Text File component reads and outputs the contents of a file as plain text. Inputs:
File Name

Outputs:
Output
Rename FileThe Rename File step is used to rename files in a Flow. Users must specify the name of the file and the name they wish to change it to under INPUTS.
Inputs:
File Name, New Name

Outputs:
None
Rename DirectoryThe Rename Directory step is used to rename a directory within a Flow. A user must specify the directory name and the new name they want to give the directory under INPUTS.
Inputs:
Directory Name, New Name

Outputs:
Output
Create DirectoryThe Create Directory step creates a directory on the storage file back-end. Inputs:
Directory Name

Outputs:
None
Rename DirectoryThe Rename Directory step renames the specified directory with the New Name input.Inputs:
Directory Name (String), New Name (String)

Outputs:
None
Move DirectoryThe Move Directory step relocates the specified directory to the desired location via file path. This functions similarly to the Move File step. The Directory Name specifies the directory to move, the Move To input takes in the desired file path, and finally the Overwrite If Exists boolean toggles overwriting the pre-existing directory with the new one if duplicates of the same name exist.Inputs:
Directory Name (String), Move To (String), Overwrite If Exists (Boolean)

Outputs:
None
Delete DirectoryThe Delete Directory step deletes the specified directory by taking in the Directory Name input. The Error If Not Empty boolean toggles appearance of an error if the deleted directory populated with data when attempting to delete it to prevent accidental data loss.
Inputs:
Directory Name (String), Error If Not Empty (Boolean)

Outputs:
None
List Sub DirectoriesThe List Sub Directories step lists all sub directories.
Inputs:
Directory Name

Outputs:
Output
Get Last Write TimeThe Get Last Write Time takes in the complete file name and uses it to get the last file write time. Inputs:
File Name

Outputs:
Output
Load and Delete FileThis step loads and deletes a specified file. Inputs:
File Name

Outputs:
Output
Open Fast File WriterThis step has two additional steps which are Write Line and Close. The main purpose of this step is is to have a quick, asynchronous step that lets a user create and name an open fast file. After that, a user must have a step called Write Line. After using Write Line, a user must use the Close step. Users must always have these three steps in combination. They cannot be used independently. This doesn't bring the full file into memory, and it writes on a different thread. Inputs:
Delete If Exists, File Name

Outputs:
Output


File Management > Compression
Add File to ZipThe Add File to Zip step takes in a single file and includes it into the designated zip file. It then outputs the zip file with the new file inside.Inputs:
File To Add (FileData), Zip File (FileData)

Outputs:
Output (FileData)
Create Zip File
The Create Zip File component takes in a single file and a file name and outputs a zipped version of the file under the defined name.
Inputs:
File To Add (FileData), Zip File Name (String)

Outputs:
Output (FileData)
Unzip Files
The Unzip Files step takes in a single zipped folder and outputs an array of files found within that folder. If these outputs need to be converted to FileReference a 'Load From File Data' step can be used to create a FileReference type from FileData

Inputs:
Zip File (FileData)

Outputs:
Output (FileData)
Unzip (Advanced)The Unzip (Advanced) step take in a single zipped folder as well as its password to output an array of now unzipped files within the folder. If these outputs need to be converted to FileReference, a 'Load From File Data' step can be used to create a FileReference type from FileDataInputs:
Zip File (FileData), Password(String)

Outputs:
Output
Unzip to DirectoryThe Unzip to Directory step takes in a single zipped folder as well a directory path. Once it runs, it unzips the folder and places its contents within the designated directory path.Inputs:
Directory Path (String), File Data(FileData)

Outputs:
None
Zip ArrayThe Zip Array step takes in list of bytes, zips them, and outputs the new zipped byte folder.Inputs:
Data (Byte[])

Outputs:
Output (FileData)
Zip DirectoryThe Zip Directory step takes in a directory path, zips it, names it according to the designated zip file name, and finally outputs the new zipped directory folder. The Include Sub Directory input toggles the inclusion or exclusion of subdirectories within the zipped directory folder.Inputs:
Include Sub Directory (Boolean), Path to Zip (String), Zip File Name (String)

Outputs:
Output (FileData)
Zip Files
The Zip Files step takes in an array of FileData and outputs a single FileData value. It's important to note that ".zip" will need to be included on the end of the file name in order for a computer to recognize the output as a zipped folder.

Inputs:
Files To Include, Name

Outputs:
Output
Was this article helpful?
What's Next
Decisions
Resources
Organization
Connect