Difference between revisions of "Upgrades"

From SmartWiki
Jump to: navigation, search
m
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==General Details==
+
=General Information=
===Upgrade Dates===
+
==Current Upgrade Dates==
Public Cloud Production release date: '''March 11 2021'''<br />
+
Key Release Date: '''November 14 2024'''<br />
Public Cloud Backup release date: '''February 23 2021'''
+
Key Backup Release Date: '''October 29 2024'''
  
Private Cloud Production (Managed Upgrades) release date: '''March 25 2021'''<br />
+
Global Release Date: '''November 28 2024'''<br />
Private Cloud Backup (Managed Upgrades) release date: '''March 11 2021'''
+
Global Backup Release Date: '''November 14 2024'''
  
==Overview==
+
==Upcoming Upgrades Schedule==
Watch this video to get a general overview of the new features in this release.
+
{{Upgrade Schedule}}
  
{{#ev:youtube|kkBhkJx3ZoU}}
+
We regularly update the list of upgrade features and schedule for both the backup and production environments on this page.
  
''To watch this video in full screen, please click on the '''full screen''' button on the bottom right.''
+
This page will provide a general overview of each upgrade, with links to the Wiki articles describing the new or updated features and how to use them.
  
==Global System Upgrades==
+
More information around the [[#About_the_System_Upgrade_Process|system upgrade process]] can be found below.
The new features listed below are enhancements to the SmartSimple system and will be immediately available to SmartSimple users upon the application of the upgrade to their server:
 
  
===Major Updates===
+
=Current Upgrade Package=
====Removed Base API Key for Signority E-Signature Integration====
+
{{November2024Upgrade}}
Deprecated the default system API key that is used for Signority e-signature integration services when no authentication credentials are configured. Going forward, in order to use the Signority e-signature integration, you will need to engage our partner vendor Signority in order to obtain a license and API key for use in your SmartSimple Platform3 instance. Clients currently leveraging our Signority integration would have already been contacted by a SmartSimple account manager to coordinate this transition, but if you currently have an integration with Signority enabled but have not transitioned to your own license key, please contact our support team for assistance with this. The Online Signature Provider setting can be found at '''Menu''' Icon > '''Global Settings''' > '''Integrations''' tab.
 
<!--107486 - Remove smartsimples Signority account credentials-->
 
  
====Deprecated Job Costing Application====
+
=About the System Upgrade Process=
Deprecated the legacy Job Costing application. In ages past, prior to the creation of the fully configurable Universal Tracking Application, several static Tracking Applications were created for out-of-the-box use. As these static Tracking Applications are now no longer in use, they are being removed from various configuration menus and settings pages. We do not anticipate any behaviour change to your system.
+
The objective of the system upgrade process is to ensure that customers have a chance to review how their applications and information will work following the upgrade without compromising the integrity of their production system. In order to take advantage of this, you will need to know how to access your backup instance of SmartSimple Cloud. If you need assistance with this, either refer to the [[Backup Server and Testing Instances]] Wiki article or contact the [[SmartSimple]] support desk.
<!--118184 - Can we remove Job Costing option from Menu-->
 
  
====Deprecated Classic-style Calendar====
+
For clients on a Private Cloud environment, please review the [[SmartSimple Upgrade Process – Dedicated Server]] page.
Deprecated of the Classic-style Calendar. Previously, we introduced an update to the Calendar interface to update it inline with the latest Arcadia styling and behaviour. We also introduced a setting within the '''Global Settings''' > '''Classic Options''' area to allow you to continue using the previous Classic-styled calendar. However, for maintenance reasons we'll be removing this Classic Calendar option and again update your system to use the latest Calendar interface. If the setting for Classic Calendar within the '''Global Settings''' > '''Classic Options''' area is not enabled in your instance, then this change will have no affect on your system.
 
<!--120665 - Deprecate the classic calendar-->
 
  
====Deprecated IP Address and Workstation Based Login Restrictions====
+
===Upgrade Schedule Details===
Deprecated user login restrictions to restrict access based upon IP address, or local computer. These were two options found within the Roles and Access menu within each user account. They were older features that allowed you to restrict user access, one based upon the source IP address of a user's connection, and the other based upon a static cookie file stored on a user's local computer. These are now legacy features that no longer function with the highest security standards that the system can offer.
+
{{Upgrade Schedule Details}}
<!--121943 - Deprecate session options for IP restriction and workstation cookie-->
 
  
====Deprecated Personalized Alert Messages====
+
===Backup Environment Update===
Deprecated personalized alert messages. In an attempt to create more friendly, and personal system alerts and experience, we previously modified system alert messages for end users with an opening like "Hey John". Unfortunately, that wasn't quite well received by our entire audience, so we're removing that personal message from system alerts, and replacing it with simple symbols or generic "Alert" text where appropriate.
+
* Each [[Backup Server and Testing Instances|backup environment]] will be updated to the "release candidate" prior to the upgrade date.
<!--120659 - Deprecate the Personalized Alert-->
+
* This update will provide for instance specific testing of release candidate, as you can log into your respective [[Backup Server and Testing Instances|backup environment]] and test the changes against your most current data and configuration.
 +
* Internal staff will also be using these environments to perform instance specific testing.
  
[[File:2021-03-ticket-120659-1.png|thumb|none|800px|After the upgrade, alerts messages will be styled like the image on the right and will no longer say "Hey, first name".]]
+
===Update Go/No-Go===
 +
Subject to satisfactory testing on both the pre-production environments and the backup environments, the Go/No-Go decision will be made on the Wednesday prior to an upgrade release.
  
====New Limitation to Max Number of Records Returned by SmartConnect API Call====
+
===Upgrade Feedback and Questions===
New limit has been introduced to cap the number of records returned by a single SmartSimple API call to 10000 records. This limit has been introduced in order to improve the response speed of API calls. If the criteria of your API call matches more than 10000 records, you will need to leverage the pagination parameters in order to make multiple calls to page through the results and return the full data set.
+
If you have questions or need assistance or want to share your thoughts on the upgrade contact our support team toll-free at 866.239.0991 or email support@smartsimple.com
<!--122236 - SmartConnect API need to apply limit of 10000 records-->
 
  
====Updated Interface for Association of Records====
+
=Previous Upgrades=
Updated the interface and behaviour when searching and adding record associations to other records. This applies to areas such as Contact and Company associations to records, as well as the Special - Linked Record List custom field. An example of the affected area is the multiple contact and multiple company standard field lists within a UTA Level 1 record. The behaviour of adding contact or company record associations has been altered to allow you to perform multiple searches, and review all your selected records in comparison with the current list of contacts and companies before you attach them. A simple search and add function for contacts and companies has been added inline at the top of the list view as well. These changes will now make it faster and more intuitive for users to attach contacts or companies to records.
+
See the [[Previous Upgrades]] page for a list of previously-implemented upgrade features.
<!--120443 - Improved Add Assign Users Construct-->
 
  
[[File:2021-03-ticket-120443-1.png|thumb|none|800px|This '''Association Entry View''' pre-upgrade required opening a modal window.]]
+
[[Category:Upgrades]]
 
 
[[File:2021-03-ticket-120443-2.png|thumb|none|800px|This '''Association Entry View''' post-upgrade allows you to add one or more contacts in different roles without the need to open a modal window.]]
 
 
 
====Enhanced Settings Screens for User Menu Permissions====
 
Enhanced and consolidated the settings screens for configuration of permissions to menus and features. The configuration of access to menus and features can be a little daunting and confusing with settings pages split across multiple areas. We're addressing this by first migrating the settings for menus and features that were previously found under '''Roles and Security''' > '''User Roles''' > '''Menu''', and consolidating them into the '''Roles and Security''' > '''System Feature Permissions''' screen. Secondly, while the default behaviour lists each setting and all the user roles that you have configured for each, we'll be introducing a new role-based entry mode. This role-based entry mode will instead allow you to specify all the feature permissions that you'd like to set per role much more easily in one shot.
 
<!--113278 - user role menu page move settings and remove page-->
 
 
 
[[File:2021-03-ticket-113278-1.png|thumb|none|800px|Menu permissions can now be found under <strong>System Feature Permissions</strong> and can be viewed in feature-based or role-based entry modes.]]
 
 
 
====Extended Group Email Functionality for Associated Companies of UTA Records====
 
Extended Group Email function to be available for contacts within associated companies of a UTA Level 1 record. Previously, the Group Email function could only target contacts directly associated with the Level 1. Now, instead of having to connect contacts directly to the Level 1, you can email various contacts of the companies associated to the Level 1. The setting for this is located in the desired UTA > '''Configuration Settings''' > '''Security''' > '''Feature and Function Permissions''' > Level 1 item > '''Enable Group Email'''.
 
<!--41820 - Group Email In Company Section of UTA-->
 
 
 
[[File:2021-03-ticket-41820-1.png|thumb|none|800px|Group email contacts of associated organizations.]]
 
 
 
====Enhanced Interface of Geomapping List Views====
 
Enhanced the interface and behaviour of list views with geo mapping enabled. The map frame will now dynamically re-size accordingly as you adjust the search radius of the search filter. Improved interaction between the list records and the map icons, selecting either will highlight the corresponding list record or map icon to better connect the two.
 
<!--117888 - proximity list view phase 3 ( map ) geocoding-->
 
 
 
[[File:2021-03-ticket-117888-1.png|thumb|none|800px|When you search a list view based on proximity, the map will now zoom in and out based on your settings and items in the list will highlight if you select them on the map.]]
 
 
 
====Updated Interface for Question Set Builder Custom Fields====
 
Updated interface when setting up questions for a Special - Question Set Builder custom field. Previously, every question row listed formatting options such as number type, number precision, and currency. As these formatting options aren't always applicable to every field type, we've changed the default behaviour to instead now have these columns hidden, but provide you the option of showing these columns if you wish, as well as limit the available format options within. You can find this setting to control the format columns within the custom field configuration of a Special - Question Set Builder field.
 
<!--117008 - Limit Question Set Builder Options-->
 
[[File:2021-03-ticket-117008-1.png|thumb|none|800px|Updates to the Question Set Builder Custom Field allow for more dynamic control over available columns and the options within.]]
 
 
 
====Updated Interface Styles of Checkbox and Radio Inputs====
 
Updated interface styling for checkbox and radio input elements and increased their size as well as updated styling for their state. This makes it easier for users to select these elements and to determine their current state.
 
<!--115604 - improved checkbox ui-->
 
 
 
====Updated Visibility of Older Log Data====
 
Updated visiblity of older log data to allow you to view log entries older than 2 years ago. In the November 2020 upgrade, we began moving log data older than 2 years ago into a separate archive location in the database. We've now linked these archive locations into the regular system screens, e.g. viewing field change history, where you will once again see these older log data seamlessly once again.
 
<!--121313 - Create archived database for old log entries to allow interface access to these archived logs-->
 
 
 
====Updated Interface of UTA Record Copy Action====
 
Updated the Copy UTA Level 1 or Level 2 action for simplified and improved user experience. The interim screen when you copy a record has been updated to hide options that are not available for the user to select copy behaviour for. A confirmation has been added whether you wish to remain on the current record that you're copying from, or whether you wish to navigate to the newly created record. Lastly, we've updated the behaviour when copying both a UTA Level 1 and its Level 2s to only create the records at the very end, instead of the current behaviour of creating the new Level 1, and then Level 2 as you step through the option screens.
 
<!--120439 - Improved Copy of Level 1s/2s-->
 
 
 
[[File:2021-03-ticket-120439-1.png|thumb|none|800px|A new alert will display when you copy records giving you the option to navigate to the new record or stay where you are.]]
 
 
 
===Minor Updates===
 
====Updated Chart-type Portal Sections with Ability to Open Records====
 
Updated chart-type sections within a portal to allow you to drill down, and open up individual records. This will now function similar to the table-type sections allowing you to navigate to and open individual records for review.
 
<!--50994 - portal section Chart improvements-->
 
 
 
====Updated Login Page to Include Language Selection When Not Explicitly Defined====
 
Updated the display of the login page to include a language selection when you have multiple login pages configured for multiple languages. While you may still navigate to the language specific login pages using the lang parameter in the URL, if the lang parameter is not specified, then a language selection will be presented to the end user on the login page. Upon logging in, the language selection from the login page will carry through the user's login session.
 
<!--114983 - Language preferences cleared with browser cache-->
 
 
 
[[File:2021-03-ticket-114983-1.png|thumb|none|800px|The language dropdown on the login page when no default language is specified and when a language is specified. Note the parameter in the URL.]]
 
 
 
====Added Additional Aggregate Record Count to Activities within Contact and Company Profile====
 
Added the aggregate count of associated records within the left menu when viewing contact and company records. Some of the menu tabs representing activities, and UTA Level 2, and UTA Level 3 records associated to contact and company records did not have record counts displayed. These have been updated now to show you a count of these record types per contact or company.
 
<!--116930 - No count on profile for activities-->
 
 
 
[[File:2021-03-ticket-116930-1.png|thumb|none|800px|Aggregate count for activities added in left navigation as seen on the user profile.]]
 
 
 
====Added Ability to Export Configuration Error Log====
 
Added support for export of Configuration Error Log results, as well as Autoloader Process logs. The output from these two areas may now be exported as a file and more easily reviewed by system administrators.
 
<!--115939 - Make Configuration Error Log Exportable-->
 
 
 
====Updated Search Reference Within Custom Field Configuration to Include Reports====
 
Updated the Search Reference function within a custom field to now also include reports where the custom field is included in. You can now determine if a field has been included within any reports.
 
<!--117253 - Search Reference for custom field - add Reports where field is used-->
 
 
 
====Added Ability to Disable List View Sticky Search Behaviour====
 
Added ability to disable the sticky search behaviour of list views. The default behaviour of list views to remember your last search, and display the results of your last search can now be disabled via your personal list view settings and disabling the "Remember Previous Search" option.
 
<!--117013 - Ability to prevent sticky search-->
 
 
 
==On-Demand System Upgrades==
 
The following features are available immediately with the application of the upgrade, but must first be enabled or configured by a '''Global Administrator''':
 
 
 
===Major Updates===
 
====New Shopping Cart Feature====
 
New Shopping Cart feature allows for the tracking as well as processing of payments from users. When this feature is configured, it will allow users to process payments towards organizations, or UTA Level 1 records. This feature was designed with end user donation purposes in mind and will allow you to process payments directly via our integration with our partner Stripe, or through an integration with your own financial system by way of payroll deduction. Users may choose from one-time payments to multiple payment plans. For system administrators, this feature can be enabled in the Global Settings area through settings called Shopping Cart. You can define what system objects are available to for inclusion within an order, and multiple payment forms as well to specify different attributes for different methods of payment. For example, you can include a flat processing fee, and either choose to display or hide this from the user's order summary screen. For end users, when they navigate the records made available for payment towards, they will be presented an option to add to their shopping cart, from which they may check out when done.
 
<!--119405 - Shopping Cart - Payroll and Fees-->
 
 
 
[[File:2021-03-ticket-119405-1.png|thumb|none|800px|Donating to an organization using the shopping cart.]]
 
 
 
[[File:2021-03-ticket-119405-2.png|thumb|none|800px|Choosing payroll or credit card payment options on the shopping cart summary screen.]]
 
 
 
[[File:2021-03-ticket-119405-3.png|thumb|none|800px|The confirmation screen for a recurring payroll donation in the shopping cart.]]
 
 
 
====Added Additional Themes and Templates Available to Portal Configuration====
 
Added additional themes and templates available for use in portal configurations. Three new themes are now available. Five new templates have been added for use within these new themes. These templates allow you to setup well-designed tailored portals in a snap for specific audiences and focus areas. 
 
<!--120769 - Portal Templates-->
 
 
 
[[File:2021-03-ticket-120769-1.png|thumb|none|800px|Three new themes (looks) were added for use in portals as well as a visual picker. Note that the "Default" theme has been renamed to "Traditional".]]
 
 
 
[[File:2021-03-ticket-120769-2.png|thumb|none|800px|Five new Templates (predefined layouts) were added for use in portals.]]
 
 
 
====New Integration with ORCID Research Database====
 
New integration with ORCID research and funding database. This allows you to integrate your SmartSimple platform with ORCID in order for users to pull down their ORCID profile into your SmartSimple platform, and also to push out funding data from the platform out to ORCID. Your organization will need to sign up for an API or integration key directly with ORCID, to be entered as an Integration Key in the platform. Additionally, individual users will need to each authenticate their user profile with ORCID and authorize the platform to access ORCID data in order to pull down or update their ORCID profile within the platform.
 
<!--114889 - Requirements for ORCID Certification-->
 
 
 
====New Ability to Generate Fillable PDF Forms for E-signature====
 
Added new ability to configure Web Page View custom fields with custom content that will include fillable forms on a system-generated PDF sent through an e-signature provider. Currently, this feature is only available for integrations with DocuSign.
 
<!--117380 - E-Signature Document With Fillable Form-->
 
 
 
====New Custom Field Type Special - Like Button Rating====
 
New custom field type called Special - Like Button Rating can be used to present a thumbs up and down rating. You can set the permissions and availability for this field just like any, and present your users with the ability to like or dislike a record.
 
<!--120767 - Enhancement - Like-->
 
 
 
====Updated Disbursement Creator Tool Now Available to Non-Admin Users====
 
Updated Disbursement Creator tool to be available for non-admin users. This feature may now be enabled for use by non-admin users via a role permission located in the allocation mapping settings. Enabling this for users will then display the Disbursement option within the Tools menu within a UTA Level 1 record.
 
<!--117490 - Role Permissions for Disbursements Creator Tool-->
 
 
 
====New Ability to Restrict Available Consumer Records for Provider Connection Based on Consumer Type and Status====
 
New ability to restrict the type and status of Consumer records that you can choose from the Provider UTA. Within the configuration of Consumer connection within the Provider UTA connectivity settings, you can now more granularly control the availability of which Provider records can be linked with which Consumer records by type and status combinations of both Provider and Consumer.
 
<!--117053 - Restrict Consumer Types-->
 
 
 
====New Import Templates Now Available to Non-Admin Users====
 
New Import Templates to allow you to configure import wizards for use by non-admin users. This functionality is available for use with UTA Level 1, Level 2, and Level 3 type records. The configuration setting for this can be found within the UTA settings page -> respective level tab -> Import Templates. These templates allow you to create an import profile restricted to specific record types, statuses, and also the fields to import into. You may then permission the templates for use by user role. We've also extended the import wizard functionality to be available now for UTA Level 2, and Level 3 records as well. The interface and behaviour of the import wizard will now allow you to directly copy and paste content for upload in addition to file upload, as well as allow you to specify more options for column delimiter where only comma delimiters were accepted previously. The error detection and data validation has also been improved and will now alert you on any issues encountered at the end of the import. Lastly, you will be able to save your column mapping selection and reload these the next time you use the Import Template for a quicker import experience.
 
<!--120445 - Improved Importing level 1s-->
 
 
 
===Minor Updates===
 
====Extended Bulk File Download Function for use With Consumer Provider List Views====
 
Extended bulk file download functionality to be available for Consumer Provider list views. You may now configure Consumer Provider list views with the ability to download file uploads from the records returned in the list.
 
<!--116650 - Download files functionality not available on consumer/provider list views-->
 
 
 
====Added Options for Invitation-type Workflow Task to Create or Send Invitations====
 
Added two new options for the Invitation-type Workflow Task to allow you create or send Draft Invitations. You can now trigger the creation and sending of contact invitations via Workflow Task, and additionally if the Workflow is triggered on a UTA Level 2 record, you will also have the ability to trigger a Level 2 activity Workflow Task that will create or send invitations off the parent Level 1 record.
 
<!--121190 - Invitation Updates/Improvements-->
 
 
 
====Enhanced Hashtag-enabled Text-type Fields with Additional Options====
 
Enhanced the Hashtag option for text-type custom fields with some additional options for improved usability. Introduced an option to restrict the ability to create new hashtag values to certain user roles. Introduced an option to categorize multiple fields into similar categories, such that end users entering in any of these fields will be able to search from the collective hashtags across all fields within the same category. Also introduced a new admin page, Hashtag Library, found in the Global Settings that will show you the list of available hashtags, and that also allows you to change the hashtag value and category.
 
<!--120766 - Enhancement - Hashtags Part2-->
 
 
 
====Added Support for JSON Format for Report Exports====
 
Added support for exporting report resultsin JSON format through the File Export feature of reports. Within the File Export configuration menu of a report, you can now specify an export format of JSON.
 
<!--121612 - add JSON format to Scheduled Report Export-->
 
 
 
==Beta Previews==
 
No features are available for beta preview this upgrade.
 
 
 
==Notes for Admins==
 
====Added New Parameters to SmartConnect API for Pagination of Records====
 
Added additional parameters to the SmartConnect API to allow for pagination of record sets. For List action API calls, new parameters recordcount, recordstart, and recordend will now be returned to you. New parameters recordsperpage, recordstart, and pageofrecord will be available for you to pass to the calls to page through the result set. You may pass just the recordstart to indicate which record to start from, for example, given a recordsperpage 100, you could pass recordstart 1, 101, and 201 in order to obtain records 1-100, 101-200, 201-300 respectively. Another example, given a recordsperpage 100, you could pass recordstart 1, 1, and 1, in combination with pageofrecord 1, 2, and 3 in order to obtain the same record sets 1-100, 101-200, 201-300 respectively.
 
<!--120958 - Enhance SmartConnect API to allow pagination of records-->
 
 
 
====Added New Criteria Operators to SmartConnect API for Searching of Empty or Non-empty Values====
 
Added additional operator available to the SmartConnect API for use within criteria to search for records where a field is empty or not. You may now include an operator of isempty, with a corresponding value of either true or false, within a criteria in order to search for records based on either empty or non-empty value.
 
<!--117307 - SmartConnect API - add a new criteria to search for field that is blank or NULL-->
 
 
 
====Added New Attributes to SmartConnect API to Describe Sub-type of Custom Field Metadata====
 
Added additional attribute fieldsubtypeid to the SmartConnect API function for Get Meta. This will allow you to retrieve the subcategory of a custom field. Where you were able to previously retrieve the field type, e.g. Text Box - Single Line, you can now retrieve the subcategory, e.g. Text Box - Date, or Text Box - Number for more granularity. You will be able to retrieve both the type name as well as internal type ID assigned to these types and subtypes.
 
<!--110981 - Enhance API 'Get Meta' function to more precisely indicate type-->
 
 
 
====Updated Default Settings for New Instances====
 
Updated the default settings for any newly created instance to enforce stronger and recommended settings. Some of these default settings involve security settings, such as deprecation of plain text passwords in email reset template, and enforcement of SmartCheck server-side validation, Organization and User Security matrix, CAPTCHA validation, and cookie usage acceptance message. Some of these default settings involve interface settings, such as disabling of Classic-type interface options, enabling of compact header, and title bar navigation pane. Some of these default settings involve enforcement of configuration standards such as restriction of special characters and spaces in field names, and deprecated support for some variable syntax including reportproperty variable syntax in custom field options, as well as list variable syntax within group functions in template formulas.
 
<!--54549 - default settings for new instance-->
 
 
 
==Service Packs==
 
 
 
===Service Pack 4===
 
Release Date: March 8 2021
 
 
 
====Bug Fixes====
 
* Fixed an issue with the validation engine that would intermittently begin failing, and blocking the submission of records. The issue was apparent when users would encounter a validation error blocking them from submitting records, or sign up pages. Messages such as "There are some issues with the form validation. Please contact your system administrator." would have been encountered.
 
<!--123921 - Validation error-->
 
* Fixed an issue with the permission validation for ability to create a UTA level 3 record. The system would incorrectly block the creation of a level 3 activity when the user did not have view access to the level 1, where it should instead check for access to the level 2.
 
<!--123800 - Error Message on Apply-->
 
* Fixed an issue where a field configured with both a number formatting of "Percent", and a precision, would round numbers incorrectly in view mode.
 
<!--123302 - Percentage Number field rounding incorrectly-->
 
* Fixed an issue where currency values were not storing correctly within an advanced data table for certain number formats. The number value was being incorrectly formatted for users with a locale that specified number formats without a comma symbol as the thousands separator, and a period symbol as the decimal separator. For example, a Spanish speaker entering a Euro currency formatted number as "1.234,56" would encounter an issue where the system did not correctly transform the number to the expected North American raw number format during calculation.
 
<!--123771 - XML calculations not working-->
 
* Fixed an issue where organization signup pages configured with verification services for National Center for Education Statistics (NCES) were unable to select an organization, and copy the organization details to the signup form.
 
<!--123430 - NCES Integration not working on Sign up page-->
 
* Fixed an issue where the sort order setting of an Upload - Multiple Files Storage field would be reset when navigating to another tab and re-saving within the custom field settings page.
 
<!--123915 - Multi-File field; Sort order being reset-->
 
* Fixed an issue where clicking on the new activity button on the activity list view incorrectly opens the page in the background screen when working from a modal window.
 
<!--123261 - New activity shows in background when L1 is opened in modal window-->
 
* Fixed an issue where selecting a user or contact association through the lookup modal window would not automatically close the window when the record was selected.
 
<!--123769 - No submit button in contact association modal window-->
 
* Fixed an issue where the language setting of an advanced data table section may be cleared during configuration of the sections, when built in a certain sequence.
 
<!--123954 - BUG: XML Section overwriting settings-->
 
 
 
====Other Changes====
 
* Updated list view and report display to now render line breaks from the stored values onto the web browser.
 
<!--121411 - Line breaks are not preserved in list view columns-->
 
* Updated the default message shown for linked record list field type when creating a new record from "Click Save before using linked record list" to "Click Save before using FIELD_CAPTION".
 
<!--122306 - Update linked record list message on new record-->
 
* Updated the invitation import feature to support the use of role caption. Previously it only supported role name.
 
<!--121333 - invitation Import requires role name instead of role caption.-->
 
* Updated the configuration of advanced data table sections to no longer accept commas within a node name.
 
<!--123899 - Saving button on ADT is clearing the form instead of saving it-->
 
* Updated the PDF generator engine to cache and load images from temporary files instead of fully within system memory while compiling the PDF file. This is intended to reduce memory usage from the PDF generation process and improve overall system performance.
 
<!--123638 - CA & Com server PDF Generation-->
 

Latest revision as of 09:56, 22 October 2024

Contents

General Information

Current Upgrade Dates

Key Release Date: November 14 2024
Key Backup Release Date: October 29 2024

Global Release Date: November 28 2024
Global Backup Release Date: November 14 2024

Upcoming Upgrades Schedule

Upgrade Key Release Date Global Release Date
November 2024 Thu, Nov 14 2024 Thu, Nov 28 2024
February 2025 Thu, Feb 13 2025 Thu, Feb 27 2025
June 2025 Thu, Jun 12 2025 Thu, Jun 26 2025
October 2025 Thu, Oct 9 2025 Thu, Oct 23 2025
February 2026 Thu, Feb 12 2026 Thu, Feb 26 2026
June 2026 Thu, Jun 11 2026 Thu, Jun 25 2026
October 2026 Thu, Oct 8 2026 Thu, Oct 22 2026

We regularly update the list of upgrade features and schedule for both the backup and production environments on this page.

This page will provide a general overview of each upgrade, with links to the Wiki articles describing the new or updated features and how to use them.

More information around the system upgrade process can be found below.

Current Upgrade Package

Overview

Watch this video to get a general overview of the new features in this release.


To watch this video in full screen, please click on the full screen button on the bottom right.

Upgrade Highlights

  • A new rich text editor is being introduced for enhanced security. It is optional for this release but will become mandatory in a future upgrade.
  • The "Display – Instructions" field has been renamed to "Display – Message" with new styling options for displaying custom messages whenever and wherever needed.
  • A new "Special - Button" custom field allows users to easily open system functionality in a modal window, streamlining navigation as well as allowing task completion without losing context.
  • The upgrade schedule for 2025 and beyond has been updated with key releases now occurring on the second Thursday of upgrade months (February, June, and October).
  • The initial upgrade package is 202411.01. See below for upcoming service packs and and updates between upgrades.

Global System Upgrades

The new features listed below are enhancements to the SmartSimple system and will be immediately available to SmartSimple users upon the application of the upgrade to their server:

Major Updates

Upcoming Changes to the Rich Text Editor

We are introducing a new rich text editor to enhance security. While using the new editor will be optional for this release, it will become mandatory in a future upgrade. The rich text editor is surfaced in the "Special – Rich Text" and "Display – Message" custom fields, as well as in system areas used for emails and other areas of configuration.

Along with visual changes, this new editor will no longer allow customization of which buttons to display.

Several currently available features will be removed in the new version, including:

  • Preview, Print
  • Cut, Copy, Paste, Paste Text, Paste From Word
  • Undo, Redo
  • Find, Replace, Select All
  • Button, Image Button
  • Remove Format, Blockquote, Create Div
  • Left to Right / Right to Left text direction
  • Anchor, Image, Special Character
  • Styles, Format, Font
  • Maximize, Show Blocks

To enable the new rich text editor, navigate to Global Settings > System tab.

Note:

  • There are some changes to the interface in areas where you can toggle between the plain text editor and the rich text editor, such as when editing email templates or broadcasts.
  • The new editor will strip out certain HTML tags (html, header, script, and body) as well as event handler attributes such as onclick and onerror.
  • The "Special – Rich Text" custom field enables end users to customize the appearance of their data within the system. However, it has some limitations: data entered in this field is not suitable for exporting to Excel, PDF, or MS Word merges. Additionally, tables wider than 700 pixels may get cut off in system generated PDFs. Data in this field cannot be displayed in list views. Using this field type can slow down page load times and impact overall performance.
An example of the previous rich text editor component with all features enabled as seen on the "Create New Email Template" page.
An example of the new rich text editor component on the "Create New Email Template" page when "HTML" is selected as the Message Format and the rich text editor is enabled. Note: You must opt in to the new system-wide editor as part of this upgrade to access and test it. We will be enabling this for everyone in a future upgrade.


Updated Message Styling Options and Field Name Change

The "Display – Instructions" field was renamed to "Display – Message" and now includes enhanced styling options. These updates make it easier to present styled messages based on your desired logic. You can choose from the following message styles: Instructions (blue), Warning (yellow), Error (red), and Success (green). These new options are available within the custom field settings.

The "Display – Instructions" custom field has been renamed to "Display – Message." You can now choose from four message style options to easily display custom messages wherever and whenever needed.

On-Demand System Upgrades

The following features are available immediately with the application of the upgrade, but must first be enabled or configured by a Global Administrator:

Major Updates

New “Special – Button” Custom Field with Configurable Open Behavior

Introducing the new "Special – Button" custom field, which allows users to create an inline button within an application to launch system functions such as the assignment grid, activity scheduler, or an easy way to edit an organization's profile. This field allows you to choose whether the functionality opens in the main window, a modal window, or a new tab. This approach simplifies access to system features and helps users maintain context, offering a more streamlined solution compared to customizing a browser script button for this purpose. To use this new custom field, go to UTA Configuration Settings > Level 1 tab > Custom Fields > Create or edit a custom field with the Field Type set to "Special - Button". Click the "URL Lookup" button beside the URL field to specify the system object you want the button to open. The Open in field allows you to select the open behavior.

See full wiki article: Custom Field Type: Special - Button

The new "Special – Button" custom field settings page is displayed which enables you to place a button directly on records to launch functionality within a modal window. For example, you can add a button on an application to let users easily edit their organization profile without leaving the page. You can also include a custom confirmation message.

Color Options for Browser Script Buttons

Added the ability to select preset button colors for "Special - Browser Script" custom fields with the Trigger Type set to "On Demand", making them consistent with submit button color options. This feature gives you the ability to differentiate buttons as well as assign them differing visual prominence and semantic meaning.

Added the ability to choose the button style for "Special - Browser Script" custom fields.

New Ability to Retain Dynamic Content Options

We’ve introduced a new feature that allows you to retain historical selections for dynamic content, similar to how SSRETIRE functions, but now applicable to dynamic content in "Lookup - Autocomplete Options" and "Select One - Dropdown" custom fields.

To use this feature, follow these steps on the custom field settings page:

  1. If your custom field has Enable Dynamic Content and Use Custom Lookup Options toggled on, you can upload a CSV file that contains your desired options to Global Settings > System tab > Custom Lookup Options.
  2. In the CSV, add a new column to indicate whether an option is active (0) or inactive (1).
  3. Any option marked as inactive (1) will no longer appear in the lookup or be selectable. However, older records that previously used the inactive value will still retain and display that value.


When importing a CSV to the custom lookup options, you can now specify whether a value should be selectable. Enter "1" to mark the option as inactive. Options marked inactive will not appear in the dropdown or be selectable (unless it was previously selected).

New Default Status Option for Copy Profiles

We’ve added a Default Status field to copy profiles, allowing users to set a specific status for newly copied records. If no default status is selected, the system will default to the status with Is Default Copy Status enabled. Otherwise, the copied record will inherit the status of the original record.

Minor Updates

New Option to Force Search on a Single Column

We’ve introduced an instance-wide option to improve performance by enforcing searches on a single column for all quick searches. When this setting is enabled, the "All Columns" option will be removed from the scope selector and by default, searches will target the first column in the list view. Users can still select other columns to search if needed. Limiting the search to one column significantly reduces search time across all records.

To enable this feature, go to Global Settings > System tab > Toggle on Limit List View Search Scope to a Single Column to Improve Performance.

Additionally, the "All Columns" option has been removed from list views in the Message Queue for faster search performance.

A new system-wide setting allows you to optimize performance by limiting searches to a single column. By default, it will search the first column but users can select other columns to search if needed.

BYO SMS Credentials

We’ve introduced an integration setting that allows clients to enter their own Vonage credentials for use with Short Message Service (SMS) in the Multi-factor Authentication (MFA) login process. This enables clients to manage their accounts and associated costs directly, rather than paying SmartSimple for this third-party service.

To enter your account details, navigate to Global Settings > Integrations tab > Integration Key Management, and create a new key of the type “Vonage.” Please note that you must still contact SmartSimple to enable SMS notifications in your system, which can be done through a setting found at Global Settings > Communications tab.

New Workflow Option for Notifications

Added a feature to allow users to be notified of workflow acknowledgement tasks through the bell icon in the header, similar to notification broadcasts. To see this option, go to Menu Icon > Workflows > Edit a workflow with an acknowledgement task > Edit the acknowledgement task > Message Template tab > Under Message Type, select "System Notifications". This replaces the previous "Instant Message" type. Instead of sending emails to internal staff for approvals, you can now utilize the notifications area for a more streamlined process.

Use the new "System Notifications" workflow message type to display in-system messages under the bell icon as an alternative to sending emails.

Notes for Admins

Object Email/Email Anything Domain Name Change

As of October 24th, the email services for the Object Email (Email Anything) feature have transitioned from using the @smartsimple.com domain to the @smartsimplecloud.com domain. If someone replies to an email thread that still contains the old object email domain, you’ll need to update the email address within that thread to the new @smartsimplecloud.com domain. Emails sent to the old domain may receive a bounce back message indicating "550 Invalid Recipient" or may otherwise indicate the mail was undelivered.

Note: This change only applies to object emails. No configuration adjustments are necessary. For instance, do not alter the "From" address located under Global Settings > Communications tab > Email Options and Security. The "From" address domain should remain as @smartsimplemailer.com, @smartsimplemailer.ca, or @smartsimplemailer.eu depending on your geographic region. If you are using an SMTP relay, the "From" address will be set to something prescribed like your corporate domain. If you are using workflows to send emails to an object's email address, be sure to include the object email as a CC. This is because the object email cannot be set as the “From” address since it will have a different domain than the mail-sending service.


The domain for object emails will change on October 24, 2024. Object emails sent to the old domain will not be delivered unless they are updated to the new smartsimplecloud.com domain.

Upcoming Changes to Upgrade Schedule

The upgrade schedule for 2025 and beyond has been updated. Key releases will now occur on the second Thursday of February, June, and October, with Global releases following two weeks later.

Added Ability to Run Triggered Workflows Asynchronously

Looking to speed up your autoloader, report export and API updated processes? A new option allows workflows triggered by these actions to run asynchronously in batches using concurrent threads to enhance performance. The new toggle is called Run triggered workflow asynchronously to improve performance and can be enabled when workflows don't require immediate sequential execution.

To access the new setting for Reports, go to the desired report > Export tab > Scheduled Export tab. For autoloaders, go to the desired autoloader > Process tab. For API updates go to the desired SmartConnect API function.

Added Option to Delete Files upon Autoloader Completion

We added a new autoloader option called Delete processed and source data files upon autoloader completion. If enabled, files in the processing folder (including encrypted and decrypted files) will be deleted for improved security.

Added Validation for Default "From" Address

Validation has been added to the default "From" address located at Global Settings > Communications tab > Email Options and Security > Toggle on Enable Default From Address > From Address. Only valid email addresses or system variable syntax will be accepted.

Added SSO Signing Certificate Expiry Notifications

Added a feature that allows system notifications to alert users before the expiry of SSO signing certificates. These notifications will appear under the notification bell in the system header at designated intervals leading up to the expiration date. To enable these notifications, go to Global Settings > Integrations tab > Integration Key Management > Edit an integration key with the type "Certificate" and category "Keystore". You can then specify which users and roles should receive the expiration alerts.

Updated Consumer Creation Button Security

We enhanced the security of the consumer creation button by updating its visibility behavior. Previously, the Deny Organization Status setting (which controls the button’s visibility) was checked against the user's parent organization. After this upgrade, the button’s visibility will now be based on the organization the user is associated with during the current login session. If a user is affiliated with multiple organizations, the button's visibility will correspond to the organization the user has currently selected in the Organization drop down.

You can find the consumer creation button settings within the UTA configuration settings on the Connectivity tab if the UTA is connected to another UTA as a provider.

Updated Session Logs and Message Queue for Improved Performance

To enhance performance related to session logs and the message queue, the display criteria for messages and login details have been reduced from 2 years to 90 days. Messages older than 90 days are available in the Archived tab. Archived messages and login details are still accessed through reports for example the login details can be accessed using the dataset "Session Log (Archived)".

You can find the Message Queue by navigating to Menu Icon > Global Settings > Communications tab > Message Queue. To see a user's login details, navigate to the desired user's profile > Logs > Login History.

Updated Field Change History Log to Exclude API Calls

We’ve added a setting to exclude API calls from the field change history log to improve performance, reduce log size, and minimize unnecessary tracking. To enable this feature, navigate to Menu Icon > Global Settings > Integrations tab > SmartConnect API > Create or edit an API function with the action type “Update” > Toggle on Disable Field Change History.

Updated Delegation Notification Emails

We’ve updated the delegation notification email so that users who have opted out of all system emails will still receive a notification when they are delegated to.

Updated Styling of Work with +AI Conversation Starters

Updated the template prompts (conversation starters) of the Work with +AI feature from being displayed in a dropdown menu to being displayed as buttons.

Updated Level 3 Associations in Report Builder

The Report Builder has been updated to distinguish between Level 2 and Level 3 associations. For example, you can now generate a report that returns a list of organizations associated exclusively with Level 3 records where previously it returned associations for level 2s and 3s.

Updated Electronic Signature Screen Interface

We have updated the electronic signature screen, which can be used to send documents for e-signatures, cancel e-signature requests for sent documents, and check the e-signature status of a document. Changes include renaming the submit button to “Send for E-Signature” for improved clarity. To view these updates, navigate to a web page view custom field that has e-signatures enabled. Open the web page view and click the e-signature button to see the new interface.

Updated Advanced Data Table Custom Field

Updated the "Special - Advanced Data Table" custom field for enhanced security, specifically in relation to permissions and the way data is saved and returned.

Updated User Menu Configuration Naming

The user menu configuration item previously labeled "Dropdown" has been renamed to "Titlebar" to better reflect its role within the portal header.

Updated Aggregate Shortcuts

Fixed an issue where aggregate shortcuts linked to a list view with quick load enabled where an incorrect count may have been displayed on the shortcut.

Performance Enhancements

We've implemented changes to offload resource-intensive tasks affecting reports and archiving from the main database, reducing the workload and boosting overall performance.

Deprecated Web Forms

The Web Forms feature was deprecated in 2017, in this upgrade it will no longer be possible to create a web form in systems where web forms are not already in use.

Deprecated Support for Older Excel Formats

Two Excel report export format options (Excel 2000 and 2003) have been deprecated and are no longer supported. While existing reports using these older formats will retain their configurations for backward compatibility, you will no longer be able to select these formats for new report exports. Moving forward, there will be a single export option using the Excel 2007 format which offers improved performance and supports bigger worksheets.

Service Packs

November 21st 2024 (202411.02)

  • Fixed an issue where shortcut aggregates were incorrectly returning a zero value when calculating a sum from a custom field.
  • Updated the Classic Data Exchange feature to prevent potential issues when a single user unpacks multiple packages simultaneously.


About the System Upgrade Process

The objective of the system upgrade process is to ensure that customers have a chance to review how their applications and information will work following the upgrade without compromising the integrity of their production system. In order to take advantage of this, you will need to know how to access your backup instance of SmartSimple Cloud. If you need assistance with this, either refer to the Backup Server and Testing Instances Wiki article or contact the SmartSimple support desk.

For clients on a Private Cloud environment, please review the SmartSimple Upgrade Process – Dedicated Server page.

Upgrade Schedule Details

The following tables outline the detailed upgrade release cycle.


If you are part of our Key Release your SmartSimple Cloud system will be automatically upgraded according to the following schedule. Generally North American Clients are on the Key release.

Hosting Environment Date Maintenance Window Typical Downtime
Key Release Production Second Thursday of an upgrade month 22:00 - 23:59 EST 5 minutes
Key Release Backup Two weeks prior to the production upgrade 22:00 - 23:59 EST 5 minutes

If you are part of our Global Release your SmartSimple Cloud system will be automatically upgraded according to the following schedule. Generally clients in Europe, Middle East and Asia as well as Managed Dedicated clients are on the Global release.

Hosting Environment Date Maintenance Window Typical Downtime
Global Release Production Fourth Thursday of an upgrade month 22:00 - 23:59 local time 5 minutes
Global Release Development/Test Fourth Thursday of an upgrade month 22:00 - 23:59 local time 5 minutes
Global Release Backup Second Thursday of an upgrade month 22:00 - 23:59 local time 5 minutes

If you are on dedicated environment that is client-managed your SmartSimple Cloud system is only upgraded manually by your system administrator or by submitting a request to SmartSimple. The upgrade package is made available for you according to the following schedule.

Hosting Environment Date Maintenance Window Typical Downtime
Global Release All Fourth Thursday of an upgrade month client-managed 5 minutes

Backup Environment Update

  • Each backup environment will be updated to the "release candidate" prior to the upgrade date.
  • This update will provide for instance specific testing of release candidate, as you can log into your respective backup environment and test the changes against your most current data and configuration.
  • Internal staff will also be using these environments to perform instance specific testing.

Update Go/No-Go

Subject to satisfactory testing on both the pre-production environments and the backup environments, the Go/No-Go decision will be made on the Wednesday prior to an upgrade release.

Upgrade Feedback and Questions

If you have questions or need assistance or want to share your thoughts on the upgrade contact our support team toll-free at 866.239.0991 or email support@smartsimple.com

Previous Upgrades

See the Previous Upgrades page for a list of previously-implemented upgrade features.