Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

The File Event enables you to specify when and how frequently a process flow should be executed based on either the creation of a new file, or existence of a file(s) in a pre-defined location, or upon its modification.

Steps to create a File Event activity

  1. Click Configure > EVENTS > File Event.
  2. Click CREATE File Event.

  3. On Create File Event screen, enter the name and description of the new JMS Event in the Name and Description textboxes respectively.



  4. Select the trigger type from the Trigger Type drop-down list. The available options are On FileCreated, On FileExists, and On FileModified. 


    Trigger Type Selection

    Description

    On FileCreated

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

    On FileExists

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

    On FileModified

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


  5. Select Check for File Modification check box if you want to process the files that are modified after creation. This option is enabled only if On FileCreated option is selected in the Trigger Type drop-down list box.

  6. Select Run Initial Load check box if you want to process the files that are created when the event is not active. This option is enabled only if On FileCreated option is selected in the Trigger Type drop-down list box.

     
    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, and and for subsequent activations, only the unprocessed files are processed each time.
  7. Select Don't Process Duplicate Files check box if you don't want to process the same file again.

  8. Select Process Empty Files check box if you want to run the event even when the input file is empty.
  9. Enter the file name that the file event needs to verify in the File Include Criteria textbox.
  10. Enter the name of file that the file event does not need to verify in the File Exclude Criteria textbox. For example, if you enter *.txt as a value for the File Include Criteria text boxfield, but don't want the two files – Gdata.txt and Gdata1.txt – to be verified by the File Event, enter Gdata.txt and Gdata1.txt (separated by a comma) as the value for the File Exclude Criteria text boxCriteria field.

    Tip
    To specify multiple files in the File Include Criteria and File Exclude Criteria text boxesfield, you can also use regular expressions.


  11. Provide the path of the file in the File Base Location text boxfield, for example, C:/Gmdata.

  12. Select Use VFS check box if you want to enforce the validation of User ID and Password every time while accessing the file on a remote machine.

    Info
    When Adeptia Server is installed on Windows Operating System, File Event uses windows service to connect to the remote machine to access any file. It just connects once and uses the same connection with the same User ID and Password (which is stored in the cache) every time.


  13. Select the Secure check box , if the File Event is secured, that is, username and password are required to access it.

  14. Type Enter the username and password required to access the file in the User ID and Password  text boxes respectivelyfield respectively. 

    This option is applicable only when the file specified is file is located on a remote machine.

  15. Confirm Enter the password in the Confirm Password text box field.
  16. Provide In the Event Start Date field, provide the date from which the file event will start triggering in the Event Start Date. 
    The date must be in MMmm/dd/yyyy format. Click the Calendar icon and select the required date from the calendar.Provide  
  17. Select the start time from the Time drop-down list.
  18. Provide In the Event Expiry Date field, provide the date on which file event will stop triggering in the Event Expiry Date. 
    The date must be in MMmm/dd/yyyy format. Click the Calendar icon and select the required date from the calendar.Provide  
  19. Select the expiry time from the Time drop-down list.
  20. Select the type of trigger from the Trigger drop-down list. Following are the options:
    • Simple
    • Cron 

    By default, Simple is selected. This option triggers the File event as per the defined polling frequency.
    If you select Simple then do , do the followingfollowings:

    1. Provide In the Polling Frequency field, provide the time interval for at which File the file event will check for the arrival of any file or upon modification of an existing file in the Polling Frequency

    2. Enter the digit in the Frequency field and select Select the unit of time (seconds, minutes or hours) from the Duration drop-down list.

      Info
      We recommended minimum Adeptia recommends that you use the Polling Frequency to be of more than 60 seconds.


    If you select Cron then do , do the followingfollowings:

    1. Select the days of the week on which the event should fire from the Firing Days drop-down list.  Following are the available options:


      Days

      Description

      All Days

      The event will fire on all days (Mon to Sun) of the week.

      Business Days

      The event will fire from Monday to Friday excluding holidays.

      Week Days

      The event will fire from Monday to Friday even if there are any holidays.including the holidays


    2. Define the frequency of execution (in Cron Expression) in the Firing Schedule. Click Help to know more about Cron Expressions. 

  21. Provide the file stable time in the text box and the  field, and select the duration from the drop-down list. 

    Info
    • This is the wait time given for the file to get stable. Event waits for the given time before getting fired.
    • This option is applicable for On FileCreated and On FileModified Trigger Type. The trigger will wait for the specified time for the file to become stable.


  22. Click Advanced Properties to expand the hierarchy. All items in the fields in the Advance Properties are  section are displayed.



  23. Select the type of trigger from In the Send Mail Notification For box to send the mail notification.If field, 

    • Select No Data Found On Trigger if you want to send
    mail
    • email notification when
    no data found on Trigger, select No Data Found On Trigger.
    If
    • the file event doesn't find any data when triggered.
    • Select Error In Trigger if you want to send
    mail
    • email notification
    for error in Trigger, select Error In Trigger
    • if any error occurs when the file event triggers.
  24. Enter the recipient('s ) email address in the textbox  Notification Receiver Email-ID(s) field. You can add multiple email address addresses by adding comma after each email address.

  25. Select Trigger in Sequence check box  checkbox to trigger the Event event in sequential manner. If you do not select the Trigger in Sequence check box then  checkbox, the associated Event event will trigger concurrently.

  26. If you want to enable misfire handling for your JMS event then, select the Run Once option from  from the Action on Misfire Event drop-down list. If you do not wish to enable misfire handling for your file event then, select the Ignore Misfire option.

     


    Info
    The Run Once option will run only one collective instance of all the misfires for a particular event. Whereas, the Ignore Misfire option will not run a misfired event.

    The default value of for Action on Misfire Event field is set to Run Once for all of the earlier events.
  27. Click Save.

Anchor
regex
regex
Using regular expressions

To You can use regular expressions described in the following table when you want to specify more than one file in the File Include Criteria and File Exclude CriteriaCriteria field. For example, you can use regular expressions listed in the following tableif you enter h*/*.txt in the File Include Criteria field and C:/Gmdata in the File Base Location field, it will search for all .txt files that start with h inside all the directories under C:\Gmdata.

Expression

Description

*.*

For all the files with some having any extension

*

For all the files in a directory

a*.txt

For files starting the file names that start with a and having extensiontxt(e.g. have .txt as their extension, for example, arch.txt)

a??????.txt

For files starting the file names that start with a and have 6 followed by six more characters followed by txt extension (e.g. and have .txt as their extension, for example, archive.txt)

a[1-9]

For a1, a2 ,a3 …………..a9

b[aiu]t

For bat, bit, or but

a.txt, a.doc

For two files named as a.txt, and a.doc

For example, if you enter h*/*.txt in the File Include Criteria field and C:/Gmdata in the File Base Location field, it will search for all .txt files that start with h inside all the directories under C:\Gmdata.


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