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

Queue Management

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJun 21, 2024
  • 5 minute read

You can package and deploy a queue along with its associated and child artifacts from one environment or repository to another environment or repository.

Users are not be added to the queue. When the queue is installed, the user installing the queue will become the owner of the queue. When the queue is installed, the role will be added to the queue only if the role name matches in any of the target providers.

To add Queue Management to Package Template

  1. Log on to the Enterprise Console.

  2. In the Enterprise Console, click the Menu button, click Settings, and then click Queue Management.

    The Queue Management window appears.

  3. Right-click on a queue, 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.

    You can set the configuration properties of queue 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 queue package in the Settings form on the right side of the Add to Package Template window.

    When you select the Include Associated Artifacts option as Yes while adding the queue to a package template, the associated artifacts are added to the package template. You can then view the associated artifacts of a queue in the tree view of a package. If you select the Include Associated Artifacts option as No, the associated artifacts are not added to the package template. Then, you cannot see the associated artifacts in the tree view of a package. This condition holds good for both the Include Child Artifacts and Include Security Artifacts options as well.

    When you select the Include the automatically generated SQL Script option as Yes while adding the queue to a package template, the automatically generated SQL script is included in the package template. If you select the Include the automatically generated SQL Script option as No, the automatically generated SQL script is not included in the package template.

Runtime Initialization Settings

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

Configuration settings for Queue

Queue 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 > Edit

  • Target Environment > Manage Package > Edit

Settings

You can define the configuration settings of a queue artifact in the Settings tab. Set the properties in this tab to take appropriate actions while installing, updating, or uninstalling the package.

Install

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

  • Queue exists: Use this property to take appropriate action when the Queue to be installed is present in the target environment.

    • Overwrite existing Queue: Select this option to overwrite the Queue present in the target environment with the one that you packaged.

    • Use existing Queue: Select this option to use the Queue which is present in the target environment.

  • SQL script: While installing the script in the target environment, the SQL script is run first to make necessary database entry related to the dispatch provider, so that the queue with the dispatch provider works without any manual intervention.

    If a default dispatch pattern is configured, then the SQL scripts are not generated.

    See Also: SQL Script Generation and Execution

Update

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

  • Delete Queue: Use this property to delete the Queue present in the target environment.

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

      If Queue is modified after installation: Use this option to retain, delete, or rollback to original state the queue in the target environment even after the package is updated. This property is applicable only if Delete Queue is set to Yes and the queue is modified.

      • Retain: Select this option to retain the Queue along with the modifications, in the target environment even after the package is updated.

      • Rollback to original state: Select this option if you want to rollback to the original state. All modifications that were done to the Queue after it was installed in the target environment will be reverted. However, the Queue is retained in the target environment.

      • Delete: Select this option if you want to delete the Queue from the target environment when updating the package.

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

      Queue exists: Use this option to take appropriate action when the queue that is being installed is present in the target environment.

      • Overwrite existing Queue: Select this option to overwrite the Queue that is present in the target environment with the one present in the package.

      • Use existing Queue: Select this option to use the Queue that is present in the target environment.

Uninstall

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

  • Delete Queue: Use this property to decide if you want to retain or delete the Queue in the target environment after you uninstall the package.

    • Yes: Select this option to delete the Queue from the target environment while uninstalling the package.

    • No: Select this option to retain the Queue in the target environment after uninstalling the package.

  • If Queue is modified after installation: Use this property to decide if you want to retain, rollback, or delete the Queue in the target environment after uninstalling the package. This property is displayed only if Delete Queue is set to Yes. However, However, if Delete Queue is set to No, this property is not displayed.

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

    • Rollback to original state: Select this option to rollback to the original state. All modifications that were done to the Queue after the installation in the target environment is. However, the Queue is retained in the target environment.

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

Note:

- The SQL script does not run when the package is installed in update mode.

- Changes made to the package through SQL scripts will not be reverted during package uninstallation.

Associated Artifacts of Queue

The Associated Artifacts tab displays all the associated artifacts of the selected Queue.

The following artifacts can appear as Associated Artifacts, if you are using any one of the following artifacts while designing the queue:

  • Workflow

  • Work Item Field

  • Work Item Layout

  • Queue

Child Artifacts

Queue does not have any child artifact.

Note: Packaging of Users (that is, participants of type Users) are not supported.

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