File trigger

Operation name

File trigger

Functional Overview

File trigger is a trigger function to execute scripts when a event of watch file being created/updated/deleted occurs.

Type of event to monitor

When creating new file

The trigger fires when the watch file is newly created.

Fire image

Before trigger firing
Trigger firing timing

When updating file timestamp

The trigger fires when the watch file is overwritten/updated.

Fire image

Before trigger firing
Trigger firing timing

When deleting file

The trigger fires when the watch file is deleted.

Fire image

Before trigger firing
Trigger firing timing

Properties

File trigger settings

Item name	Content	Remarks
Trigger name	Enter the name of the trigger.
Watch event	Select the trigger event to be monitored. [When creating new file]:(default) [When updating file timestamp]: [When deleting file]:
Execute if the watch file already exists	Select whether to fire the trigger when the watch file already existed. [Checked]: If the file already exists at the time of DataSpiderServer startup or trigger registration/enabling, the trigger fires. [Not Checked]:(default) If the file already exists at the time of DataSpiderServer startup or trigger registration/enabling, the trigger does not fire.	Enabled if [When creating new file] is selected in [Watch event].
Watch file	Enter the path of the to be monitored. Click [Browse] button to activate the file Selectr and select the file.	Please specify the absolute path of file. To monitor a directory, please check [Observe directory]. Constrained Characters of DataSpider File System cannot be used except for path separator "/" and wildcard "". Wildcards (""( asterisk) only) are available in file names.
Watch file	Select the file system to refer to. [DataSpider filesystem]: (Default) Refer to the specific system of DataSpider. [Server local filesystem]: Refer to the file system of the OS on which DataSpiderServer operates.	For more information about DataSpider filesystem and mount, refer to "DataSpider filesystem".
Observe directory	[Checked]: Monitor the directory specified in [Watch file]. [Not Checked]: (default) Not monitor the file specified in [Watch file].
Watch interval	Enter the monitoring interval in seconds.	The default value is "10".
End option	Select the option when the script execution ends. [Do not delete watch file]: (default) Do not delete the watch file when the script execution ends. [Delete watch file]: Regardless the success/failure of execution, deletes the watch file. [Delete watch file only when trigger ended normally]: Delete watch file only when the script execution ended normally.

Execution content settings

Item name	Content	Remarks
Trigger owner	Select the owner of the trigger to be created.	Can only be selected by users with administrator privileges. (Ordinary users can select themselves only.)
Execution user name	Select the user to run script specified by [Script].
Password	Type the password associated with the user specified by [Execution user name].
Service	Select the script to run by trigger.	Project that was registered as a service displays.
Script	Select the script to run by trigger.	Script in the service specified by [Service] displays.
Script arguments	script input variables that is set in script specified by [Script] displays	The script output variable does not display. Refer to "Input variable / Output variable" for how to set script output variable on script and use it.
Script arguments / Variable name	Script variable name is displayed.	Can not be edited.
Script arguments / Type	Script variable number type is displayed.	Can not be edited.
Script arguments / Value	Enter a script variable value.	Trigger variables and environment variables can be specified from [Advanced operations] window.

Execution option settings

For more information about Setting execution option, refer to "Execution option settings".

Trigger Variables

In file triggers, information about the watch file can be retrieved from the trigger variables.
Trigger variable is set to the script input variable of the executing script.

Trigger variable name	Value	Content	Remarks
File path	trigger.filepath	The path of the file to be monitored.	Specify Example: ${trigger.filepath}
File name	trigger.filename	The name of the file to be monitored.	Specify Example: ${trigger.filename}

Specification limit

When multiple events occur in the seconds specified in [Watch interval], the change may be not detected.

Example: When [Watch interval] is "10" seconds and the file is newly created and then deleted in 10 seconds.
```
 Trigger Monitoring    Monitor                                              Monitor
                         *----------------*----------------*-------------------*
 Event                                Create new         Delete
```
In the case above, the file created in the interval of monitoring cannot be detected.

When monitoring a file on network drive, if the monitoring operates when the network drive is cut, the file is considered as deleted.
In that case, when the network is reconnected, the file is considered to be newly created by the event monitoring.

Monitoring will start about one second after it has been enabled.

Considers as deleted, if the timestamp in Watch file is retrieved as "0" (1970/1/1 00:00:00, GMT).

Main exceptions

Nothing.

Notes

After registering trigger, if you change the status of the services and scripts that are set to trigger (or add/delete script variables, change service name/script name), those changes are not reflected in the registered trigger.
Open the properties of the target trigger, after re-selection of services and scripts Click [Finish] to re-register.

Events to detect when the watch file, the file system target file exists, depends on the specifications to detect the update and delete files Create new.
For example, In Windows and Linux file system, when file is overwritten/updated, the timing of updating the timestamp is different, so the timing of the trigger firing is different.
Please contact the vendor of the target file system for the specifications of each file system.
Especially for large files, the timing of detecting the event is very different depending on the file system, so the trigger may fires before the file processing is done.
It is recommended to verify the action of event detecting before using the trigger.