ProcessMaker API Documentation
ProcessMaker Examples

Start Event Element

Add, copy, delete, change the color, align, and configure Start Event elements in your Process model.

Don't Know What a Start Event Element Is?

See Process Modeling Element Descriptions for a description of the Start Event element.

Permissions Required

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

See the Process permissions or ask your Administrator for assistance.

Add a Start Event Element

Follow these steps to add a Start Event element to the Process model:

  1. View your Processes. The Processes page displays.

  2. Create a new Process or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Locate the Start Event element in the Elements and Connectors palette that is to the left of the Process Modeler canvas. If the Hide Menus buttonis enabled, the Elements and Connectors palette displays the Start Event element's icon.

  4. Drag the element into the Process model canvas where you want to place it. If a Pool element is in your Process model, the Start Event element cannot be placed outside of the Pool element.

  5. Do one of the following:

    • From the Elements drop-down menu, select the Start Event option.

    • Click anywhere in the Process model. The Start Event element selects by default.

Start Event element

After the element is placed into the Process model, you may adjust its location in the following ways:

Moving a Start Event element has the following limitations in regards to the following Process model elements:

  • Pool element: If the 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 Start Event element inside the Pool element closest to where you attempt to move it.

  • 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.

Change a Start Event Element's Color

The Start Event element and label have a default green color to indicate that this element is a starting Request event. After a Start Event element is added to a Process model, its shape and label color can be changed. Element and connector colors may only be changed individually.

Follow these steps to change the color and label for a Start Event element:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the Start Event element to change its color. Available options display above the selected element.

  4. Click the Open Color Palette icon. The color palette displays.

  5. Do one of the following to change the color:

    • Select a color swatch: Select one of the color swatches from the color palette. The Start Event element and label change to that color.

    • Specify a custom color: Click theicon to display the color selector, and then select a color, enter the Hex color code, or enter the red, green, blue, and alpha color values for the custom color. The Start Event element and label change to that color.

    • Reset to the default color: Click theicon to reset the Start Event element and label to its default color.

Replace a Start Event Element with a Different Starting Request Event Element

After a Start Event element is added to a Process model, you may replace it with a different starting Request event 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 starting Request event element:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the Start Event element to change to another starting Request event element. Available options display above the selected element.

  4. Click the Elements icon. The Elements drop-down menu displays the starting Request event elements.

  5. Select the element to replace the Start Event element. The Change Type screen displays to confirm replacing the currently selected element.

  6. Click Confirm. The new element replaces the Start Event element with its default settings and color.

Copy a Start Event Element

Copying a Start Event element copies the original along with its current settings, making it easier and faster to continue designing without adding default elements or connectors with their default settings.

The copied Start Event element displays below the original. Any Sequence Flow and/or Message Flow elements incoming to or outgoing from the original are not copied.

Follow these steps to copy a Start Event element in your Process model:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the Start Event element to copy. Available options display above the selected element.

  4. Click the Copy Element icon. The Process model element copies.

Delete a Start Event Element

Deleting a Process model element also deletes any Sequence Flow elements incoming to or outgoing from that element. For example, if a Process model element is deleted that has both incoming and outgoing Sequence Flow elements, the Sequence Flow elements must be reconnected for the remaining elements/connectors.

Follow these steps to delete a Start Event element from your Process model:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the Start Event element to delete. Available options display above the selected element.

  4. Click the Delete icon. The Process model element deletes.

Settings

The Start Event element has the following panels that contain settings:

Configuration Panel Settings

The Start Event element has multiple settings in the Configuration panel:

Edit the Element Name

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:

  1. Select the Start Event element from the Process model in which to edit its name. Panels to configure this element display.

  2. Expand the Configuration panel if it is not presently expanded. The Name setting displays. This is a required setting.

  3. In the Name setting, edit the selected element's name and then press Enter.

Display the Next Assigned Task to the Task Assignee

When the Display the Next Assigned Task to the Task Assignee setting is used in a Start Event element, a selected Display-type Screen displays after the initial Task for this Request completes. An 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:

  • 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 ProcessMaker 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:

  • Initial Task in the Request uses a Conversational-type Screen: During an automated chat-style conversation with the Request participant using the Conversational Forms 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 What is a Conversational Screen? for information how to design modern-style chat experiences with Conversational Screens and the Conversational Forms package. 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 Web Entry panel, which is available if the Web Entry package is installed.

  • Initial Task in the Request uses a Form-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.

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.

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 To Do Tasks page displays after each Task completes.

The Display the Next Assigned Task to the Task Assignee setting applies only for that Start Event element.

If the next Task is assigned to a different user or group, then the interstitial Screen displays until that Request completes or another Task is assigned that user.

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.

First Task Uses a Conversational-type Screen
First Task Uses a Form-type Screen
First Task Uses a Conversational-type Screen

First Task Uses a Conversational-Type ProcessMaker Screen

Use the Display the Next Assigned Task to the Task Assignee setting to link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. Multiple elements and connectors 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 Image or Rich Text control that displays an animated GIF to imply that the other conversational participant is typing.

Animated GIF in Image control for a Screen to link between Conversational Screens

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.

First Task Uses a Form-type Screen

First Task Uses a Form-Type ProcessMaker Screen

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 Form Task and/or Manual Task elements so that Tasks are assigned quickly.

Follow these steps to configure a Start Event element to display an interstitial Screen after the initial Task in that Request completes:

  1. Select the Start Event element from the Process model in which to configure it to display an interstitial Screen after the first Task completes. Panels to configure this element display.

  2. Expand the Configuration panel if it is not presently expanded, and then locate the Display Next Assigned Task to Task Assignee setting.

  3. Select the Display Next Assigned Task to Task Assignee setting. The Screen Interstitial setting displays.

  4. From the Screen Interstitial drop-down menu, select which Display-type ProcessMaker Screen to display after the initial Task in that Request completes. This is a required setting.

Documentation Panel Settings

Edit the Element's Description Displayed in Process Documentation

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.

ProcessMaker Package Required

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:

  1. Select the element from the Process model in which to edit its description. Panels to configure this element display.

  2. Expand the Documentation panel if it is not presently expanded. The Description setting displays.

  3. 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.

    Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:

    • 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:

      1. Select the required text from the Rich Text control.

      2. Click on theicon. The Insert/Edit Link screen displays.

      3. In the URL setting, enter the destination URL.

      4. In the Text to display setting, edit or enter the text displayed in the Rich Text control.

      5. In the Title setting, enter the text to display when a user hovers over the displayed text.

      6. 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 iconto insert an image. Follow these guidelines:

      1. Click on the Insert/Edit Image icon.

      2. The Insert/Edit Image screen displays:

      3. In the Source setting, enter a URL for the image.

      4. In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.

      5. In the Width setting, enter the maximum width for the image.

      6. In the Height setting, enter the maximum height for the image.

      7. Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.

      8. Click Save.

    • 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.

    • 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 theicon.

        • From the Paragraph/Formats menu, select Inline and then Bold.

      • Italics: Do one of the following:

        • From the editor toolbar, select theicon.

        • 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 theicon. 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 theicon to select a custom color from the Color Picker.

          • Click theicon 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 theicon 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 theicon 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 theicon 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 theicon to justify text.

          • From the Paragraph/Formats menu, select Align and then Justify.

      • 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.

Start Permissions Panel Settings

Select whether a user or any member of a group may start a Request:

Select the ProcessMaker User That Can 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.

If this Start Event element is configured to start Requests anonymously via Web Entry, 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 Web Entry Panel Settings.

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 Web Entry panel.

Follow these steps to select which user can start a Request via this Start Event element:

  1. Select the Start Event element from the Process model in which to select the user that may start a Request. Panels to configure this element display.

  2. Expand the Start Permissions panel if it is not presently expanded. The Type setting displays.

  3. From the Type drop-down menu, select the User option. The User drop-down menu displays below the Start Permission drop-down menu.

  4. From the User drop-down menu, select which user can start a Request via the Start Event element. That user may start a Request.

Select the ProcessMaker Group That Can 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.

Follow these steps to select which group members can start a Request via this Start Event element:

  1. Select the Start Event element from the Process model in which to select the group that may start a Request. The Configuration setting section displays.

  2. Expand the Start Permissions panel if it is not presently expanded. The Type setting displays.

  3. From the Type drop-down menu, select the Group option. The Group drop-down menu displays below the Start Permission drop-down menu.

  4. 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.

Web Entry Panel Settings

Select Who Can Start a Request via a Web Entry

When a Start Event element is placed into a Process model, Web Entry settings for that element are disabled. Therefore, even if the Web Entry package is installed, it must be configured for use.

In overview, configuring Web Entry involves making the following decisions:

  1. Who may start the Request: Decide to allow any person to start the Request via Web Entry anonymously or only the authenticated user(s) specified from the Start Permissions panel. In conjunction, decide the following based on who may start the Request:

    • 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.

  2. 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:

    • Conversational-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 Conversational Forms package is installed.

    • Form-type: The Request starter enters information into an interactive form, and then submits it to start the Request.

  3. 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.

  4. 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.

ProcessMaker Package Required

The Web Entry package must be installed to select who can start a Request via Web Entry. The Web Entry package allows anonymous or authenticated users to start or participate in Requests via a published URL.

Follow these steps to select who can start a Request via a Web Entry URL from this Start Event element:

  1. Select the Start Event element from the Process model in which to select who may start a Request via a Web Entry URL. Panels to configure this element display.

  2. Expand the Web Entry panel if it is not presently expanded. The Web Entry setting displays.

  3. 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.

    • 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. Note that if an anonymous person starts a Request and a later Task element or Manual Task 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.

      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.

    • 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 Start Permissions panel, then only those user(s) may start a Request via Web Entry from this Start Event element.

      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.

  4. From the Screen Associated drop-down menu, select the Screen that displays when the Web Entry URL is accessed. This drop-down menu displays only Conversational and Form types so the Request starter can interact with information in the Screen. This is a required setting.

    Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.

  5. 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.

      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 Display types to display a message to the request starter. This is a required 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.

      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 mustache syntax to reference the value of a Request variable as the URL. This is a required setting.

  6. 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.

    In the Password Protect setting, enter the password that the anonymous Request starter must enter to access the Web Entry.

  7. 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.

  8. The Web Entry URL displays the Web Entry URL from which the Request starter accesses the Web Entry. The Web Entry URL value cannot be changed. ProcessMaker generates this URL using the following structure: ProcessMaker 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.

  9. 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.

  10. 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.

    Configure how the chat box displays in the embedded container from the following options:

    1. 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.

    2. 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.

    3. 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.

    4. 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.

    5. Click Save.

The Start Event element's icon changes to indicate that this element uses Web Entry to trigger.

Start Event element configured to use Web Entry

Vocabularies Panel Settings

Assign ProcessMaker Vocabularies That Validate Request Data from This Element

Assign Vocabularies 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 Web Entry package. 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 What is a Vocabulary? for more information. See Select Who Can Start a Request via a Web Entry for information how to use the Web Entry package on a Start Event element.

Each moment ProcessMaker evaluates workflow routing for an in-progress Request, ProcessMaker 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.

During an in-progress Request, if ProcessMaker 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 Request summary. 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.

If no Vocabularies are assigned, ProcessMaker does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.

One or more Vocabularies must be created before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Start Event element.

ProcessMaker Package Required

The Vocabularies package must be installed to assign which Vocabularies validate Request data at a Start Event element. Use the Vocabularies package to maintain uniform JSON schemas across all assets in your organization. These assets include Processes, Screens, and Scripts.

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:

  1. Select the Start Event element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes. Panels to configure this element display.

  2. Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.

  3. Click theicon to add a Vocabulary. The Assign Vocabulary option displays.

  4. From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.

    If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.

  5. Click Save.

  6. Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.

Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.

After one or more Vocabularies are assigned to a Start Event element, the Vocabulary icon displays above that element.

Start Event element with an assigned ProcessMaker Vocabulary

Advanced Panel Settings

Edit the Node's Identifier Value

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:

  1. Select the Start Event element from the Process model in which to edit its identifier value. Panels to configure this element display.

  2. Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.

  3. 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.

Related Topics