Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

TABLE OF CONTENTS

Event Associations of Type File Watcher

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 01, 2024
  • 7 minute read

You can package and deploy the Event Associations of type File Watcher along with its associated artifacts from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.

To add Event Association of Type File Watcher to Package Template

  1. Log on to the Enterprise Console.

  2. On the Enterprise Console menu, click Workflows. The Workflows window appears.

  3. Select a Workflow with an event association of type file watcher associated to it.

  4. Right-click the workflow, and then select View Association. All associations of the selected workflow appear.

  5. Right-click Event Associations of type file watcher that you want to package, and then click Add to Package Template.
    The Add to Package Template window appears.

For more information about adding artifacts to Package Template, see Adding Artifacts to a Package Template.

In the Package Template tree view, the File Watcher Event Association will appear in the following format:

<Workflow Name_Provider Name_Event Name_Path_File Name/Pattern>

Here,

  • Workflow Name: Name of the workflow to which the file watcher is associated

  • Provider Name: Name of the file watcher

  • Event Names: Created, deleted, changed, or renamed

  • Path: Physical path of the file watcher in the source environment

  • File Name/Pattern: Extension of the file or a name of the file. For example, .txt or .doc file.


Configuration Settings for Event Association of Type File Watcher

The Event Associations of type File Watcher has a unique set of configuration settings required to install, update, and uninstall the package.

You can view and edit the configuration settings from one of the following windows:

  • Source Environment > Package Template window

  • Target Environment > Manage Package window

You can use the Settings tab to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Event Association of type File Watcher definition. The Child Artifacts tab displays child artifacts of the Event Association of type File Watcher definition.

The Package Template configuration window contains the following tabs:

  • Settings

    • Install

    • Update

    • Uninstall

  • Associated Artifacts

  • Security Artifacts


Settings Tab

The properties in this tab allow you to take appropriate actions while installing, updating, or uninstalling the Package.

Behavior of File Watcher Event Association while installing, updating or uninstalling the package:

  • You cannot overwrite an already existing item.

  • You can delete or uninstall a File Watcher Event Association only if it was installed by the Package.

Install

The settings in this tab are referred to when installing the Package. When installing the package, if the Event File Watcher dates are invalid, then the package will not be installed. Edit the dates and install the package.

  • Workflow Version: This displays the version of the Workflow to which Event Association of type File Watcher is mapped in the Source environment and it also allows you to specify the version of Workflow to which Event Association of type File Watcher should be mapped in the Target environment.

    • Source: Displays the version of Workflow in the source environment to which the Event Association of type File Watcher is mapped.

    • Target: Enter the version of the workflow:

      • Specify the version of the Workflow to which you want to map the Event Association of type File Watcher in target environment.

      • If you do not specify the Workflow version in the Target environment, the Workflow version from the Source environment will be considered while installing the package.

        Note:
        - If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is not present in the target environment, then the Event Association will not be installed.
        - If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is in Draft status, then the Event Association of type File Watcher will be installed and mapped to the
        latest version of the workflow.

  • File Watcher Event Association Settings: This displays the settings of the Event Association of type File Watcher in the Source environment and it also allows you to specify the settings of the Event Association of type File Watcher in the Target environment.

    • Source

      • Event Folder: Displays the physical path of File Watcher in the source environment.

      • Effective From: Displays the date from when the Event should be triggered in the source environment.

      • Effective To: Displays the date till when the Event should be triggered in the source environment.

    • Target

      • Event Folder: Enter the physical path of the File Watcher in the target environment. If this field is left blank then the physical path for the target environment will be the same as the path specified in source environment.

        Note: Ensure that the path specified in this field and the path specified in the Physical Path of the associated File Watcher configuration settings is the same. If it is not, then the File watcher Event Association will not be mapped to the File Watcher.

      • Effective From: Select the date from when the Event should be triggered in the target environment.

        If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

      • Effective To: Select the date till when the Event should be triggered in the target environment.

        If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

Note:

  • Ensure that you follow the following guidelines while packaging the File Watcher Event Association in the target environment:

  • Effective From and Effective To should be in a valid format.

  • Effective From should be less than or equal to Effective To respectively.

  • Effective To should be greater than or equal to current date.

  • Effective From and Effective To can be 'Null'. However, you cannot have either one of them as 'Null'.

  • If you want to leave the dates as blank, then you have to enter 'Null' in the Effective From and Effective To fields in the Target section.

Update

The settings in this tab are referred to when the same Package is installed for the consecutive time.

  • Delete Event Association: Select this option to delete the Event Association that is present in the target environment.

    • Yes: Select this option to remove the Event Association in the target environment.

    • No: Select this option to retain the Event Association in the target environment or install the Event Association if it is not present in the target environment.

  • Workflow Version: This displays the version of Workflow to which Event Association of type File Watcher is mapped in the Source environment and it also allows you to specify the version of Workflow to which Event Association of type File Watcher should be mapped in the Target environment.

    • Source: Displays the version of Workflow in the source environment to which the Event Association of type File Watcher is mapped.

    • Target: Enter the version of the workflow:

      Specify the version of the Workflow to which you want to map the Event Association of type File Watcher in target environment.

      If you do not specify the Workflow version in the Target environment, the Workflow version from the Source environment will be considered while installing the package.

      Note:
      - If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is not present in the target environment, then the Event Association will not be installed.
      - If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is in Draft status, then the Event Association of type File Watcher will be installed and mapped to the latest version of the workflow.

  • File Watcher Event Association Settings: This displays the settings of the Event Association of the type File Watcher in the Source environment and also allows you to specify the settings of the Event Association of the type File Watcher in the Target environment while updating the Package.

    • Source

      • Event Folder: Displays the physical path of File Watcher in the source environment.

      • Effective From: Displays the date from when the Event should be triggered in the source environment.

      • Effective To: Displays the date till when the Event should be triggered in the source environment.

    • Target

      • Event Folder: Enter the physical path of the File Watcher in the target environment. If this field is left blank then the physical path for the target environment will be the same as the path specified in source environment.

      • Effective From: Update the date from when the Event should be triggered in the target environment.

        If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

      • Effective To: Update the date till when the Event should be triggered in the target environment.

        If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

Uninstall

The settings in this tab are referred to when the Package is being uninstalled in the target environment.

  • Delete Event Association: This property allows you to retain or delete the Event Association of the type File Watcher in the target environment even after the Package is uninstalled.

    • Yes: Select this option to delete the Event Association from the target environment when the Package is uninstalled.

    • No: Select this option to retain the Event Association in the target environment even after the Package is uninstalled.

Click Save Event Association Settings.

Note: You cannot uninstall individual versions, when uninstalling a package. All the version will be uninstalled and a message is logged for every single version that is uninstalled.

Associated Artifacts

The Associated Artifacts tab displays all the associated artifacts of the selected Event Association of type File Watcher definition.

File Watcher Event Association has the following associated artifacts:

  • Workflow

  • File Watcher: While installing the package we will verify if the file watcher with the same path as specified in the configuration settings is available in the target environment. If available, then the File Watcher Event Association will be installed by mapping to the identified (one with the same path) file watcher. If it is not available then the File Watcher Event Association will not be installed.
    If the File Watcher title is same and path is different than the one specified in the configuration settings of the File Watcher Event Association, then the File Watcher Event Association will not be installed.

Child Artifacts

Event Association of type File Watcher does not have any child artifact.

Security Artifacts

The Security Artifacts tab displays the security artifacts of an Event Association of type File Watcher, if any.

You can enable the security settings of the grid view that you want to include in the package.
For more information about including security artifacts, see Include Security Artifacts.

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in