Difference between revisions of "Upgrades"

From SmartWiki
Jump to: navigation, search
m
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==General Details==
+
=General Information=
===Upgrade Dates===
+
==Next Upgrade Date==
Public Cloud Production release date: '''March 11 2021'''<br />
+
The next upgrade is scheduled for '''{{CurrentUpgradeDate}}'''.
Public Cloud Backup release date: '''February 23 2021'''
 
  
Private Cloud Production (Managed Upgrades) release date: '''March 25 2021'''<br />
+
==Upgrade Schedule==
Private Cloud Backup (Managed Upgrades) release date: '''March 11 2021'''
+
{{Upgrade Schedule}}
  
==Overview==
+
We regularly update the list of upgrade features and schedule for both the backup and production environments on this Wiki page.
Watch this video to get a general overview of the new features in this release.
 
  
{{#ev:youtube|kkBhkJx3ZoU}}
+
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. <!--You can also [https://smart.smartsimple.com/s_signup.jsp?token=XVtQC1oGZ11ZQxRbXxdSQUlTZlN9 subscribe] to the [[:Category:Newsletter Archives|Technical Journal]] that is sent out prior to each upgrade on the [https://smart.smartsimple.com/s_signup.jsp?token=XVtQC1oGZ11ZQxRbXxdSQUlTZlN9 Newsletter Signup Page]. ([https://smart.smartsimple.com/s_signup.jsp?token=XVtQC1oGZ11ZQxRbXxdSQUlTZlJ0 Unsubscribe here]).-->
  
''To watch this video in full screen, please click on the '''full screen''' button on the bottom right.''
+
==System Upgrade Process==
 +
The objective of the System Upgrade Process is to ensure that customers have a chance to review, without compromising the integrity of their production system, how their applications and information will work following the upgrade. In order to take advantage of this you will need to know how to access your backup instance of SmartSimple. If you need assistance with this either refer to the [[Backup Server and Testing Instances]] Wiki article, or contact the [[SmartSimple]] support desk.
  
==Global System Upgrades==
+
For clients on a Private Cloud environment, please review the [[SmartSimple Upgrade Process – Dedicated Server]] page.
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===
+
===Upgrade Schedule Details===
====Removed Base API Key for Signority E-Signature Integration====
+
{{Upgrade Schedule Details}}
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====
+
===Backup Environment Update===
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.
+
* Each [[Backup Server and Testing Instances|backup environment]] will be updated to the "release candidate" prior to the upgrade date.
<!--118184 - Can we remove Job Costing option from Menu-->
+
* 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.
  
====Deprecated Classic-style Calendar====
+
===Update Go/No-Go===
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.
+
* 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.
<!--120665 - Deprecate the classic calendar-->
 
  
====Deprecated IP Address and Workstation Based Login Restrictions====
+
==Upgrade Feedback and Questions==
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.
+
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
<!--121943 - Deprecate session options for IP restriction and workstation cookie-->
 
  
====Deprecated Personalized Alert Messages====
+
=Previous Upgrades=
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.
+
See the [[Previous Upgrades]] page for a list of previously-implemented upgrade features.
<!--120659 - Deprecate the Personalized Alert-->
 
  
[[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".]]
+
=Current Upgrade Package=
 +
{{March2023Upgrade}}
  
====New Limitation to Max Number of Records Returned by SmartConnect API Call====
+
[[Category:Upgrades]]
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.
 
<!--122236 - SmartConnect API need to apply limit of 10000 records-->
 
 
 
====Updated Interface for Association of Records====
 
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.
 
<!--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.]]
 
 
 
[[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-->
 

Revision as of 15:06, 27 February 2023

Contents

General Information

Next Upgrade Date

The next upgrade is scheduled for July 20 2023.

Upgrade Schedule

Upgrade Key Release Date Global Release Date
March 2024 Thu, March 14 2024 Thu, March 28 2024
July 2024 Thu, July 18 2024 Thu, July 25 2024
November 2024 Thu, November 14 2024 Thu, November 28 2024
March 2025 Thu, Mar 13 2025 Thu, Mar 27 2025
July 2025 Thu, July 17 2025 Thu, July 24 2025
November 2025 Thu, November 13 2025 Thu, November 27 2025

We regularly update the list of upgrade features and schedule for both the backup and production environments on this Wiki 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.

System Upgrade Process

The objective of the System Upgrade Process is to ensure that customers have a chance to review, without compromising the integrity of their production system, how their applications and information will work following the upgrade. In order to take advantage of this you will need to know how to access your backup instance of SmartSimple. 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.

Current Upgrade Package

General Details

Upgrade Dates

Public Cloud Production release date: March 9 2023
Public Cloud Backup release date: February 23 2023

Private Cloud Production (Managed Upgrades) release date: March 23 2023
Private Cloud Backup (Managed Upgrades) release date: March 9 2023

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.

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

Multi-Factor Authentication Enabled by Default

Main Article: Multi-Factor Authentication

Multi-Factor Authentication (MFA) using verification codes sent by email will be enabled for all systems to improve security. If you have already enabled MFA in your SmartSimple Cloud system and have assigned roles to a single-use verification code sent by email, this enhancement will NOT change your existing settings. You may change your MFA preferences after the upgrade but we recommend you adjust your settings prior to the upgrade. If you did not set up MFA prior to the upgrade, the 'Everyone' role will be added to the setting called Roles with Verification Code via SMS and Email.

The MFA setting above will be updated to "Everyone" if this Role setting is empty.

Time-based One-Time Password (TOTP) settings will NOT be affected. In addition, the setting Enable Trusted Device will also be toggled on by default. This allows users to choose whether they want the system to remember their device the next time they log in. Remembered devices can also be set to expire after a specific number of days by using the Expire Devices After setting. Note: Backup environments will be allowed to send out MFA emails. If your backup environment is not sending out emails, check to see if you have set up a default email address. To do this, go to Menu Icon > Global Settings > Communications tab > Email Options and Security > Toggle on Enable Default From Address. In the From Address field, you would typically enter something like donotreply@smartsimplemailer.com. If this field is empty, as part of this upgrade, we will be populating it with the email address used for new users (located at Menu Icon > Global Settings > Security tab > Password and Activation Policies > Activation Emails tab > From Address).

If you are using an SMTP relay and/or have a dedicated instance, make sure you have set up a default email address that matches your domain. Additionally, if you are using the SMTP relay with an IP restriction for sending emails, ensure the IP of your environments is in your IP list (backup, testing, production). If you need to help with identifying the IPs of your environments or have questions, reach out to our support team.

If you are using Single Sign-On (SSO), you may opt to bypass MFA by going to Global Settings > Integrations tab > Single Sign-On > Edit a configuration > Under the "Authentication" section, toggle on Bypass Multi-Factor Authentication (MFA) when logging in with Single Sign-On (SSO).

Minor Updates

Enhancements to System Security Summary

Added the ability to create notes on items flagged as potential problems in the System Security Summary. For example, a note can be added to explain why an item has been flagged and when or how it will be fixed in the future. Only the last note is displayed in the list, but you can see the full note history inside the notes modal window when you add a note. To see this feature, go to Menu Icon > Global Settings > System tab > System Security Summary > Click the Add Notes icon button located to the right of each flagged item. In addition, another tab was added to the System Security Summary and the System Summary called Global Administrators which lists all the Global Administrators in the system. We highly recommend you review the list of Global Administrators that have user access in your system regularly and remove access as needed.

Add an explanatory note to items flagged in the System Summary.
Easily see who has Global Administrator access and regularly review this list to remove access as needed.

Added Reference Search to Reports

Added the ability to check to see if a report has been referenced via a URL or used in ReportProperty syntax. Specifically the following is checked: Custom Fields, Template/Role Formulas, Submit Buttons, SmartCheck validations, Workflows, Shortcuts, Portals. To see this feature, go to Menu Icon > Reports > Edit a report > Click the Search Reference icon button in the action bar.

Easily identify some areas where a report is in use.

Added Primary Contact to Group Emails

Added the ability to easily send a group email to the primary contact from a Level 1, 2, or 3 list view. The primary contact when selected from Level 2 or Level 3, refers to the primary contact associated with the L2 or L3's root L1 record Branch standard field.

Easily send a group email to the primary contact from a Level 1, 2, or 3 list view.

Added New Address Type Standard Field

Added ability to control the edit permission of the address type dropdown when using the multiple address feature through a new standard field. To use this feature, go to Global Settings > Users or Organizations tab > Address Types > Edit an address type > Click the Standard Field tab in the left navigation > Edit the Address Type standard field > Permissions & Availability tab. This controls which users or organizations can change the Address Type dropdown in the address book.

Updated Autoloader Send Email Notification Options

The email notification options within the Autoloader process have been updated. We also added the ability to send a notification email to the user who initiated the autoloader once the process is complete, regardless of success or failure. To see these revised settings, go to Menu Icon > Autoloaders > Edit an autoloader > Process tab > New settings are under the Send Email Notification section.

Note: The Email To field accepts a comma separated list of email addresses.

Updated email notification settings for the Autoloader.

Updated Inputs to be Search and Select

Converted several dropdowns within the autoloader and report configuration pages to be search and select type inputs. The search and select type inputs make it easier to find and select desired values. To see this feature, go to Menu Icon > Autoloaders > Edit an autoloader > File Layout tab. When a field dropdown is selected, there is now a search box to find the field you are looking for.

A search and select has been added to the dropdown within the autoloader and report configuration pages.

Added Check for Duplicate Invitations

Added additional check for invitations to warn users if they attempt to send out a duplicate invitation.

Added Notification for Account Email Address Changes

Added a new notification sent to users when they change their email in the system for security purposes.

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

Updated File Uploader Interface

Introducing a new file uploader (Beta). Enable the new file uploader and let us know your thoughts. To enable this setting, go to Menu Icon > Global Settings > Branding tab > Toggle on Enable New File Uploader (Beta).

The new interface of the file uploader will show the upload progress of selected files.

Minor Updates

Added Ability to Batch Update User Roles and Organization Categories

Added ability to batch add roles to multiple users and add categories to multiple organizations. To see this feature, go to Menu Icon > People or Organizations > Select the desired users/organizations > Click the Batch Update button > Select the Roles or Categories option from the left-hand menu > Select the desired roles/categories you want to add.

Easily add a Role/Category to multiple users/organizations using batch update.

Note: You can only add roles and categories and not remove roles and categories. You will also not be able to add roles flagged as internal to external users and vice versa.

Updated Hashtag Library Availability

Added role-based permission to allow users to access the hashtag library from the menu. To give role access to the hashtag library, go to Menu Icon > Global Settings > Security tab > System Feature Summary > Menu tab > Add desired roles to Hashtag Library – Menu Access. Roles added to this setting will see a link to the hashtag library under the Tools section of the main menu and have access to the library.

New role-based access to the Hashtag Library. Users with permission may access the Hashtag Library using a link under the menu icon.

Notes for Admins

Added Support for AI Integration

Added ability for users to add their own API Integration key for a third-party AI integration. There is a cost associated with this feature and we will be sharing more information in the near future. To prepare for future enhancements regarding this feature, a Help section has been added to the Variable Syntax Checker found under Tools > Configuration Mode.

Added SmartField Configurations to System Performance Summary

Added additional checks to the System Performance Summary to flag SmartFields that have been configured to reference fields that have SmartFields syntax within a list syntax.

Updated Logos on External Pages

Updated the size of logos in the headers of external pages to have a maximum height of 56px.

Updated API Page Response Codes

An HTTP 429 response code will be shown when the API call limit is reached.

Updated SmartCheck Validation

Updated the error dialog in Smartcheck Validation under the source tab to improve error messaging. Read our SmartCheck Validation examples section for some sample validation statements.

Deprecated Setting for Menu Icon Header Font

Deprecated the Menu Icon Header Font setting which was never supported in the current header.

Password Reset Emails on Non-Production Environments

In addition to MFA emails being sent from non-production environments, password reset emails will also be sent from non-production environments. If you wish to add role restrictions for access to your backup environment, the setting is located at Menu icon > Global Settings > Security tab > System Feature Permissions > Feature tab > Restrict Login to Backup Environment to these Roles. When testing MFA and password reset emails on non-production environments, always use a test user and test email.

Service Packs

June 8th 2023 (202306.01)

Fixes

  • Fixed an issue with the Special - MSWord Merge custom field where some data was not displaying properly if exported from a list view.
  • Fixed an issue with the List View – Mixed Record Type portal section where sorting by the Type column was ordering the rows by the type name rather than the caption.
  • Fixed an issue with the list view search where the results were not returning exact matches if predefined options were used.
  • Fixed an issue where new workflow tasks could not be added if the From Address contained many SSlogic conditions.
  • Fixed an issue where the language switcher did not appear on the upper right-hand corner for signup pages using a verification service.


Other Changes

  • Updated the Gort Automation process. In the case of a process error, the process lock will be automatically removed to allow the process to run again without the need for manual intervention. Also, a new maximum limit of 2 hours has been set for the runtime length of any single Gort process to improve the recovery time from processes that did not terminate correctly. This limit does not apply to the autoloader.
    Note: The maximum limit can be adjusted for clients subscribed to the Private Cloud offering by submitting a request to our Support team.
  • Updated the rich text editor.
  • Updated various areas of the system for improved security.


May 18th 2023 (202305.02)

Fixes

  • Fixed an issue with the copy feature not working correctly after T2P under specific conditions.
  • Fixed an issue with list view export where negative numbers were being converted to text fields rather than number fields in Excel.

Other Changes

  • Updated the request timeout limit from 30 seconds to 90 seconds for sending SOAP request to external APIs.
  • Updated translations for English (UK) and Spanish.

May 11th 2023 (202305.01)

Fixes

  • Fixed an issue affecting clients using T2P that caused scheduled reports to run outside of schedule.
  • Fixed an issue where scheduled reports were not being displayed under the Scheduled Exports tab if the report was using the classic scheduler.
  • Fixed an issue where the Global Administrators tab was not displaying on the System Security Summary page under certain conditions.

Other Changes

  • Added the ability to generate user tokens to be used for bearer authentication in SmartConnect API authorization. To view this feature, go to Global Settings > Integrations tab > SmartConnect API > API Users tab > Edit a user account.
  • Added a limit to the image dimensions when rendering PDFs. If an image in a PDF exceeds approximately 50 megapixels (which is over twice the resolution of 4K Ultra HD), it will not be rendered and a message will be displayed in the PDF. Uploading images scanned at 150 or 300 DPI is recommended.
  • Added the ability to instantly push and unpack records using the new Data Exchange (DEX3).
  • Updated the cookies policy translations for Spanish, Portuguese, French (Canada), Danish, Gaelic, Catalan, and Japanese.
  • Deprecated the Janus Machine Learning feature.

April 20th 2023 (202304.02)

Fixes

  • Fixed an issue with HTML tags displaying in custom field captions.
  • Fixed an issue with email broadcast previews not rendering as expected. For security reasons, the email broadcast preview screen will now contain a link to open emails containing HTML in a new window.
  • Fixed an issue where the workflow initiator was receiving emails under specific conditions.
  • Fixed an issue with user accounts not having access to the Organization Hierarchy page. This issue occurred when the user’s organization was flagged as container.

Other Changes

  • Updated the default From Address behavior. If the default From Address is empty or cleared, the system will compile the From Address from the instance email domain settings if SMTP relay is configured. Otherwise, the system will set the default from address to donotreply@smartsimplemailer.com. The default from address can be found by going to Menu Icon > Global Settings > Communications > Email Options and Security > Toggle on Enable Default From Address.


April 13th 2023 (202304.01)

Fixes

  • Fixed an issue where opening an Level 2 event on a calendar would return a permission error under specific conditions.
  • Fixed an issue where annotations were locked if a status had a status trigger attached to it.
  • Fixed an issue with the autoloader throwing a file extension error for decrypted files.
  • Fixed an issue where users were temporarily unable to download files from SmartFolders or access email broadcasts after a password reset.

Other

  • Added variable syntax support for @state.name@ and @province.name@ which will return the full name of the state/province instead of the abbreviation. Also added support for the @rolecaption@ variable within invitation templates which will return the role caption instead of the role name.
  • Added ability to edit the sender email address used to send mail on behalf of the default From Address. To see this feature, go to Global Settings > Communications tab > Email Options and Security > Toggle on Enable Send Email On Behalf Of > Edit the address in the On Behalf Of Email field.
  • Updated Message Queue to include emails sent containing autoloader logs.
  • Updated charts so that the average value displayed is rounded to two decimal places for improved readability.
  • Updated the word counts on text fields to exclude guillemets ( « » ). These double chevrons are used as quotation marks in a number of languages and are therefore no longer counted as words.
  • Updated Spanish translations.
  • Updated various system areas for improved security.

March 30th 2023 (202303.05)

Fixes

  • Fixed an issue with the open button on Level 2 contact association list views.
  • Fixed an issue with API queries for validation on a set criteria.


March 23rd 2023 (202303.04)

Fixes

  • Fixed an issue with portal report charts not displaying if they had a negative value.
  • Fixed an issue with invitations to improve performance when there are many invitation records.

Other

  • Updated the word parsing feature found on the Upload - Single File Storage and Upload – Multiple File Storage fields to be able to parse an entire text document and store it in a single field. To use this feature, go to the configuration settings for the desired field and toggle on Enable Word Parsing. Inside the Field Mappings input, enter [fieldname]=documnettext; where fieldname is the name of the field where you want to store the text to. Additionally, if you only wish to parse the document body text without any header or footer information, enter [fieldname]=documentbody; instead.
  • Updated the permissions for the sub-company tab in the left navigation of the organization record so that the tab will only appear to users if the company contains sub-companies and if the user has at least a view permission for the sub-companies.


March 16th 2023 (202303.03)

Fixes

  • Fixed an issue where the Pronouns standard field was not displaying on user signup pages.
  • Fixed an issue with the button that opens the record in a modal window on Level 2 Provider list view on the Level 1 record.

Other

  • Updated behavior of the variable processor when processing custom fields to optimize efficiency.
  • Updated workflow emails to allow support for activation link syntax.
  • Updated API for conditional versioning support on Universal Tracking Applications.
  • Updated translations for French (Canada), Spanish, and Catalan.


March 10th 2023 (202303.02)

Fixes

  • Fixed an issue with emails not being sent from the record.