How to handle multiple files [9.3]

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.

Step-by-step guide

To handle multiple files follow these steps:

1. Overview of the flow
2. Configure the connection
3. Create a multiple file upload
4. Create a download service
5. Create a delete service
6. Create an update meta data service

Overview of the flow

The flow of an application handling multiple files could be as follow:

Configure the connection

To be able to handle files, a connection has to be specified. This connection states where the files should be stored. The connection can be specified in the aquima.properties file in the home folder.

Currently there are two connection flavors:

1. in memory

2. or on file system

Ad 1) In case the files should be uploaded to memory add the following line at the end of the file:

connection.<connection name>.memory

Where <connection name> is a custom name of the connection, e.g. "connection.memoryconnection.memory".

Ad 2) In case the files should be uploaded to the file system add the following line at the end of the file:

connection.<connection name>.filesystem.path=<your path>

Where <connection name> is a custom name of the connection, e.g. "connection.filesystemconnection.filesystem.path=C:/Files/". Note to use '/' in your path, e.g. C:/Files/.

Also check that your language properties file contains the following lines:

#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

Follow the steps below to model a multiple file upload:

1. Define a connection name as described before.

2. Create an entity, e.g. 'File', in your model.
3. Create at least one attribute: File.Id. 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.
4. Create an exposed flow.
5. Create a page which is put in the flow and is connected.

6. 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 AQ_File_Upload.

   Parameter	Value
   Connection	<connection name>
   Persistence	Temporary
   Mode	Multiple files
   FileID	File.Id
   FileName	File.Name
   FileType	File.Type
   FileSize	File.Size

7. Create a container of type AQ_InstanceSelectorPlus.
   1. Let the containment be: File.Id, File.Name, File.Type, File.Size, all of them read-only
   2. Let the parameters be: Parameter 'entity' should be 'File'.
8. Let the instance selector container be the second container on the page.
9. The upload container is ready to use.

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 use the download file container, 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:

This container can be used in the containment of the instance selector plus 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:

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 AQ_File_UpdateMetaData service. This is an example with one meta data.

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.

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.

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.

To be able to do this follow theses steps:

• Add an event, e.g. 'AutomaticUpload'.
• Add this event to the expected events of the AQ_File_Upload in the tab 'Events'.
• Connect a service in the flow which is connected to this event.

Every time a new file is uploaded, this exit event will be taken.

Example application

See the file upload example project.