Form Controls

You can package and deploy the Form Controls 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 Form Controls to Package Template

1. Log on to the Enterprise Console.

2. In the Enterprise Console, click menu icon, click Tools, and then click Form Controls.

   The Form Controls window appears.

3. Select the Form Controls that you want to package.

4. Right-click the form controls 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.

Runtime Initialization Settings

You can configure runtime initialization settings for form controls registered through GAC. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

Configuration settings for Form Controls

The Form Controls 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 window

• Target Environment > Manage Package window

You can use the Settings tab to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Form Controls definition. The Child Artifacts tab displays child artifacts of the Form Controls definition.

The Package Template configuration window contains the following tabs:

• Settings

  • Install

  • Update

  • Uninstall

• Associated Artifacts

• Child Artifacts

• Security Artifacts

Settings Tab

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

Install

The settings in this tab are referred to when installing the Package.

• Form Control exists: Select this property to take appropriate action when the Form Controls which is installed is present in the target environment

  • Do not install Form Control: Select this option to use the Form Controls which is present in the target environment

  • Install to overwrite existing Form Control: Select this option to overwrite the Forms Control which is present in the target environment with the one that is currently being packaged

• Associated artifacts not present: Select this property to take appropriate action when the associated artifacts of the Form Control is not present in the target environment.

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

  • Do not install Form Control: Select this option if you do not want to install the Forms Control 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 Form Control: Select this option to delete the Forms Control which is present in the target environment

  • Yes: Select this option to remove the Form Controls in the target environment. On selection of this option, the Form Control Is Modified option appears.

    Form Control Is Modified: Select this option to retain, roll back to original state, or delete the Forms Control in the target environment even after the Package is updated. This property is applicable only if Delete Forms Control is set to Yes and if the Form Control is modified.

    • Retain: Select this option to retain the Forms Control 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 Forms Control after it was installed in the target environment will be reverted. However, the Forms Control will be retained in the target environment.

    • Delete: Select this option to delete the Forms Control from the target environment when updating the Package.

  • No: Select this option to retain the Form Control in the target environment. On selection of this option, the Form Control Exists option appears.

    Form Control exists: Select this property to take appropriate action when the Form Control definition present in the package is already present in the target environment.

    • Do not install Form Control: Select this option to use the Forms Control which is present in the target environment.

    • Install to overwrite existing Form Control: Select this option to overwrite the Forms Control, which is present in the target environment with the one that is currently being packaged.

      Associated artifacts not present: Select this property to take appropriate action when the associated artifacts of the Form Control are not present in the target environment.

    • Update Form Control: Select this option to update the Forms Control.

    • Do not update Form Control: Select this option if you do not want to update the Forms Control as the 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 Form Control: Select this property to retain or delete the Forms Control in the target environment even after the Package is uninstalled.

  • Yes: Select this option to remove the Forms Control from the target environment when the Package is uninstalled.

  • No: Select this option to retain the Forms Control in the target environment even after the Package is uninstalled.

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

  • Retain: Select this option to retain the Forms Control 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 Forms Control after it was installed in the target environment will be reverted. However, the Forms Control will be retained in the target environment.

  • Delete: Select this option to delete the Forms Control from the target environment when uninstalling the Package.

Associated Artifacts for Form Controls

This tab displays all the associated artifacts of the selected Form Controls artifact.

The following artifact can appear as an Associated Artifact, if you are using any one of the following artifacts while designing the Forms Control:

• SOA Folder

Child Artifacts for Form Controls

Form Controls does not have any child artifact.

Security Artifacts for Form Controls

The Security Artifacts tab displays the security artifacts of form controls, if any.

You can enable the security settings of the form controls that you want to include in the package.

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

Note: If a Form Control is consumed inside a form, you cannot modify or delete the Form Control. To modify or delete the Form Control, you have to first modify or delete all its associated artifacts.