Page History
Table of Contents |
---|
Goal
This how-to describes how to use the multiple file upload.
...
...
For the functionality of multiple files you do not need to install any plug in.
Configuration
Please configure the connection in the aquima.properties
file in the home folder first. Currently there are two connection flavors:
...
Memory
Code Block |
---|
connection.<connection name>.memory |
Step-by-step guide
To handle multiple files follow these steps:
Table of Contents | ||
---|---|---|
|
View the flow
The flow of an application handling multiple files could be as follow:
View the runtime application
When putting a multiple file upload container on a page, in the standard styling it will be presented as follows:
Configure the connection
To be able to handle files, a connection has to be specified. This connection states where the files should be stored. See How to setup a connection
File system
Code Block |
---|
connection.<connection name>.filesystem.path=<your path> |
...
.
Also check that your language properties file (e.g. messages_en-GB
) contains messages properties filecontains the following lines:
Code Block |
---|
#fileupload fileupload.label.single=Add file... fileupload.label.multi=Add files... fileupload.description.filesize=Maximum file size is: {0} fileupload.description.extension=Allowed file extensions are: {0} fileupload.validation.extension=File type not allowed fileupload.validation.filesize=File is too large fileupload.status.succes=File(s) uploaded successfully fileupload.status.failed=Upload failed because the following file(s) do not meet all conditions: |
...
Create a multiple File Upload
To build the functionality of Follow the steps below to model a multiple file upload the following steps have to be taken:
Define a connection name as described before.
- Create an entity, e.g. 'File', in your model.
- Create at least one attribute: File.Id. For convenience add also This attribute is needed to store the id of the file, and without this attribute this functionality does not work. When handling files it is often practical to use a few other attributes such as File.Name, File.Type and File.Size. Create these attributes too.
- Create an exposed flow.
- Create a page which is put in the flow and is connected.
Create a container of type
AQ_File_Upload
and place it on the page with the following parameters. For more information on the parameters of this container see the Container type: AQ_File_Upload.
CommentsParameter Value Connection <connection name> Persistence Temporary Mode Multiple files FileID File.Id FileName File.Name FileType File.Type FileSize File.Size - Create a container of type
AQ_InstanceSelectorPlusInstanceList
.- Let the containment be: File.Id, File.Name, File.Type, File.Size, all of them read-only
- Let the parameters be: Parameter 'entity' should be 'File'.
- Let the instance selector container be the second container on the page.
- The upload container is ready to use.
When uploading a file the following default meta data will be stored. These are:
...
- .
...
...
It is possible to extend this list with some custom meta data fields. These can be created and updated by using the AQ_File_UpdateMetaData
service.
...
Create a download service
To get use the download file container work, first create a text item with the name 'DownloadText' and enter some text, e.g. Download.
Create a AQ_File_Download
container and add the following parameters:
Parameter | Value |
---|---|
Connection | <connection name> |
FileId | File.Id |
ButtonText | DownloadText |
This container can be used in the containment of the instance selector plus list and it is ready to use.
...
Create a delete service
To be able to delete a file you need a service for that. Create a new service of type AQ_File_Delete
. Enter the following parameters:
Parameter | Value |
---|---|
Connection | <connection name> |
FileId | File.Id |
RemoveInstance | True |
This service can be used in the flow when a delete event is triggered. This service can be used directly.
...
Create an update meta data service
Next to the default meta data that are stored, it is possible to define some of your own. These can be specified in the CustomMetaData parameter of the Service call type: AQ_File_UpdateMetaData service. This is an example with one meta data.
Parameter | Value |
---|---|
Connection | <connection name> |
FileId | File.Id |
CustomMetaData | Meta = File.Meta |
...
The previous steps are needed for a simple and complete application. The following services and constructs can be used in more specific situations.
Get meta data service
Is is possible to retrieve the meta data when providing an Id.
Parameter | Value |
---|---|
Connection | <connection name> |
FileId | File.Id |
FileName | File.Name |
FileType | File.Type |
FileSize | File.Size |
Move a File
By using the AQ_File_Move
it is possible to move a file from one connection to another connection. This could be useful when uploading to memory by default, adding some meta data and storing it on the file system afterwards. This service can be used by entering the following parameters.
Parameter | Value |
---|---|
ConnectionFrom | <connection name from one system> |
ConnectionTo | <connection name to another system> |
FileId | File.Id |
...
Trigger a flow when uploading
There could be a need for directly triggering a flow when uploading a file. This could be useful when calling some services for setting information.
...
Every time a new file is uploaded, this exit event will be taken.
Example application
See the file upload example project.
...
title | Related articles |
---|
...