Attachments Folder

  • Updated

The Attachments Folder is a form field that displays the content in the instance's content folder. This gives users who have access to the form the ability to upload, update, and delete the files inside that folder directly from the form.

Default configuration settings

Add the Attachment Folder as shown in the form below.


Folder is the name of the folder in the Content Folder where all files that are uploaded to the field will be saved. Attachments is the default value, but you can change the value in that field to customize the folder's name. If the folder does not already exist, a folder will automatically be created in the content folder once the first file is uploaded. If a folder with that name already exists, then files will be added to that folder. Any files uploaded to the content folder will also be shown in the Attachment Folder field in the form.

Hiding the folder when downloading the form as a PDF

The configuration settings hideInVewModes, hideInStates, lockInViewModes, and lockInStates all work as expected for the Attachment Folder field. By default, the setting hideInViewModes=PRINT is added to the field. The viewMode PRINT is a default viewmode that is used when downloading a form as a PDF (if that option has been activated for the process application). Any fields that have the setting to be hidden in the viewmode PRINT will be hidden in the PDF version of the form. You may remove the settings, but the best practice is to keep the field hidden when printing. 

The Attachment folder is not supported in start events, only tasks

The Attachment Folder cannot be used when viewing the form from a Start event. In order for the Attachment Folder to work, an instance must be created. In the Start event, an instance has not yet been created. Therefore the default configuration setting lockInStates=CREATE is added to the field which is the default state of forms being viewed from a Start Event. It is possible to remove it, but the field will show an error message and not work in your Start Event.

Other configuration settings

Locking the folder in viewmodes

Lock the folder in viewmodes if you want users to be able to view files but not add, update, or delete them. This is useful when you want to give users access to read files without giving them access to the Content Folder.

If the field is locked in a viewmode, but the user has access to the content folder, it will be possible for them to add, update and delete files in the content folder that are shown in the locked Attachment Folder field.

Using the Attachment Folder

The Attachment Field makes it possible to upload, delete, and update files. 

All attached files will be available in the Content Folder in the Task View shown in relation to the form, but they can not be deleted from this view.

Adding files

You can upload any kind of file format to the Attachment Folder, but the maximum size of the file should exceed 20 MB. You can either drag and drop one or more files onto the grey section at the bottom of the field, or you can upload files by clicking on the upload icon. 

There are some files with extensions that are considered unsafe to download because they can potentially conceal information that is harmful to the user. We do not recommend uploading files with the following extensions:

.a6p .ac .as .acr .action .air .app .awk .bat .cgi
.cmd .com .csh .dek .dld .ds .ebm .esh .exe .ezs
.fky .frs .fxp .gadget .hms .hta .icd .inx .ipf .isu
.jar .js .jse .jsx .kix .lua .mcr .mem .mpx .ms
.msi .mst .obs .paf .pex .pif .prc .prg .pvd .pwc
.py .pyc .pyo .qpx .rbx .reg .rgs .rox .rpj .scar
.scr .script .sct .shb .shs .spr .tlb .tms .u3p .udf
.vb .vbe .vbs .vbscript .wcm .wpk .ws .wsf .xqt  

Removing files from the folder

To delete a file from the field and the folder that the field has been configured to use, hover over the file and click on the trash can icon that appears on the far right side of the file.

Updating files

If you upload a file with the same name as a previously uploaded file, you will be asked whether you want to overwrite the existing file with the new one or if you want to add it as a new file. If you choose to add the file as a new file, it will be uploaded and a number (beginning at 1) will be added to the end of the file name so that the files have unique names.

If you choose to add a new file with the same name they will have the suffix _(x) added to the end.

For more information about how to work with tasks, please read the article, Work with Tasks

Was this article helpful?

0 out of 0 found this helpful



Article is closed for comments.