Security Group - Repository Level

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

To add Repository Level Security Group to Package Template

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

1. Log on to the Enterprise Console.

2. Click Repository Settings.
   The Repository Settings window appears.

3. On the Advanced Settings tab, click Manage Security Groups.

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

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

Associated Artifacts for Security Group Definition

The Security Group at repository level can have the following associated artifacts:

• Workflow

• Form Link

Child Artifacts for Security Group Definition

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

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

Install

You can refer to the configuration settings in the Install tab to install 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: This property allows you 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

You can refer to the settings in this tab to install the same package 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 Yes to remove the Security Group definition in the target environment. When you select Yes, the Security Group is Modified and Resource Mapping is Identified options appear.

  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.

  Resource Mapping is Identified

  • Retain: Select this option to retain the Resource Mapping definition in the target environment when updating the Package.

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

• No: Select No if you want to retain the Security Group definition in the target environment.
  When you select No, 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 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 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 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: Select this property to retain or delete the Security Group definition in the target environment even after the Package is uninstalled.

  • Yes: Select Yes to remove the Security Group definition from the target environment when the Package is uninstalled. When you select Yes, the Security Group is Modified and Resource Mapping is Identified options appear:

    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 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 uninstalling the Package.

      Resource Mapping is Identified

    • Retain: Select this option to retain the Resource Mapping definition in the target environment when uninstalling the Package.

    • Delete: Select this option to delete the Resource Mapping definition from the target environment when uninstalling the Package.

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

When you select Yes in the Delete Security Group option while doing the Update or Uninstall, the following scenarios are possible:

Associated Artifacts Tab

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

If a form link with the same name is present in the target environment and it is not overwritten, then the security right might not work as expected if the form link in the target environment is of a different type and different mode.

Child Artifacts Tab

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