Links

DocuSign Connector

Customize and send documents for signatures by fully integrating DocuSign’s eSignature functionality into your Processes.

Overview

DocuSign eSignature provides a service to digitally sign legally-binding documents including contracts, account openings, and invoices. You require a DocuSign eSignature account, and its accompanying token, to use the DocuSign connector in your Process models.
See the example how to get a DocuSign eSignature app integration and secret key with which to configure ProcessMaker to use a DocuSign eSignature template, and then configure a DocuSign connector.

Package and Permissions Required

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

Follow these steps to add a DocuSign connector to the Process model:
  1. 1.
    View your Processes. The Processes page displays.
  2. 2.
    Create a new Process or click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
  3. 3.
    Locate the DocuSign connector's icon
    in the Elements and Connectors palette that is to the left of the Process Modeler canvas.
  4. 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 DocuSign connector cannot be placed outside of the Pool element.
The DocuSign Connector
After adding the DocuSign 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 DocuSign connector has the following limitations in regards to the following Process model elements:
  • Pool element: If the 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 connector inside the Pool element closest to where you attempt to move it.
  • Lane element: If the connector is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the connector cannot be moved outside of the Pool element.

Customize the Appearance of a DocuSign Connector

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

Change a DocuSign Connector's Color

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

Change a DocuSign Connector's Icon

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

Copy a DocuSign Connector

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

Delete a DocuSign 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 DocuSign connector from your Process model:
  1. 1.
    View your Processes. The Processes page displays.
  2. 2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
  3. 3.
    Select the DocuSign connector to delete. Available options display above the selected connector.
  4. 4.
    Click the Delete icon
    . The Process model connector deletes.

Settings

The DocuSign connector has the following panels that contain settings:

Configuration Panel Settings

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 DocuSign connector:
  1. 1.
    Select the DocuSign connector from the Process model in which to edit its name. Panels to configure this connector display.
  2. 2.
    Expand the DocuSign panel if it is not presently expanded. The Name setting displays.
  3. 3.
    In the Name setting, edit the selected connector's name and then press Enter.

Document for Signature Panel Settings

Edit the DocuSign Template ID and User Roles

Select a DocuSign Template ID referencing the document for which an eSignature is required and select recipient roles for users to sign the document. For more information on how to create a DocuSign template and create recipient roles, refer to Working with Templates - DocuSign eSignature User Guide.
Ensure the following before configuring the settings described in this section:
  • Your organization uses a DocuSign eSignature account.
  • You created a template for the document in which this DocuSign connector is to solicit signatures. This template must be configured with at least one role.
  • You created a DocuSign app that uses this DocuSign template.
  • Your ProcessMaker settings for DocuSign are configured with the DocuSign app integration and secret keys that use this DocuSign template. Your DocuSign settings must also be configured with the DocuSign server and authorized access to that server to authenticate your DocuSign app's integration and secret keys.
Contact your ProcessMaker Administrator for assistance if necessary.
See this example.
Follow these steps to select a Template ID and recipient role(s):
  1. 1.
    Select the DocuSign connector from the Process model in which to edit its name. Panels to configure this connector display.
  2. 2.
    Expand the Document for Signature panel. Settings for this panel display.
  3. 3.
    From the Template ID setting, select the DocuSign template that references the document to send for eSignature. The template list populates from your DocuSign server specified in the DocuSign settings. If you do not see your templates here, review the DocuSign eSignature templates in your DocuSign account. Note that you may need to ask your ProcessMaker Administrator for assistance.
  4. 4.
    After a DocuSign template is selected, recipient roles populate from DocuSign. For guidance on how to define recipient roles, see Create Templates - DocuSign eSignature User Guide.
  5. 5.
    Click the settings
    icon to view or edit a Role. Named recipient roles created in DocuSign display with predefined values which cannot be edited in Process Designer.
    Placeholder recipient roles created in DocuSign must be configured in Process Designer.
    From the Select a Type drop-down menu for each role, select one of the following options:
    • User: Select the User option to email the document to a selected user. The Send to User setting displays. From the Send to User setting, select which user serves as that role. The email address associated with this user account is used to send the document for eSignature. This is a required setting when the User option is selected.
    • Requester: Select Requester to email the document to the Request starter.
    • User ID: Select User ID to email the document to a user based on a Variable Name value as entered into a Screen during a previous Task in that Request. For example, if a Line Input control in a Screen has the Variable Name setting value of UserId that contains a user's ID, then use that value to thereby send the document for eSignature. When this option is selected, the Send to User ID setting displays. The email address associated with this user account is used to send the document for eSignature. This is a required setting when the User ID option is selected.
    • Email Address: Select Email Address to email the document to a non-ProcessMaker user. When this option is selected, Recipient Email and Recipient Name settings display. Enter the email address and name for the intended recipient, respectively. The Recipient Email and Recipient Name settings are required when the Email Address option is selected.
    • Process Manager: Select Process Manager to email the document to the owner of the Process. The Process Manager understands the Process design and workflow dynamics to troubleshoot Request routing incidents. Ensure that a Process Manager is configured for this Process. This option is only available if the Advanced User package is installed.

Response Options Panel Settings

Edit Signature and Output Variable Settings

Configure whether to pause a Request while awaiting user signatures and how to save the response from DocuSign.
Follow these steps to configure the response from DocuSign:
  1. 1.
    Select the DocuSign connector from the Process model in which to edit its response. Panels to configure this connector display.
  2. 2.
    Expand the Response Options panel. Settings for this panel display.
  3. 3.
    From the Wait for Signature setting, select one of these options:
    • Yes: Select Yes to wait for the user to sign this document. When this option is selected, the Request pauses and does not resume until the document is signed.
    • No: Select No to continue the Request irrespective of whether the user signs this document. This is the default option.
  4. 4.
    In the Output Variable setting, enter the Request variable in which to save the response from DocuSign.

Loop Characteristics Panel Settings

Specify Characteristics to Perform Multiple Instances of the Task

Use the Loop Characteristics panel settings to specify how to perform multiple instances of this element. The following loop modes are available for this element:
  • No Loop Mode: Select the No Loop Mode option to perform this element's Task only once.
  • Loop: Select the Loop option to sequentially repeat this element's Task multiple times until an exit condition is True. This is useful when a Task should be performed multiple times with the same set of data, such as, processing a credit card payment. This loop mode has the following characteristics:
    • The element's Task is repeated until the exit condition is True or the maximum iterations limit is reached.
    • At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
    • The same exit condition evaluates at the end of each instance; however, value(s) of the Request variable(s) used in the exit condition can change during an instance resulting in the exit condition to eventually evaluate as True.
    • If any one instance of that Task does not complete, workflow pauses.
    • All active instances are terminated if an interrupting boundary-type event element triggers.
    • An element configured in this mode shows the Loop icon
      in Process Modeler.
  • Multi-instance (Parallel): Select the Multi-instance (Parallel) option to perform this element's Task multiple times in parallel a fixed number of times. This is useful when performing any action in bulk, such as sending an email to several people. This loop mode has the following characteristics:
    • Instances of the Task are governed by the size of an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respective array index.
    • All instances begin simultaneously when this element triggers; however, they perform their Task independently of each other.
    • The Task as a whole completes when all instances are complete.
    • The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
    • All active instances terminate if an interrupting boundary-type event element triggers.
    • An element configured in this mode shows the Multi-instance (Parallel) icon
      in Process Modeler.
  • Multi-instance (Sequential): Select the Multi-instance (Sequential) option to perform this element's Task multiple times sequentially a fixed number of times or until an exit condition is True. This is useful when sequentially repeating a Task multiple times but with a different set of data each time. This loop mode has the following characteristics:
    • Instances of the Task are governed by the size an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respect array index.
    • At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
    • At the end of each instance an exit condition evaluates and the loop activity halts if the exit condition is True.
    • The Task as a whole completes when all instances are complete.
    • The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
    • All active instances terminate if an interrupting boundary-type event element triggers.
    • An element configured in this mode shows the Multi-instance (Sequential) icon
      in Process Modeler.
‌Follow these steps to specify characteristics to perform multiple instances of the Task:‌
  1. 1.
    Select the element from the Process model in which to specify multiple instance characteristics. Panels to configure this element display.
  2. 2.
    Expand the Loop Characteristics panel. The Loop Characteristics setting displays. By default, Loop Activity is set to No Loop Mode and the Task is performed only once.
  3. 3.
    From the Loop Mode setting, select one of the following options to perform this element's Task more than once.
    • Loop: Select the Loop option. The settings for this loop mode display:
      Follow these steps:
      1. 1.
        In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.
      2. 2.
        In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
    • Multi-instance (Parallel): Select the Multi-instance (Parallel) option. The settings for this loop mode display:
      Follow these steps:
      1. 1.
        In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
      2. 2.
        In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
    • Multi-instance (Sequential): Select the Multi-instance (Sequential) option. The settings for this loop mode display:
      Follow these steps:
      1. 1.
        In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
      2. 2.
        In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
      3. 3.
        In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.

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.

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. 1.
    Select the connector from the Process model in which to edit its description. Panels to configure this connector display.
  2. 2.
    Expand the Documentation panel if it is not presently expanded. The Description setting displays.
  3. 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. 1.
        Select the required text from the Rich Text control.
      2. 2.
        Click on the
        icon. The Insert/Edit Link screen displays.
      3. 3.
        In the URL setting, enter the destination URL.
      4. 4.
        In the Text to display setting, edit or enter the text displayed in the Rich Text control.
      5. 5.
        In the Title setting, enter the text to display when a user hovers over the displayed text.
      6. 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. 1.
        Click on the Insert/Edit Image icon
        .
      2. 2.
        The Insert/Edit Image screen displays:
      3. 3.
        In the Source setting, enter a URL for the image.
      4. 4.
        In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
      5. 5.
        In the Width setting, enter the maximum width for the image.
      6. 6.
        In the Height setting, enter the maximum height for the image.
      7. 7.
        Toggle the Constrain Proportions icon
        to maintain the width-height ratio of the image to its original proportion.
      8. 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 connector:
  1. 1.
    Select the connector from the Process model in which to edit its identifier value. Panels to configure this connector display.
  2. 2.
    Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
  3. 3.
    In the Node Identifier setting, edit the connector's identifier to a unique value from all nodes in the Process model and then press Enter.