Wait for a file

Description

You can use the Wait for file job entry to wait for a file. This job entry will sleep and periodically check whether the specified file exists after which the flow will continue. The job entry can either wait indefinitely for the file or it can timeout after a certain time.

Options

Option

Description

Job entry name

The name of the job entry. This name has to be unique in a single job.

File name

The name and path of the file to wait for.

Maximum timeout

The maximum timeout in number of seconds, or 0 to wait indefinitely. This is the number seconds after which the flow will continue even if the file was not created. When the timeout is reached the "Success on timeout" option will determine whether the outgoing success or failure hop will be followed.

Check cycle time

The time in seconds between checking for the file. The file will be checked for in the start of the execution and then every "check cycle time" seconds until the maximum timeout is reached. A job can only be stopped every "check cycle time" as else the job entry step will be sleeping. A check cycle time of 30 or 60 seconds seems to be a good trade-off between the period until the file is detected and the required CPU usage.

Success on timeout

This option determines what to do when the "Maximum timeout" has been reached and the file has not been found. If enabled, the job entry will evaluate successfully, and the outgoing success hop will be followed.

File size check

When this is switched on, once the job entry detects the specified file, and will only continue if the file size hasn't changed the last check "cycle time seconds". This is useful in cases where a file is created in the final place, and another process is still writing to the file.  (As a best practice, files should be written to a temporary location, and then moved when completed)