File Reference Entity
  • 07 May 2021
  • 2 Minutes to read
  • Dark
    Light
  This documentation version is deprecated, please click here for the latest version.

File Reference Entity

  • Dark
    Light

Article summary

Overview

Where File References typically function as means of storing Files within the File System, they are also used as a part of a larger object known as a File Reference Entity.

Additional Info on File References
For more information regarding File References, see the File References document. 

File References Entities are created and used to store files within a Folder in Decisions. These are especially useful in instances involving Process logic where a user may want to store an added File within a Process Folder. This allows the user to utilize the file within Decisions outside of its initial Flow and without having to pull it from the File System after it's added.


Example 

The following example demonstrates how to utilize File Reference Entity steps to create File Reference Entities and store files in Decisions.

Note on Example 
The following example demonstrates the basic setup for storing files via File Reference Entity. This may then be applied to any pre-existing Flows or processes involving FIle References and Process Folders. 

 To do so:

  1. From Decisions Studio, right-click the desired Designer Folder and select Add > Folder; provide a Folder Name, then click SAVE. 
    Note on Folders 
    If this example is being applied to a pre-existing Process Folder, proceed to step two without creating a Folder.

  2.  Right-click the Folder and select Manage > Get Folder ID
  3.  From the ID window, click COPY TEXT, then DONE.
  4. Navigate to a Designer Folder and CREATE a new Flow by selecting CREATE FLOW from the Global Action Bar.
  5. From the Flow Designer, attach a Load From File Data step, from Steps > Integration > File, to the Start step.
  6. Select the Load From File Data step to navigate to its Properties; under Inputs, set File's mapping to Constant. Then, select CHOOSE FILE and select the desired file.  
    Note using Flow with additional Logic
    If this example is being followed within a Flow involving any additional logic, the data may be Select From Flow mapped into the File Input, from any step that outputs FileData

  7. From Flow Management > Data in the Steps tab, attach an Add FileReferences To Folder step to the Done path of the Load From File Data step and to the End step. 
  8. From the Properties of the Add FileRefereneces To Folder step, constant map the Folder Id to its respective Input. Then set File References to Build Array; map LoadFromFileData1_Output to Item 0
  9. Save and if desired, Close the Flow. 

Debug

  1. From the Flow Designer, click the Debug link on the top Action bar, then click FULL. 
  2. After the Flow runs, navigate to and verify that the FileRefernceEntity has been added to the designated Folder
    Note on File Reference Entity 
    This File Reference Entity can now be accessed and utilized in Decisions outside of the Flow that it was added from. 



Was this article helpful?