Workflow and ServiceDesk Community

 View Only
Back to Library

Wait On External Event 

Jun 13, 2012 09:48 AM

Wait On External Event

Component definition

This component pauses the workflow. It then waits for an external event (an event based outside of the component or even in another process). Finally, it continues the workflow after the event finishes.

Component icon

The following screen shot shows the Wait on External Event component icon:

Description of component output paths

Unknown

The component output paths are described in the following table:

Property

Description

External Event Complete

When the external event completes (an End component in the Wait Process model maps to True), this path is followed.

timeout

Unknown

Description of component tabs and their properties

The properties on the General tab in the Wait On External Event component are listed and described in the following table:

Property

Description

Start Process

Lets you build the model for the start process. If a start process is defined, it gets executed first when this component starts.

For example, the start process may email a user to inform them that the process has started, but waits for an external event.

Time Between Checks

Lets you set the amount of time to wait between checking for the external event.

Timeout Path Name

Lets you enter the name of the timeout path

Timeout Type

Lets you select the timeout type

Timeout Type options:

  • Time Span

    Lets you set how long to wait before this component times out.

  • Date

    Lets you set a specific date when the component times out.

Timeout Time Span

Lets you set how long to wait before this component times out (the system becomes unresponsive).

Timeout Date

Lets you set a specific date when the component times out (the system becomes unresponsive).

This option contains a reference to a variable within your Project which holds the date you want your process to time out.

Wait Process

Lets you build the model for the wait process.

The End component in this model needs to have a boolean mapping. You use this model to create the rules or conditions that monitor the external event. When the external event occurs, the output path for that event should be connected to the End component that is mapped to True.

The properties on the Settings tab in the Wait On External Event component are listed and described in the following table:

Property

Description

Component Class Name

The class name of this component. This property is not editable, but useful if you call Symantec support.

Description

The description of this component. This property lets you describe how the component is used. You can use it to provide any wanted documentation for this component.

This description is included in the model reports that are created when you click Plugins > Generate Business Model.

Location

The physical location of the top left point of this component on the workflow model.

Name

The name of this component. You can change the name.

If you changed the component name when you double-clicked it on the workflow model, the changed name appears here.

Override Background Color

This property lets you change the background color of this component.

To Do

This property lets you record what you still need to do with the component. Use this property to help you remember the configuration that you want to apply to this component.

The text that you enter for this property appears at the bottom of the component editor. If you enter text for this property, a checklist symbol appears on the component in the workflow model.

Is Enabled

This property lets you enable or disable the component. By default, components are enabled. When a component is disabled, it has no effect on the Project. Uncheck Is Enabled to disable the component.

  • Execution Outcome

    If a component with more than one outcome path is disabled, you must select which outcome path you want the component to take. Click the Execution Outcome drop-down list and select the outcome path for the workflow to follow.

  • Disabled Mapping

    If the component has output parameters, you must configure all output parameters with fixed data to pass on. This configuration can be performed in the Disabled Mapping option.

The properties on the Message Listeners tab in the Wait On External Event component are listed and described in the following table:

Property

Description

Allow Exit Via Message Monitoring

Lets you create an exit (output path) in the component when it receives a message by another application or Project. Each message that is created places a unique output path in the component.

Each component that has message listening turned on receives messages from Microsoft Exchange. If the message matches the Path Name, the output path for that message is used.

You can use the Send Complete Workflow Message component to place messages into Microsoft Exchange.

Message Responses

Lets you set up your message responses.

Edit Object dialog box options:

  • Path tab

    Lets you enter the property path name.

    This property is the name of the output path that is added to the Workflow component.

  • Path Data tab

    • Empty Message

      Lets you select to allow message data.

      To allow message data, uncheck Empty Message.

    • Payload Data Type

      Lets you select the message datatype from the other application or Project.

    • Variable Name

      Lets you enter the message variable name.

      This property is the name of the variable that contains the message data

Connection information

Not applicable

Component settings

Unknown

Use cases

An example for the Wait on External Event component:

  • Server set-up

    A new server needs to have a database application installed before it is ready for use.

Server setup

Scenario: A new server needs to be set up. Instead of setting up the server manually, use a workflow to automate as much of the set-up as possible. Part of this set-up involves installing a database and populating it with data. The installation of the database takes about 15 minutes, so the workflow needs to wait for it to finish before it populates the data.

Process: This process is created as an auto start Workflow Project type.

The following screen shot shows the process:

The Wait On External Event component in this screen shot is in charge of running the database installer and delaying the process until the database is installed. If the installation times out, an email is sent to the server administrator.

The Wait on External Event component contains two embedded models: a start process and a wait process. The start process contains a component that launches the database installer. The wait process runs on a schedule to check if the installer has finished.

If the installation succeeds, the process moves into an embedded model that contains more steps for setting up the server. These steps include populating the newly installed database with data. In the workflow diagram screen shot, this model is called "More steps for setting up the server."

The following screen shot shows the editor for the Wait On External Event component:

Notice the start process, the Time Between Checks schedule, and the wait process. The Time Between Checks schedule dictates how often the wait process runs; in this case once per minute.

The following screen shot shows the Start Process:

Inside the Start Process, an Execute Process (Run) component runs the installer file. The database application is sizeable, and the installation takes considerable time. While the installer is running, the Wait On External Event component waits and periodically checks to see if the installation is finished.

You can set how often the component checks the installation by changing the Time Between Checks property. You can also set when the component stops checking by changing the Timeout Time Span property.

The following screen shot shows the Wait Process:

This process runs as often as the "Time Between Checks" property tells it to run. The File Exists component is set to look for a file that appears when the database has finished installing. When it finds this file, it knows the installation is complete.

When the Wait On External Event component recognizes that the installation is complete, it exits the waiting cycle and begins the rest of the process.

Other components in this example are as follows:

  • Embedded Model

  • Send Email

In the example, the workflow process is running locally on the server being set up. In actual business use, the process would more likely need to connect with the server by the network. This same "remote set-up" idea can be accomplished by integrating with Deployment Solution, another solution Symantec offers.

For example, a new employee is hired and needs to have the computer imaged. A workflow process invokes (similar to the one shown) the Deployment Solution server to image the computer. A Wait on External Event component checks the Deployment Solution server progress, waits for it to finish, and then continues the process after it is done. Upon completion, the process continues with other elements of the New Hire process, such as employee benefits or training.

Statistics
0 Favorited
0 Views
0 Files
0 Shares
0 Downloads

Tags and Keywords

Related Entries and Links

No Related Resource entered.