FTP Polling

The FTP Polling service is used to check the arrival or modification of a file(s) on a FTP location.

Steps to create a FTP polling:

  1. Click Configure > POLLING > FTP.

  2. Click Create FTP Polling.



  3. On the Create FTP Polling window, enter the name and description of the new FTP Polling service in the Name and Description fields.
  4. Enter the Host name and Port on which FTP Server is running.
  5. Enter the username and password required to access FTP Server in the User ID and Password fields.
  6. Re-enter the password in the textbox Confirm Password.
  7. Select the transfer type as either Active or Passive from the drop-down list of Transfer Type
    1. ACTIVE transfer is more secure since the client only initiates communication to the Server on one port.
    2. PASSIVE transfer the client initiates communication to the Server over two ports. Passive mode is useful when you are behind a firewall or a proxy.
  8. Select the trigger from the Trigger Type drop-down list. 

    On FileModified

    To configure the FTP Polling service to check for any modification in the file(s).

    On FileExists

    To configure the FTP Polling service to check for the existence of the file(s).

    On FileCreated

    To configure the FTP Polling service to check for the creation of a new file(s).

    Trigger Name

    Description

  9. Select SFTP checkbox if the FTP Server specified in the Host Name is an FTP Server over SSL.
  10. Select the key manager from the Key Manager drop-down list.
  11. Select FTPS checkbox if the FTP Server specified in the Host Name is an FTP Server over TLS/SSL.  

    1. Select the mode from the FTPS Mode drop-down list. It can be Explicit or Implicit depending on FTP Server you are accessing. 

    2. Select the protection level supported by the FTP Server from the Protection Level drop-down list. This drop-down list has the following three options: 

      • None
      • Clear
      • Private

      By default, the option None is selected.

    3. Select Validate Server checkbox to validate the certificate sent by the FTPS Server against the certificate imported in Keystore.

    4. Select the activity from the Keystore Name drop-down list. This option is applicable only if you have selected Validate Server.

      When Validate option is unchecked, it always accepts the certificate sent by FTPS Server. When this option is checked, it validates the certificate sent by FTPS server against the certificate imported in Keystore.
  12. Enter the name of file that FTP Polling service needs to verify in the File Include Criteria field.
  13. Enter the name of the file that the FTP Polling service does not need to verify in the File Exclude Criteria.

    For example, you have typed *.txt as a value in the File Include Criteria, and you want following two files Gdata.txt and Gdata1.txt file not to be verified by the FTP Polling Service, then Gdata.txt and Gdata1.txt file name need to be entered separated by a comma in the File Exclude Criteria. You can also use regular expressions to specify more than one file in the File Include Criteria and File Exclude Criteria.
  14. Enter the path of file in the File Base Location. Example c:/Gmdata.

    You can also use regular expression for folders in File Include Criteria and File Exclude Criteria fields. For example, if you enter h*/*.txt in File Include Criteria field and C:/Gmdata in File Base Location field, it will search for all .txt file inside all directories which starts from h under C:\Gmdata.

  15. Enter the time interval, the FTP Polling Service will check for the arrival of any file or modification of existing file in the Polling Frequency field. Enter digit in the Frequency field and select the unit of time i.e. seconds, minutes or hours etc. from the dropdown list Duration.

    We recommended minimum Polling Frequency to be more than 60 seconds.
  16. Enter the file stable time in the File Stable Time field. This is applicable only when user selects On FileModified in trigger type. Polling will wait for the above specified time to become a file stable.
  17. Enter the expiry time in the Expiry Time field. After expiry time process flow does not poll for the file.

    When a FTP polling service is used in a process flow, it creates a Polling Status activity variable. For more information, refer to Polling Status.

  18. Expand the Advanced Properties section. 

    1. Select the Project from Project drop-down list.
    2. The Connector lists the APIs to connect to the FTP Server.

      For any new service, by default Apache Camel is selected. 

      The options of the Connector drop-down list changes as per your selection of the protocols to use to establish the FTP connection. 

      FTP

      Apache Camel
      NATIVE
      Secured Inet Factory (Deprecated)

      SFTP

      Apache Camel
      J2SCH (VFS)
      Secured Inet Factory (Deprecated)
      J2SSH

      FTPS

      Apache Camel
      J2SCH (VFS)
      Secured Inet Factory (Deprecated)

      Protocol

      Options

    3. Enter the additional configuration details in the Add On Configurations text box. This field is available only if you have selected Apache Camel connector.

    4. If you want to create a log file of your FTP service then check the Verbose check box.

      You can enable the Verbose check box only if you have selected the Secure Inet Factory or Apache Camel option from the Connector field. When you select the Verbose check box using Secure Inet Factory option, the log file is created within …ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\logs\ftplogs folder. Whenever you execute this activity, a separate log file is created with the name <ActivityName_MM-dd-yyyy hh-mm-ss.S>. Where, ActivityName is the name of the FTP activity for which the log file is created.

      When you select the Verbose check box using Apache Camel option, the log files are generated on the basis of the FTP protocols. For example, if a user runs FTP activity named FTP Source (connecting with FTP protocol only), the verbose log file path for this activity will be ...\logs\ftpLogs\ftpcomponent.log. If the user runs this activity more than once, all the generated logs will be appended to this ftpcomponent.log file.

      Log file will be generated on the basis of FTP protocols (FTP/FTPS/SFTP) at the different location as explained below:

      • For FTP protocol:  ...<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\logs\ftpLogs\ftpcomponent.log
      • For FTPS protocol:  …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\logs\ftpLogs\ftpscomponent.log
      • For SFTP protocol:  …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\logs\ftpLogs\sftpcomponent.log
  19. Click Save.