Search

Page tree
Skip to end of metadata
Go to start of metadata

An FTP Event enables you to specify when and how frequently a process flow should be executed based on either creation of a new file or existence of a file(s) on an FTP Server or upon its modification. To create an FTP Event:

  1. Go to Develop > Events > FTP.

  2. Click Create New to create a new FTP event.



  3. On the New FTP Event window, type the name and description of the new FTP event in the Name and Description.
  4. Type the name and port number on which FTP Server is running in the Host name and Port.
  5. Type the username and password required to access FTP Server in the User ID and Password. Confirm the password in the Confirm Password.
  6. Select the transfer type (ACTIVE or PASSIVE) from the 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 with the server over two ports. PASSIVE mode is useful when you are behind a firewall or a proxy.
  7. Select the trigger from the Trigger Type. Following are the available options - On FileCreated, On FileExists, and On FileModified. 

    Trigger Name
    Description

    On FileModified

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

    On FileExists

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

    On FileCreated

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

  8. Select Run Initial Load check box to process the files created when the event is not active. This option is enabled only if On FileCreated option is selected in the Trigger Type

     
    After the activation of the event, for the first time, the system processes all the files that exist in the base folder location, irrespective whether they were processed earlier or not. However, for subsequent activations, only the unprocessed files are processed each time.
  9. Select Don't Process Duplicate Files check box if you don't want to process the same file again. This option is enabled only if On FileCreated option is selected in the Trigger Type
  10. Select SFTP check box if the FTP Server specified in the Host Name is an FTP Server over SSH. 
    • Select the key manager from the Key Manager drop-down list.
  11. Select FTPS check box if the FTP Server specified in the Host Name is an FTP Server over TLS/SSL. 

     
    • Select the mode from the FTPS Mode. It can be Explicit or Implicit depending on FTP Server you are accessing. 

    • Select the protection level supported by the FTP Server from the Protection Level

    • Select Validate Server check box to validate the certificate sent by the FTPS Server against the certificate imported in Keystore.

    • Select the activity from the Keystore Name. This option is applicable only if you have selected Validate Server.

       

  12. Type the name of the file(s) that the FTP event needs to verify in the File Include Criteria. To select the file(s), click Define List. The File Include Criteria List window appears.

    1. Type the name of the file or any criteria in the File Include Criteria, for example, .txt. a*, and so on, and then click Add to List
    2. Click Save

  13. Type the name of the file that the FTP event 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 Event. 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

     

    If more than one file is specified in the File Include Criteria, the process flow will trigger for each file.

  14. Type the path of the file from where FTP events verify the file in the File Base Location
     

     
    In File Include Criteria and File Exclude Criteria, you can also give the folder name along with the file name. For example, suppose you have typed C:\Gmdata in the File Base Location field. There are two sub-folders - Purchase and Purchase1 in the Gmdata folder. Now, you don't know whether the file is in Purchase or Purchase1 folder. To handle this scenario, you can define File Include Criteria as defined below: 
    Purchase/.txt,Purchase1/.txt. 
     
    You can also use regular expression in the folder name as given below: 
    Pur*/*.txt 
    This path includes both the folders - Purchase and Purchase1.
  15. Provide the date from which FTP event will start triggering in the Event Start Date. The date must be in MM/dd/yyyy format. Click the Calendar icon and select the required date from the calendar.
  16. Select the start time when the event will start triggering from the Time.
  17. Provide the date on which FTP event will stop triggering in the Event Expiry Date. The date must be in MM/dd/yyyy format. Click the Calendar icon and select the required date from the calendar.
  18. Select the expiry time when the event will stop triggering from the Time.
  19. Provide the time interval for which FTP event will check for the arrival of any file or modification of existing file in the Polling Frequency. Type the digit in the Frequencyand select the unit of time (seconds, minutes or hours) from the Duration.

     

    We recommended minimum Polling Frequency to be more than 60 seconds.

  20. Type the time in the File Stable Time for which trigger will wait for the file to become stable and select the duration from the Duration. This is applicable for OnFileCreated and On FileModified Trigger Type. Type 0 to pick up the file without checking its stability (not running MDTM and size commands).  
  21. Expand Advanced Properties to view the advanced properties of an FTP Event.



  22. Select the Option you want to send email notification for. You would view Duplicate file in this box only if you have clicked the option Don't Process Duplicate Files (Step 9).
  23. Type the email id in the Notification Receiver Email-ID(s) (comma separated) to receive error emails related to this FTP event.
  24. Select Trigger in Sequence check box to trigger the associated process flow in a sequential manner. If you do not select the Trigger in Sequence check box then the associated process flow will trigger concurrently.

  25. The Connector lists the APIs to connect to the FTP Server.

    For any new activity, by default Secured Inet Factory 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. 

    Protocol

    Options

    FTP

    Native 
    Secured Inet Factory

    SFTP

    J2SCH (VFS) 
    Secured Inet Factory 
    J2SSH

    FTPS

    J2SCH (VFS) 
    Secured Inet Factory

  26. Select Verbose check box to create a log file of your FTP activity.

     

    The Verbose check box is enabled only if you select the Secure Inet Factory option from the Connector. When you select the Verbose checkbox, the log file is created within .../<AdeptiaSuiteInstallationfolder>/AdeptiaServer/ServerKernel/Log/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.

     

    For information on Advanced Properties, refer to Changing Advanced Properties
     
    For information on event misfire handling, refer to Handling Misfire Event
     
    For information on how to enable email error notification, refer to Creating Email Error Notification.

     

  27. Click Save.
  • No labels