Work Item Field

You can package and deploy the Work Item Field from one environment or repository to another environment or repository using the package feature in AVEVA Work Tasks.

To add Work Item Field to Package Template

1. In the Process Designer for Workflow window, point to Settings, and then click Work Item Fields.
   The Work Item Field dialog box appears.

2. Right-click the work item field 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.

The naming convention of the Work Item Field at workflow level is Work Item Field name(Workflow name).

If you change an existing Work Item Field that is already added to the package template, you can rebuild the data in the package template.

To configure settings for Work Item Field

The Work Item Field 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 Work Item Field definition. The Child Artifacts tab displays child artifacts of the Work Item Field 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

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

• Work Item Field Exists: This property allows you to take appropriate action when the Work Item Field to be installed is present in the target environment.

  • Do not Install Work Item Field: Select this option if you want to use the Work Item Field which is present in the target environment.

  • Install to overwrite existing Work Item Field: Select this option if you want to overwrite the Work Item Field is present in the target environment with the one that you packaged.

• Associated Artifacts Not Present: This property allows you to take appropriate action when the associated artifacts of the Work Item Field is not present in the target environment.

  • Install Work Item Field: Select this option if you want to install the Work Item Field even if the associated artifacts are not present in the target environment.

  • Do not install Work Item Field: Select this option if you do not want to install the Work Item Field 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 Work Item Field: Select this option if you want to delete the Work Item Field that is present in the target environment.

  • Yes: Select this option to remove the Work Item Field in the target environment. On selection of this option, the Work Item Field Is Modified property appears.

    Work Item Field is modified: Use this property to retain or delete the Work Item in the target environment even after the package is uninstalled. This property is applicable only if Delete Work Item Field is set to Yes and the Work Item Filed is modified.

    • Retain: Select this option if you want to retain the Work Item Field along with the modifications, in the target environment even after the package is updated.

    • Rollback to Original State: Select this option if you want to roll back to the original state. All modifications that were done to the Work Item Field after it was installed in the target environment will be reverted. However, the Work Item Field will be retained in the target environment.

    • Delete: Select this option if you want to delete the Work Item Field from the target environment when updating the package.

  • No: Select this option if you want to retain the Work Item Field in the target environment. On selection of this option, the Work Item Field Exists option appears.

    Work Item Field Exists: Use this property to take appropriate action when the Work Item Field definition specified in the package is already present in the target environment.

    • Do not Install Work Item Field: Select this option if you want to use the Work Item Field that is present in the target environment.

    • Install to overwrite existing Work Item Field: Select this option if you want to overwrite the Work Item Field that is present in the target environment with the one present in the package.

      Associated Artifacts Not Present: This property allows you to take appropriate action when the associated artifacts of the Work Item Field is not present in the target environment.

    • Install Work Item Field: Select this option if you want to update the Work Item Field even if the associated artifacts are not present in the target environment.

    • Do not install Work Item Field: Select this option if you do not want to update the Work Item Field as its associated artifacts are not present.

Uninstall

You can refer to the following settings in the Uninstall tab to uninstall a Work Item Field:

• Delete Work Item Field: You can use this property to decide if you want to retain or delete the Work Item Field in the target environment after you uninstall the package.

  • Yes: Select this option if you want to delete the Work Item Field from the target environment while uninstalling the package.

  • No: Select this option if you want to retain the Work Item Field in the target environment after uninstalling the package.

• Work Item Field Is Modified: You can use this property to decide if you want to retain, roll back, or delete the Work Item Field in the target environment after uninstalling the package. This property is displayed only if Delete Work Item Field is set to Yes. However, if Delete Work Item Field is set to No, this property is not displayed.

  • Retain: Select this option if you want to retain the Work Item Field with the modifications in the target environment after uninstalling the package.

  • Rollback to original State: Select this option if you want to roll back to the original state. All modifications that were done to the Work Item Field after it installation in the target environment will be reverted. However, the Work Item Field will be retained in the target environment.

  • Delete: Select this option if you want to delete the Work Item Field from the target environment when uninstalling the package.

Associated Artifacts tab

The Associated Artifacts tab displays all the associated artifacts of the selected Work Item Field.

The Work Item Field can have the following associated artifacts:

• Workflow
  
  The Work Item Field at workflow level considers the workflow as an associated artifact. When you package the Work Item field, the associated workflow cannot be packaged as the workflow is in draft state. You must manually package the workflow, install the workflow in target, and then install the Work Item Field.

Child Artifacts tab

Work Item Field does not have any child artifact.

 

Note: If the Workflow is already added to the package, it automatically takes the Work Item Field. So before installing the package, it is recommended to add the Work Item Field to the package before adding the Workflow.