Scheduled

Workflow Properties

Description

Workflows are the heart of Agent because they perform all the desired functions. A workflow configuration consists of the workflow-properties and the workflow-script. The workflow-properties contain the details about how and when a workflow is triggered. The workflow-script contains the actual commands which must be executed by the workflow.

There are two types of internal triggers;

Scheduled	The workflow is triggered every "interval".
Hotfolder	The workflow is triggered when a file is found in the specified hotfolder.

And there are external triggers which consist of trigger dll's. The full-version ships with the following external triggers;

FTP	The workflow is triggered when a file is found in the remote-directory on the ftp-server. (only available in full-version)
Query	The workflow is triggered when the specified query returns the specified result. (only available in full-version)
JobTicket	The workflow is triggered when a jobticket variable contains a specific value. (only available in full-version)
MailOnServer	The workflow is triggered when the configured mailbox contains specific messages. (only available in full-version)
RSSfeed	The workflow is triggered when the specific RSSfeed contains (new) articles. (only available in full-version)

Common Settings

Enabled

Set the workflow to enabled, disabled or standby.

Enable	Enable the workflow
Disable	Disable the workflow
Standby	Set workflow to Standby. When a workflow is set to "Standby" it will never get activated "on its own" but has to be executed from another workflow by using the "ForkWorkflow" command.

Shared

When a workflow is set to "Shared" it will be moved from the standard daemon configuration file to the shared configuration file (fstp7shared.ini). This way the workflow is available to all other daemons.

Description

Description of the workflow.

Scan Interval

Defines how often/when the workflow will be checked to find out if it needs to be executed.

ON-STARTUP	Workflow will only be excuted once when the daemon starts.
ON-SHUTDOWN	Workflow will be executed when the daemon is stopping.
FIXED	Workflow will be executed on fixed times every hour, determined by the "Fixed Scheduling" settings.
Interval	Workflow will be executed every "interval" seconds.
dd-mm-yyyy	Workflow will be executed once at the configured date.
hh:mm,	Workflow will be executed every day at the configured time.
dd-mm-yyyy hh:mm	Workflow will be executed once at the configured date/time.

Valid Run Days

On which week-days the workflow is allowed to run.

Valid Run Hours

On which hours-of-the-day the workflow is allowed to run.

Fixed Scheduling

If enabled, will override the "Interval" setting and the workflow will start every valid-hour on the configured "minutes".
Example: if "Fixed Scheduling" is enabled and set to "10" and "30" the workflow will start every valid hour on [hour]:10 and [hour]:30

Calendar

Using the calendar you can configure on which dates the workflow is or is not allowed to run (a combination of the two is not possible). If no dates are set this function is not used and the other scheduling settings are used.
Note that the combination of all scheduling settings determine if a workflow is allowed to run!

Force Logging...

If enabled, will override the global "Plugin Internal Logging" setting (when it's disabled) for this particular workflow.

Auto-disable after n error(s)

If set to a value greater then zero (0) the workflow will automatically stop and be disabled when the workflow has had the specified number of errors.

OnError Workflow

If set to something else then "None", this workflow will be executed when the workflow-trigger has an error. Errors can be a non-existing hotfolder or any other error in any (external/internal) trigger. Note that only "standby" workflows are listed in the selectionbox and the selected workflow is always executed "Commands Only".

Hotfolder Workflow

Hotfolder

The directory that the workflow will scan for incoming files.

Workflows support dynamic hotfolders. This means you can choose from a limited set of variables which you can use to specify the hotfolder.

Using the "+" and "-" buttons you can add hotfolders to a list. Each hotfolder in this list will be scanned for files and the same workflow-script will be run on these files. Use this if you have more than one hotfolder which requires exactly the same workflow-script.

Stabletimer

Time in seconds the file must be unchanged to be considered safe to process or be "stable". Increase this value if you are processing files over a slow network. Typically a value of "20" should be fine in almost all cases.

You can also disable the file-timestamp-check. This might be useful if there are time-differences which cause the file to remain stable (if the file timestamp is "in the future" ascompared to the system clock).

Allow Locked Files

When checked, locked-files that would normally be registered as "not stable" will now get processed.

File Sort Order

The sort-order defines in which order the files that are found in the hotfolder are processed.

Oldest First	Oldest files will be processed first.
Newest First	Newest files will be processed first.
Smallest First	Files with the smallest filesize will be processed first.
Biggest First	Files with the biggest filesize will be processed first.
Filename A-Z	Files are sorted in ascending order according to their filename (a,b,c,d...).
Filename Z-A	Files are sorted in descending order according to their filename (z,y,x,w...).

Include Subdirectories

When checked, the workflow will also scan the subdirectories of the hotfolder.

Directory Trigger

When checked, the hotfolder-workflow will only scan for directories in the specified hotfolder and ignore all files. This means that when a directory is present in the hotfolder it will be seen by the workflow, even though this directory might not contain any files. The full path of this directory is contained withing the internal-variable <ScanPathFileName>.

Include Hidden Files

When checked, the workflow will also include hidden files.

Single File Handling

When checked, the daemon will process only one file of the current workflow before continuing with the next workflow. When unchecked, all files of the selected workflow will be processed in one run. Checking this setting in all workflows will make sure all incoming files of all workflows will be processed in a balanced manner. By default this option is unchecked.

Use Archive-bit

When checked, the archive-bit of the files is used to determine if a file should be processed.

Archive-bit must be on	When this option is selected, only files where the archive-bit is set will be processed. Note: the daemon will automatically turn the archive-bit off when the file is being processed.
Archive-bit must be off	When this option is selected, only files where the archive-bit is off will be processed. Note: the daemon will automatically turn the archive-bit on when the file is being processed.

Filter

Filter contains regular-expressions that will be applied to the filename of all files that are found in the hotfolder. All filenames that match any of these regular-expression will be processed. Default filter is set to . which means all files will be included.

Note: values supports variables.

Reject

Reject contains regular-expressions that will be applied to the filename of all files that are found in the hotfolder. The "Reject Options" will determine what happens to files that match the reject filter.

Note-1: the reject-filter overrules the standard "Filter".
Note-2: value supports variables.

Reject Options

Skip	All files that match the "Reject" filter will be skipped.
Delete	All files that match the "Reject" filter will be deleted.
Move	All files that match the "Reject" filter will be moved to the specified directory.

SetConnect

Scheduled

Documentation