Description:
The plugin containing components used to communicate with the FTP server.
Requirements:
System version required PWFL: 3.2.149
Plugin version required PWE: 2.3.50
Plugin version required PCM (Plugin Configuration Manager): 1.0.0
Configuration file
The server connection configuration must be in the Plugin Configuration Manager (PCM) configuration file on the Plus FTP Client tab. By default, after uploading a plugin, no configuration file is created, so new one needs to be created and configured. The configuration file stores data in JSON format.
| Name of the parameter | From version | Description | Parameter type | Notes and restrictions |
|---|---|---|---|---|
| serverAddress* | 1.0.0 | The parameter indicates the server address. The value can be a domain name (e.g. websiteaddress.com) or an IP address (e.g. 5.249.140.95). | Text | |
| portNumber* | 1.0.0 | FTP port number. | Integer | |
| userName* | 1.0.0 | The name of the user configured on the server, which, depending on the privileges granted to him, can operate on files on the server | Text | |
| password* | 1.0.0 | User password. | Text | |
| ssl* | 1.0.0 | Specifies whether the client's connection to the server is encrypted or not. A value of true means that the FTPs protocol will be used. In this case, an SSL certificate must be configured on the server. A value of false indicates the use of unsecured FTP. | Logic |
Parameter*- required field
Forbidden signs
Certain characters and ways of writing directory and file names are prohibited in Windows and Linux. To use the components of this plugin successfully, avoid the characters shown in the table below.
| Windows | Linux |
|---|---|
|
|
Sample configuration
{
"serverAddress":"192.168.0.240",
"portNumber":21,
"userName":"anowak",
"password":"Workflow-u1F%H",
"ssl":false
}
Available components:
Setters / Automatic tasks | ||||||
| Name | Version | Category | Button ID | Description | Details | |
|---|---|---|---|---|---|---|
| Sending documents to an FTP server | 1.0.0 | FTP | Komponent pozwala na wysłanie wszystkich dokumentów danej klasy podpiętych do procesu na serwer FTP. | More... | ||
← 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 server connection configuration must be in the Plugin Configuration Manager (PCM) configuration file on the Plus FTP Client tab. By default, after uploading a plugin, no configuration file is created, so new one needs to be created and configured. 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.
Configuration parameters
| Name of the parameter | From version | Description | Parameter type | Default value | Field type | Notes and restrictions |
|---|---|---|---|---|---|---|
| Configuration file* | 1.0.0 | The name of the configuration file, 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 | Editable field | ||
| 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 | ||
| Document Class* | 1.0.0 | List of names of available document classes from the system. | Text | Uneditable drop-down list |
Parameter*- required field
Configuration file
The configuration file stores data in JSON format
| Name of the parameter | From version | Description | Parameter type | Notes and restrictions |
|---|---|---|---|---|
| serverAddress* | 1.0.0 | The parameter indicates the server address. The value can be a domain name (e.g. ftp://websiteaddress.com) or an IP address (e.g. 5.249.140.95). | Text | |
| portNumber* | 1.0.0 | FTP port number. | Integer | |
| userName* | 1.0.0 | The name of the user configured on the server, which, depending on the privileges granted to him, can operate on files on the server | Text | |
| password* | 1.0.0 | User password. | Text | |
| ssl* | 1.0.0 | Specifies whether the client's connection to the server is encrypted or not. A value of true means that the FTPs protocol will be used. In this case, an SSL certificate must be configured on the server. A value of false indicates the use of unsecured FTP. | Logic |
Parameter*- required field
Sample configuration
Change log
1.0.0
- Adding component