Slack Notification Connector
Send automatic notifications to Slack channels during Requests.
Overview
The Slack Notification connector is part of the Slack Notification package. When you add the Slack Notification connector to your Process model and then select to which Slack channel to send a notification, ProcessMaker Platform can automatically send notifications via Slack during Requests.
Grant ProcessMaker Platform Access to Your Slack Workspace
Before using the Slack Notification connector in your Process models, your ProcessMaker Platform instance must be granted access to your Slack workspace by building a Slack App. Ask your Slack administrator to help you with the following:
Otherwise, when configuring the Slack Notification connector, the following ProcessMaker Platform error displays: Request failed with status code 404.
Package and Permissions Required
The Slack Notification package must be installed to use the Slack Notification connector.
Furthermore, your user account or group membership must have the following permissions to configure a Slack Notification 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 Slack Notification Connector to the Process Model
Add a Slack Notification connector 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 Slack Notification connector from the Explorer panel to the Process model:
Locate the Slack Notification object category from one of the following locations in the Explorer panel:
Pinned Objects: The Slack Notification object category displays from the Pinned Objects section when it is pinned. This element type is not pinned by default.
Object Category: The Slack Notification object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this connector type may be placed into the Process model.
After adding the Slack Notification connector, consider adding the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:
Boundary Timer Event element (Don't know what that is?)
Boundary Error Event element (Don't know what that is?)
After the connector is placed into the Process model, you may adjust its location in the following ways:
Move the connector by dragging it to a new location.
Select the connector 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 connector in relation to other selected elements and/or connectors.
Moving a Slack Notification connector has the following limitations in regards to the following Process model elements:
Pool element: If the Slack Notification 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 Slack Notification connector inside the Pool element closest to where you attempt to move it.
Lane element: If the Slack Notification connector is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Slack Notification connector cannot be moved outside of the Pool element.
Change a Slack Notification Connector's Appearance
See Customize the Appearance of a Process Model Object.
Copy a Slack Notification Connector
See Copy Process Model Objects into the Clipboard.
Clone a Slack Notification Connector
See Clone Process Model Objects Without the Clipboard.
Delete a Slack Notification Connector
See Delete Process Model Objects.
Settings
The Slack Notification connector has the following panels that contain settings:
Loop Characteristics panel
Documentation panel (available when the Documentation package is installed)
Configuration Panel Settings
The Slack Notification connector has the following settings in the Configuration 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:
Select the Slack Notification connector from the Process model in which to edit its name.
In the Name setting, edit the selected connector's name and then press Enter.
Select the Slack Channel to Send the Notification
Select to which Slack channel to send the notification. Slack channels are only available for the Slack workspace that your ProcessMaker instance is granted access.
Follow these steps to select to which Slack channel to send the notification:
Select the Slack Notification connector from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Select a Slack Channel drop-down menu, select the Slack channel to send the notification.
Enter the Slack Notification Message to Send
Follow these steps to enter the Slack notification message to send:
Select the Slack Notification connector from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Input Your Message setting, enter the notification message and then press Enter.
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.
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.
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.
Follow these steps to specify characteristics to perform multiple instances of the Task:
Select the element from the Process model in which to specify multiple instance characteristics.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
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.
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:
In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.
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:
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.
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:
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.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
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:
Select the connector 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.
Related Topics
Slack Notification PackageWhat is a Connector?What is a Package?Last updated