Introduction

The File Display Gallery component is used to facilitate the uploading and displaying of multiple files in PhixFlow. Files are previewed and where this is not possible, a generic placeholder image is displayed. The Serene Grey palette provides a number of templates, below is an example of the File Display Gallery form field.

File Display Gallery components require the following key items in order to function:

1. A directory on the server to store the uploaded files and an entry in the

   Insert excerpt
   _system_config _system_config name full nopanel true

    to point at this location
2. A special type of table called a

   Insert excerpt
   _tableFile _tableFile nopanel true

   to hold the information about the uploaded files
   1. This is added using an ERD
3. A

   Insert excerpt
   _tables _tables nopanel true

   containing an attribute called folderId and of type, string, that is related to the above

   Insert excerpt
   _tableFile _tableFile nopanel true

   via this attribute
   1. This is added using an ERD

Initial Setup

In order to store an uploaded file the following must be completed.

1. Directory
   1. On your server, create a directory where the files will be uploaded. This should be accessible to the application
   2. In PhixFlow, from the

      Insert excerpt
      _administration _administration nopanel true

       menu, open System → 

      Insert excerpt
      _system_config _system_config nopanel true

1. 1. In the System Directories section → File Table Upload Location field, add the address of the directory setup in the first step, e.g. /opt/phixflow/data/file

   2. Insert excerpt
      _save_icon _save_icon nopanel true

       save your changes
   3. All uploaded files will now be placed in this directory
2. File Table
   1. On your ERD, add a new 

      Insert excerpt
      _tableFile _tableFile nopanel true

      1. All the required attributes are added by default and cannot be modified
3. Table
   1. On your ERD, use an existing or add a new

      Insert excerpt
      _tables _tables nopanel true

      1. Create a new attribute:
         1. Name: folderId
         2. Type: String
   2. Create a Relationship from the folderId attribute on the

      Insert excerpt
      _tableFile _tableFile nopanel true

      to the folderId attribute on the 
      

      Insert excerpt
      _tables _tables nopanel true

   3. Data can now be saved directly to this table or via a relationship

Uploading Files

1. Drag the File Display Gallery component from the Serene Grey palette onto your screen

   1. 
      

      Expand
      title View Serene Grey Template
      Serene Grey provides a number of templates that incorporate the File Display Gallery component, each designed to help you tackle a different task.  Form Fields - Defaults This File Display Gallery component is designed to sit inline with the other default form fields. Basic Layouts The File Display Gallery is a component that provides the functionality of the file display gallery in its raw form ready to be added to a screen or your own design.

      
      

2. Add a backing attribute by clicking on the component until the properties for the inner component, File Display Gallery, displays on the right
   1. On the

      Insert excerpt
      _property_tabs _property_tabs nopanel true

      , in the Backing Attribute section, click the

      Insert excerpt
      _attributes_add_backing _attributes_add_backing name icon nopanel true

      icon
   2. Select the folderId attribute on your 

      Insert excerpt
      _tables _tables nopanel true

3. Now, with your screen

   Insert excerpt
   _lock _lock nopanel true

   ed you can drag files onto the File Display Gallery component to populate the data. This populates the field
4. Ensure the File Display Gallery form field is added to your save actionflow, so the data is saved

Creating a Download Hyperlink

A text hyperlink can be created that facilitates the downloading of a file.

1. On the screen that is backed by the required table, click

   Insert excerpt
   _attributes _attributes nopanel true

2. Navigate the File Table and drag the Url attribute onto your screen
3. A hyperlink will be created that downloads the file associated to the current record, i.e. the file for the record currently on the form
   1. The hyperlink component is created using the template defined in the application's

      Insert excerpt
      _property_settings _property_settings nopanel true

       →

      Insert excerpt
      _property_tabs _property_tabs name style nopanel true

       → Default Components section → Default File Url Component  

Background Icons

1. When the File Display Gallery is available for the user to upload a file:
   1. 
2. When the user is dragging a file over the File Display Gallery component:
   1. 
3. When the File Display Gallery is read-only, this includes when the screen is

   Insert excerpt
   _unlock _unlock nopanel true

   ed:
   1. 

These style can be changed using Formatting Rule and the new CSS Drag Over property that can be applied to a CSS Property.

Basic Settings

Image Removed

Advanced Settings

Style Settings