Difference between revisions of "Upgrades"

From SmartWiki
Jump to: navigation, search
m (Reverted edits by Chin (talk) to last revision by Mark)
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}}
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.
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=
====New Limitation to Max Number of Records Returned by SmartConnect API Call====
=Future 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.
View [[Future Upgrades|future upgrade dates]].
<!--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 12:23, 8 April 2021


General Information

Next Upgrade Date

The next upgrade is scheduled for July 8 2021.

Upgrade Schedule

Upgrade Planned Production Date
July 2021 Thu, July 8 2021
November 2021 Thu, November 11 2021
March 2022 Thu, March 10 2022
July 2022 Thu, July 14 2022
November 2022 Thu, November 10 2022
March 2023 Thu, March 9 2023
July 2023 Thu, July 13 2023
November 2023 Thu, November 9 2023

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 subscribed to our Public Cloud offering your SmartSimple system will be automatically upgraded according to the following schedule

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

If you are subscribed to our Private Cloud offering with managed upgrades your SmartSimple system will be automatically upgraded according to the following schedule

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

If you are subscribed to our Private Cloud offering with client-managed upgrades your SmartSimple 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
Private Cloud - Client-Managed Upgrades 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: November 14th 2019
Public Cloud Backup release date: October 29th 2019

Private Cloud Production (Managed Upgrades) release date: November 28th 2019
Private Cloud Backup (Managed Upgrades) release date: November 14th 2019


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

Change to Upgrade Schedule

Starting in 2020, we'll be changing our upgrade cycle to a 4-month release cycle. Instead of 4 upgrades a year, we'll be producing 3 upgrades a year. The reason for this is to be able to produce more polished, as well as larger functional enhancements. The 3-month cycle was limiting our ability to develop some of our larger features in a more comprehensive manner. Lengthening the release cycle will allow us to produce some bigger, meaner features, so stay tuned for these starting in 2020!

Deprecation of Classic Interface

It's time to step boldly into the future. With this upgrade we've deprecated our Classic interface. If you haven't yet made the switch to Arcadia interface, your system will automatically be converted to using the Arcadia interface after this. This is to ensure the best user experience for all of our clients, and their communities, not only with a modern interface but also with the rich set of features that we're able to offer through the Arcadia interface that wasn't possible in Classic. Note, your system interface will change if it currently looks similar to the Classic Interface example below, and after this upgrade it will be updated to look like the Arcadia example instead.

Displayed is a Classic Interface that will be automatically converted into the Arcadia Interface.
Displayed is the same Classic Interface converted into the Arcadia Interface.

Deprecate Decimal and Integer Number Formats from Question Set Builder Field

Deprecated the number Format options of Decimal, and Integer from fields used in the Question Set Builder custom field. Note that this only applies to the Question Set Builder custom field, and only in the case where you have created questions that use these format options. This change was made to align the configuration of these fields more consistently with our other custom field settings for Number Precision. Note that if you have any questions current configured in a Question Set Builder configured for the deprecated format options above, they will just be converted to the value of None after this upgrade. You will have to update the fields manually and set the Number Precision if needed.

Change to CAPTCHA Bypass Setting

Change to the CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) bypass function previously used to disable CAPTCHA functionality for users by country. Instead we've re-introduced an older CAPTCHA feature of ours that will apply a simple CATPCHA test that is verified locally on the server instead of reaching out to our Google reCAPTCHA integration that was being blocked by some countries. Instead of outright disabling CAPTCHA functionality for a country, this setting will now instead supply users in selected countries with a SmartSimple CAPTCHA in order to always present some challenge to malicious automation out there.

New Ability to Attach Multiple Filters to a List View

New ability to attach multiple filters to a single list view. You may now build complex list filters by combining multiple simple list filters. For example to list all grant applications that you created or that your organization created or that your co-applicant created all in one list. When assigning multiple filters to a list view, the results of each individual filter are returned and then combined together to render the list. In other words, the resulting list will contain records that satisfy any single one of the attached filters.

Expanded Field Search to List View Configuration

Expanded the ability to search for fields to the list view configuration screen. Now when editing a list view, you can easily search for specific fields that you're looking for, similar to the functionality in the report builder.

Displayed is the List View Builder with the new field search.

Expanded Edit List View Icon to More Areas

Expanded the availability of the edit list view icon to more areas. We've now extended the ability to easily configure the list view that you currently have open to most of the list view areas in the system including lists on contact records, organization records, and UTA consumer/provider lists.

Enhanced Search Panel Function

Enhanced the search panel area for list view sections in portals. This search panel is an easy way for you to provide a simple search filter for your end users to use, by predefining a set of criteria that they're able to filter on. Within the configuration of a portal section of type list view, simply enable the Search Panel option, and then select which columns of the list view you want to allow end users to filter on.

Displayed is the enhanced portal search which can be added to sections with list views. You define what columns your portal users can filter on.

New View of Workflow Connectivity Configurations

New settings screen that lists workflow connectivity to help you to trace through complex workflow processes. In the configuration screen of a workflow, we've introduced a new menu tab called Workflow Connections that will allow you to see other workflows that trigger, or are triggered by the workflow you're viewing. Also, when you are editing a workflow task that triggers another workflow, we've introduced a link for you to review the workflow that you're linking to.

Displayed is the new Workflow Connections tab in the left navigation which shows connectors and tasks.

New Ability to Test Report Exports and Autoloader Imports

New ability to test report exports and autoloader imports on the fly now. We've introduced a Test Now button on the scheduling screen for report exports and autoloader imports for you to manually kick off a test.

Enabled Change History for Reports

Enabled change history functionality for reports. You can now see detailed change history for your reports and also even revert changes to a previous version! Note that changes to reports will only begin to be logged after the upgrade and you will not see previous changes made before.

Enabled Audit History for UTA Security Matrix

Enabled audit history for UTA security matrix. The system will now log changes made to the UTA security matrix.

Minor Updates

Update to SmartCheck Error Message

Updated the standard message for a failed SmartCheck validation from "please correct the following errors" instead to "submission failed due to the following". This was done to avoid confusion in situations where the failed submission logic should not actually be corrected, such as an eligibility form, where suggesting to correct the failed criteria would invite perjury.

Enhanced Tab Bar Mode Feature

Enhanced the Tab Bar feature and extended it to more areas. You can now enable Tab Bar mode from the portal, where previously it was restricted to admin user views only. Also added the ability to re-order your tabs, as well as to use the various split-screen features such as list view split-screens, and map panels. We've also updated the modal window functionality from covering the entire screen instead to just covering the main application window when using the Tab Bar feature. This will allow you to more easily work with multiple tabs and switch between them.

Displayed is the improved Tab Bar mode with the ability to re-order tabs.

Updated Icon Library

Updated the library of available icons, for use in places like portal shortcuts. This will grant you more variety in the available icons you can choose from, as well as different styles of icons. Please note some system icons are a little larger for improved accessibility.

Displayed is the new icon selector as seen when configuring shortcuts. There are now more icons and four icon styles to choose from.

Added Ability to Show All Records in Portal List View

Added the ability to show all records in a portal list view now. Previously in the portal view, list views were limited in the number of records they could display at a time.

Updated Settings Terminology of Data Categorization Feature

Updated some of the terminology and field labels for the settings of the Data Categorization functionality to improve clarity around the feature. In the Global Settings, Security menu, the previous Data Categorizations and Policies link has been moved down to a new section labelled Data Management Policies, and Data Categories has been re-labelled to Field Sets. These changes were made to have access to this feature more apparent and intuitive.

Updated Icon for Configuration of Translation Text

Updated the icon for the configuration of custom translation text within settings pages. Previously this was an icon beside the text boxes that could be translated, such as caption label, however, this functionality has now been moved up to the top of configurations screen with a new icon. This change was made to have access to text translations more consistent and easily available to administrators.

Displayed is the button used for entering translations. Prior to this upgrade the button was usually located beside the caption.
Displayed is the button used for entering translations. After this upgrade the button will be located in the action bar near the top of the screen.

Added Baseline Language Translations for Japanese

New language supported by default. We have introduced default baseline system translations now in Japanese.

Simplified Report Builder joins for Audit Logs

Updated the report builder to simplify the inclusion of Standard and Custom Field Audit Log record sets. Now when you add one of these record sets, the link field option will also show specific fields that you can link on in order to limit your report of field history to specific fields.

Enhanced Reporting of Privacy and Security Policy Agreements

Enhanced the Privacy and Security Policy agreements to now capture the policy version, as well as expose the information to be exportable via Reports. You can now build a report to export the information of user acceptance of your policy agreements.

Enabled Additional Logging of Emulation Users in Field Change History

Enabled logging of emulation users for field change history. If a user is emulating another user, the original user will also be logged in the field change history to indicate that the target user was being emulated by another at the time. When viewing field changes, a new Emulated By column has been added to indicate this.

Enhanced Association Entry Interface

Enhanced the new association entry view for ease of use. Added the ability to select and drag multiple rows. Also, extended the new association entry interface to custom fields of type Linked Record List. If you're using the new association entry interface, this will also now be applied to custom fields that display association lists as well. This will be applied to your system if in Global Settings -> Classic Options -> you must toggle off Use Classic Association Entry View in order to try out the new interface.

Displayed is the new Association Entry view where you can choose the role to assign, search/filter for specific users and then add those users in that role.

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 System Administrator:

Major Updates

Added Options for Configuring Minimum and Maximum Selection Requirement for Lookup - Autocomplete Custom Fields

Added options for the configuration of Lookup - Autocomplete custom field types to allow you to easily configure a minimum requirement, as well as maximum limit on options for users to select.

New Option for Update Behavior with Organization Signups for Matching Organizations

New update behavior option for organization sign up pages introduced that when used will allow new registrants the ability to select existing organizations to sign up under. This new option will automatically create a new organization when no matches are found, but will alternatively display matching organizations that match a category you specify when found and allow users the ability to select which organization to create their user account underneath.

Displayed is the new duplicate match found screen on an Organization signup page. If this option is chosen the user can select an organization within your system and create themselves under that organization or the user can choose to create a new organization.

New Option for Organization and User Signups to Apply SmartCheck Validation

New ability to assign a SmartCheck validation to a signup page. While the signup page would apply field level validations, you may now also apply SmartCheck Validations to configure more complex validation requirements.

New Location Proximity Searching

New ability for list views with the map panel enabled to filter and sort records based on location proximity. Now available for UTA Level 1, users, and companies list views. This will allow users to list records in order of proximity to the user's choice of their current location, an address search, or simply pointing on the map. Records can be mapped based on the address of the person, contact, customer or organization.

Displayed is a level 1 list view (example grants) with the map option enabled. You can modify the proximity and adjust the filters at the top right.

Minor Updates

Expanded Quick Assign for use in Portal Sections

Expanded the Quick Assign feature to be available inside portals. Previously, this was limited to just the full UTA view, but we've now made it available to your end users inside their portal. Just create a shortcut and use the URL lookup to select this option.

Added Option for Workflow Connector to Exclude by Record Status and Type

Added an option to add a status and type exclusion list for workflow connectors. Previously, there was only an inclusion option for status and types, but now you can choose either or to simplify your configuration.

Added Option to Show Record Count for Mixed Record Type List Views in Portal

Added the Show Record Count option for portal sections of type List View - Mixed Record Type.

Added Ability to Restrict Availability of Invitation Templates

Added ability to restrict the availability of Invitation templates of the Invitations feature to certain user roles. Visibility Condition settings have been added for Invitation templates to allow you to limit their use.

Added Additional Expiry Options for Privacy and Security Policy Agreements

Added an option to enforce that your end users accept your Privacy and Security policies on a daily or weekly basis. Previously, the shortest available option to you was monthly.

New Ability to Manifest UTA Level 3 Tabs

New ability to manifest UTA Level 3 list views as tabs now.

Beta Previews

No features are available for beta preview this upgrade.

Notes for Admins

New Ability to Search within History and Pending Workflow Tasks

New ability to perform searches within the workflow task history/pending queue lists. You can now search, filter, and sort on the workflow task queue to better trace the automated workflow processes being triggered in your system.

Added Option for use of Private Key File for Authentication of Report Exports

Added option to use private key file for use in authentication of report exports. You may now upload a private key file for use in report exports to external sites such as SFTP sites.

Expanded Variable Processor to Maximum Word/Character Setting of Custom Field

Enhanced the maximum word/character setting of a custom field to run through the variable processor. You can now make the maximum word/character limits of your custom fields dynamic and dependent upon the value of another field.

Added Option to Restrict Dynamic Content Enabled Custom Field to List Only Parent Associated Objects

Added an option for selection-type custom fields with dynamic content enabled to restrict the list of dynamic content to related child records. For example, a multi-select custom field on a UTA Level 1, with the dynamic content option enabled will have an additional setting Enforce Parent Restriction available to you now. Enabling this setting will restrict the list of Level 2 records to only the child Level 2s under the Level 1 record the user is on.

Expanded Variable Processor to Records Linked via Linked Record Custom Field

Added the ability to reference field values from another record linked through a selection-type custom fields with dynamic content. You'll be able to use the following variable syntax to reference an object linked to one of these fields:

@linked.linkfield[#~recordstandardfield~ $recordcustomfield$#]@

e.g. @linked.EmergencyContact.cellphone@ given that EmergencyContact is a Linked Record custom field of type contact, and cellphone is a cellphone custom field belonging to the contact.

Future Upgrades

View future upgrade dates.