Configure Start-type Event elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Loading...
Add, copy, delete, change the color, align, and configure Signal Start Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Signal Start Event element.
Your user account or group membership must have the following permissions to configure a Signal Start Event element 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 a Signal Start Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Signal Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Signal Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Signal Start Event element. This element's icon's displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Signal Start Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Signal Start Event element is inside of a Pool element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Signal Start Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Signal Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Signal Start Event element cannot be moved outside of the Pool element.
After a Signal Start Event element is added to a Process model, you may replace it with a different starting Request event element:
Start Event element
Start Timer Event element
Message Start Event element
Conditional Start Event element
The selected Signal Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Signal Start Event element with a different Start-type event element:
Select the Signal Start Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Signal Start Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Signal Start Event element has the following panels that contain settings:
Documentation panel (available when the Documentation package is installed)
Advanced panel
An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.
Follow these steps to edit the name for a Signal Start Event element:
Select the Signal Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
A Signal Start Event element starts a Request for a Process when it triggers by receiving a specific Signal from a broadcasting element in any other Request. The element that broadcasts the Signal does not need to be in the same Process model as the Signal Start Event element to receive the broadcast. Select the Signal that triggers this element.
Follow these steps to select the Signal that triggers the Signal Start Event element:
Select the Signal Start Event element from the Process model in which to select the Signal that triggers it.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Signal drop-down menu, select the Signal that triggers this element. This setting is required. To know more about Signals, see Signal Manager.
When the Signal Start Event element receives a broadcasting Signal for which it is listening, enter the Request variable that stores the Request data in the broadcasting Signal's payload. The Request data within the broadcasting Signal may then be used in the new Request that the Signal Start Event element starts.
Follow these steps to enter the Request variable to store the broadcasting Signal's payload:
Select the Signal Start Event element from the Process model in which to enter the Request variable.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Request Variable setting, enter the name of the Request Variable to store the broadcasting Signal's payload and then press Enter.
If the Documentation package is installed, describe the element'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 element 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.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
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.
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.
Click Save.
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 Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
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.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value 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 a Signal Start Event element:
Select the Signal Start Event element 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 element display.
In the Node Identifier setting, edit the Signal Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Signal Start Event option.
The Signal Start Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Signal Start Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Signal Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Request Variable setting.
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 element 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.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Add, copy, delete, change the color, align, and configure Start Timer Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Start Timer Event element.
Your user account or group membership must have the following permissions to configure a Start Timer Event element 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 a Start Timer Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Start Timer Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Start Timer Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Start Timer Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Start Timer Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Start Timer Event element is inside of a Pool element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Start Timer Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Start Timer Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Start Timer Event element cannot be moved outside of the Pool element.
After a Start Timer Event element is added to a Process model, you may replace it with a different starting Request event element:
Start Event element
Signal Start Event element
Message Start Event element
Conditional Start Event element
The selected Start Timer Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Start Timer Event element with a different Start-type event element:
Select the Start Timer Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Start Timer Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Start Timer Event element has the following panels that contain settings:
Configuration panel
Timing Control panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.
Follow these steps to edit the name for a Start Timer Event element:
Select the Start Timer Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
When a Start Timer Event element is placed into a Process model, it has the following settings by default before it triggers:
The timing control is set to midnight of the current date.
The timing control is set to repeat weekly on the current day.
If these are not the timing control settings you want, the Start Timer Event element must be configured. Set the timer controls for a Start Timer Event element using the following parameters:
Set the date and hour when the trigger the Start Timer Event element, thereby starting a Request.
Optionally, set an interval from which to periodically trigger the Start Time Event element, thereby staring a Request at that interval. This may be done in any of the following intervals:
Set the timer to periodically trigger on a specified number of days, weeks, months, or years.
Set the timer to periodically trigger on specific days of the week.
Set when the timer control ends from any of the following options, thereby limiting when to start a Request:
The timer never ends.
The timer ends on a specified date.
The timer ends after a number of occurrences.
Follow these steps to set the timer controls for a Start Timer Event element:
Select the Start Timer Event element from the Process model in which to set its timer controls.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Timing Control panel if it is not presently expanded. The Start date setting displays.
From the Start date setting, use the date control to select the date to initially trigger the Start Timer Event element. If this setting has not been previously set, the current date is the default.
Set the periodic interval to trigger the Start Timer Event element again, thereby starting a new Request. Follow these guidelines:
From the Repeat every setting, select at how many intervals of a set time period to trigger the Start Timer Event element. 1 week is the default setting. Then select one of the following time periods for that element to trigger:
Day
Week (default setting)
Month
Year
Alternatively, select from the Repeat on setting the day(s) of the week in which to trigger the Start Timer Event element. Selected days display with a blue-colored circle around each.
Set when to end the timer control from the following options:
Select Never to never end the timer control. Never is the default setting.
Select On to select a specific date in which to end the timer control. If this setting has not been previously set, the current date is the default.
Select After and then enter how many occurrences to end the timer control after the Start Timer Event element has triggered that may times. If this setting has not been previously set, 1 is the default setting.
If the Documentation package is installed, describe the element'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 element 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.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
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.
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.
Click Save.
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 Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
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.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value 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 a Start Timer Event element:
Select the Start Timer Event element 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 element 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 Start Timer Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Start Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Start Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Start Event element from one of the following locations in Process Modeler:
Follow these steps to add a Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Start Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Start Event element cannot be moved outside of the Pool element.
The selected Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Start Event element with a different Start-type event element:
Select the Start Event element to change to another Start-type event. Available options display above the selected element.
Click Confirm. The new element replaces the Start Event element with its default settings and color.
The Start Event element has the following panels that contain settings:
Configuration panel
Start Permissions panel
Advanced panel
The Start Event element has multiple settings in the Configuration panel:
An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.
Follow these steps to edit the name for a Start Event element:
Select the Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
The Request assigns another Task to the same Task assignee, at which time the new Task displays.
The Request completes, at which time the Request summary displays.
The user clicks a link to leave that page to display another location.
Use the Display the Next Assigned Task to the Task Assignee setting in the following ways:
See the tabs below for more information how to use the Display the Next Assigned Task to the Task Assignee setting with Conversational- and Form-type Screens.
The Display the Next Assigned Task to the Task Assignee setting applies only for that Start Event element.
The Display the Next Assigned Task to the Task Assignee setting has two purposes depending on whether the initial Task in that Request uses a Conversational- or Form-type Screen.
Non-assigned automated actions run as part of that Request while the interstitial Screen displays. When the Request assigns the next Task to that Task assignee, the new Task displays in the chat box as continued conversation in a seamless chat experience to the Request participant.
Follow these steps to configure a Start Event element to display an interstitial Screen after the initial Task in that Request completes:
Select the Start Event element from the Process model in which to configure it to display an interstitial Screen after the first Task completes.
From the Screen Interstitial drop-down menu, select which Display-type Screen to display after the initial Task in that Request completes. This is a required setting.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
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.
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.
Click Save.
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 Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
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.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
When a Start Event element is placed into a Process model, it is not configured to indicate how a Request can start via that Start Event element. Therefore, it must be configured.
Select the Start Event element from the Process model in which to select the user that may start a Request.
Expand the Start Permissions panel if it is not presently expanded. The Type setting displays.
From the Type drop-down menu, select the User option. The User drop-down menu displays below the Start Permission drop-down menu.
From the User drop-down menu, select which user can start a Request via the Start Event element. That user may start a Request.
When a Start Event element is placed into a Process model, it is not configured to indicate how a Request can start via that Start Event element. Therefore, it must be configured.
Select the Start Event element from the Process model in which to select the group that may start a Request.
Expand the Start Permissions panel if it is not presently expanded. The Type setting displays.
From the Type drop-down menu, select the Group option. The Group drop-down menu displays below the Start Permission drop-down menu.
From the Group drop-down menu, select which group can start a Request via the Start Event element. Any member of that group may start a Request.
In overview, configuring Web Entry involves making the following decisions:
Anonymously: Decide one or both of the following:
Password-protect access to the Web Entry.
Read query string parameters suffixed as JSON key name and value pairs to the Web Entry's base URL to be included in that Request's data. This setting is useful to suffix metadata for email campaigns. For example, if the Web Entry's base URL is http://pm/webentry/7/node_24
, add parameters to the URL that represent the JSON key name and value pairs to add to that Request such as http://pm/webentry/7/node_24?data1=123&data2=456
. Parameters are interpreted as strings.
Authenticated user: Read query string parameters as described above.
Screen for the chat or Task: Select from which Screen the Request starter interacts with this Request. This may be one of the following types of Screens:
Completed action after Screen submission: Decide whether to display a separate Screen when the initial Screen submits or to route that person to a URL. If to display a Screen, select that Screen.
Embed the Web Entry into a third-party site: If embedding the Web Entry into a third-party site, decide one or both of the following:
Embed the Web Entry if using a Form-type Screen: Copy the JavaScript that contains the Web Entry URL, and then embed that JavaScript into your Web server's or blog's HTML header.
Embed the Web Entry if using a Conversational-type Screen: Copy the JavaScript that contains the Web Entry URL, configure options how the chat-style presentation displays in your site, and then embed that JavaScript into your Web server's or blog's HTML header.
Follow these steps to select who can start a Request via a Web Entry URL from this Start Event element:
Select the Start Event element from the Process model in which to select who may start a Request via a Web Entry URL.
Expand the Web Entry panel if it is not presently expanded. The Web Entry setting displays.
From the Mode drop-down menu, select one of the following options:
Disabled: Select the Disabled setting to disable Web Entry for this Start Event element when this element currently is configured to do so. This is the default setting.
If selecting the Anonymous option, consider selecting the Enable Password Protect setting below the Completed Action setting (described below) to require a password to access the Web Entry.
If selecting the Authenticated option, consider selecting the Allow query string data setting below the Completed Action setting (described below) to read JSON key name and value pairs from the Web Entry's base URL to be included in that Request's data.
Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.
From the Completed Action drop-down menu, select one of the following options:
Screen: Select the Screen option to indicate that a Screen displays after the Requester submits the Screen selected from the Screen Associated drop-down menu described above. Screen is the default setting.
Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.
URL: Select the URL option to indicate that the Request starter is redirected to a URL after the Request starter submits the Screen selected from the Screen Associated drop-down menu.
In the Password Protect setting, enter the password that the anonymous Request starter must enter to access the Web Entry.
Select the Allow query string data setting to read JSON key name and value pairs from the Web Entry's base URL to be included in that Request's data. This setting is useful to suffix metadata for email campaigns. For example, if the Web Entry's base URL is http://pm/webentry/7/node_24
, add parameters to the URL that represent the JSON key name and value pairs to add to that Request such as http://pm/webentry/7/node_24?data=123&data2=456
. Parameters are interpreted as strings.
The Web Entry URL displays the Web Entry URL from which the Request starter accesses the Web Entry. ProcessMaker Platform generates this URL using the following structure: ProcessMaker Platform instance domain
/webentry/
Web Entry numerical instance
/
Identifier Value of this Start Event element
. If necessary, click the Copy button below the Web Entry URL setting to copy the Web Entry URL so that it is available in your clipboard.
Follow these steps to customize the Web Entry URL:
Click the Options button below the Web Entry URL setting. The URL Options screen displays. By default the Standard URL option is enabled, indicating that the automatically generated URL is used for this Web Entry.
Enter as many parameters as necessary. Use the following icons to remove or sort the order of added URL parameters:
Click Save to exit the URL Options screen with the saved custom Web Entry URL settings.
Configure how the chat box displays in the embedded container from the following options:
From the Position setting, select one of the following options:
Fill Container: The chat box displays the width of the container to which the Web Entry's JavaScript code is applied. This is the default setting. When the Fill Container setting is selected, all other settings in the Embed Options screen are disabled.
Top Left: The chat box displays in the top left corner of the container to which the Web Entry's JavaScript code was applied.
Top Right: The chat box displays in the top right corner of the container to which the Web Entry's JavaScript code was applied.
Bottom Left: The chat box displays in the bottom left corner of the container to which the Web Entry's JavaScript code was applied.
Bottom Right: The chat box displays in the bottom right corner of the container to which the Web Entry's JavaScript code was applied.
In the Title setting, enter the title that displays in the chat box. Form is the default setting. This setting does not apply when the Fill Container option is selected from the Position setting.
From the Color setting, select the color that displays for button to show the chat box and for the chat box frame itself. The left-most color option is the default. This setting does not apply when the Fill Container option is selected from the Position setting.
From the Icon setting, select an icon that displays to show the chat box. The Question Circle is the default option. This setting does not apply when the Fill Container option is selected from the Position setting.
Click Save.
The Start Event element's icon changes to indicate that this element uses Web Entry to trigger.
Each moment ProcessMaker Platform evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the Vocabularies applied to the Process and/or a specific BPMN 2.0 element in the Process model. The Request's JSON data model must conform to the Vocabulary's JSON schema.
If no Vocabularies are assigned, ProcessMaker Platform does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.
A Vocabulary is a JSON schema. The JSON schema describes the data objects, types, and structure that you want in both a machine and human readable format. Apply one or more Vocabularies to your Processes and/or specific BPMN 2.0 elements in your Process models to ensure the JSON data model in Request data complies with the data structure outlined in the JSON schema that you need to meet regulatory specifications or ensure Request data contains required information.
Follow these steps to assign Vocabularies that validate Request data from a Start Event element:
Select the Start Event element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
Click Save.
Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to a Start Event element, the Vocabulary icon displays above that element.
Process Modeler automatically assigns a unique value 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 a Start Event element:
Select the Start Event element from the Process model in which to edit its identifier value.
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 Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Message Start Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Message Start Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Message Start Event element from one of the following locations in Process Modeler:
Follow these steps to add a Message Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Message Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Message Start Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Message Start Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Message Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Message Start Event element cannot be moved outside of the Pool element.
The selected Message Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Message Start Event element with a different Start-type event element:
Select the Message Start Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Message Start Event element with its default settings and color.
The Message Start Event element has the following panels that contain settings:
Configuration panel
Advanced panel
An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.
Follow these steps to edit the name for a Message Start Event element:
Select the Message Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to select from which element to listen for a message to trigger the Message Start Event element:
Select the Message Start Event element from the Process model in which to select the Process model element from which to listen for a message.
From the Listen For Message drop-down menu, select from which element to listen for a message based on its Message Name setting value.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
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.
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.
Click Save.
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 Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
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.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value 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 a Message Start Event element:
Select the Message Start Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Message Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Conditional Start Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Conditional Start Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Conditional Start Event element from one of the following locations in Process Modeler:
Follow these steps to add a Conditional Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Conditional Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Conditional Start Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Conditional Start Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Conditional Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Conditional Start Event element cannot be moved outside of the Pool element.
The selected Conditional Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Conditional Start Event element with a different Start-type event element:
Select the Conditional Start Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Conditional Start Event element with its default settings and color.
The Conditional Start Event element has the following panels that contain settings:
Configuration panel
Advanced panel
An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.
Follow these steps to edit the name for a Conditional Start Event element:
Select the Conditional Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
The Conditional Start Event ignores the call to start a Request in the following scenarios:
The Request condition(s) do not evaluate to the condition(s) set in the Condition setting.
The Request condition(s) evaluates as null
.
The Condition setting contains no value.
A Process model may use multiple Conditional Start Event elements. However, each Conditional Start Event element must use a unique condition for that element to trigger.
Follow these steps to enter the Request conditions that trigger a Conditional Start Event element:
Select the Conditional Start Event element from the Process model in which to edit its name.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
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.
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.
Click Save.
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 Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
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.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value 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 a Conditional Start Event element:
Select the Conditional Start Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Conditional Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Start Timer Event option.
The Start Timer Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Start Timer Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
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 element 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.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Start Event object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Event element cannot be placed outside of the Pool element.
Ensure that the Start Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Start Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Start Event element inside the Pool element closest to where you attempt to move it.
After a Start Event element is , you may replace it with a different starting event element:
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays Start-type event elements.
Select the element to replace the Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
Web Entry panel (available when the is installed)
Vocabularies panel (available when the is installed)
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Use the Display the Next Assigned Task to the Task Assignee setting to display an interstitial Screen that displays until the next Task displays. An interstitial Screen can only be a -type Screen. The interstitial Screen displays while the Request resumes routing. Non-assigned automated actions run as part of that Request while the interstitial Screen displays. The interstitial Screen displays indefinitely until one of the following occurs:
Initial Task in the Request uses a -type Screen: During an automated chat-style conversation with the Request participant using the package, link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. After the Request participant responds to the conversation designed in the initial Screen, use the Display the Next Assigned Task to the Task Assignee setting to display a message and/or image while the Request routes to the next Conversational Screen. See for information how to design modern-style chat experiences with Conversational Screens and the Conversational Forms . Use this setting regardless of configuring this Start Event element to use Web Entry to start a Request. While the Web Entry panel configures which Conversational- or Form-type Screen the initial Task uses, the Display the Next Assigned Task to the Task Assignee setting indicates that a Screen displays after that initial Task completes. Web Entry is configured from the , which is available if the is installed.
Initial Task in the Request uses a -type Screen: After the initial Task in the Request completes, display a message with a Display-type Screen that reads Loading your next Task. While this Screen displays, the Request routes to the next Form Task or Manual Task element's Task.
Following the Start Event element is a Script Task element: If a element immediately follows the Start Event element (see below), use the Display the Next Assigned Task to the Task Assignee setting to trigger any Form Task element or element that follows the Script Task element.
After selecting the Display the Next Assigned Task to the Task Assignee setting, the Screen Interstitial setting displays to select which Screen displays after the initial Task in that Request completes. This behavior is different than the default functionality, whereby the page displays after each Task completes.
If the next Task is assigned to a different or , then the interstitial Screen displays until that Request completes or another Task is assigned that user.
Use the Display the Next Assigned Task to the Task Assignee setting to link together while the resumes routing based on previous conversational responses by the participant. Multiple elements and may perform automatic tasks after the initial Conversational Screen's Task before the next Conversational Screen's Task triggers in that Request. However, the Request participant experiences a seamless conversation between the two Conversational Screens' Tasks while the interstitial Screen displays in the chat box. For example, use a Screen that uses an or control that displays an animated GIF to imply that the other conversational participant is typing.
Use the Display the Next Assigned Task to the Task Assignee setting when you understand that this Task assignee will be assigned multiple Tasks during the same Request regardless of whomever that Task assignee is. This becomes convenient for that Task assignee to display the next Task immediately after submitting the current Task in that Request, especially if other elements and connectors are between and/or elements so that Tasks are assigned quickly.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Locate the Display Next Assigned Task to Task Assignee setting. It is selected by default when the Start Event element is to the Process model.
Select the Display Next Assigned Task to Task Assignee setting. The Screen Interstitial setting displays.
If the is installed, describe the element'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 element 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 .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element 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 element 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.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Select whether a or any member of a may start a :
If this Start Event element is configured to start Requests anonymously via , the settings described below are disabled because these Start Event element settings only configure which authenticated user(s) may start a Request from this element. Therefore, to configure these settings, either disable Web Entry or select that authenticated users may start Requests from this element via Web Entry. See .
To allow anonymous or authenticated users to start or participate in Requests via a published URL do not configure who may start Requests from the Start Permissions panel. Configure those persons from the .
Follow these steps to select which can start a Request via this Start Event element:
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Follow these steps to select which members can start a Request via this Start Event element:
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
When a Start Event element is placed into a Process model, Web Entry settings for that element are disabled. Therefore, even if the package is installed, it must be configured for use.
Who may start the Request: Decide to allow any person to start the Request via Web Entry anonymously or only the authenticated user(s) . In conjunction, decide the following based on who may start the Request:
-type: The Request starter interacts in an automated chat-style correspondence by responding to questions and responses, and then either submits the chat or the Screen submits itself if it times out from interaction. The Conversational-type Screen is available only if the is installed.
-type: The Request starter enters information into an interactive form, and then submits it to start the Request.
The must be installed to select who can start a Request via Web Entry. The Web Entry allows anonymous or authenticated users to start or participate in Requests via a published URL.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Anonymous: Select the Anonymous option to allow any person who has access to the Web Entry's URL to start a Request. This person is not authenticated as a user. As a best practice, use Anonymous Web Entry URLs when an active session will not be used in the same Web browser. Note that if an anonymous person starts a Request and a later Form Task element or element is assigned to the Request starter, ensure that the anonymous person enters an email address for that Task or chat-style interaction. Otherwise, that person cannot receive notifications for the subsequent Task. If this happens, the following Request error occurs: This process was started by an anonymous user so this task can not be assigned to the requester. Therefore, use this option cautiously.
Authenticated: Select the Authenticated option to require an authenticated user or group member to start a Request via the Web Entry's URL. If an authenticated user or group member is already selected from the , then only those user(s) may start a Request via Web Entry from this Start Event element.
From the Screen Associated drop-down menu, select the that displays when the Web Entry URL is accessed. This drop-down menu displays only and types so the Request starter can interact with information in the Screen. This is a required setting.
After the Screen option is selected, the Screen For Completed setting displays below the Completed Action option. From the Screen For Completed drop-down menu, select the Screen that displays after submitting the Screen selected from the Screen Associated drop-down menu. This drop-down menu displays only types to display a message to the request starter. This is a required setting.
After the URL option is selected, the Redirect URL setting display below the Completed Action option. From the Redirect URL setting, enter the URL to which the Request starter redirects after submitting the Screen selected from the Screen Associated drop-down menu, and then press Enter. The redirect URL supports to reference the value of a Request variable as the URL. This is a required setting.
If the Anonymous option is selected from the Mode setting, the Enable Password Protect setting displays.
Select the Enable Password Protect setting to require a password to access the Web Entry. If the Enable Password Project setting is selected, the Password Protect setting displays below it.
Optionally, customize the Web Entry URL using values as URL parameters. Reference these Request variable values using single curly brackets surrounding each Request variable name, such as {variableName}
, in the custom URL.
Select the Custom URL setting. Settings enable below the Custom URL setting. The Web Entry URL Preview setting displays the currently customized Web Entry URL. If necessary, click the Copy button below the Web Entry URL Preview setting to copy this custom URL.
In the First URL segment setting, enter the base segment that displays after your base ProcessMaker Platform instance component of the Web Entry URL. A forward slash (/
) precedes the first URL segment. The first URL segment must be unique to other Web Entry URLs from other Start Event elements in this Process, and may only use alphanumeric characters. This setting is required. In the example below, baseurl
is the first URL segment.
Use the URL parameters setting to enter custom parameters in the Web Entry URL based on Request variable name values. In the Name... setting, enter the Request variable name from which to reference its value for the Web Entry URL, and then click the Add Parameter button. That parameter displays within the URL parameters setting with single curly brackets ({
}
) surrounding it. In the example below, city
is a Request variable name from which to reference its value for the custom Web Entry URL.
Delete: Click the Delete iconto delete the selected parameter from the Web Entry URL.
Sort order: Hold and drag theicon to sort the order of parameters in the Web Entry URL. Sort parameters in the URL parameters setting from top to bottom as they are to display left to right in the custom URL.
The Embed Code setting displays the JavaScript that contains the Web Entry URL to embed into your Web server's or blog's HTML header. If necessary, click the Copy button below the Embed Code setting to copy the Web Entry URL so that it is available in your clipboard.
If this Start Event element's Web Entry uses a Conversational-type Screen to provide a chat-style interaction with the Request starter, optionally click the Options button below the Embed Code setting to configure how the chat box displays in the embedded container to which the Web Entry's JavaScript code is applied. When the Options button is clicked, the Embed Options screen displays.
Assign that validate Request data complies with a specific JSON schema. This is often mandatory for many types of business sectors including banking and healthcare. Ensure the quality and compliance of Request data. For example, during a Loan Application process, ensure that personal information has been included in the Request to that moment in that in-progress Request. The Vocabularies package must be installed to make this configuration.
Use a Vocabulary on a Start Event element when using the . After the Request data is submitted from the Web Entry, Vocabularies assigned to the Start Event element validate the Request data complies with the Vocabulary's JSON schema. See for more information. See for information how to use the Web Entry package on a Start Event element.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the . Vocabularies are cumulative in an in-progress Request: as the Request progresses, if Request data does not conform with any Vocabulary's JSON schema to that moment in the Request, the Request errors.
One or more Vocabularies must be created before assigning a Vocabulary. See . Multiple Vocabularies can be assigned to a Start Event element.
The must be installed to assign which Vocabularies validate Request data at a Start Event element. Use the Vocabularies to maintain uniform JSON schemas across all assets in your organization. These assets include , , and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Click theicon to add a Vocabulary. The Assign Vocabulary option displays.
If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See .
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Message Start Event option.
The Message Start Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Message Start Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Message Start Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Message Start Event element inside the Pool element closest to where you attempt to move it.
After a Message Start Event element is , you may replace it with a different starting event element:
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Message Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
An Message Start Event element starts a when that element receives a message from either an element or a element (but not both) located in a different element than the Message Start Event element receiving the message. After the Message Start Event element receives its message, that element triggers. Select from which element to listen for a message based on the Intermediate Message Throw Event or Message End Event element's Message Name setting value.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded and then locate the Listen For Message setting.
If the is installed, describe the element'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 element 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 .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element 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 element 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.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Conditional Start Event option.
The Conditional Start Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Conditional Start Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Conditional Start Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Conditional Start Event element inside the Pool element closest to where you attempt to move it.
After a Conditional Start Event element is , you may replace it with a different starting event element:
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Conditional Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Enter the Request condition(s) that triggers the Conditional Start Event element, thereby starting a . A Conditional Start Event element starts a child Request for a when a parent Request sends its Request data to the Conditional Start Event element via a element. The Conditional Start Event element triggers when the parent Request's data meets one or more specified conditions.
.
See .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Condition setting. This is a required setting.
Enter the that trigger this Conditional Start Event element and then press Enter, thereby starting a Request of its Process.
If the is installed, describe the element'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 element 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 .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element 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 element 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.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.