Security Group - List Item Level

You can package and deploy the list item level Security Group definition and its associated artifacts from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.

To add List Item Level Security Group to Package Template

Complete the following tasks to add list item level security group definition to package template:

1. Go to the List Item which contains the security group that you want to package. For example, Workflow List.

2. Right-click a list item, and then click Security Settings in the context-menu.
   The security settings window opens.

3. Click Advanced Settings tab.

4. Click Customize Security Group for this List Item.
   The security group list at list item level window appears.

5. Right-click the Security Group that you want to package, and then click Add to Package Template.
   The Add to Package Template dialog box appears with the List Item Level Security Group.

For more information about adding artifacts to Package Template, see Adding Artifacts to a Package Template.

The following shows the tree view format of the list item level security group, for example, Add to Package Template: <Security Group Name - List Item - List Name/List Item Name>:

Associated Artifacts for Security Group Definition

A List Item Level Security Group can have the following Associated Artifacts:

• Repository Level Security Group

• List Specific Custom Security Right

• Workflow

• Form Link

• Dynamic Lists

• Form

• List Item

For information about whether a list item can be packaged or not, see Packageable Artifacts.

If the Security Group at repository level is not available in the target environment, then the security group at list item level will not be installed.

In a dynamic list, you cannot package a list item, but you can package security group of the list item. Thus, when you package the security group of the list item, the dynamic list is identified as the associated artifact of the security group. The list item, however, does not become an associated artifact of the security group. It is recommended that you package the dynamic list and the security group of the list item in two different packages. In this case, when you install the package in target environment, install the package that contains the dynamic list first. Then manually create the list item of the dynamic list, and run the package that contains the security group of the list item.

On the other hand, if you package both the dynamic list and the security group of the dynamic list item in one package, you have to install the package twice. When you install the package for the first time, the dynamic list gets installed, while it cannot install the security group as the list item is not available in the dynamic list. Create the required list item in the dynamic list manually and install the package again.

Child Artifacts for Security Group Definition

A List Item Level Security Group does not have any child artifact.

Security Artifacts for Security Group Definition

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

Configuration Settings for Security Group

The Manage Security Group definition 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

You can use the Settings tab of the Manage Security Group definition artifact to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Manage Security Group definition.

The Package Template configuration window contains the following tabs:

• Settings

  • Install

  • Update

  • Uninstall

• Associated Artifacts

• Child Artifacts

Settings Tab

You can use the properties in the Settings tab to take appropriate actions to install, update, or uninstall a package.

Install

During List Item Level security group installation, the package checks whether the security group customization is enabled at the list item level. If the security group customization is not enabled, then the package first enables the security group customization. Then the package overwrites the security group definition. If the security group customization is already enabled, then the package overwrites the security group.

The configuration settings in the Install tab is referred to when installing the package.

• Security Group Exists: Select this property to take appropriate action when the Security Group definition specified in the package is already present in the target environment.

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

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

    By default, Install to overwrite existing Security Group is selected, since the security group will be available in the target environment and on installing the package it will be overwritten. If the security group is not available in the target environment then prior to installing the package the security group will be enabled, hence the security group will be overwritten.

• Associated Artifacts Not Present: Select this property to take appropriate action when the associated artifacts of the Security Group is not present in the target environment.

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

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

Update

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

• Delete Security Group: Select this option to delete the Security Group definition that is present in the target environment.

  • Yes: Select this option to remove the Security Group definition in the target environment. On selection of this option, the Security Group is Modified option appears:

    Security Group is Modified

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

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

    • Delete: Select this option to delete the Security Group definition from the target environment when updating the Package.

  • No: Select this option to retain the Security Group definition in the target environment. On selection of this option, the Security Group Exists option appears.

    Security Group Exists

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

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

      Associated Artifacts not present

    • Update Security Group: Select this option to update the Security Group definition even though no associated artifacts are present.

    • Do not update Security Group: Select this option if you do not want to update the Security Group definition when the associated artifacts are not present.

Uninstall

You can refer to the following settings in the Uninstall tab to uninstall a package from a target environment:

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

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

    When you select Yes, the Security Group is Modified option appears.

    Security Group is Modified

    • Retain: Select this option to retain the Security Group 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 the Security Group to the original state. All modifications that were done to the Security Group definition after it was installed in the target environment will be reverted. However, the Security Group definition will be retained in the target environment.

    • Delete: Select this option to delete the Security Group definition from the target environment while uninstalling the package.

  • No: Select this option to retain the Security Group definition in the target environment even after the Package is uninstalled.

Remove Security Group Customization at List Item Level

While uninstalling the security group at list item level, the security group artifact checks whether the security group customization is enabled by the current security group artifact.

• If not, then uninstall rolls back the security group definition to the original state, but does not remove the security group customization as it was not enabled by it.

• Otherwise, the security group artifact checks whether any other security group is modified at the list item level.

  • If yes, then uninstall does not remove the security group customization, but rolls back the security group definition to the original state.

  • Otherwise, uninstall removes the security group customization.

• Consider that a custom security group is packaged at list item level and a repository level security group is an associated artifact. While installing, both the security groups are installed. While uninstalling, select the "Delete" option for the repository level security group and "Retain" option for the list item level security group. Then, the list item level security group artifact is uninstalled or retained first, followed by the repository level security group artifact which is deleted while uninstalling. As the repository level security group is deleted, it removes the complete definition of the security group from all the levels.

  • Thus, the list item level security group gets uninstalled, though the delete option is to "Retain" the security group. However, the security group customization is retained.

  • The security group customization cannot be removed by the package, even if you uninstall the package again. So it is advisable to select the "Delete" option for list item level security group. If you select the "Delete" option for repository level security group, irrespective of the option that is selected for list item level security group, the security group as a whole is deleted.

You can package the list item level security group from the following lists:

• Dynamic list with default field

• Dynamic list with unique field

• Reports with duplicate names

• Manage ListViews

• Security Rights with different scopes

Associated Artifacts tab

The Associated Artifacts tab displays all the associated artifacts of the selected Security Group definition.

Child Artifacts tab

The Security Group at List Item level does not have any child artifact.

Security Artifacts

The Security Artifacts tab displays the security artifacts of a database connection, if any.