Overview
Messages Manager gives you the ability to communicate key information from InFocus. With support for on-event emailing, you'll be able to keep your staff and clients more connected through InFocus.
Note Messages Manager is developer tool. If additional assistance is needed, please contact Clearview Support.
Field Descriptions
Toolbar
| • | New - Creates a new message under the selected message type |
| • | Save - Saves the selected message |
| • | Copy - Copies the selected message |
| • | Delete - Deletes the selected message |
| • | Send Test - Sends a test based on a provided KeyID |
Messages Tab
Selections Pane
| • | Message Type (drop down) - Used to categorize messages (e.g Email, Webhook, etc.) |
| • | Name (selection pane) - List of messages to select from |
Messages Pane
| • | Name - Name of the selected message |
| • | Message Type - Designates the message type for categorization |
| • | Content Wrapper - Specifies a content wrapper to define the design of the email |
| • | IsActive - When checked, message is active |
Content Tab
Defines the content to be sent in the message. While messages can be used for purposes other than email, for context, the documentation below
| • | Subject - Message subject |
| • | SMTP Relay - SMPT Relay used to send the message. Available relays are defined via AD>Global Settings>SMTP / Webhoook Relay Servers. |
| • | HTML Body - Body of the message, supports HTML markup. |
| • | Body - Body of the message, supports plain text. Only used if HTML Body is blank. |
| • | Preview - Click to render a preview of the message. |
Queries Tab
Messages are dynamic in that they can be used to communicate a defined set of information to one or many recipients.
These parameters are defined on the Queries tab.
| • | Render Variables - Used to return a result set for processing when rendering a message. The result set must contain two columns. |
| o | VariableName (nvarchar) - Name of the variable. Must be defined in the query and should be returned as a string wrapped in braces (e.g. '{{Body}}'). The VariableName can be referenced in the content of the message. For instance, the HTML Body could contain a reference to {{Body}} which, upon render, would be replaced with the VariableValue. |
| o | VariableValue (nvarchar) - Results returned in the variable. Must be declared in the query (e.g. @Body) |
| o | KeyID - Specifies the internal InFocus record ID to use in the query. |
| • | Recipient List - Query to define the recipients. The result set should return the following columns- one of which should be null. |
| o | EmpID (int) - Use to specify a single Employee |
| o | Receipients (nvarchar) Use to supply a comma separated list of email addresses. |
| • | Attachments - Query to define documents to be sent with the message. The result set should return the the following columns |
| o | PdfFileName (nvarchar) - If supplied, all files with matching values will be merged into a single PDF file. Optional. |
| o | ZipFileName (nvarchar) - If supplied, all matching values will be added to a .zip file. Optional. |
Headers Tab
Optionally supply additional Headers. The header values will be processed by the Render Query as well as the Standard Variable Replacement.
Wrappers Tab
| • | Content Variable - Variable Name, must be contained in braces (e.g. {{TEMPLATE-CONTENT}} |
| • | Wrapper Text - Style sheet to be used by the wrapper. |
|