- 22 Feb 2022
- 1 Minute to read
File Type Overview
- Updated on 22 Feb 2022
- 1 Minute to read
Files can be handled as data that can be handled by a Flow, a reference to or from the local File System, or to store the file as an object within Decisions. As a way to increase productivity and handling, files exist in Decisions as File Data, File References, and File Reference Entities.
File Data is the Data Type used for file handling and is stored as a Byte Array within a Flow. This data is handled as Flow data and increases the overall size of the Flow's data. By using a Create Data step, or by defining Input/Output Data as File Data, users are able to utilize files within their Workflows. The File Data Data Type stores the following information on the File to provide assistance when processing/referring to the File within a Flow:
|Id||Id for which the file is stored under|
|FileName||String value for the imported file's name|
|Length||Numerical value denoting the length of the file's byte array|
File References are used to increase efficiency and reduce the amount of data consumed by the Flow engine with larger files. This is accomplished by allowing Decisions to reference files that are stored on the File System, rather than within the Flow. This allows users to pass in a File only when it is needed.
Utilizing a Load From File Data step allows users the ability to create a File Reference that can be used within a Flow to reference a File on a Local System. This can be used as input for an element such as a File Download Form Component.
File Reference Entity
File Reference Entities are an extension of the File Reference Data Type and have the same behavior of File References but provide the File Reference a Folder context. This means the File Reference can exist within the Decisions Studio/Portal via a Folder or Designer Project. The Folder context for File Reference Entities is provided by their Entity Reference Id and can be used with the Add FileReferences to Folder step.