Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
namescreen
nopaneltrue

Contents

Table of Contents
maxLevel1
excludeContents

Introduction

The File Display component is used to facilitate the uploading of and displaying of files in PhixFlow. Images can be Files are  previewed and files can have a placeholder image - do you mean a generic image? Like the CSV icon. Serene Grey 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 form field.

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

  1. A directory on the server to store the uploaded files and an entry in System Configuration to the
    Insert excerpt
    _system_config
    _system_config
    namefull
    nopaneltrue
     to point at this location.
  2. A special type of table called a File Table to
    Insert excerpt
    _tableFile
    _tableFile
    nopaneltrue
     to hold the information about the uploaded files. 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
      nopaneltrue
       menu, open System → Configuration System → 
      Insert excerpt
      _system_config
      _system_config
      nopaneltrue
    1. In the System Directories section → File Table Upload Location field, add the address of the directory setup in the first step, e.g. C:\Tomcat\webapps\phixflow\data\images
    2. Insert excerpt
      _save_icon
      _save_icon
      nopaneltrue
       save your changes
    3. All uploaded files will now be placed in this directory
  1. File Table
    1. On your ERD, add a new 
      Insert excerpt
      _tableFile
      _tableFile
      nopaneltrue
      1. All the required fields attributes are added by default
    2. If required, create a relationship between this File Table and your desired target table. The target table will require an attribute with a Type of type File in order to create a relationship.
      1. For Exampleexample, if you wish to upload company logos, create a relationship to a your company table, create a logo attribute of the type File and link to the File Table Primary Key.
        Insert excerpt
        _key_primary
        _key_primary
        nopaneltrue

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

Uploading Files

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

    1. Expand

      Serene Grey provides a number of template templates that incorporate the File Display component, each designed to help you tackle a different task. 

      Form Fields - Defaults

      This File Display component is the default for the File data type and is designed to sit inline with the other default form fields.

      Basic Layouts

      The File Display is a component that provides the functionality of the file display in its raw form ready to be added to a screen or your own design.

      Card Containers

      File Display Card

      A card container which incorporates a read-only File Display component for displaying files and images. Ideal for product images or visual information.

      Contact Card

      A card container which incorporates a read-only File Display component for displaying files and images in a small circle. Ideal for contact profile images.


  2. Add a backing attribute by right-clicking on the File Display component and selecting
    Insert excerpt
    _attributes_add_backing
    _attributes_add_backing
    nopaneltrue
    1. Select the Primary Key from your File Table if you are saving directly to the table or use the relational attribute (foreign key) on your related table
  3. Now, with your screen
    Insert excerpt
    _lock
    _lock
    nopaneltrue
    ed you can drag files onto the File Display component to populate the data. This populates the field
  4. Ensure the File Display form field is added to your save mechanism, like with all form fieldsactionflow, so the data is saved

Creating a Download Hyperlink

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

  1.  On On the screen that is backed by the required table, click Attributes
    Insert excerpt
    _attributes
    _attributes
    nopaneltrue
  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 Properties → Styles Tab → Default Components Section
      Insert excerpt
      _property_settings
      _property_settings
      nopaneltrue
       →
      Insert excerpt
      _property_tabs
      _property_tabs
      namestyle
      nopaneltrue
       → Default Components section Default File Url Component  Component  

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
Component
Component
name_parentDetails
nopaneltrue

Basic Settings

FieldDescription
Name
Insert excerpt
Component
Component
name_name
nopaneltrue
Aggregate Function
Insert excerpt
Component
Component
name_aggregateFunction
nopaneltrue
Allow file downloadWhen ticked allows users to click on a File Component to download the associated file.
Show the file nameWhen ticked the name of the file associated to the File Component is displayed.
Show preview

When ticked a preview of the file is associated to the File Component is displayed. For files where a preview is not possible, such as a CSV, a holding generic image is displayed which illustrates the file type.

When unticked a an appropriate holding image illustrating the file type for the record is displayed by the File Display.    


Insert excerpt
Component
Component
name_backingAttribute
nopaneltrue

Insert excerpt
Component
Component
name_preferredParentCategory
nopaneltrue

Advanced Settings

FieldDescription
Type
Insert excerpt
Component
Component
name_type
nopaneltrue
Internal Icon Source
Insert excerpt
Component
Component
name_internalIconSource
nopaneltrue
External Icon Source
Insert excerpt
Component
Component
name_externalIconSource
nopaneltrue


Insert excerpt
Component
Component
name_description
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
namestyle-h
nopaneltrue

Insert excerpt
Component
Component
name_styles
nopaneltrue

Style Settings

Insert excerpt
Component
Component
name_styleSettings
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
nameaction-h
nopaneltrue

Insert excerpt
Component
Component
name_eventHandlers
nopaneltrue

Insert excerpt
Component
Component
name_dropTargets
nopaneltrue

Insert excerpt
_access
_access
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue