Description:

The Generate Event workflow step generates an event using a selected event and configured event parameters. The step is defined in the Events category as a Process step with two incoming and two outgoing connections.

The step supports:

• Selecting an event from the available event list.
• Configuring parameters for the selected event.
• Generating an event with the configured parameters.
• Sending the generated event to the event service bus (ESB), as stated by the step definition.
• Using event generation as part of workflow automation.
• Returning a True or False result for subsequent workflow processing.

Usage:

The Generate Event step typically comes after the workflow completes an operation or reaches a business condition that requires generating an event.

The workflow selects an event, maps the required event parameters, and executes the Generate Event step.

A typical workflow pattern is:

Process Data → Generate Event → Continue Processing

You can use the generated event in an event-driven workflow design. The step definition specifically describes its purpose as generating an event with parameters to the event service bus (ESB).

Typical workflow uses include:

• Generating an event after a business operation completes.
• Passing event-specific parameters.
• Triggering downstream event-driven processing.
• Publishing workflow state changes as events.
• Integrating event generation into an existing workflow.
• Generating an event after a request is approved or rejected.
• Generating an event after a document or record is processed.
• Continuing the workflow after successful event generation.
• Handling an alternate path when event generation fails.

To use this step, configure events in FlowWright event definitions. Navigate to the Integration - Event Service Bus (ESB) page, select the ESB menu, then the Event Definitions page. 

Typical Workflow Suggestions:

Generate an Event After a Business Operation

Use Generate Event after an important workflow operation has completed.

Example:

Process Request
      ↓
Generate Event
      ↓
Continue Process

Generate an Event After Request Submission

You can incorporate Generate Event after a request has been submitted.

Example:

Submit Request
      ↓
Generate Event
      ↓
Continue Request Processing

Generate an Event After Approval

An approval workflow can generate an event after an approval decision.

Example:

Approval Task
      ↓
Generate Event
      ↓
Continue Workflow

Generate an Event After Rejection

Similarly, Generate Event can be placed on a rejection path.

Example:

Approval Decision
       ↓
   Rejected
       ↓
Generate Event
       ↓
Handle Rejection

Generate an Event After Document Processing

A document-processing workflow can generate an event after a document-related operation.

Example:

Process Document
      ↓
Generate Event
      ↓
Continue Processing

Generate an Event After Data Processing

Use the step when an event needs to be generated after data has been retrieved, transformed, or processed.

Example:

Retrieve Data
      ↓
Process Data
      ↓
Generate Event
      ↓
Continue

Generate an Event with Parameters

The Event parameters property allows parameters to be mapped for the selected event.

A typical pattern is:

Prepare Event Data
      ↓
Select Event
      ↓
Map Event Parameters
      ↓
Generate Event

Generate an Event from Workflow Data

Workflow data can be prepared before the Generate Event step and then mapped into the event parameters.

Example:

Get Workflow Data
       ↓
Prepare Event Parameters
       ↓
Generate Event

Generate an Event for Integration Processing

Generate Event can be used at a point where the workflow needs to publish an event for downstream event-driven processing.

Example:

Complete Business Operation
          ↓
Generate Event
          ↓
Continue Workflow

Generate Different Events on Different Workflow Branches

You can place Generate Event on separate workflow branches when different business outcomes require different events.

Example:

                    ┌─ Approved → Generate Event
Approval Decision ──┤
                    └─ Rejected → Generate Event

Generate an Event for Status Changes

A workflow can generate an event when it reaches a significant process status.

Example:

Update Status
      ↓
Generate Event
      ↓
Continue Process

Generate an Event Before Completing a Workflow

Generate Event can be placed near the end of a workflow when an event needs to be generated before the workflow reaches its final activity.

Example:

Complete Processing
      ↓
Generate Event
      ↓
Finish Workflow

Reuse a Standard Event Pattern

When you use the same event-generation pattern repeatedly, standardize the event-selection and parameter-mapping approach.

Example:

Business Operation
       ↓
Prepare Event Data
       ↓
Generate Event
       ↓
Next Activity

Generate an Event Conditionally

You can place Generate Event on a conditional branch when an event is needed only under a particular business condition.

Example:

                    ┌─ Condition Met → Generate Event
Decision ───────────┤
                    └─ Condition Not Met → Continue

Generate an Event After Multiple Processing Steps

You can place the step after several workflow activities when the event should represent completion of a larger operation.

Example:

Retrieve Data
     ↓
Validate Data
     ↓
Process Data
     ↓
Generate Event
     ↓
Continue

Handle Event Generation Failure

Because the step provides True and False return paths, workflows can provide separate processing paths for successful and alternate outcomes.

Example:

                 ┌─ True → Continue
Generate Event ──┤
                 └─ False → Log/Handle Error

Example:

Let’s build and execute the “generateEventDef” example.          

• Create a new process definition named “generateEventDef” and open it in designer mode. 
• Drag a “generateEvent” step to the canvas. 
• Connect the dots between the “Start” and “generateEvent” steps, as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable or a global to store the parameter value. 
• Click the “generateEvent” step to configure its “Required” properties. Provide a name for the step. Select the event from the drop-down list. Click the button to configure the event parameters. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the button to configure the event parameters. A pop-up window appears for configuration. Click the Add Row button to insert an empty row. Enter the event parameter and value. Click the Save button. You may add multiple event parameters and values using the Add Row button.  

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Render the process instance and click the Generate Event step to view its properties. When the workflow reaches the Generate Event step, FlowWright uses the selected event and configured event parameters to generate the event. The step definition describes this operation as generating an event with parameters to the event service bus (ESB). The workflow then follows the appropriate return path. The step should generate an event with parameters for the Event Service Bus (ESB). 
• Navigate to the Integration - Event Service Bus (ESB) page, select the ESB menu, and then view the Events menu. The page displays the events generated by the ESB service, as shown below. 

• Expand the event category to view more details.

Tips:

• Select the appropriate event before executing the step.
• The Select event property is required. 
• Configure the Event parameters required by the selected event.
• The Event parameters property is required. 
• Verify the available events in the FlowWright designer for the installed version.
• Verify the parameter requirements for the selected event before executing the workflow.
• Prepare event data before the Generate Event step when parameters depend on workflow information.
• Use meaningful workflow Variables when preparing values that will be mapped into event parameters.
• Test the event-generation workflow with representative business data.
• Verify that the selected event and its parameters correspond to the intended business operation.
• Keep event-generation logic close to the workflow operation that causes the event.
• Use separate Generate Event configurations when different business branches require different events.
• Connect the True path to the normal continuation of the workflow.
• Consider connecting the False path to appropriate error handling.
• Avoid generating duplicate events unless duplicate event generation is intentionally required by the workflow design.
• Test workflows that execute the Generate Event step multiple times.
• Verify the behavior of event generation when parameter values are missing or unexpected.
• Keep event parameter mappings maintainable when the workflow evolves.
• Document the purpose of important events and the business operation that causes them.
• When event parameters contain sensitive information, avoid exposing those values in workflow logs unless necessary.
• Do not assume event delivery guarantees, retry behavior, ordering, duplication handling, persistence, or consumer behavior unless those characteristics have been confirmed for the FlowWright event service bus implementation.
• Do not assume the available event names or parameter definitions from the XML alone; those are not enumerated in the supplied step definition.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Before executing a workflow containing the Generate Event step, verify:

1. The Generate Event step has been added to the Process Definition.
2. An event has been selected.
3. The event parameters have been configured.
4. All parameter values required by the selected event have been supplied.
5. The upstream workflow activity is connected to the Generate Event step.
6. The True path is connected to the normal continuation path.
7. The False path is connected to appropriate alternate or error handling where required.
8. Logging has been configured if workflow progress needs to be documented.
9. The event-generation operation has been tested with representative workflow data.
10. Downstream processing has been tested for the generated event.
11. Any environment-specific event configuration has been verified.

Click here to download the sample file.