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
- 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
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).
- 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.
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, and 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.
- Enter the file name that the file event needs to verify in the File Include Criteria textbox.
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 field, 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 field.
To specify multiple files in the File Include Criteria and File Exclude Criteria field, you can use regular expressions.Provide the path of the file in the File Base Location field, 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.
Enter the username and password required to access the file in the User ID and Password field respectively.
This is applicable only when the specified file is located on a remote machine.
- Enter the password in the Confirm Password field.
- In the Event Start Date field, provide the date from which the file event will start triggering.
The date must be in mm/dd/yyyy format. - Select the start time from the Time drop-down list.
- In the Event Expiry Date field, provide the date on which file event will stop triggering.
The date must be in mm/dd/yyyy format. - Select the expiry time from the Time drop-down list.
- Select the type of trigger from the Trigger drop-down list. Following are the options:
- Simple
- Cron
By default, Simple is selected. This triggers the File event as per the defined polling frequency.
If you select Simple, do the followings:In the Polling Frequency field, provide the time interval at which the file event will check for the arrival of any file or modification of an existing file .
Select the unit of time (seconds, minutes or hours) from the Duration drop-down list.
Adeptia recommends that you use the Polling Frequency of more than 60 seconds.
If you select Cron, do the followings:
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 including the holidays
Define the frequency of execution (in Cron Expression) in the Firing Schedule.
Provide the file stable time in the field, 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 the fields in the Advance Properties section are displayed.
In the Send Mail Notification For field,
- Select No Data Found On Trigger if you want to send email notification when the file event doesn't find any data when triggered.
- Select Error In Trigger if you want to send email notification if any error occurs when the file event triggers.
Enter the recipient's email address in the Notification Receiver Email-ID(s) field. You can add multiple email addresses by adding comma after each email address.
Select Trigger in Sequence checkbox to trigger the event in sequential manner. If you do not select the Trigger in Sequence checkbox, the associated event will trigger concurrently.
If you want to enable misfire handling for your JMS event, select Run Once from the Action on Misfire Event drop-down list. If you do not wish to enable misfire handling for your file event, select Ignore Misfire.
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 for Action on Misfire Event field is set to Run Once for all of the earlier events.Click Save.
Using regular expressions
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 Criteria field. 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.
Expression | Description |
|---|---|
*.* | For all the files having any extension |
* | For all the files in a directory |
a*.txt | For the file names that start with a and have .txt as their extension, for example, arch.txt |
a??????.txt | For the file names that start with a and followed by six more characters 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 |