← Return to the list of applications
If you have a problem understanding how the action works, check: Automatic tasks, Conditional execution, Components params
Basic information
Category: Tools
Available from version: 1.0.26
Description
The component downloads documents attached to the process or from the archive and saves them to the indicated location on the disk.
Configuration parameters
Parameter name | From version | Description | Paremeter type | Default value | Field type | Comments and restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Files download source* | 1.0.26 | Specifies the source from which files should be downloaded. There are 3 options:
| Text |
| Editable field |
| ||||||||
| Document class [Process] | 1.0.26 | Names of the document Classes from which documents will be retrieved. In case of an empty document class names array (parameter not completed), all documents attached to the process will be downloaded. | Text values array | Uneditable drop-down list | ||||||||||
| Document class [Archive]* | 1.0.26 | The name of the document class from which documents will be retrieved. | Text | Uneditable drop-down list | ||||||||||
| Index name | 1.0.26 | Optional filtering by indexes of the selected document class. This parameter specifies the name of the index. | Text | Uneditable drop-down list / editable field | Index list after selecting a document class from the list. If a variable or function is used in the Document class parameter, this parameter becomes an editable field. | |||||||||
| Index value | 1.0.26 | Optional filtering by indexes of the selected document class. This parameter specifies the value of the index. | Text | Editable field | ||||||||||
| File identifiers | 1.0.26 | Document identifiers to download from the archive. | Integer values table | Editable field | ||||||||||
| Directory* | 1.0.26 | Absolute path to save files on the server or path resolved by using one of the followed tags. Available tags:
The parameter indicates the location under which the documents attached to the process or from the archive will be saved. | Text | Editable field | ||||||||||
| File name | 1.0.26 | The name of the file saved on the disk. With the help of context variables: File name with extension, File name without extension, File extension, the target file name can be changed. | Function | Editable field | The field is optional. If no value is entered, the field will be completed with the original file name. | |||||||||
| Filename filter | 1.0.X | Regex filter for source filenames. | Text | Editable field | Remember to escape special regex characters when using filename filter. Example searching for .docx files only - filter value: .*\.docx (backslash before literal dot character).
Special characters that need to be escaped with a backslash:
|
Parameter*- mandatory field
In a situation where several documents with the same name will be saved, they would be saved with consecutive numbers in the name, e.g. file.txt, file (1).txt, file (2).txt. If a file is uploaded to a directory where a file with the same name already exists, it is overwritten.
Context variables
| Context variable name | From version | Description | Parameter type |
|---|---|---|---|
| File name with extension | 1.0.26 | Stores the file name with extension of the currently processed document. | Text |
| File name without extension | 1.0.26 | Stores the file name without extension of the currently processed document. | Text |
| File extension | 1.0.26 | Stores the file extension of the currently processed document. | Text |
Configuration example
Change log
1.0.26
- Component adding
1.0.X
- Add regex filename filter
- Add tag support in "directory" parameter
Add Comment