This action plugin waits for the arrival of folders matching a certain pattern and optionally waits for the stability of all files in that folder.
Saved Parameters Description
- Name: The name used to identify a saved LocalFolderWatcher configured instance.
- Watch directory: The search root. GLOB wildcard are supported (*, ** and ?). Dynamic attributes are supported.
- Multi folder search?: Check this box if multiple folders are provided in the watch directory field.
- Folder pattern: (optional) The pattern for the name of the folders to be detected. Pattern can be either expressed in GLOB or in REGEX (depending on the switch chosen below). Dynamic attributes are supported. If no patterns are provided any new folder will trigger.
- Use regex pattern matching?: By default, GLOB matching is used, but if checked, REGEX will be used.
- Ignore folder name pattern: (optional) The pattern (expressed as REGEX) of directory names to be excluded.
- Ignore folder name pattern applied to full path?: By defualt the exclusion pattern above is applied just to the basename of the foldername folder. If checked, the pattern will be applied to the full path.
- Polling frequency: (optional) The wait time between each status check. The polling frequency is also used as the minimum time a folder as to be stable if 'trigger on partial' is not checked.
- Return folder content?: If checked, an additional inputs providing a list of the content for the trigger folders will be provided.
- Keep ongoing?: If checked, the containing workflow will be cloned after each trigger event.
- Return all matching entries?: By default only the oldest matching entry is returned, but if checked, all matching entries will be returned.
- Trigger on partial?: By default, only stable folders are returned, but if checked, the stability check is by-passed.
- Trigger persistence scope: Sets the scope/availability of the trigger output. The default value is 'By workorder group'. The definitions are: 'By workorder group', 'By action template', 'absolute', 'By step', 'By workflow', 'None'
Details:
- 'By workorder group' - Trigger folders are tracked while workorder is executing and will only be trapped once. If the workorder is restarted, all past triggers will be detected again if they are still present.
- 'By workflow' - Same as 'By workorder group' except no triggering will occur upon a 'restart' action as the workflow is still the same.
- 'By action template' - Allows the tracking and thus non-triggering in the second workflow for previously processed trigger files shared across workflows that contain the same template,
- 'absolute' - One trigger list is tracked regardless of the where it occurs,
- 'By step' - Similar to 'By workflow', but allows for multiple independent trigger steps within the workflow.
- 'None' – No persistence at all. If a past trigger file is still present, it will re-trigger if ‘keep on-going’ is selected. This option is recommended when ‘keep on-going’ is not selected.
Inputs Description
The list of inputs depends on the configuration of the LocalFolderWatcher action template.
- Watch_directory: If a 'Watch directory' is not provided in the configuration, it can be provided as an input.
- Folder_pattern: If a 'Folder pattern' is not provided in the configuration, it can also be provided as an input.
If dynamic attributes are used in the 'Watch directory' or 'Folder pattern', they will be required inputs typed as strings.
Outputs Description
- Folder_path: Only if 'Return all matching entries?' is not checked - returns the full path to the detected folder matching the set search criteria.
- Folder_list: Only if 'Return all matching entries?' is checked - returns an array of the full path to the detected folders matching the set search criteria.
- Content: Only if 'Return folder content?' is checked - returns the list of the full paths to the files present in the trigger folder (or folders). If 'Return all matching entries?' is checked, this output is presented as a Hash of arrays, with the trigger folder path as the key, else it is just an array of the files with the single trigger folder.
Supported Actions
None
Operating Instructions
This plugin does not support value overwrites: if a value is specified in the template it will not be available as input of the step at run time.