Manage List

You can package and deploy the Manage List along with its associated artifacts and child artifacts from one environment or repository to another environment or repository. After installation, ensure that you refresh the Enterprise Console site to add list items to the installed list.

When you package a Manage List, the list items get added to the package. However, while packaging a folder containing list items, the Description of the folder does not get packaged.

To add Manage List to Package Template

1. Log on to the Enterprise Console.

2. In the Enterprise Console, click menu icon, click Tools, and then click Manage List.

   The Manage List window appears.

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

4. Right-click the manage list artifact 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 the Manage List 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 Manage List package in the Settings form on the right side of the Add to Package Template window.

5. Configure the required settings.

6. Click Save Template to save the configured settings.

Configuration Settings for Manage List

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

Settings

You can define the configuration settings of the Manage List 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.

• Manage List exists: Use this property take appropriate action when the Manage List definition present in the package is already present in the target environment.

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

  • Do not install Manage List: Select this option to use the Manage List definition that is present in the target environment.

• Associated artifacts not present: Use this property to take appropriate action when the associated artifacts of the Manage List definitions are not present in the target environment.

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

  • Do not install Manage List: Select this option to install the Manage List definition as its associated artifacts are not present.

• Install all List items: Use this property to take appropriate action when list items are included in the package.

  • Yes: Select this option to install the list items of Manage List.

  • No: Select this option if you do not want to install the list items of Manage List.

    Note: The default value is No. However, if you want to package list items, select Yes, and then generate and export the package.

• SQL script: When a Manage List contains an existing custom list, while adding the Manage List to the package template, a script is generated and populated in the SQL script text area. While installing the package in the target environment, the SQL script is run first and then the package is installed.

  The auto-generated script contains the the following:

  • Table structure, with field name, data types, and their order

  • Keys - primary key and foreign key

  • Constraints - default or check, and so on

  • Index

  • Child list and all the previously mentioned related scripts

    The following points are not considered while generating the SQL script:

  • User defined types

  • Table partitioning

  • Parent list

  • Views

  • Triggers

  • Functions

  • Synonyms

    If you need any of the unsupported objects, then you can choose to do one of the following:

  • Write and run the script manually in SQL Server

  • Write and append the script to the SQL script text area

    The auto-generated script contains a pre-condition statement which checks for the existing tables in the target environment. If the table exists in the target environment, the SQL script does not run. If the table does not exist in the target environment, the SQL script runs and creates the table, and adds the keys, index, constraints as defined in the source environment.

    Ensure that the object names used in the source repository does not conflict with the destination repository. If any of the objects (name of a table, key, constraint, or index) exists in the target environment, then the script execution will fail. This will be recorded in Package History page after the package installation.

    Similar scripts are also generated for all the child list items of the existing custom list. However, if a child list is being packaged, the SQL script will be generated only for that list and its child items. No SQL script will be generated for the parent of the current list item being packaged.

    As the script is auto-generated, we recommend not to modify the script. If you want to add your own piece of code sample to the script, you can either add it at the start of the script or append it to the end of the script. Do not add or edit the existing script.

Note:

- If the list exists in the target environment, the list items will not be installed.

- In the case of List items, ensure that the Table schema in the List matches in the target environment before you install the Manage List package to the target environment. If you install the Manage List package in the target environment without matching the schema, the package will install the List with the following warning:

You cannot create the list items. Either the Table schema is missing or not matching. Verify your Database.

Besides this, you might also get the same warning if you use a repository which is a case-sensitive database and the queries or 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 Schema details in the target environment.

- When you select the Include the automatically generated SQL Script option as Yes while adding the Manage List 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.

See Also: SQL Script Generation and Execution

Update

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

• Delete Manage List: Use this property to delete or retain an existing Manage List definition that is present in the target environment.

  • Yes: Select this option to remove the Manage List definition in the target environment.

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

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

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

    • Delete: Select this option to delete the Manage List definition from the target environment when updating the package.

  • No: Select this option if you want to retain the Manage List definition in the target environment.

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

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

    • Do not update Manage List: Select this option to overwrite the Manage List definition that is present in the target environment with the one present in the package.

      Associated artifacts not present: Use this option to take appropriate action if associated artifact is not present in the target environment.

    • Update Manage List: Select this option to update the Manage List definition.

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

Note:

- Update and uninstall of list items is not supported.

- While updating a list item through package updation, if you overwrite the schema of the existing list in the target environment through package, the existing list items will get corrupted.

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

Uninstall

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

• Delete Manage List: Use this property to decide if you want to retain or delete the Manage List definition in the target environment even after the package is uninstalled.

  • Yes: Select this option to remove the Manage List definition from the target environment when the package is uninstalled

  • No: Select this option to retain the Manage List definition in the target environment even after the package is uninstalled

• Manage List is modified: Use this property to retain, rollback to original state, or delete the Manage List definition in the target environment even after the package is uninstalled. This property is displayed only if Delete Manage List  is set to Yes. However, if Delete Manage List is set to No, this property is not displayed.

  • Retain: Select this option to retain the Manage List definition along with the modifications in the target environment even after the package is uninstalled.

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

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

Associated Artifacts of Manage List

The Associated Artifacts tab displays all the associated artifacts of the selected Manage List definition.

Manage List can include the following Associated Artifacts:

• Parent Folder

• Lookup

• Form

• Attachments. You can have n number of attachments.

Child Artifacts of Manage List

The Child Artifacts tab displays all the child artifacts of the Manage List definition.

Manage List can include the following child artifacts:

• Folder

• Child Manage List

Include Child Item

For more information, see Include Child Item.

Security Artifacts of Manage List

The Security Artifacts tab displays the security artifacts of a manage list definition, if any. You can enable the security settings of the manage list that you want to include in the package.

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

Note:

- Manual uninstallation of forms may be required when uninstalling packages in certain scenarios. For example, a package with a form associated to a generic list is created in the source repository and then installed, reinstalled, and uninstalled from the target repository as follows:

Installation: Package is imported and installed. The associated form (version 1) and the generic list (version 1) are created.

Reinstallation: Same package is installed again with the default settings. The next minor version of the associated form (version 1.1) is created but the list (version 1) is not overwritten.

Uninstallation: Package is uninstalled. The minor version of the associated form (version 1.1) and the generic list (version 1) are removed but the previously associated version of the form (version 1) is retained.

- For a custom Manage List definition packaged with particular Manage List item types and installed, while uninstalling only the list items installed through the package will be uninstalled. Any list item created for the Manage List after installing the package will not be uninstalled during package uninstallation.

- Along with a Manage List containing User Lookup, the list items will be packaged and installed in the target environment. The user lookup field will be blank in case the user provider in target environment does not match the user provider in the source environment. For example, if you select a user in user lookup from active directory provider and install in the target repository with AVEVA Work Tasks list provider, the List items will be installed , but the user lookup field will remain blank. In this case, if the user lookup field is mandatory, the list item will not be installed as it cannot be left blank.

- Update and uninstall for List items are not supported through package. During uninstall, the Manage List even though marked for deletion will not be deleted as List items cannot be deleted through package.