MQTT Connections

You can package and deploy a MQTT Connection from one environment or repository to another environment or repository using the package feature in AVEVA Work Tasks.

To add MQTT Connection to Package Template

1. Log on to the Enterprise Console.

2. On the menu, point to Tools, and then click MQTT Connections.

   The MQTT Connection List window appears.

3. Select the MQTT Connection that you want to package.

4. Right-click the MQTT Connection 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.

   You can set the configuration properties of a MQTT Connection in the Add to Package Template window. The left side of the configuration window shows the package template and its configurations. You can set the configuration properties of the MQTT Connection package in the Settings form on the right side of the Add to Package Template window.

Runtime Initialization Settings

You can configure runtime initialization settings for MQTT Connections. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

Configuration Settings for MQTT Connection

The MQTT Connection has an 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

The Package Template configuration window contains the following tabs:

• Settings

  • Install

  • Update

  • Uninstall

• Associated Artifacts

• Child Artifacts

Settings Tab

You can define the properties in the Settings tab to take appropriate actions to install, update, or uninstall a package.

Install

Use this tab to set the configurations for installing the package.

• Connection Exists: Select this property to take appropriate action when the MQTT Connection in the package is already present in the target environment.

  • Do not install connection: Select this option to use the MQTT Connection, present in the target environment.

  • Install to overwrite the existing connection: Select this option to overwrite the MQTT Connection in the target environment with the one that is present in the package. During the package installation, backup will be taken before overwriting the existing artifact.

Update

Use the settings in this tab to update an installed package.

• Delete connection: Use this property to delete the MQTT Connection present in the target environment.

  • Yes: Select this option to remove the MQTT Connection from the target environment.

    Connection is modified: Select this option to retain, roll back to original state, or delete the MQTT Connection in the target environment even after the package is updated. This property is applicable only if Delete connection is set to Yes and the MQTT Connection is modified.
    

    • Retain: Select this option to retain the MQTT Connection with the modifications in the target environment even after the uninstalling the package.
      

    • Rollback to original state: Select this option to rollback the MQTT Connection to the original state. All modifications done to the MQTT Connection after installation in the target environment will be rolled back. However, the MQTT Connection will be retained in the target environment.
      

    • Delete: Select this option to delete the MQTT Connection from the target environment while updating the package.

  • No: Select this option to retain the MQTT Connection in the target environment.

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

    • Do not install connection: Select this option if you do not want to update the MQTT Connection as associated artifacts are not present.

    • Install to overwrite existing connection: Select this option to overwrite the MQTT Connection present in the target environment with the one that is currently being packaged.

Uninstall

Use this tab to configure the settings when the package is being uninstalled from the target environment.

• Delete connection: Select this property to retain or delete the MQTT Connection in the target environment after you uninstall the package.

  • Yes: Select this option to delete the MQTT Connection from the target environment when the package is uninstalled.

  • No: Select this option to retain the MQTT Connection in the target environment even after the package is uninstalled.

• Connection is modified: Select this property to retain, rollback, or delete the MQTT Connection in the target environment after uninstalling the package. This property is displayed only if Delete connection is set to Yes. However, if Delete connection is set to No, this property is not displayed.

  • Retain: Select this option to retain the MQTT Connection with the modifications in the target environment even after the package is uninstalled.

  • Rollback to original state: Select this option to rollback the MQTT Connection to the original state. All modifications that were done to the connection after it was installed in the target environment will be reverted. However, the connection will be retained in the target environment.

  • Delete: Select this option to delete the MQTT Connection from the target environment when uninstalling the package.

Connection Details

Use the Connect to Repository DataSource settings to choose between an existing repository connection string or a different connection string.

Source:

Target:

Associated Artifacts of MQTT Connection

MQTT Connection does not have any associated artifact.

Child Artifacts of MQTT Connection

MQTT Connection does not have any child artifact.

Security Artifacts of MQTT Connection

You can enable the security settings of the MQTT Connection that you want to include in the package.

For more information about including security artifacts, see Include Security Artifacts.

Note: Restart the Workflow Engine service to utilize the MQTT Connection installed through package.