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

Manage View

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

You can package and deploy the Manage View definition from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks. The Manage View artifacts installed will be listed in the tree view and displays the name of the List View along with the artifact name in the parenthesis.

You can package the available views for the following artifacts:

  • Workflows

  • Manage Forms

  • Form Controls

  • Grid Configuration

  • Grid View

  • Manage Package

  • Package Template

  • Lookup Settings

  • Manage View

  • Database Connections

  • Deleted List Items

To add Manage View to Package Template

  1. Log on to the Enterprise Console.

  2. On the Enterprise Console menu, point to Tools, and then click Manage Views.
    The Manage Views window appears.

  3. Select the List View that you want to package.

  4. Right-click the List View 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.

Note: Ensure that the List Views are in Published state in order to add the selected List Views to a package template.

Configuration Settings for Manage View

The Manage View 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

You can use the Settings tab to define the configuration settings. The Associated Artifacts and the Child Artifacts tabs are not available as Manage View does not contain any associated or child artifacts.

The Package Template configuration window contains the following tabs:

  • Settings

    • Install

    • Update

    • Uninstall

  • Security Artifacts

Settings

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

Note: In the case of List view, ensure that the Table is present in the target environment before you install the List View package in the target environment. When you are installing the List view package in the target environment, if the table is not present in the target environment, the following message appears: You cannot view the list items. The table is missing. Verify your Database. Besides this, you may also get the above error message if you are using a repository which is a case-sensitive database and the queries/columns in the target environment do not match as it is written in the source environment. You can resolve this issue by correcting the Table Name or creating the table in the target environment.

Install

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

  • List View Exists: This property allows you to take appropriate action when the List View definition present in the package is already present in the target environment.

    • Do not install List view: Select this option if you want to use the List View definition that is present in the target environment.

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

  • Default List View: This property allows you to specify default list view in the target environment. This will create a new default list view or overwrite an existing default list view.

    • Yes: Select this option to create the List View as the default List View in the target environment. If an existing List View is already available in the target environment, the selected List View will replace the existing one as default in the target environment.

    • No: Select this option if you do not want to specify the default List View definition in the target environment.

  • Associated Artifacts Not Present: Use this property to take appropriate action when the associated artifacts of the List View are not present in the target environment.

    • Install List View: Select this option to install the List View in the Draft status, even if the associated artifacts are not present in the target environment.

    • Do not install List View: Select this option if you do not want to install the List View as its associated artifacts are not present.

Update

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

  • Delete List View: Select this option if you want to delete the List View definition that is present in the target environment.

    • Yes: Select this option to remove the List View definition in the target environment. On selection of this option, the List View Is Modified option appears.

      List View Is Modified: Use this option to retain or delete the List View in the target environment even after the package is updated. This property is applicable only if Delete List View is set to Yes and the List View is modified.

      • Retain: Select this option if you want to retain the List View definition along with the modifications, in the target environment even after the Package is updated.

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

      • Delete: Select this option if you want to delete the List View definition from the target environment when updating the Package.

    • No: Select this option if you want to retain the List View definition in the target environment. On selection of this option, the List View Exists option appears.

      List View Exists: This property allows you to take appropriate action when the List View definition present in the package is already present in the target environment.

      • Do not install List View: Select this option if you want to use the List View definition that is present in the target environment

      • Install to overwrite existing List View: Select this option if you want to overwrite the List View definition that is present in the target environment with the one present in the Package.

  • Default List View: This property allows you to specify default list view in the target environment. This will create a new default list view or overwrite an existing default list view.

    • Yes: Select this option to create the List View as default in the target environment. If an existing list view is already available in the target environment, the selected List View will replace the existing one as default in the target environment.

    • No: Select this option if you do not want to specify the Package List View as default List View definition in the target environment.

  • Associated Artifacts Not Present: Use this property to take appropriate action when the associated artifacts of the List View are not present in the target environment.

    • Install List View: Select this option to update the List View in the Draft status, even if the associated artifacts are not present in the target environment.

    • Do not install List View: Select this option if you do not want to update the List View as its associated artifacts are not present.

Uninstall

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

  • Delete List View: This property allows you to decide if you want to retain or delete the List View definition in the target environment even after the Package is uninstalled.

    • Yes: Select this option if you want to remove the List View definition from the target environment when the Package is uninstalled.

    • No: Select this option if you want to retain the List View definition in the target environment even after the Package is uninstalled.

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

    • Retain: Select this option if you want to retain the List View definition along with the modifications, in the target environment even after the Package is uninstalled.

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

    • Delete: Select this option if you want to delete the List View definition from the target environment when uninstalling the Package.

Note: Consider a scenario when a "Default list view" of Manage Package List that is installed in the target environment is packaged, and the same List View is selected to view the Manage Package List items. In this scenario, if you uninstall the package that had installed the Default List View, then the package will be uninstalled successfully. However, an exception occurs when the Package History page is closed. This exception occurs because the List View that you are using to view the list items, gets deleted when the package is uninstalled.

Associated Artifacts tab

This tab is not available as the List View does not have any associated artifact.

Child Artifacts tab

This tab is not available as the List View does not have any child artifact.

Security Artifacts tab

The Security Artifacts tab displays the security artifacts of a List View, if any.

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

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