ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
Data Connector Connector
Access both ProcessMaker Collection records and third-party data sources from Process models, then make workflow routing decisons based on that data.

Overview

The Data Connector connector is part of the Data Connector package. From the Data Connector connector, select a Data Connector from which to interact with a data source.
Use the Data Connector connector in your Process models in the following ways:
    Access Collections: From your Process model, interact with any Collection in your ProcessMaker instance, including viewing, creating, updating, and/or delete records in a selected Collection. By default, each Collection has a corresponding Data Connector when it is created. Incorporate Collection record data into your Process model so you can make business decisions using it. Likewise, automatically change records in a Collection during a Request when workflow routing conditions are met.
    Access third-party data sources: Similarly to Collections, interact with third-party data sources such as Application Program Interfaces (APIs). Reference data from that API, then incorporate it into your Process's Request data. Incorporating data from external data sources helps you make business decisions from information outside of your ProcessMaker instance.

Package and Permissions Required

The Data Connector package must be installed to use the Data Connector connector.
Furthermore, your user account or group membership must have the following permissions to configure a Data Connector connector to 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 Data Connector Connector to the Process Model

Follow these steps to add a Data Connector connector to the Process model:
    1.
    View your Processes. The Processes page displays.
    2.
    Create a new Process or click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Locate the Data Connector connector's icon
    in the Elements and Connectors palette that is to the left of the Process Modeler canvas.
    4.
    Drag the connector into the Process model canvas where you want to place it. If a Pool element is in your Process model, the Data Connector connector cannot be placed outside of the Pool element.
Data Connector connector
After adding the Data Connector connector, consider adding the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:
After the connector is placed into the Process model, you may adjust its location in the following ways:
Moving a Data Connector connector has the following limitations in regards to the following Process model elements:
    Pool element: If the Data Connector connector 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 Data Connector connector inside the Pool element closest to where you attempt to move it.
    Lane element: If the Data Connector connector is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Data Connector connector cannot be moved outside of the Pool element.

Customize the Appearance of a Data Connector Connector

Customize the Data Connector connector's appearance in the following ways:
After a Data Connector connector is added to a Process model, optionally customize these aspects of its appearance. Each Data Connector connector's appearance may only be changed individually.

Change a Data Connector Connector's Color

A Data Connector connector's shape, icon, and label are black-colored by default.
Follow these steps to change the color for a Data Connector connector:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Data Connector connector to custom. Available options display above the selected connector.
    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 Data Connector connector's shape, icon and label change to that color.
      Specify a custom color: Click the
      icon 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 Data Connector connector's shape, icon and label change to that color.
    6.
    Click the
    icon to reset the Data Connector connector, icon, and label to its default color.

Change a Data Connector's Icon

Data Connector connectors display the
icon in the shape by default.
Follow these steps to change the icon for a Data Connector connector:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Data Connector connector to customize. Available options display above the selected connector.
    4.
    Click the Open Color Palette icon
    . The color palette displays.
    5.
    Click the
    icon. The Select a custom icon screen displays.
    6.
    From the Search drop-down menu, select the icon to display. The Data Connector connector's icon changes to the selected icon.
    7.
    Click OK.
To reset the Data Connector connector to its default icon, click the Reset to Default button from the Select a custom icon screen.

Copy a Data Connector Connector

Copying a Data Connector connector 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 Data Connector connector 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 Data Connector connector in your Process model:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Data Connector connector to copy. Available options display above the selected connector.
    4.
    Click the Copy Element icon
    . The Process model connector copies.

Delete a Data Connector Connector

Deleting a Process model connector also deletes any Sequence Flow and/or Message Flow elements incoming to or outgoing from that element. For example, if a Process model connector 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 Data Connector connector from your Process model:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Data Connector connector to delete. Available options display above the selected connector.
    4.
    Click the Delete icon
    . The Process model connector deletes.

Settings

The Data Connector connector has the following panels that contain settings:

Data Connector Panel Settings

The Data Connector connector has the following settings in the Data Connector panel:

Edit the Connector Name

A connector name is a human-readable reference for a Process model control. Process Modeler automatically assigns the name of a Process model connector with its connector type. However, a connector's name can be changed.
Follow these steps to edit the name for a Data Connector connector:
    1.
    Select the Data Connector connector from the Process model in which to edit its name. Panels to configure this connector display.
    2.
    Expand the Data Connector panel if it is not presently expanded. The Name setting displays.
    3.
    In the Name setting, edit the selected connector's name and then press Enter.

Select the ProcessMaker Data Connector

The Data Connector connector uses a Data Connector that is configured to interact with a data source, such as a Collection or a third-party Application Program Interface (API). A Data Connector must already exist before it can be selected for use in a Data Connector connector. Each Data Connector is already configured with which data source it interacts.
Collections automatically create a Data Connector when the Collection is created. Data Connectors created from a Collection by default have the same name as the Collection that it references.
Follow these steps to select the Data Connector the Data Connector connector uses:
    1.
    Select the Data Connector connector from the Process model in which to specify the Data Connector to reference. Panels to configure this connector display.
    2.
    Expand the Data Connector panel if it is not presently expanded, and then locate the Select a Data Connector setting.
    3.
    From the Select a Data Connector drop-down menu, select which Data Connector the Data Connector connector uses.
Ensure to select which of the Data Connector's Resources interacts with the data source to properly configure the Data Connector connector.

Select the Resource the Data Connector Connector Uses to Interact with the Data Source

Each Data Connector contains at least one Resource. These Resources are configured from the Data Connector itself. A Resource is an action the Data Connector uses to interact with the data source. The Data Connector connector uses a Resource to interact with the data source. These Resources may interact with Collection records, Application Program Interfaces (APIs), or other data source types. After a Data Connector has been selected from the Select a Data Connector setting, select the Resource from that Data Connector the Data Connector uses to interact with the data source.
Data Connectors created from Collections use a default set of Resources. See Resources for Collections.
Follow these steps to select which Resource the Data Connector connector uses:
    1.
    Select the Data Connector connector from the Process model in which to select the resource the Data Connector uses. Panels to configure this connector display.
    2.
    Expand the Data Connector panel if it is not presently expanded, and then locate the Select a Data Connector setting. Ensure that a Data Connector is selected from the Select a Data Connector setting. If not, see Select the Data Connector.
    3.
    Locate the Select a Resource setting.
    4.
    From the Select a Resource drop-down menu, select which Resource the Data Connector connector uses to interact with the data source.

Add Outbound Properties to Send Data to the Data Source

Configure to which data properties the Data Connector connector sends to the data source, whether that be an Application Program Interface (API) or Collection to which the Data Connector is configured to interact.
Ensure that you have configured the following before configuring outbound properties, in this order:
Outbound data may be sent to each parameter, header, or body configured in the Data Connector once.
Follow these steps to configure outbound properties:
    1.
    Select the Data Connector connector from the Process model in which to add outbound properties. Panels to configure this connector display.
    2.
    Expand the Data Connector panel if it is not presently expanded, and then locate the Outbound Configuration. Ensure that a Data Connector and a Resource are selected from the Select a Data Connector and Select a Resource settings, respectively. If not, see Select the Data Connector and Select the Resource, in that order.
    3.
    Locate the Outbound Configuration setting.
    4.
    Locate and click the
    icon. The Add Option screen displays.
    5.
    From the Type drop-down menu, select from which type of data configured for the selected Resource in which to interact with its data:
    6.
    From the Property drop-down menu, select a property configured for the selected type from the selected resource. If no properties are configured for the selected type in that Resource, Not available displays.
    7.
    In the Request Variable setting, enter using mustache syntax the Request variable name to use that variable's value when the Resource calls the data source. If the Request Variable setting value is not contained in mustache syntax, the Data Connector uses the literal string during its Resource call.
    8.
    Click Save.
Each outbound configuration to a data source property displays in the Outbound Configuration setting. An icon to the left of each outbound configuration represents its property type:
    P: The P icon represents an outbound configuration for a parameter property type.
    H: The H icon represents an outbound configuration for a header property type.
    B: The B icon represents an outbound configuration for a body property type.
Data Source properties configured to receive data from the Data Connector connector

Map Data from the Data Source to the Request's JSON Data Model

Configure how data from the data source integrates with Request data.
Ensure that you have configured the following before configuring outbound properties, in this order:
The procedure to integrate the data source's data to the Request JSON data model is called response mapping: specifying into which Request variable to store the data source's data. The Data Connector may be configured with response mapping, whereby a specified source name in the body or header of the data source response's is mapped to store that value in a specified Request variable. By relying on the Data Connector's response mapping, the Process designer only needs to select the Request variable name as mapped in the Data Connector's response without knowing technical details for this mapping.
Each JSON object contains a key name that references the JSON object, and the value for that key. If the JSON object already exists in a Request's JSON data model, then the Data Connector connector overwrites the existing JSON object value with that from the data source. If the JSON object(s) to map the data source data does not exist, then the Data Connector connector adds the JSON data object(s) to that Request's JSON data model.
Follow these steps to specify the Request JSON data object(s) to which to map the data source's data:
    1.
    Select the Data Connector connector from the Process model to map the data source's data to the Request JSON object(s). Panels to configure this connector display.
    2.
    Expand the Data Connector panel if it is not presently expanded. The Response Mapping setting displays.
    3.
    Click the
    icon to add a JSON object to which to map data from the data source. The Source and Set to Request Variable settings display to add the JSON source name and its variable, respectively, for the JSON object.
    4.
    In the Source setting, enter the name of the source from which to store the response. If the source is from Request data, such as from a Collection, the source name is data. data is the is the name of the JSON object that stores all data for each Request. However, the Source setting corresponds with how the Data Connector maps the data response: by selecting a mapped Request variable from the Set to Request Variable setting below, its corresponding source name displays in the Source setting.
    5.
    From the Set to Request Variable drop-down menu, select the Request variable as configured in the Data Connector's response mapping in which to store the data source's response. After doing so, the Source setting displays the source's name configured for that response mapping.
    6.
    Click Save.
    7.
    Repeat Steps 4 through 6 for each Request variable to store the data source's response.
Click the Delete icon
to delete a mapped response from the Response Mapping setting.

Callback Panel Setting

The Data Connector connector has the following settings in the Callback panel:

Configure the Server Callback

Configure how the Data Connector connector automatically calls back the data source by enabling the Wait for server callback setting with a callback. A callback automates receiving data from the data source, such as a third-party service, and then subsequently sending back data to that data source. The Data Connector connector monitors for data from the data source via a unique URL that may be stored in a Request variable. Likewise, the data that the Data Connector connector sends to the data source as a response may be stored in a Request variable. Configure the callback to use GET and/or POST methods to retrieve and/or send data, respectively.
In overview, a callback functions as follows:
    A Data Connector connector interacts with a data source, such as the third-party service Stripe that automates payment services. For example, a Request participant has submitted information for a payment via a Task earlier in that Request.
    The Request pauses while the Data Connector connector waits for the data source to respond. The connector monitors for that response. For example, Stripe responds that the submitted payment is accepted or rejected. The third-party service is the Data Connector's data source.
    After the third-party service processes its data and responds to the Data Connector connector, the connector calls back that data source: the connector may get data or post data to that third-party service.
For example, consider a course enrollment process where each student selects courses for that semester and then must pay for tuition. After enrolling in courses, a Task presents the student with a final invoice and payment options. When the student submits payment, the Request invokes a payment service's Application Program Interface (API), such as Stripe, to verify the payment. Use a Data Connector connector callback to monitor when the payment service's API verifies the payment information entered by the student. The Request now waits for a response from the payment service's API. The API response returns to a Request variable which can be used to determine next steps in that Request. If the student entered correct payment information and payment is honored, then their course enrollment is confirmed; otherwise the student must re-enter their payment details.
Follow these steps to specify a Data Connector connector's callback to the data source:
    1.
    Select the Data Connector connector from the Process model in which to configure the server callback. Panels to configure this element display.
    2.
    Expand the Callback panel if it is not presently expanded. The Wait for server callback setting displays, which is disabled by default.
    3.
    Enable the Wait for server callback option to configure callback settings.
    4.
    In the Variable Name for Callback URL setting, enter the URL that the data source calls to trigger a callback to the Data Connector connector. This URL may be stored in a Request variable that must be encapsulated using mustache syntax.
    5.
    In the Response Variable Name setting, enter the Request variable name within mustache syntax that stores the response from the data source. If the response is JSON, the Request variable stores the response as a JSON object. Otherwise, the Request variable stores the response as text.
    6.
    In the Accepted methods setting, toggle the GET and/or POST methods as the callback to retrieve and/or send data, respectively.
    7.
    In the Authentication drop-down menu, select one of the following authentication methods:
      None: Select the None option if no authentication is required.
      Basic Authentication: Select the Basic Authentication option to configure basic authentication. When selected, the Username and Password settings display.
      Follow these steps to enter basic authentication credentials:
        1.
        In the Username setting, enter the username to authenticate with the data source.
        2.
        In the Password setting, enter the password to authenticate with the data source.
    8.
    In the Allow Access From setting, enter the server URLs from where the Data Connector connector accepts callbacks. If a server URL is not included in the Allow Access From setting, then the Data Connector connector does not accept the response.
    Follow these guidelines to manage server URLs:
      Click the Delete
      icon to delete an added server URL.
      Click the Add
      icon to add an additional server URL.
    9.
    After entering a server URL, press Enter.

Documentation Panel Settings

Edit the Connector's Description Displayed in Process Documentation

If the Documentation package is installed, describe the connector'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 connector 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 or connector. 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 a connector:
    1.
    Select the connector from the Process model in which to edit its description. Panels to configure this connector 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 connector and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon
    .
    Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
      Undo changes: Click on the
      icon to undo the last action.
      Redo changes: Click on the
      icon to redo the last undone action.
      Insert/Edit Link: Click on the
      icon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
        1.
        Select the required text from the Rich Text control.
        2.
        Click on the
        icon. 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 icon
      to 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 icon
        to 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 icon
      to insert a page break when a PDF document is created for this documentation if your browser supports this feature.
      Format text: Follow these guidelines to format text:
        Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
        Bold: Do one of the following:
          From the editor toolbar, select the
          icon.
          From the Paragraph/Formats menu, select Inline and then Bold.
        Italics: Do one of the following:
          From the editor toolbar, select the
          icon.
          From the Paragraph/Formats menu, select Inline and then Italic.
        Underline: From the Paragraph/Formats menu, select Inline and then Underline.
        Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
        Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
        Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
        Code: From the Paragraph/Formats menu, select Inline and then Code.
        Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
        Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
        Division: From the Paragraph/Formats menu, select Blocks and then Div.
        Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
        Change text color: Use the Text Color drop-down to change text color. Click on the
        icon. The color palette displays. Do one of the following:
          Select one of the color swatches from the color palette. The selected text changes to that color.
            Click the
            icon to select a custom color from the Color Picker.
            Click the
            icon to reset the text to its default color.
        Align text: Follow these guidelines to align text:
          Left align: Do one of the following:
            From the editor toolbar, use the
            icon to left-align text.
            From the Paragraph/Formats menu, select Align and then Left.
          Center align: Do one of the following:
            From the editor toolbar, use the
            icon to center-align text.
            From the Paragraph/Formats menu, select Align and then Center.
          Right align: Do one of the following:
            From the editor toolbar, use the
            icon to right-align text.
            From the Paragraph/Formats menu, select Align and then Right.
          Justify: Do one of the following:
            From the editor toolbar, use the
            icon to justify text.
            From the Paragraph/Formats menu, select Align and then Justify.
        Insert a bullet list: Use the
        icon to format text as a bulleted list.
        Insert a numbered list: Use the
        icon to format text as a numbered list.
        Indent text: Click on the
        icon to increase text indenting.
        Outdent text: Click on the
        icon to decrease text indenting.

Advanced Panel Settings

Edit the Node's Identifier Value

A Process node represents a component of a Process model, whether that is a BPMN element or a connector. Process Modeler automatically assigns a unique value to each Process node added to a Process model. A Process 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 Data Connector connector:
    1.
    Select the Data Connector connector from the Process model in which to edit its identifier value. Panels to configure this connector 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 Data Connector connector's identifier to a unique value from all nodes in the Process model and then press Enter.

Related Topics

Last modified 3mo ago