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

Wait for Event Activity

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 23, 2023
  • 7 minute read

Activity Description

The Wait for Event Activity is used to wait for list events and list item events like creating workflows, publishing workflows, creating users etc. This activity waits for one or more event and once the event is triggered, the workflow proceeds. When the activity is waiting for an event it can be paused,resumed or killed through process execution view.

Activity Properties

The Wait for Event activity has to be configured by specifying appropriate values for the different properties in the Activity Properties area. The Activity Properties can be accessed by clicking the Activity Properties tool in the tool bar or by selecting the appropriate option from the right-click menu for the Wait for Event activity. The Activity Properties are organized under the following groups of related properties. The properties under each group are described in this topic.

Name & Description

The properties in the Name & Description group have been described below. You can use these properties to specify the name and description for the activity.

Name - This property can be used to specify a name for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Description - This property specifies a brief description to be displayed for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Display Name - This property specifies the name to be displayed for the activity.

Property Type: Optional (This property need not be set if the display name is already configured in the Actions.xml. The name entered here overrides any display name that is configured for this activity in the Actions.xml file.)

Configuration

The properties in the Configuration group have been described below. You can use these properties to configure the functionality of the activity.

Event Scope - This property is used to select the scope to which event association is required. Available options are - List and ListItem.

Property Type: Mandatory

Event Scope Explanation:

  1. List: Select this scope option only when List Id is required.

  2. List Item: Select this scope option when List Id and Listitem Id is required.

Steps to select the Event Scope property

  1. Select scope from the Event Scope drop-down list.

  2. If you select List as event scope, then you need to specify only list name.

  3. If you select ListItem as event scope, then you need to specify list name and list item under the list.

  4. Click Save in the Activity Properties window.

    Event Type - This property is used to select the event type. Items should change depending on Event Scope property selection.

    Property Type: Mandatory

    If you select Event Scope property as List, then the following are the available event types:

    If you select Event Scope property as ListItem, then the following are the available event types:

    The options shown for Event type are dependent on Event Scope property selection.

    Note:

    The following Event types are not supported:

    • OnSaveAsNextVersion

    • OnSaveAsNextMajorVersion

    • OnSaveAsNextMinorVersion

    • OnSaveAsSpecificVersion

    Steps for selecting Event Type property

    1. Select event type from the Event Type drop-down list.

    2. Click Save in the Activity Properties window.

      List ID - This property is for taking list name or list item to which the event to be associated and waited. List ID property window displays the items depending on the Event Scope property selection. If you select Event Scope property as 'List', then the List ID property window will ask only List name to select. If you select Event Scope property as 'ListItem', then the List ID property window will ask List name as well as ListItem name.

      Property Type: Mandatory

      Note: The options shown for List ID are dependent on Event Scope property selection.

      Steps to set the List ID property

      1. To select the List ID property, click the edit button for the 'List ID' property to open the property window.

      2. If you select List as event scope, then select list name from the List Name drop-down list.

      3. If you select ListItem as event scope, select list name from the List Name drop-down list and select list item from the ListItem drop-down list.

      4. Click Save in the Activity Properties window.

        See Wait for Event: List ID for a detailed description of the List ID property window.

        List Item ID - This property displays the list item id which was selected in List ID property.

        Note: List Item ID are dependent on Event Scope property selection.

        No of Events - This property is used to execute the wait for event activity by specified number of events. If you specified No Of Events as '0' then this activity will wait for 'n' number of times. If you specified No Of Events as '4' then this activity will wait for four times and next time it will not wait for the event.

        Property Type: Optional

        Steps for specifying No Of Events property

        To select the No Of Events property, click the edit button for the 'No Of Events' property to open the property window.

        1. You can directly type in the text editor.

        2. Or you can specify the No of Events by using field controls and then click Append.

        3. Click Update.

        4. Click Save in the Activity Properties window.

          See Wait for Event for a detailed description of the No Of Events property window.

          Effective From - This property is used to specify the effective from date for the association, i.e the date starting from which the activity will wait for the events. If left blank, the activity will wait for events starting from the day the association is created.

          Property Type: Optional

          Steps to set Effective From property

          1. To select the Effective From property, click the edit button for the Effective Form property to open the property window.

          2. You can directly type in the text editor, or you can specify the date by using field controls and then click Append.

          3. Click Update.

          4. Click Save in the Activity Properties window.

            See Wait for Event: Effective From From for a detailed description of the Effective From window.

            Effective To - This property is used to set the Effective To Date. Enter the effective to date for the association, i.e the date till which the activity will wait for the events. If left blank, it will be wait till the activity is paused/killed or the workflow is aborted.

            Property Type: Optional

            Steps to set Effective To property

            1. To select the Effective To property, click the edit button for the Effective To property to open the property window.

            2. You can directly type in the text editor, or you can specify the date by using field controls and then click Append.

            3. Click Update.

            4. Click Save in the Activity Properties window.

              See Wait for Event: Effective To for a detailed description of the Effective To window.

              Output Values

              Event XML Data Variable. - This property is used to capture the Output details of the wait for event activity.

              Property Type: Optional (This property needs to be set only if necessary).

              See Wait for Event: Workflow Event Data XML Variable for details on Event XML Data Variable and the output details.

              Looping Behavior

              The properties in the Looping Behavior group have been described below. You can use these properties to specify the looping Behavior of the activity.

              Loop through this action if output is - This property is used to specify the condition for looping the activity by selecting an activity output from the drop down. Available options are - Event Received and List Item Not Found.

              Property Type: Optional

              If you select Enable Errors Encountered Output property as No, then the following are the available outputs:

              If you select Enable Errors Encountered Output property as Yes, then the following are the available outputs:

              Note: The options shown for Looping through this action if output is are dependent on Enable Errors Encountered Output property selection.

              Activity outputs:

              The Wait For Event Activity returns the following values -

              Event Received: Displayed when the event is received.

              List Item Not Found: Displayed when the list item is not found.

              Error Encountered: Displayed when an error encountered.

              Action Completed: Displayed when no event is received.

              Exception Behavior

              These options of Wonderware Skelta BPM 2009 have now been integrated with Raise Error on Unhandled Linked Output and Exception Email Template Configuration in the latest version of the product.

              Each activity has the Raise Error on Unhandled Linked Output property on click of which, it shows all the default configured mapped error outputs in red with their check boxes selected.

              See Mapped Error Outputs for more details.

              Property Type: Optional (This property needs to be set only if necessary.)

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