The File 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) in a pre-defined location or upon its modification.
Steps to create a File Event Activity
- Click Configure > EVENTS > File Event.
Click CREATE File Event.
On Create File Event screen, enter the name and description of the new JMS Event in the Name and Description textboxes respectively.
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
To configure the file event to check for the creation of a new file(s).
To configure the file event to check for the existence of the file(s).
To configure the file event to check for any modification in the file(s).
- Select Check for File Modification check box if you want to process 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.
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, for subsequent activations, only the unprocessed files are processed each time.
Select Don't Process Duplicate Files check box if you don't want to process the same file again.
- Select Process Empty Files check box if you want to run the event even when the input file is empty.
- Type the file name that the file event needs to verify in the File Include Criteria textbox.
Type the name of file that the file event does not need to verify in the File Exclude Criteria textbox. For example, if *.txt is provided as a value in the File Include Criteria but two files - Gdata.txt and Gdata1.txt are not required to be verified by File Event. Then Gdata.txt and Gdata1.txt file name need to be entered separated by a comma in the File Exclude Criteria text box. To specify more than one file in the File Include Criteria and File Exclude Criteria use regular expressions listed in the following table.
For all files with some extension
For all files in a directory
For files starting with a and having extensiontxt(e.g. arch.txt)
For files starting with a and have 6 more characters followed by txt extension (e.g. archive.txt)
For a1, a2 ,a3 …………..a9
For bat, bit, or but
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.
If more than one file is specified in the File Include Criteria text box, the process flow will trigger for each file.
Provide the path of the file in the File Base Location text box, for example, C:/Gmdata.
- 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. 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.
Select the Secure check box, if the File Event is secured, that is, username and password are required to access it.
Type the username and password required to access the file in the User ID and Password text boxes respectively. This option is applicable only when the file specified is located on a remote machine.
- Confirm the password in the Confirm Password text box.
- Provide the date from which file 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.
- Provide the start time from the Time drop-down list.
- Provide the date on which file 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.
- Provide the expiry time from the Time drop-down list.
- Select the type of trigger from the Trigger drop-down list. Following are the options:
By default, Simple is selected. This option triggers the File event as per the defined polling frequency.
If you select Simple then do the following:
Provide the time interval for which File event will check for the arrival of any file or upon modification of existing file in the Polling Frequency.
Enter the digit in the Frequency field and select the unit of time (seconds, minutes or hours) from the Duration drop-down list.We recommended minimum Polling Frequency to be more than 60 seconds.
If you select Cron then do the following:
Select the days of the week on which the event should fire from the Firing Days drop-down list. Following are the available options:
The event will fire on all days (Mon to Sun) of the week.
The event will fire from Monday to Friday excluding holidays.
The event will fire from Monday to Friday even if there are any holidays.
Define the frequency of execution (in Cron Expression) in the Firing Schedule. Click Help to know more about Cron Expressions.
Provide the file stable time in the text box and select the duration from the drop-down list. 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.
- Click Advanced Properties to expand the hierarchy. All items in Advance Properties are displayed.
Select the type of trigger from Send Mail Notification For box to send the mail notification.
If you want to send mail notification when no data found on Trigger, select No Data Found On Trigger.
If you want to send mail notification for error in Trigger, select Error In Trigger.
Enter the recipient(s) email address in the textbox Notification Receiver Email-ID(s). You can add multiple email address by adding comma after each email address.
Select Trigger in Sequence check box to trigger the Event in sequential manner. If you do not select the Trigger in Sequence check box then the associated Event will trigger concurrently.
If you want to enable misfire handling for your JMS event then, select the Run Once option 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.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 Action on Misfire Event field is set to Run Once for all of the earlier events.
Select the project from the Project drop-down list.