Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

TABLE OF CONTENTS

Event Associations of Type System Platform Events

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedApr 15, 2024
  • 6 minute read

You can package and deploy the Event Associations of type System Platform Events along with workflow and its associations, from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.

Consider the following scenario where:

  • An environment is set up with System Platform and AVEVA Work Tasks.

  • A WorkflowGateway object is configured and the repository is provisioned.

  • An object in System Platform has an event and this event is associated with a workflow in AVEVA Work Tasks.

When this System Platform event is triggered, the associated workflow is executed.

To make the above scenario work in the target environment, perform the following in the source and target environments.

Source Environment

  • Export the object and its dependent objects from System Platform.

  • Package the Workflow with System Platform Events in AVEVA Work Tasks , and then export the package.

Target Environment

  • Import the object and its dependent objects to System Platform.

Note:
- Ensure that the WorkflowGateway object name is same in the target environment.
- You can map multiple event associations for the same workflow. If you package workflows with multiple System Platform Event Associations and install this package in the target environment, then only the first event association mapping will be retained. You have to manually map all the other event associations for the same workflow after the package is installed.

  • Import the package to AVEVA Work Tasks and then install the package.

    For more information about importing a package, see Importing a Package.

Add Event Associations of type System Platform Events to Package Template

To package Event Associations through Workflows

  1. Log on to the Enterprise Console.

  2. In the Enterprise Console, click the Menu button, and then click Workflows. The Workflows window appears.

  3. Right-click the workflow, and then click Add to Package Template. The Add to Package Template dialog box appears.

  4. In the Include Associated Artifacts section, select Yes.

  5. Click Save Template.

    The System Platform events along with the workflow are included in the package.

To package Workflows through Event Association

  1. Log on to the Enterprise Console.

  2. In the Enterprise Console, click the Menu button, and then click Workflows. The Workflows window appears.

  3. Select a Workflow with an event association of type System Platform Events.

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

  5. Right-click Event Associations of type System Platform Events 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.

    Runtime Initialization Settings

    You can configure runtime initialization settings for Event Associations of type System Platform Events. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

    Configuration Settings for Event Associations of type System Platform Events

    The Event Associations of type System Platform have 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 Event Association of type System Platform Events definition. The Child Artifacts tab displays child artifacts of the Event Association of type System Platform Events definition.

    The Package Template configuration window contains the following tabs:

    • Settings

      • Install

      • Update

      • Uninstall

    • Associated Artifacts

    • Security Artifacts

    Settings Tab

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

    Behavior of Event Associations of type System Platform Events while installing, updating or uninstalling the package:

    • You cannot overwrite an already existing item.

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

    Install

    You can use the settings in this tab while installing the package.

    • The following event association details are displayed:

      • Type: The type of event. In this scenario, the type is displayed as ArchestrA.

      • Define in Object: The System Platform object to which this event is associated.

      • Event: The name of the event.

      • Workflow: The workflow associated to the event.

    • Workflow Version: This displays the version of Workflow to which Event Association of type System Platform Events is mapped in the Source environment. It also allows you to specify the version of Workflow to which Event Association of type System Platform should be mapped in the Target environment.

      • Source: Displays the version of Workflow in the source environment to which the Event Association of type System Platform Events 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 System Platform Events 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.

        Note:
        - 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 System Platform Events will be installed and mapped to the latest version of the workflow.

    • Galaxy Configuration Settings: This displays the galaxy configuration settings in the Source environment and it also allows you to specify the galaxy configuration settings of the Event Association of type System Platform Events in the target environment.

      • Unique Environment Name

        • Source: Displays the unique environment name in the source environment.

        • Target: Enter or select the unique environment name in the target environment.

      • Galaxy Name

        • Source: Displays the galaxy name in the source environment.

        • Target: Select the galaxy name in the target environment.

    Update

    You can refer to the settings in this tab when you install the same Package 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 to install the Event Association if it is not present in the target environment.

        Note: The settings configured in the Workflow Version and Galaxy Configuration Settings grids are common for the Install and Update tabs.

    Uninstall

    You can refer to the settings in this tab when you uninstall the Package from the target environment.

    • Delete Event Association: This property allows you to retain or delete the Event Association of the type System Platform Events 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.

    Note: You cannot uninstall individual versions, when uninstalling a package. All the versions will be uninstalled and a message is logged for every single version that is uninstalled.

    Associated Artifacts Tab

    The Associated Artifacts tab displays all the associated artifacts of the selected Event Associations of type System Platform Events definition.

    Event Associations of type System Platform Events has the following associated artifacts: Workflow

    Child Artifacts Tab

    Event Associations of type System Platform Events does not have any child artifact.

    Security Artifacts Tab

    The Security Artifacts tab displays the security artifacts of an Event Associations of type System Platform Events, if any.

    You can enable the security settings of the Event Associations of type System Platform Events that you want to include in the package.
    For more information about including security artifacts, see Include Security Artifacts.

    In This Topic
    Related Links
    TitleResults for “How to create a CRG?”Also Available in