Versions Compared

Old Version 9

changes.mady.by.user Dział Wdrożeń

Saved on

compared with

New Version Current

changes.mady.by.user Joanna Jankowiak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Polish

Planowany termin wydania: 01.2021

Opis:

Wtyczka zawierająca komponenty służące do komunikowania się z serwerem FTP.

Wymagania:

Wymagana wersja systemu PWFL: 3.2.149
Warning
Table Excerpt
nameplugininfo
Plugin info
MaintenanceDepartmentDev CUF
LicTypePłatna
ArtifactIdplus-ftp-client
PriceEUR710
PricePLN2 950,00
TypWtyczkiWtyczka
PluginIdcom.suncode.plugin-plus-ftp-client
ShortDescription Wtyczka zawiera zadanie automatyczne służące do wysyłania dokumentów podłączonych do procesu na serwer FTP.
 

Image Added

 

Panel
titleOpis ogólny

Plus FTP Client jest wtyczką pozwalającą na zintegrowanie systemu PlusWorkflow z serwerem FTP. Obsługiwane protokoły komunikacyjne to:

  • FTP – nieszyfrowany protokół przesyłania plików. Pliki przesyłane za pośrednictwem FTP mogą zostać „podsłuchane” przez osoby niepowołane (wraz z loginem i hasłem do serwera FTP). Z tego powodu używanie protokołu FTP nie jest zalecane z uwagi na niebezpieczeństwo wycieku danych dostępowych do serwera FTP.
  • FTPS – Protokół działa bardzo podobnie jak FTP, a jego główną różnicą jest szyfrowanie przesyłanych danych dostępowych podczas połączenia z serwerem FTP.
  • SFTP - Połączenie przez SFTP zapewnia szyfrowanie zarówno przesyłanych plików oraz danych dostępowych (loginu i hasła dostępu) do serwera FTP. Natomiast tradycyjne połączenie FTP nie zapewnia szyfrowania plików i danych dostępowych do serwera. Z tego względu połączenie przez SFTP jest uznawane za najbezpieczniejszą metodę przesyłania plików i katalogów na hosting.
Warning
titleWymagania

Wymagana wersja systemu PWFL: 4.1.16

Wymagana wersja wtyczki PWE: 2.3.50

Wymagana wersja wtyczki Plugin Configuration Manager: 14.0.01

Parametr*- pole wymagane

- pole wymagane

Panel
titleKonfiguracja połączenia

Konfiguracja połączenia z serwerem musi znajdować się w pliku konfiguracyjnym wtyczki Plugin Configuration Manager (PCM) w zakładce Plus FTP Client. Domyślnie, po wgraniu wtyczki, nie jest utworzony żaden plik konfiguracyjny, więc należy utworzyć i skonfigurować nowy. Plik konfiguracyjny przechowuje dane w formacie JSON.

Nazwa parametruOd wersjiOpisTyp parametru

Uwagi i ograniczenia

protocol*1.0.0

Określa sposób połączenia klienta z serwerem. Do wyboru są następujące protokoły:

  • FTP - przesyłane pliki, login i hasło nie są szyfrowane.
  • FTPS - zapewnia szyfrowanie przesyłanych danych dostępowych (login i hasło) podczas połączenia z serwerem. Nie szyfruje plików. Stanowi rozszerzenie standardowego protokołu FTP i wykorzystuje protokół SSL/TLS zapewniający poufność i integralność transmisji danych. Aby klient mógł korzystać z FTPS, na serwerze musi być skonfigurowany certyfikat SSL.
  • SFTP - zapewnia szyfrowanie zarówno przesyłanych plików, jak i danych dostępowych do serwera. Jego działanie opiera się na standardzie protokołu SSH.
TekstWielkość liter w polu nie ma znaczenia (case insensitive).
serverAddress*1.0.0Parametr wskazuje na adres serwera. Wartością może być nazwa domeny (np. websiteaddress.com) lub adres IP (np. 5.249.140.95).Tekst 
portNumber*1.0.0Numer portu protokołu FTP.Całkowity 
userName*1.0.0Nazwa użytkownika skonfigurowanego na serwerze, który w zależności od nadanych mu uprawnień może operować na plikach na serwerze.Tekst 
password*1.0.0Hasło użytkownika.Tekst ssl

Parametr*

1.0.0Określa, czy połączenie klienta z serwerem ma być szyfrowane lub nie. Wartość true oznacza, że wykorzystywany będzie protokół FTPs. W takiej sytuacji na serwerze musi być skonfigurowany certyfikat SSL. Wartość false określa użycie niezabezpieczonego protokołu FTP.Logiczny 
Panel
titleZabronione znaki
Warning

Niektóre znaki i sposoby zapisywania nazw katalogów i plików w systemach Windows i Linux są zabronione. Aby pomyślnie wykorzystywać komponenty tej wtyczki, należy unikać znaków przedstawionych w poniższej tabeli.

WindowsLinux
  • " / \ < > ? : * |
  • Wszystkie znaki wpisywane przy użyciu klawisza Ctrl
  • Wszystkie nazwy kończące się spacją lub kropką
  • Maksymalna długość nazwy 260 znaków
  • /
  • Maksymalna długość nazwy 256 znaków
Panel
titlePrzykładowa konfiguracja
Image RemovedImage Added

 

Code Block
languagejs
linenumberstrue
{
	"protocol":"ftp",
	"serverAddress":"192.168.0.240",
	"portNumber":21,
	"userName":"anowak",
	"password":"Workflow-u1F%H",
	"ssl":false
}
Panel
titleDostępne komponenty
:

 

Description:

The plugin containing components used to communicate with

Klasy ustawiające zmienne / Zadania automatyczne

NazwaWersjaKategoriaID przyciskuOpisSzczegóły
Wysyłanie dokumentów na serwer FTP1.0.0FTP Komponent pozwala na wysłanie wszystkich dokumentów danej klasy podpiętych do procesu na serwer FTP.Więcej...
English

Zadania zaplanowane

NazwaWersjaKategoriaID przyciskuOpisSzczegóły
Pobieranie dokumentów z serwera FTP1.0.1FTP Zadanie pobiera najnowsze pliki z serwera FTP do katalogu lokalnegoWięcej...
Panel
titleChange log

1.0.0 (obowiązująca dokumentacja)

  • Dodanie wtyczki

1.0.4(dokumentacja)

  • Obsługa protokołu SFTP
English
Plugin info
MaintenanceDepartmentDev CUF
LicTypePłatna
ArtifactIdplus-ftp-client
PriceEUR710
PricePLN2 950,00
TypWtyczkiWtyczka
PluginIdcom.suncode.plugin-plus-ftp-client
ShortDescriptionThe plugin contains an automatic task for sending documents attached to a process to the FTP server.
Requirements:
 
Warning
titleRequirements

System version required PWFL: 34.21.14916

Plugin version required PWE: 2.3.50

Plugin version required PCM (Plugin Configuration Manager): 14.0.01

Parameter*- required field

- required field

Panel
titleConfiguration 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 parameterFrom versionDescriptionParameter typeNotes and restrictions
protocol*1.0.0

Specifies how the client connects to the server. The following protocols can be selected:

  • FTP - transferred files, login and password are not encrypted.
  • FTPS - provides encryption of transmitted access data when connected to the server. It is an extension of the standard FTP protocol and uses SSL/TLS protocol to ensure confidentiality and integrity of data transmission. An SSL certificate must be set up on the server for the client to use FTPS.
  • SFTP - provides encryption of both transmitted files and access data to the server. Its operation is based on the SSH protocol standard.
TextThe field is case-insensitive.
serverAddress*1.0.0The 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.0FTP port Port number.Integer 
userName*1.0.0The name of the user configured on the server, which, depending on the privileges granted to him, can operate on files on the serverText 
password*1.0.0User password.Text ssl

Parameter*

1.0.0Specifies 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 
Panel
titleForbidden signs
Warning

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.

WindowsLinux
  • " / \ < > ? : * |
  • All characters typed using the Ctrl key
  • All names ending with a space or a period
  • The maximum length of the name is 260 characters
  • /
  • The maximum length of the name is 256 characters

 

 

Panel
titleSample configuration

Image RemovedImage Added

 

Code Block
languagejs
linenumberstrue
{
	"protocol":"ftp",
	"serverAddress":"192.168.0.240",
	"portNumber":21,
	"userName":"anowak",
	"password":"Workflow-u1F%H",
	"ssl":false
}
 
Panel
titleAvailable components
:

 

 
English

← Return to the list of available setters

← Return to the list of available applications 

Info

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

Panel
titleBasic information

Category: FTP

Available from version: 1.0.0

Panel
titleDescription
The component is used to send

Setters / Automatic tasks

NameVersionCategoryButton IDDescriptionDetails
Sending documents to an FTP server1.0.0FTP 
Komponent pozwala na wysłanie wszystkich dokumentów danej klasy podpiętych do procesu na serwer FTP.More...
 

 

Sends all documents of a given class attached to
a
the process to
an
the 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.
Panel
titleConfiguration parameters
Name of the parameterFrom versionDescriptionParameter typeDefault valueField typeNotes and restrictions
Configuration file*1.0.0The 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.0Indicates 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.0List of names of available document classes from the system.Text Uneditable drop-down list 

Parameter*- required field

Panel
titleConfiguration file

The configuration file stores data in JSON format

Name of the parameterFrom versionDescriptionParameter typeNotes and restrictions
serverAddress*1.0.0The 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.0FTP port number.Integer 
userName*1.0.0The name of the user configured on the server, which, depending on the privileges granted to him, can operate on files on the serverText 
password*1.0.0User password.Text 
ssl*1.0.0Specifies 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

Panel
titleSample configuration

Image Removed

Image Removed

Panel
titleChange log

 1.0.0

  • Adding component
server.More...

Scheduled tasks

NameVersionCategoryButton IDDescriptionSzczegóły
Pobieranie dokumentów z serwera FTP1.0.1FTP Downloads the latest files from the FTP server to a local directoryMore...
Panel
titleChange log

1.0.0 (applicable documentation)

  • A plugin adding

1.0.4 (documentation)

  • Supprot for SFTP protocol