Navigation List

You can package and deploy the Navigation List item along with its associated and child artifact from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.

After install, ensure that you refresh the Enterprise Console site to view the installed links.

You can package Navigation lists of type Navigation Link, List Link, and Form Link. For all these three types of links, you can update the source path of the icon. Additionally, for the Navigation Link, you can also update the name of the page to which you want to navigate to.

You can also package folders. For more information about adding folders to package template, see Folders.

Adding Navigation List to Package Template

1. Log on to the Enterprise Console.

2. Click the <User> icon, and then click Repository Settings. The Repository Settings page appears.

3. Click the Advanced Settings tab, and then click Manage Navigation List. The Navigation List page appears.

4. Select the Navigation List that you want to package.

5. Right-click the Navigation 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.

Configuration Settings for Navigation List

The Navigation List 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 List > Edit

You can use the Settings tab to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Navigation List item. The Child Artifacts tab displays child artifacts of the Navigation List item.

The Package Template configuration window contains the following tabs:

• Settings

  • Install

  • Update

  • Uninstall

• Associated Artifacts

• Child 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.

• Navigation Link Exists: This property allows you to take appropriate action when the Navigation List item present in the package is already present in the target environment

  • Do Not Install Navigation Link: Select this option if you want to use the Navigation List item that is present in the target environment.

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

• Associated Artifacts Not Present: This property allows you to take appropriate action when the associated artifacts of the Navigation List items are not present in the target environment.

  • Install Navigation Link: Select this option if you want to install the Navigation List item, even if the associated artifacts are not present in the target environment.

  • Do Not Install Navigation Link: Select this option if you do not want to install the Navigation List item 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 Navigation Link: Select this option if you want to delete the Navigation List item that is present in the target environment.

  • Yes: Select this option to remove the Navigation List item in the target environment. On selection of this option, the Navigation Link Is Modified option appears as shown in the following table.

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

    • Retain: Select this option if you want to retain the Navigation List item 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 roll back to the original state. All modifications that were done to the Navigation List item after it was installed in the target environment will be reverted. However, the Navigation List item will be retained in the target environment.

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

  • No: Select this option if you want to retain the Navigation List item in the target environment. On selection of this option, the Navigation Link Exists and the Associated Artifacts not present options appear.

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

    • Do Not Install Navigation Link: Select this option if you want to use the Navigation Link definition that is present in the target environment.

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

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

    • Update Navigation Link: Select this option to update the Navigation Link in the Draft status, even if the associated artifacts are not present in the target environment.

    • Do not update Navigation Link: Select this option if you do not want to update the Navigation List items 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 Navigation Link: This property allows you to decide if you want to retain or delete the Navigation List in the target environment even after the Package is uninstalled.

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

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

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

  • Retain: Select this option if you want to retain the Navigation List item 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 Navigation List item after it was installed in the target environment will be reverted. However, the Navigation List item will be retained in the target environment.

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

Associated Artifacts for Navigation List Item

This tab displays all the associated artifacts of the selected Navigation List item.

Navigation List can include the following Associated Artifacts:

• Parent Folder

• List

• Form

• Parent Navigation List item

Child Artifacts for Navigation List Item

This tab displays all the child artifacts of the Navigation List item.

Navigation List Item can include the following child artifacts:

• Folder

• Child Navigation List Item

Security Artifacts for Navigation List Item

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

You can enable the security settings of the navigation list item that you want to include in the package.

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