Event Associations of Type Enterprise Console

You can package and deploy the Event Associations of type Enterprise Console and its associated artifacts from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.

To add Event Associations of Type Enterprise Console to Package Template

1. Log on to the Enterprise Console.

2. On the Enterprise Console menu, click Workflows. The Workflows window appears.

3. Select a Workflow with an event association of type enterprise console associated to it.

4. Right-click the workflow, and then select View Association. All associations of the selected workflow appears.

5. Right-click Event Associations of type enterprise console 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.

Note: If you create an Event Association of type Enterprise Console for a dynamic list item and if you delete the list item, then you cannot add the Enterprise Console Event Association to the package template.

Package Template Tree View

In the Package Template tree view, the Event Association of type Enterprise Console appears in the following format:

Format in the tree view in case of List level

<Workflow Name_EC_Event Name_Type_List Name>

Here,

Workflow Name: Name of the workflow to which the Enterprise Console event is associated

EC: Name of the Event Provider, in this case it is the Enterprise Console

Event Names: On Create, On Delete, On Publish, On Unpublish, and On Version Change

Type: List

List Name: Name of the list which is associated to the workflow

The same information is also seen in the Configuration Settings.

Format in the tree view in case of List item level

<Workflow Name_EC_Event Name_Type_List Name_List item Name/Unique Values>

Here,

Workflow Name: Name of the workflow to which the Enterprise Console event is associated

EC: Name of the Event Provider, in this case it is the Enterprise Console

Event Names: On Create, On Delete, On Publish, On Unpublish, and On Version Change

Type: List or List Item.

List Name: Name of the list in which the associated list item is present

List Item Name/Unique Values: Default value of the list item or the Unique field values of the list items. If the list item has multiple unique values defined, then each of the value is displayed separated by (_).

The same information is also seen in the Configuration Settings.

Associated Artifacts for Event Associations of Type Enterprise Console

Event Associations of type Enterprise Console has the following associated artifacts:

• Workflow

• Dynamic List (if the dynamic list is selected as the list name while creating Enterprise Console Event Association. Users list is also considered as a dynamic list.)

In case of Enterprise Console Event Association of list item level, along with the above two associated artifact, the following additional artifacts are identified:

• List items of the Standard list

• List item of Dynamic list (these items will not be listed as an individual artifact in the package template tree view)

Dynamic List item which is associated to Enterprise Console at list item level Event Association will not appear in the Package template as an individual artifact  even though it is identified as an associated artifact for the Event Association. However, the same will be listed in the Associated Artifacts tab as an associated artifact of Enterprise Console at list item level  Event Association. This occurs since Dynamic list item is not a packageable artifact. Therefore, to install Enterprise Console at list item level Event Association, the dynamic list item should be available in the target environment.

Enterprise Console Event Association at list item level, will package the following items if "include associated artifacts" is set to true in package template:

• DB connection or Connection List

• Lookup list

• Forms Data Grid View

• Grid Configuration

• Form Controls

• Navigation details

• DB connection

• Lookup list

• List Views

• Forms List

• Security Right

• Security Group

Enterprise Console Event Association package will identify the items of following lists as associated artifacts and will not add to package template. However, in target if the item with the same title or default field value is available in the same list, then event association will be installed by mapping to the identified list item.

• Manage Package

• Package Template

• Initiate form

• List-Form Association List

Enterprise Console Event association package is not supported for the following list items:

• Deleted Items

• Event Providers

• Security Group Resource mapping

• Event Association

Child Artifacts for Event Associations of Type Enterprise Console

Event Associations of type Enterprise Console does not have any child artifact.

Security Artifacts for Event Associations of Type Enterprise Console

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

Configuration settings for Event Associations of Type Enterprise Console

The Event Associations of type Enterprise Console 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 to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Event Association of type Enterprise Console definition. The Child Artifacts tab displays child artifacts of the Event Association of type  Enterprise Console definition.

The Package Template configuration window contains the following tabs:

• Settings

  • Install

  • Update

  • Uninstall

• Associated Artifacts

• Security Artifacts

Settings Tab

The properties in this tab allows you to take appropriate actions while installing, updating, or uninstalling the Package.

Behavior of Event Associations of type Enterprise Console while installing, updating or uninstalling the package:

• You cannot overwrite an already existing item.

• You can delete or uninstall an Event Associations of type Enterprise Console only if it was installed by the Package.

Install

The settings in this tab is referred to when installing the Package. When installing the package, if the Event Enterprise Console dates are invalid, then the package will not be installed. Edit the dates and install the package.

• Workflow Version: This displays the version of the Workflow to which Event Association of type Enterprise Console is mapped in the Source environment and it also allows you to specify the version of Workflow to which Event Association of type Enterprise Console should be mapped in the Target environment.

  Source: Displays the version of Workflow in the source environment to which the Event Association of type Enterprise Console is mapped.

  Target: Enter the version of the workflow.

  • Specify the version of the Workflow to which you want to map the Event Association of type Enterprise Console in target environment.

  • If you do not specify the Workflow version in the Target environment, the Workflow version from the Source environment will be considered while installing the package.

  If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is not present in the target environment, then the Event Association will not be installed.

  If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is in Draft status, then the Event Association of type Enterprise Console will be installed and mapped to the latest version of the workflow.

• Enterprise Console Event Association Settings: This displays the settings of the Event Association of type Enterprise Console in the Source environment and it also allows you to specify the settings of the Event Association of type Enterprise Console in the Target environment.

  Source

  • Effective From: Displays the date from when the Event should be triggered in the source environment.

  • Effective To: Displays the date till when the Event should be triggered in the source environment.

  Target

  • Effective From: Select the date from when the Event should be triggered in the target environment.

    If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

  • Effective To: Select the date till when the Event should be triggered in the target environment.

    If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

Note: Ensure that you follow the following guidelines while packaging the Event Associations of type Enterprise Console in the target environment:

• Effective From and Effective To should be in a valid format.

• Effective From should be less than or equal to Effective To respectively.

• Effective To should be greater than or equal to current date.

• Effective From and Effective To can be 'Null'. However, you cannot have either one of them as 'Null'.

If you want to leave the dates as blank, then enter Null in the Effective From and Effective To fields in the Target section.

Update

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

• Delete Event Association: Select this option to delete the Event Association that is present in the target environment.

  • Yes: Select this option to remove the Event Association in the target environment.

  • No: Select this option to retain the Event Association in the target environment, or install the Event Association if it is not present in the target environment.

• Workflow Version: This displays the version of Workflow to which Event Association of type Enterprise Console is mapped in the Source environment and it also allows you to specify the version of Workflow to which Event Association of type Enterprise Console should be mapped in the Target environment:

  Source: Displays the version of Workflow in the source environment to which the Event Association of type Enterprise Console is mapped.

  Target: Enter the version of the workflow:

  • Specify the version of the Workflow to which you want to map the Event Association of type Enterprise Console in target environment.

  • If you do not specify the Workflow version in the Target environment, the Workflow version from the Source environment will be considered while installing the package.

    If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is not present in the target environment, then the Event Association will not be installed.

    If the version of the workflow that is considered while installing the package (based on the two conditions specified above) is in Draft status, then the Event Association of type Enterprise Console will be installed and mapped to the latest version of the workflow.

• Enterprise Console Event Association Settings: This displays the settings of the Event Association of the type Enterprise Console in the Source environment and also allows you to specify the settings of the Event Association of the type Enterprise Console in the Target environment while updating the Package.

  Source

  • Effective From: Displays the date from when the Event should be triggered in the source environment.

  • Effective To: Displays the date till when the Event should be triggered in the source environment.

    Target

  • Effective From: Update the date from when the Event should be triggered in the target environment.

    If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

  • Effective To: Update the date till when the Event should be triggered in the target environment.

    If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.

Uninstall

This settings in this tab is referred to when the Package is being uninstalled in the target environment.

• Delete Event Association: This property allows you to retain or delete the Event Association of the type Enterprise Console in the target environment even after the Package is uninstalled.

  • Yes: Select this option to delete the Event Association from the target environment when the Package is uninstalled.

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

Click Save Event Association Settings.

Associated Artifacts Tab

The Associated Artifacts tab displays all the associated artifacts of the selected Event Associations of type Enterprise Console definition.

Child Artifacts Tab

Event Associations of type Enterprise Console does not have any child artifact.

Security Artifacts Tab

The Security Artifacts tab displays the security artifacts of an Event Associations of type Enterprise Console, if any.