An Event-Based Gateway object evaluates a Request's workflow routing for a Process based on which event occurs immediately after the Event-Based Gateway object. Follow these guidelines to use the Event-Based Gateway object:
The Event-Based Gateway object requires two or more outgoing Sequence Flow objects. When evaluating events, workflow routes through only one Sequence Flow object; multiple events cannot pass simultaneously from one Event-Based Gateway object during a Request.
The Event-Based Gateway object can only connect with Intermediate Timer Event or Intermediate Message Catch Event objects. This creates the scenario that either a timed event occurs or an Intermediate Message Catch Event object receives a message.
When the Event-Based Gateway object triggers during a Request, workflow for that Request pauses. ProcessMaker Platform then evaluates the events immediately following the Event-Based Gateway object's via its outgoing Sequence Flow objects and waits until one of those events occur. Request workflow resumes by routing to the event that occurs first.
Consider the following example. Suppose that you have a Process that monitors if you receive package shipments on time. Use an Event-Based Gateway object to monitor which event occurs next. Refer to the Process modeling objects below.
Event-Based Gateway object example
In this example, connect the following Process modeling objects from the Event-Based Gateway object:
Intermediate Timer Event object: The first connecting event from the Event-Based Gateway object is an Intermediate Timer Event object that is set to 24 hours. This event represents a 24-hour period in which presumably a notification has not arrived that the package shipped within that time period. If the timer set in the Intermediate Timer Event expires, then workflow routes to a Manual Task object in which its assignee telephones the shipping company.
Intermediate Message Catch Event object: The second connecting object is an Intermediate Message Catch Event object that represents a notification of the package’s shipment presumably before the timer set in the Intermediate Timer Event object expires. If the Intermediate Message Catch Event object triggers, then the notification was received before the 24-hour period expired. No further action is required.
Add an Event-Based Gateway to the Process Model
Permissions
Your user account or group membership must have the following permissions to configure an Event-Based Gateway object in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Process permissions or ask your Administrator for assistance.
Add an Event-Based Gateway object from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler, the Object Panel contains various process modeling objects.
Object Bar: Located at the bottom of the Process Modeler, the Object Bar contains pinned Process modeling objects for quick access.
Follow these steps to add a Event Based Gateway from the Object panel to the Process model:
Ensure that the Object panel is visible. If not, click the Add icon
from the Object bar at the bottom.Click the Gateway object
from the Object panel to select it.Click the location in the Process model to place this object. If your process has a Pool object, the object cannot be placed outside of the Pool.
Click the Objects drop-down menu, and then select the Event Based Gateway option.
The Event Based Gateway object displays.
Follow these steps to add an Event-Based Gateway object from the Object bar to the Process model:
Ensure that the Gateway object is pinned to the Object bar. If not, see instructions to pin it.
In the Object bar at the bottom center, click the object's icon.
Click the location in the Process model to place this object. If your process has a Pool object, the object cannot be placed outside of the Pool.
Click the Objects drop-down menu, and then select the Event-Based Gateway option.
The Event-Based Gateway object displays.
Replace an Event-Based Gateway Object with a Different Gateway Object
After an Event-Based Gateway object is added to a Process model, you may replace it with a different Gateway type object:
Exclusive Gateway object
Inclusive Gateway object
Parallel Gateway object
The selected Event-Based Gateway object is replaced by the default settings and color of the replacing object.
Follow these steps to replace an Event-Based Gateway object with a different Gateway type object:
Select the Event-Based Gateway object to change to another object. Available options display above the selected object.
Click the Objects icon. The Objects drop-down menu displays the Gateway type objects.
Select the object to replace the Event-Based Gateway object. The Change Type screen displays to confirm replacing the currently selected object.
Click Confirm. The new object replaces the Event-Based Gateway object with its default settings and color.
Settings
The Event-Based Gateway object has the following panels that contain settings:
Configuration panel
Documentation panel
Advanced panel
Configuration Panel Settings
Edit the Object Name
An object name is a human-readable reference for a Process object. Process Modeler automatically assigns the name of a Process object with its object type. However, an object's name can be changed.
Follow these steps to edit the name for an Event-Based Gateway object:
Select the Event-Based Gateway object from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
In the Name setting, edit the selected object's name and then press Enter.
Documentation Panel Settings
Describe the object's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the object is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
Edit the Object's Description Displayed in Process Documentation
Follow these steps to edit the description for an object:
Select the object from the Process model in which to edit its description. Panels to configure this object display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this object and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon
. 
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Undo changes: Click on the
icon to undo the last action.Redo changes: Click on the
icon to redo the last undone action.Insert/Edit Link: Click on the
icon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink: Select the required text from the Rich Text control.
Click on the
icon. The Insert/Edit Link screen displays.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
Insert/Edit Image: Click on the Insert/Edit Image icon
to insert an image. Follow these guidelines: Click on the Insert/Edit Image icon
. The Insert/Edit Image screen displays:
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Toggle the Constrain Proportions icon
to maintain the width-height ratio of the image to its original proportion. Click Save.
Insert Page Break for PDF: Click on the Insert Page Break for PDF icon
to insert a page break when a PDF document is created for this documentation if your browser supports this feature. Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the editor toolbar, select the
icon.From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the editor toolbar, select the
icon.From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Change text color: Use the Text Color drop-down to change text color. Click on the
icon. The color palette displays. Do one of the following:Select one of the color swatches from the color palette. The selected text changes to that color.
Click the
icon to select a custom color from the Color Picker.Click the
icon to reset the text to its default color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the editor toolbar, use the
icon to left-align text.From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the editor toolbar, use the
icon to center-align text.From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the editor toolbar, use the
icon to right-align text.From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the editor toolbar, use the
icon to justify text. From the Paragraph/Formats menu, select Align and then Justify.
Insert a bullet list: Use the
icon to format text as a bulleted list.Insert a numbered list: Use the
icon to format text as a numbered list.Indent text: Click on the
icon to increase text indenting.Outdent text: Click on the
icon to decrease text indenting.
Advanced Panel Settings
Edit the Node's Identifier Value
Process Modeler automatically assigns a unique vEdit the Object's Description Displayed in Process Documentationalue to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Event-Based Gateway object:
Select the Event-Based Gateway object from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Event-Based Gateway object's identifier to a unique value from all nodes in the Process model and then press Enter.