[SETTER/ZADANIE AUTOMATYCZNE] Wysyłanie dokumentów na serwer FTP

← Return to the list of available setters

← Return to the list of available applications

If you have trouble understanding how the action works, check the descriptions: Application, Setter , Conditional execution , Component parameters

Basic information

Category: FTP

Available from version: 1.0.0

Description

The component is used to send all documents of a given class attached to a process to an FTP (File Transfer Protocol) server. The component uses the server connection configuration in the PCM plugin panel (Plugin Configuration Manager). Description of the configuration is on this page. Data transfer can be done using the FTP or FTPs (FTP SSL) protocol. The FTP protocol has no security, so user names, passwords and file data are sent unencrypted. FTPs protocol uses SSL (Secure Socket Layer) for data security and requires a certificate. The SSL certificate configured on the server ensures an encrypted connection with the FTP server. The application adds a comment to the process task when an error occurs.

Configuration parameters

Name of the parameter	From version	Description	Parameter type	Field type	Notes and restrictions
Configuration file*	1.0.0	List of names of the configuration files, which can be found in the system in the tab Administration -> System Configuration -> Plugin configuration -> Plus FTP Client. The file contains configuration data for the server address, port number, user name, password and SSL.	Text	Uneditable drop-down list
Path to directory*	1.0.0	Indicates the location where the files are saved on the server. The directory path can be absolute or relative. An absolute path starts with a forward slash "/" and does not take the current location into account, unlike a relative path for which the current location must be known since we are specifying a directory path relative to that location.	Text	Editable field	If the directory specified in the location does not exist on the server, it will be created.
Document Class*	1.0.0	List of names of available document classes from the system.	Text values table	Uneditable drop-down list
Subdirectory	1.0.0	The path to save the file along with its name on the server. The parameter indicates the location under which documents from the selected document class in the Document class parameter should be saved. The parameter value is the second part of the location that links to the path specified in the Directory parameter. For example, if the Directory parameter is "/documents/annexes" and this parameter is "/2021/january", the final path will be "/documents/annexes/2021/january".	Text values table	Editable field	The field is optional.. If no value is entered, the save path will be as specified in the Directory parameter.
File name	1.0.0	The name of the file saved on the server. With the help of context variables: File name with extension, File name without extension, File extension, the target file name can be changed.	Text values table	Editable field	The field is optional. If no value is entered, the field will be completed with the original file name.

Parameter*- required field

In a situation where several documents with the same name (not necessarily with the same content) and the same location on the server are sent, they will be saved with consecutive numbers in the name, e.g. file.txt, file (1).txt, file (2).txt, file (3).txt. If a file is uploaded to a directory where a file with the same name already exists, it is overwritten.

In a situation where a document with several versions is sent, only the latest version is sent to the server.

Context variables

Context variable name	From version	Description	Parameter type
File name with extension	1.0.0	Stores the file name with extension of the currently processed document.	Text
File name without extension	1.0.0	Stores the file name without extension of the currently processed document.	Text
File extension	1.0.0	Stores the file extension of the currently processed document.	Text

Comments in task

Content of the comment	Cause of occurrence
Incorrect JSON configuration structure of the connection to the server in the Plugin Configuration Manager panel. Please contact the Administrator to solve the problem.	any field from the JSON configuration is missing, invalid key name, entering an invalid value (e.g. there is a limited number of supported protocols for the "protocol" key).
Failed to connect to the server. Please contact the Administrator to solve the problem.	incorrect IP address, incorrect port, incorrect login, incorrect password, wrong protocol (e.g. the FTP protocol is set in the JSON configuration and the server does not allow unencrypted connections).
An error occurred while trying to save the file <file_name> to the server. Number of created files: <number_of_files>. Number of created directories: <number_of_directories>.	error while uploading files (e.g. incorrect path, no permission to create files or directories).