Sugar Messaging Release Notes

Owned by Jeff Bickart (Deactivated)
Last updated: Mar 19, 2021
9 min read

 

 

Table of Contents

2.5.11

  • Sugar 10.3 has increased the scrutiny of files passing through the package scanner. The file custom/include/SugarObjects/templates/person/vardefs.php did not have $module defined as it part of the compliation of the cache/modules/<Module>/<Module>Vardefs.php. We updated the file to pass with Sugar 10.3 package scanner.

  • Updated the custom phone field to work the changes

  • Resolved issue where the Messaging Template was incorrectly indicating that a field was locked

  • When working with a Messaging Template, you can now place the fields where the cursor is located. Previously, the field was always placed at the end of the message box.

  • Added the ability to have custom template parsing when using Sugar Messaging with modules other than, Contacts, Leads, Targets. Add a file custom/modules/PH_SMSMessages/include/customParser.php to add the functionality

  • Updated the Carrier Lookup for Ytel to return any errors directly from Ytel

  • Example Code

    <?php class customParser { /** * Update the $bean->description with any additional parsing required * * @param PH_SMSMessages $bean * @throws SugarApiExceptionNotFound */ function parse(PH_SMSMessages &$bean) { if ($bean->parent_type === 'PC1_PC_Phone') { $pc1_pc_phone = BeanFactory::getBean($bean->parent_type, $bean->parent_id); if (!empty($pc1_pc_phone->id)) { if (isset($pc1_pc_phone->leads_pc1_pc_phone_1leads_ida)) { $bean->description = EmailTemplate::parse_template($bean->description, array('Leads' => $pc1_pc_phone->leads_pc1_pc_phone_1leads_ida)); } else { if (isset($pc1_pc_phone->contacts_pc1_pc_phone_1contacts_ida)) { $bean->description = EmailTemplate::parse_template($bean->description, array('Contacts' => $pc1_pc_phone->contacts_pc1_pc_phone_1contacts_ida)); } } } } } }

2.5.10

  • Removed debugging statements from dashlets and configuration screens

2.5.9

Version 2.5.8

  • Sugar 10.2 altered the footer for SugarLive; we have updated the code to add the Messaging option back onto the footer

Version 2.5.7

  • Sugar 10.2 introduced even more restrictions as part of the package scanner. This version will pass the updated package scanner.

  • Added the ability to set the default country via the connector settings. This should be the 2 letter country code, e.g., US, AU

Version 2.5.6

  • Sugar 10.1 introduced new restrictions as part of the package scanner. This version will pass the updated package scanner.

Version 2.5.4

  • Resolved issues with variable types used when communicating to the various providers

Version 2.5.3

  • Resolved issue with merging Contacts, Leads or Prospects

  • Added missing icon for the Do Not Message module so that it appears correctly in reports

  • Added the ability to extend finding the inbound caller. This will allow for searching in modules other than Contacts,Leads, Prospects and Users

  • Added the ability to click to message on the list and sub-panels views

  • Correct the template for Phone Mobile to correctly display the Click to Call if Skype Out is enabled

Version 2.5.2

  • Resolved an issue with utilizing additonal modules with a phone_mobile to generate a message

Version 2.5.1

  • Twilio is now available as a SMS Provider

Version 2.5.0

  • Refactored Sugar Messaging to support additional SMS providers such as Twilio, Plivo, Nexmo and Infobip

  • Improved the display of inbound/outbound MMS messages on the Messages record view and the Messages Dashlet

Version 2.0.2

Bug Fixes

  • Added sms_reminder_time and sms_reminder_sent fields to Calls and Meetings. These fields are used to send SMS Reminders.

Version 2.0.1

Sending Messages from the List View

  • We have improved the Mass Sending of SMS Messages.

    • Mass Sending of SMS Messages from the List View will now queue the messages and send them in the background

Bug Fixes

  • The ID generated for the Do Not Message module has been updated to utilize the standard ID generation functionality of Sugar

  • We have corrected the width of the text areas to type a message within the Chat Dashlet on record views

Version 2.0.0

MMS

  • MMS enabled phone numbers can be purchased for an extra fee

    • Images and MP4s can be sent and received on MMS enabled numbers.

      • SMS enabled numbers can not receive or send images

    • The List Numbers API from Ytel now includes details about the phone number being MMS enabled; the logic has been updated to download MMS information directly from Ytel via the Download Phone Numbers functionality

Messages Dashlet

  • The Chat dashlet has been rewritten; users can now have a full conversation from within the dashlet.

    • The dashlet enables outbound SMS messages from within the dashlet

    • The dashlet will automatically display inbound messages as they arrive

    • The dashlet will display MMS images

    • The dashlet will display all message to the Mobile Phone number

Messages Record View

  • Users can reply to a message directly from viewing a Message.

    • The record view will display MMS images

    • The record view is now editable; you can add custom fields and they will be able to be edited.

    • In addition to sending Messages to Contacts, Leads, and Prospects, it is now possible to send messages to Users

Meetings and Calls

  • The record view has been updated to add a Message Reminder Time along with the OOTB Popup and Email Reminder Time

    • SMS reminders will automatically be sent to all Contacts, Leads, Prospects, and Users

       

Schedulers

  • A scheduler has been added that has the ability to download inbound messages. This is down to ensure that no messages are missed. OOTB this is setup to execute once per hour.

    • A scheduler has been added to send SMS message reminders for Calls and Meetings

    • A scheduler has been added to properly format the Mobile Phone of Contacts, Leads, Prospects and Users

Command Line

  • A command-line addition has been added to the bin/sugarcrm command. This adds the ability to manually download all inbound messages from the previous year. The command is bin/sugarcrm fbsg:downloadinboundmessages

    • the command-line takes as a parameter an interval. This is can be D, M or Y. Examples: 1D (1 Day), 1M (1 Month), 1Y (1 Year)

International SMS

  • International SMS enabled phone numbers can be purchased for an extra fee

    • When sending an SMS to an international number, the sending algorithm will select a local in-country phone number to send from.

    • If no available in-country phone number is available. The message will not be sent.

Contact, Leads, Prospects

  • The Messages sub-panel has been updated to display all messages to the records mobile phone number

    • The field, phone_mobile_e164, has been added to the contacts, leads and prospects tables. Along with a corresponding index.

Users

  • The field, phone_mobile_e164, has been added to the contacts, leads and prospects tables. Along with a corresponding index.

Do Not Message

  • A new module has been added that centralizes the Do No Message functionality across the mobile phone number

    • This functions like the opt-out of an email address

    • Before sending a message, the phone number is checked for Do Not Message

    • Inbound SMS messages are checked for the opt-out word, STOP, END, QUIT, CANCEL and UNSUBSCRIBE. If one of these single words is received. The phone number will be marked as Do Not Message.

      • (The opt-out word must be the only word in the message. They are not case sensitive)

    • Conversely, Inbound SMS messages are checked for the opt-in word, START or SUBSCRIBE. This will remove the Do Not Message flag.

Notifications

  • The administrator can configure who will be notified of the inbound messages. Options are the record owner or the most recent person who sent the message.

Bug Fixes

  • Inbound voice calls to US-based SMS numbers will properly be redirected.

Version 1.2.11

Version 1.2.5

  • Added custom logic to handle Ytel's international beta program to be used

  • Added highlight.js to the chat window do that URLs are clickable

Version 1.2.1

  • Corrected issue where an error generated by the messaging platform, will properly get set in the messaging module

Version 1.2.0

  • Added a new field to the Phone Numbers module. The new field Ringback Phone Number is used if a person calls the SMS Number. The inbound call will be redirected to the Ringback Phone Number. If there is not a Ringback Phone Number, the default phone number setup in the configuration will be used.

  • Added a new field to the Messages Module that indicates whether the message has been read or unread. This field can be used in Dashlets, workflows, etc. There is also added functionality to mark the message as read/unread on both the record view and within the Chat Dashlet

  • SMS Messages are limited to 1,600 characters. This is enforced by the SMS Vendor. If there is an error sending a message, the message will be flagged as failed and an error will be shown.

  • Chat Dashlet

    • The red eye icon with a slash threw it indicates that the message has not yet been read.

    • The green eye icon without the slash indicates that the message has been read.

    • Clicking either eye icon, will update the Message with appropriate new status

    • Added a link icon will take you directly to the message so you can view the details

    • Corrected an issue where the details of a message will now display properly if the message has newlines

  • As an administrator, you can now access the Phone Number module from the Messages menu.

  • If a voice call were to be placed to an associated Messaging Phone Number, the call will be routed based upon these rules

    • If there is a Ringback Phone Number set in the Messaging Phone Number, the Ringback Phone Number will be called.

    • If there is not a Ringback Phone Number, the Company Phone Number in the Messaging Setup will be used, SugarCRM/#PH_SMSMessages/layout/setup

Version 1.1.8

  • Corrected logic so that a message can be sent from mobile

  • Added default layouts of mobile screens

  • Limited a message to 160 characters in desktop

  • Expanded the Chat History Dashlet to take up more of the Intelligence Pane

  • Automatically scroll the Chat History Dashlet to the most recent message

  • Added visual elements to the Chat History Dashlet so that the user can tell if a message is queued, success, or other

  • The Sugar Notifications will no include the inbound SMS Message and not a generic message

Version 1.1.7

  • Continued removing of all references to debugging

  • Fixed issue with Sugar 7.8 and Campaigns by adding a require_once to the view.detail.php

Version 1.1.6

  • Added new Dashlet for the Contacts/Leads/Prospects/Messaging Modules that shows the threaded conversation

  • Added a new status if an error is received when sending a message to Ytel and the person is on the DNC list or has sent a STOP message

  • Cleaned up JavaScript and PHP - removed debugging statements

Version 1.1.5

  • Updated some program files for compatibility with Sugar 7.8 and PHP 5.6

Version 1.1.4

  • Corrected an issue where variables needed for mass sending of messages were missing. Added the missing variable back to Contacts, Leads, and Prospects

Version 1.1.3

  • Upon an inbound Message being received, we have added to the notifications. You will be notified in the upper right-hand corner.

Version 1.1.2

  • Added new configuration options. On the configuration screen, the following fields are now available

    • Expiration Date: Is the date your license expires

    • Days Until License Expires: Number of days remaining before your license expires. This is calculated once per day if a SMS is sent. The number of days only gets updated if an SMS is sent

    • Your company phone number is required, this field is for a future function that will direct inbound phone calls to your SMS message phone numbers.

    • Phone Number Format: Allow you to choose from the available options to format how phone numbers will be stored in the DB and displayed on the screen.

    • URL - If there is a proxy or the $sugar_config['site_url'] is not correct, this is where you will enter your proxy URL; the URL should not include the /rest/…..

    • Enabled: Is automatically set based upon the Expirations Date

  • We have added the ability to use the template fields functionality on regular messages.

Version 1.1.1

  • Added the additional configuration options for Phone Number Format and Inbound Phone Routing

  • Added to the fbsg_PhoneNumbers module a new field mms_enabled. This field is not exposed to the UI. If this field is set to 1, upon creation of a message, a new option is presented which allows an MMS message to be sent

  • MMS Messages can only be sent by Ytel with Phone Numbers that are MMS enabled. You must contact Ytel support support@ytel.com to ask for an MMS enabled phone number.

Version 1.1.0

  • Compatibility with Sugar Cloud

  • Ability to download available Phone Numbers from Ytel, that can be used to send SMS Messages

Version 1.0.1

  • Licensing has been added, validation that a license is valid before sending a message

  • Configuration of the Environment from the Configuration Screens, all you need to know is your License Key

Version 1.0.0