Creating FTP Polling Activity

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

This feature is available in:

Enterprise

Premier

Professional

Express

 


Steps to create a FTP Polling Activity

  1. On the Adeptia Suite homepage, go to Configure > Services > Polling and then click FTP.

    The Manage FTP Polling screen is displayed.

     

  2. Click the Create New link. The Create FTP Polling Service screen is displayed.

     

  3. Enter the name and description of the new FTP Polling Service in the Name and Description text boxes respectively.
  4. Enter the name and port number of the FTP Server in the textboxes Host Name and Port respectively.
  5. Enter username and password required to access FTP Server in the textboxes User ID and Password fields respectively. Then, re-enter the password in the textbox Confirm Password.
  6. Select the transfer type as either Active or Passive from the dropdown list Transfer Type. Active transfer is more secure since the client only initiates communication to the Server on one port whereas in case of 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.
  7. Select the trigger type from the dropdown list Trigger Type. For selection of values, refer to Table 2.
  8. Select the SSH FTP (SFTP) checkbox if the FTP Server specified in the Host Name field is an FTP Server over SSH.
  9. Check the FTP Over TLS/SSL (FTPS) checkbox, if the FTP Server, specified in the Host Name field is an FTP Server over TLS/SSL.
  10. In case you have selected FTP Over TLS/SSL (FTPS) checkbox, then select the FTPS mode from the FTPS Mode dropdown list. It can be Explicit or Implicit depending on FTP Server that you are accessing.
  11. Select the protection level supported by the FTP Server, from the dropdown list Protection Level. This drop-down list has the following three options:
     
    • None
    • Clear
    • Private
     

    By default, the option None is selected.

  12. If you want to validate the certificate sent by the FTPS Server select the Validate Server check box.
  13. Select keystore activity from the Keystore Name dropdown list. This option is applicable only when you have checked the Validate Server checkbox.

    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.
     
    Keystore is repository of security certificates. To know how to create Keystore and import certificates, refer to Creating Keystore section of Administrator Guide.

  14. Enter the name of file that FTP event needs to verify in the File Include Criteria field.
  15. Enter the name of file that file event does not need to verify in the File Exclude Criteria field. For example .txt is entered in *File Include Criteria, but two files Gdata.txt and Gdata1.txt are not required to be verified by FTP Polling Service. Then Gdata.txt and Gdata1.txt file name need to be entered separated by comma in File Exclude Criteria field. You can use regular expressions listed in Table 2.
  16. 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.

  17. 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 recommend minimum Polling Frequency to be more than 60 seconds.

  18. 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.

    We recommend minimum File Stable Time to be 30 seconds. It should be less than the time set for Polling Frequency.

  19. Enter the expiry time in the Expiry Time field. After expiry time process flow does not poll for the file.

    For information on Advanced Properties, refer to Changing Advanced Properties.

    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.

  20. Expand the Advanced Properties section to view the advanced properties.

     

  21. The Connector dropdown lists the APIs that you can use to connect to the FTP Server.

    For any new activity, by default Secured Inet Factory option is selected in this dropdown list. 
    The options of the Connector drop-down list changes as per your selection of the protocols that you want to use to establish the FTP connection. Please see the below table for more information:

    Protocol

    Options

    FTP

    Native
    Secured Inet Factory

    SFTP

    J2SCH (VFS)
    Secured Inet Factory
    J2SSH

    FTPS

    J2SCH (VFS)
    Secured Inet Factory

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

    The Verbose check box is enabled only when you select the Secure Inet Factory option from the Connector drop-down list. When you enable the Verbose checkbox, the log file is created within <Adeptia Suite Installation folder>\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>.
     Here:
     ActivityName is the name of the FTP Activity for which log file is created.

  23. Click Save.