Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Contents
Table of Contents | ||||
---|---|---|---|---|
|
Introduction
The File Display component is used to facilitate the uploading of and displaying of files in PhixFlow. Images can be previewed and files can have a place holder image. Serene Grey provides a number of templates, below is an example of the File Display form field.
File Display components requires the following key items in order to function
- A directory on the server to store the uploaded files and an entry in System Configuration to point at this location.
- A special type of table called a File Table 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:
- Directory
- On your server, create a directory where the files will be uploaded. This should be accessible to the application.
- In PhixFlow, from the
menu, open System → ConfigurationInsert excerpt _administration _administration nopanel true - 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
save your changesInsert excerpt _save_icon _save_icon nopanel true - All uploaded files will now be placed in this directory
- File Table
- On your ERD, add a new
Insert excerpt _tableFile _tableFile nopanel true - All the required fields are added by default
- If required, create a relationship between this File Table and your desired target table. The target table will require an attribute of type File in order to create a relationship.
- For Example, if you wish to upload company logos create a relationship to a your company table, create a logo attribute of type File and link to the File Table Primary Key.
- Data can now be saved directly to this table or via a relationship
- On your ERD, add a new
Uploading Files
- Drag the File Display component from the Serene Grey palette onto your screen
Expand Serene Grey provides a number of template 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.
- Add a backing attribute by right-clicking on the File Display component and selecting
Insert excerpt _attributes_add_backing _attributes_add_backing nopanel true - 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
- Now, with your screen
ed you can drag files onto the File Display component to populate the data. This populates the fieldInsert excerpt _lock _lock nopanel true - Ensure the File Display form field is added to your save mechanism, like with all form fields, so the data is saved
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Basic Settings
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Name |
| ||||||||||
Aggregate Function |
| ||||||||||
Allow file download | When ticked allows users to click on a File Component to download the associated file. | ||||||||||
Show the file name | When 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 image is displayed which illustrates the file type. When unticked a appropriate holding image illustrating the file type for the record is displayed by the File Display. |
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Advanced Settings
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Type |
| ||||||||||
Internal Icon Source |
| ||||||||||
External Icon Source |
|
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Insert excerpt | |||||
---|---|---|---|---|---|
|
|
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Style Settings
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|