Navigation List Folders

For a Navigation List, you can package and deploy Folder along with its associated and child artifacts from one environment or repository to another environment or repository.

Configuration Settings for Folder

The Folder 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

Settings Tab

You can define the configuration settings of the Folder artifact in the Settings tab. Set the options 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.

• Parent item is not present: Select this property to take appropriate action when the parent item is not present in the target environment.

  • Install folder: Select this option to install this folder in target environment even if the parent folder is not present.

  • Do not install folder: Select this option if you do not want to install the folder, as the parent folder is not present in the target environment.

• Folder exists: Select this property to take appropriate action when the folder in the package is present in the target environment.

  • Do not install folder: Select this option if you do not want to overwrite the existing folder in the target environment with the folder in the package.

  • Install to overwrite existing folder: Select this option to overwrite the existing folder in the target environment with the folder in the package. A backup of the existing folder is taken before overwriting the folder.

    If this option is selected and if the folder in the package is present in the target environment, only then the Parent item is not present option is considered.

Update

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

• Parent folder is not present: Select this property to take appropriate action when the parent folder is not present in the target environment.

  • Update folder: Select this option to update the folder in target environment even if the parent folder is not present.

  • Do not update folder: Select this option if you do not want to update the folder, as the parent folder is not present in the target environment.

• Folder exists: Use this property to take appropriate action when the folder being packaged is present in the target environment.

  • Do not install folder: Select this option if you do not want to overwrite the existing folder in the target environment with the folder in the package.

  • Install to overwrite existing folder: Select this option to overwrite the existing folder in the target environment with the folder in the package. A backup of the existing folder is taken before overwriting the folder.

    If this option is selected and if the folder in the package is present in the target environment, only then the Parent item is not present option is considered.

Installation and Update Scenarios

Consider that the folder to be packaged is "Folder X", which is available under "Folder A" in the source environment. The target environment contains "Folder X", which is available under "Folder B". However, "Folder A" does not exist in the target environment.

• Scenario 1: While adding "Folder X" to the package template, if the value for the Include Associated Artifact option is set as Yes, then "Folder X" will be added along with "Folder A", to the package template. If the Install to overwrite existing folder option is selected, then the following changes take place in the target environment, after the package is installed or updated:

  • "Folder A" is installed

  • "Folder X" is overwritten and moved from "Folder B" to "Folder A".

• Scenario 2: While adding "Folder X" to the package template, if the value for the Include Associated Artifact option is set as No, then only "Folder X" will be added to the package template. If the Install to overwrite existing folder option and the Install folder option under Parent item is not present option are selected, then after the package is installed or updated, "Folder X" is overwritten and moved from "Folder B" to the root level.

Uninstall

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

• Delete folder: Select this property to decide if you want to delete the folder or retain it when uninstalling the package.

  • Yes: Select this option to delete this folder after uninstalling the package.

  • No: Select this option to retain this folder after uninstalling the package.

• If folder modified after installation: Select this option to retain, rollback to original state, or delete the Navigation List Folder in the target environment. This property is displayed only if Delete folder is set to Yes. However, if Delete Folder is set to No, this property is not displayed.

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

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

    If this option is selected, then the following changes take place in the target environment:

    • The folder definition is rolled back to the definition that was available before the installation.

    • The folder will not be rolled back to its original location. However, if you want to roll back the folder to its original location, use the Organize option from the Ribbon bar.

  • Delete: Select this option to delete the Navigation List Folder definition from the target environment.

Associated Artifacts of Folder

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

Folder can include the following associated artifacts:

• Parent Folder

• Parent ListItem

Child Artifacts of Folder

The Child Artifacts tab displays all the child artifacts of the selected folder.

Folder can include the following child artifacts:

• Child Folder

• Child ListItem

Include Child Item

For more information, see Include Child Item.

Security Artifacts of Folder

The Security Artifacts tab displays all the security artifacts of the selected folder.

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