Communication Step Glossary
- 14 Dec 2021
- 7 Minutes to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
Communication Step Glossary
- Updated on 14 Dec 2021
- 7 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The following article details all steps found in the Communication category in the Step Toolbox.
| Step Name | Description | Location | Inputs/Outputs |
|---|---|---|---|
| Create Tile Return | Adds a Tile Return that can be used as an Output for Tile Flows. These can display data such as counters on Dashboards. | Communication > Dashboards | Inputs: BackgroundColor (DesignerColor), Tile Type Name (String), Tile Action Type (TileReturnActionType) Outputs:TileData (TileReturn) |
| Send Email | The Send Email step allows users to send a message to a User or list of users, and format the email message using data in the current Flow. It is unnecessary to use a Send Email step to notify people about assigned tasks. Creating assigned tasks automatically triggers notifications which include email, SMS, and popups in the Portal. | Communication | Inputs: From, To, Reply To, CC, BCC, Subject, Body, Email Template (String), High Priority, Use SMTP Settings, Clean Up HTML, ShowFail Path, Retry on Fail (Boolean), Attachments(FileData), Email Content Type (EmailContentType) Outputs: "Sent" |
| Send Notification | The Send Notification step allows users to send either an Email, IM, Popup, or SMS to an account or a group of users. These settings regarding SMS and IM are defined under each Decisions Account. | Communication | Inputs: Subject, Message, Accounts and Groups (String), NotifyGroup, NotifyUser (String[]), NotificationType (NotificationCommunicationType). Outputs:"Done" |
| Show Popup | This step shows a pop up in the User Portal or the Designer Studio. Note: This is the same type of pop up that alerts a user when they have a new task assigned to them. If used in a Flow that is Asynchronous, Popups may not display. | Communication | Inputs: Subject, Message, EntityTypeName, EntityId (String), Specify User (Boolean), Popup Location (PopupLocation) Outputs: "Done" |
| Delete (IMAP) | This step deletes an email from the specified IMAP inbox. Users need to map in the username, password, server address, and port for the IMAP Inbox. This step has no outputs as it performs an action outside of Decisions. | Communication > IMAP | Inputs: Server, Username, Password, Unique Id, Folder (String); Port (Int32); Secure Connection, Purge Deleted (Boolean). Outputs: "Deleted" |
| Get Email (IMAP) | This step gathers emails from a specified IMAP server. | Communication > IMAP | Inputs: Server, Username, Password, Unique Id, Folder (String); Port (Int32); Secure Connection (Boolean). Outputs: Message (Email) |
| Get Headers (IMAP) | This step will get (fetch) the headers for an email on an IMAP server. Users designate the server's settings and then determine how many emails are retrieved via the Count Input. | Communication > IMAP | Inputs: Server, Username, Password (String); Port, Count (Int32); Secure Connection, Unreaded Only (Boolean). Outputs: Headers (EmailHeader). |
| Mark As Read (IMAP) | This step will mark emails as read on an IMAP Server. | Communication > IMAP | Inputs: Server, Username, Password, Unique Id, Folder (String); Port (Int32); Secure Connection (Boolean). Outputs: "Done" |
| Mark As Unread (IMAP) | This step will mark an email as unread on an IMAP Server. | Communication | Inputs: Server, Username, Password, Unique Id, Folder (String); Port (Int32); Secure Connection (Boolean) Outputs: "Done" |
| Move (IMAP) | This step will move emails on an IMAP server from one Folder to a different one. The source Folder path and destination Folder path Inputs take in names of the emails current Folder and destination Folder respectively. The message id field is populated using the 'unique id' Output of the 'Get Headers' step. | Communication > IMAP | Inputs: Server, Username, Source Folder Path, Destination Folder Path, Message Id (String); Port (Int32); Secure Connection, Purge Deleted After Move (Boolean). Outputs: "Done" |
| Send Email To Contact | The Send Email to Contact step is used to send a configured Email from Decisions, to a specified contact. The step utilizes the Contact Info data type which can be contains a number of elements such as Email addresses, Phone numbers, and Addresses for a contact. The step's Email is configured similarly to other messaging steps, allowing users to customize the Subject, Body, and Attachments. | Communication > Email | Inputs: From (String), Contact Info (ContactInfoOwner), Subject (String), Body (String), Attachments. Outputs: None |
| Send Email To Multiple Contacts | The Send Email to Multiple Contacts step is used to send a configured Email from Decisions, to a list of specified contact. The step utilizes the Contact Info data type which can be contains a number of elements such as Email addresses, Phone numbers, and Addresses for a contact. The step's Email is configured similarly to other messaging steps, allowing users to customize the Subject, Body, and Attachments. The Step also offers an additional boolean that only sends the Email to primary Email addresses. The Send Email to Multiple Contacts step is used to send a configured Email from Decisions, to a list of specified contact. The step utilizes the Contact Info data type which can be contains a number of elements such as Email addresses, Phone numbers, and Addresses for a contact. The step's Email is configured similarly to other messaging steps, allowing users to customize the Subject, Body, and Attachments. The Step also offers an additional boolean that only sends the Email to primary Email addresses. | Communication > Email | Inputs: From, Bcc Contacts, CC Contacts, Send Email To Primary Email Address Only, To Contacts, Subject, Body, Attachments. Outputs: None |
| Send Email With Custom Server | The Send Email With Custom Server allows users to send an Email from a configured SMTP Server, from a Decisions Work Flow. This steps acts similar to other Email steps, asking users to configure the Subject, Body, and any applicable Attachments for the Email. Users configure the SMTP Server by configuring the Server Address, any required Authentication, SSL settings, and the Port number. | Communication > Email | Inputs: From, To, High Priority, Subject, Body, Attachments, SMTP Server. Outputs: None |
| Send SMS To Contact | The Send SMS to Contact step is used to send an SMS (text) message to a configured contact. The Step utilizes the ContactInfoOwner input to determine who to send the message to. Note: Phone contacts can be configured by Build Data mapping the ContactInfoOwner input, and then building an array on the Phones input. The input allows users to add a phone number, declare the type of phone, and select the SMS Carrier. | Communication > Email > Notification | Inputs: From, Contact Info, Subject, Body, Attachments. Outputs: None |
| List Folders (IMAP) | The List Folders (IMAP) step lists the available Folders of an IMAP Server. The step uses the Server's credentials (Server Address, Username, Port Number, Password, and whether the connection is secure) to access the Server. The step then outputs the list of folders as a string. The List Folders (IMAP) step lists the available Folders of an IMAP Server. The step uses the Server's credentials (Server Address, Username, Port Number, Password, and whether the connection is secure) to access the Server. The step then outputs the list of folders as a string. | Communication > Email > IMAP | Inputs: Password, Port, Secure Connection, Server, Username. Outputs: Folders Found |
| Get Headers in Folder (IMAP) | The Get Headers in Folder step uses an IMAP server's credentials (Server Address, Username, Password, Port Number) as inputs to access an IMAP Server to pull Header data into Decisions. The step uses the Folder Path input to determine which folder to check, and the Count input to determine how many Email headers to pull into Decisions. The Headers data type outputs as a variety of String outputsThe Get Headers in Folder step uses an IMAP server's credentials (Server Address, Username, Password, Port Number) as inputs to access an IMAP Server to pull Header data into Decisions. The step uses the Folder Path input to determine which folder to check, and the Count input to determine how many Email headers to pull into Decisions. The Headers data type outputs as a variety of String outputs. | Communication > Email > IMAP | Inputs: Count, Folder Path, Password, Port, Secure Connection, Server,Unread Messages Only, Username. Outputs: Headers |
| Get Count (IMAP) | The Count (IMAP) step outputs the number of Emails on an IMAP server as Int32 datatype. The step takes in the server's credentials (such as the Server Address, Username, Password, Port Number) as inputs to access an IMAP Server. Users designate which Folder to take the count from via the Folder Path input, and may designate whether they want a count of just the unread messages, via the Unread Messages Only boolean. | Communication > Email > IMAP | Inputs: Folder, Password, Port, Secure Connection, Server, Unread Messages Only Username. Outputs: Count |
| Send Notification (Advanced) | The Send Notification (Advanced) step is used to send a user configured notification based parameters set by the Message Input. This parameter allows the user to define the following: ActionEntities, Attachments, FolderId, FolderPath, From address, NotificationMessageType, Popup Location, Response URL and its name, and the Subject and Text in the message. Successful configuration of the Flow results in a displayed notification according to those set parameters. | Communication > Email > IMAP | Inputs: Folder Id, Message, Notification Type Name. Outputs: None |
| Send Notification With Files | The Send Notification With Files step is used to send a configured notification that contains a file attachment. The step allows the user to configure typical message parameters in the form of a Subject and Message String Input, and a Folder id. Additionally, the step requires the selection of a MSGtype via drop down, as well as a Notification Type Name to determine the notification’s behavior. For more information on notification behavior, see attached documentation. | Communication > Email > IMAP | Inputs: Files, Folder Id, Message, MSGtype, Notification Type Name, Subject. Outputs: None |
| Send Notification With URL | The Send Notification With URL step is used to send a configured notification that contains a URL. The step allows the user to configure typical message parameters in the form of a Subject and Message String Input, URL and its name input, and a Folder id. Additionally, the step requires the selection of a MSGtype via drop down, as well as a Notification Type Name to determine the notification’s behavior. For more information on notification behavior, see attached documentation. A successful running of the step results in a notification that displays according to the defined parameters. | Communication > Email > IMAP | Inputs: Folder Id, Message, MSGtype, Notification Type Name, Subject, URL, URL Name. Outputs: None |
Was this article helpful?
