File Watcher

You can package and deploy the 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 File Watcher to a Package Template

1. Log on to the Enterprise Console.

2. In the Enterprise Console, click menu icon, click Settings, and then click File Watcher.
   The FileWatcher List window appears.

3. Select the file watcher list that you want to package.

4. Right-click the file watcher list, and then click Add to Package Template.
   The Add to Package Template dialog box appears.

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

Runtime Initialization Settings

You can configure runtime initialization settings for the File Watcher. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

Configuration settings for File Watcher

The 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 File Watcher does not have any associated artifact or child artifact. So, the Associated Artifacts and Child Artifacts tab are not enabled.

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.

Install

The settings in this tab are referred to when installing the Package.

• File Watcher exists: Select this property to take appropriate action when the File Watcher that is being installed is present in the target environment.

  • Do not install File Watcher: Select this option to use the File Watcher that is present in the target environment.

  • Install to overwrite existing File Watcher: Select this option to overwrite the File Watcher that is present in the target environment with the one that present in the package.

• Physical Path: This displays the path of the File Watcher in the Source environment and it also allows you to specify path of the File Watcher in the Target environment:

  • Source: Displays the path of the File Watcher in the Source environment.

  • Target: Specify the path of the File Watcher in the target environment. If it is left blank, then the source path will be considered.

Update

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

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

  • Yes: Select this option to remove the File Watcher in the target environment.

  • No: Select this option to retain the File Watcher in the target environment.

• File Watcher exists: Select this option to take appropriate action when the File Watcher that is being installed is present in the target environment.

  • Do not install File Watcher: Select this option if you want to use the File Watcher that is present in the target environment.

  • Install to overwrite existing File Watcher: Select this option if you want to overwrite the File Watcher that is present in the target environment with the one that present in the package.

• File Watcher Is Modified: Select this option to retain, roll back to original state, or delete the File Watcher in the target environment even after the Package is updated. This property is applicable only if Delete File Watcher is set to Yes and if the File Watcher is modified.

  • Retain: Select this option to retain the File Watcher along with the modifications in the target environment even after the Package is updated.

  • Roll back to original State: Select this option to roll back to the original state. All modifications that were done to the File Watcher after it was installed in the target environment will be reverted. However, the File Watcher will be retained in the target environment.

  • Delete: Select this option to delete the File Watcher from the target environment when updating the Package.

Uninstall

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

• Delete File Watcher: Select this option to retain or delete the File Watcher in the target environment even after the Package is uninstalled.

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

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

• File Watcher Is Modified: This option allows you to decide if you want to retain, roll back to original state or delete the File Watcher in the target environment even after the Package is uninstalled. This property is displayed only if Delete File Watcher is set to Yes. However, if Delete File Watcher is set to No, this property is not displayed.

  • Retain: Select this option to retain the File Watcher along with the modifications in the target environment even after the Package is uninstalled.

  • Roll back to original State: Select this option to roll back to the original state. All modifications that were done to the File Watcher after it was installed in the target environment will be reverted. However, the File Watcher will be retained in the target environment.

  • Delete: Select this option to delete the File Watcher from the target environment when uninstalling the Package.

Associated Artifacts Tab

File Watcher does not have any associated artifact.

Child Artifacts Tab

File Watcher does not have any child artifact.

Security Artifacts Tab

The Security Artifacts tab displays the security artifacts of a file watcher, if any.

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