2021 Packages and Packets Changelogs

December

2021.13The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is December 2021.

December Installation / Upgrade Notes
Note the following installation and upgrade changes since the November 2021 release. The location of the associated changelog is identified in parentheses:
  • No Installation/Upgrade Changes
Redesigned Navigation Bar
Summary: This release includes a redesign of the left side navigation menu. With this update, we have added a More icon to the menu. When clicked, the More icon displays a submenu with additional navigation icons. The Repost, Export, and Import icons are now included on the More submenu and no longer display on the main Navigation menu. Also, the More flyout menu closes when one of the menu options is selected or if More is clicked a second time.
User Interface Changes: Required Fields
  • Type: Enhancement
  • Reference: PBI 687948
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes updates to how required fields display within the program to make them consistent across the program. Throughout the program, unpopulated required fields now display with a red line to indicate the field is required.
Search Functionality Enahnced When Adding Documents to Packet
Summary: This release includes enhancements to the search functionality available when adding documents to packets, allowing you to more easily locate which documents to include within the packets. With this release, the search function is now available within both the left and right panels, independently.
Session Timeout Enhanced
Summary: This release includes changes to the program to prevent users from timing out without warning. We have added a timeout popup messge that displays 5 minutes before the timeout occurs, with a countdown to the session expiration. Use the popup message to extend the session by clicking Extend Session. Or click Sign Me Out to end your session.
Done Button Disabled When Adding Documents
Summary: This release includes enhancements to the process of adding documents to packages or packets. We have disabled the Done button until any selected documents have been moved to the Selected Documents list or have been unchecked. Because clicking Done closes the window, this change ensures that any selected documents have been placed intentionally and also prevents you from inadvertantly leaving the window before the documents are added and having to reselect the documents.
Barcode Delete Popup Added
  • Type: Enhancement
  • Reference: PBI 683359
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes the addition of a popup message that displays after clicking Remove Barcode and allows you to confirm deletion of the barcode.
General Updates
  • Type: Enhancement
  • Reference: PBI 694033, 700179, 687426, 699969, 700457
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

November

2021.12The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is November 2021.

November Installation / Upgrade Notes
Note the following installation and upgrade changes since the September 2021 release. The location of the associated changelog is identified in parentheses:
  • Transform Variable Changes:
  • Octopus Variable Changes:
  • Changes to Prerequisites:
  • Miscellaneous Installation Changes:
    • New Audience Value for Integrator Documentation (2021.12)
    • Swagger Available for API Framework (2021.12)
Search Functionality Added When Adding Documents to Packet
Summary: This release includes the ability to enter search critieria when adding documents to packets, allowing you to more easily locate which documents to include within the packets.
  • The search limits the results to only those documents that match the search criteria.
  • The search applies to the Document ID only.
  • The search is dynamic partial text: results are returned when a match is found anywhere within the Document ID value.
  • The search may contain letters, numbers, and/or the following special characters: underscore ( _), comma (,), and period (.).
Search Functionality Added When Adding Documents to Package
Summary: This release includes the ability to enter search critieria when adding documents to packages, allowing you to more easily locate which documents to include within the package.
  • The search function is available on both the left and right panels and work independently.
  • The search limits the results to only those documents that match the search criteria.
  • The search applies to the Document ID only.
  • The search is dynamic partial text: results are returned when a match is found anywhere within the Document ID value.
  • The search may contain letters, numbers, and/or the following special characters: underscore ( _), comma (,), and period (.).
Swagger Available for API Framework
  • Type: Enhancement
  • Reference: PBI 691604, 700611
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes the availability of Swagger for customer use. Swagger can be used to generate API framework.
Important: Swagger is not inteded to be a source of API documentation as not every API available within Swagger is inteded for integration use. APIs intended for integration use are documented within the Expere EZ Config Packages and Packets Web Services Guide. All undocumented APIs are used behind the scenes to support the user interface and should not be used.
New Documentation URL
Summary: This release includes changes to the documentation URL; specifically, we have created an additional audience value to better support our self-hosted customers with the differences between documentation for down stream users and integrators themselves. With this release, the documentation intended for integrators will use a new audience value, which has been updated on the Document Generation Services Landing Page. Documentation being hosted for your downstream customers will continue to use the existing audience value.
Upcoming Feature Work: List Documents
  • Type: Enhancement
  • Reference: PBI 689311, 689312
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes changes to the APIs for future List Documents feature functionality, which will be described within upcoming release notes for Expere Document ServicesDocument Generation Services.
General Updates
  • Type: Enhancement
  • Reference: PBI 692343, 697561
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

October

2021.11The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is October 2021.

Update Copied Package
  • Type: Defect Correction
  • Reference: PBI 691899
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes changes to ensure that Packages created via Bulk Copy can be updated. Specifically, in situations where the document phase (rule source) changes, the program now allows the package to be updated and saved.
Important: Review the content release notes for changes in document rule sources to determine if you need to add the new document rule source combination to your packages and packets.
General Updates
  • Type: Enhancement
  • Reference: PBI 698092, 689093
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

September - Out of Band

2021.10The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is September 2021.

General Updates
  • Type: Enhancement
  • Reference: PBI 698092
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.
Reorder Document List
Summary: This release includes changes to the Document List to provide the ability to easily change the order of the documents within a packet. To change the order of documents in the Document List, click the # field and then enter a number to specify a position in which to place the document.
  • Only positive whole numbers can be entered, 0 or greater. Entering 0 or 1 places the document at the top of the list.
  • If the number entered is greater than the number of documents in the list, the program displays a warning about the range of numbers you may enter and disables the Apply button until an acceptable number is entered.
  • When a position is specified for a selected document, all other documents in the list reorder accordingly.

September

2021.9The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is September 2021.

September Installation / Upgrade Notes
Note the following installation and upgrade changes since the March 2021 release. The location of the associated changelog is identified in parentheses:
  • Transform Variable Changes:
    • A new transform variable was added to support customizing the maximum import and export file size:<Property Id="PKGPKT.ExportImportFileMaxSizeBytes" Value="6000000" /> (2021.4)
  • Octopus Variable Changes:
    • None
  • Changes to Prerequisites:
    • Edge browser now supported. (2021.7)
    • .NET Core 5 is now required (2021.9)
  • Miscellaneous Installation Changes:
    • First time installation always creates app pool (2021.9)
General Updates
  • Type: Enhancement
  • Reference: PBI 686009, 689091
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.
Installation Changes
  • Type: Enhancement
  • Reference: PBI 686049
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes changes to the first-time installation process to ensure the install always creates the app pool.
.NET Core 5
  • Type: System Requirements Updates
  • Reference: PBI 654523
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: DGS Installation Guide
Summary: With this release, .NET Core 5 is now required for installation.

August

2021.8The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is August 2021.

Import File Size Check
  • Type: Enhancement
  • Reference: PBI 674482
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: With this release we have added validation to the program to check the import file size earlier in the import process. Previously, if the file you were attempting to import was too large, you would receive an error once the Import button was clicked on the Import Detail page. With this enhancement, the validation now occurs on the Import Packages popup window when you select a file to import. If the file is too large to import, a message stating "File is too large" displays below the filename of the selected import file, and the Load Import button is disabled.
Document List Display Size
  • Type: Defect Correction
  • Reference: PBI 604998
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes an update to the Document List display to ensure that when adding a long list of documents to a package, the list of documents no longer extends past the Package List popup.
General Updates
  • Type: Enhancement
  • Reference: PBI 677208, 683460, 676884, 677372, 683494
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user, including behind the scenes updates to improve tracking of errors and failures and providing more graceful error handling.

July

2021.7The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is July 2021.

Support for Edge Browser
Summary: With this release, the use of the Microsoft Edge browser is now supported for use with EZ Config Packages and Packets.
General Updates
  • Type: Enhancement
  • Reference: PBI 679398, 675178, 670417, 677186
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

June

2021.6The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is June 2021.

Deleting Multiple Packages
Summary: This release includes the ability to now delete multiple packages at a time. This functionality was added so that when performing a bulk copy, you can easily remove multiple old packages at one time instead of having to remove them individually. The Packages and Packets List page now contains checkboxes for each Package. When one or more packages are checked, the number of selected packages displays at the bottom of the page. Click Delete to delete the selected Packages. A popup message allows you to confirm or cancel the deletion.
Import and Export for Documents with Different Rule Source
  • Type: Defect Correction
  • Reference: PBI 680029
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes a fix to the import and export functionality for documents with rule source(s) that differ from the Package in which they are included. Previously, a document with a different rule source than the Package got updated to match the Package in the exported .json file. The exported .json now references the rule source(s) correctly so when importing, the document references the correct rule source(s).
General Updates
  • Type: Defect Correction
  • Reference: PBI 675097
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes an update to the interface to ensure the cursor display is consistent across the program.
General Updates
  • Type: Enhancement
  • Reference: PBI 676309, 676563
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

May

2021.5The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is May 2021.

Column Display
  • Type: Defect Correction
  • Reference: PBI 664754
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes an update to the way the columns display on the Export Details page. With this update, the text from the first column no longer overlays the text in the second column. Now if column values are too long, the program displays ellipses (…). Hovering over the ellipses will display the full text value.
Export Button
  • Type: Defect Correction
  • Reference: PBI 664314
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes an update to the Export button to ensure it is no longer active when all Packages are unchecked on the Export Details page.
General Updates
  • Type: Enhancement
  • Reference: PBI 672599, 672299, 669834, 668046, 669836, 672636
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

April

2021.4The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is April 2021.

Maximum Import File Size
Summary: This release includes changes to the maximum allowed import file size. With this update, imported files larger than 6 Mb will not upload, and you will receive the following error message:

File size is too large. Contact your System Administrator.

A new transform variable was added to support customizing the maximum import and export file size:

<Property Id="PKGPKT.ExportImportFileMaxSizeBytes" Value="6000000" />

This property is used to set the maximum export and import file size, in bytes.
Packet Name Text Box
  • Type: Enhancement
  • Reference: PBI 663347
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes an update to the Packet Name field on the Details page to allow the size of the field to grow dynamically as characters are entered into the field.
General Updates
  • Type: Enhancement
  • Reference: PBI 654529, 664498, 665061, 663030, 667873, 663364
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

March

2021.3The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is March 2021.

March Installation / Upgrade Notes
Note the following installation and upgrade changes since the September 2020 release. The location of the associated changelog is identified in parentheses:
  • Transform Variable Changes:
    • Three new transform variables were added to specify logging levels. (2021.2)
      • <Property Id="DefaultData.LogLevel.Serilog" Value="Information"/>
      • <Property Id="DefaultData.LogLevel.Microsoft" Value="Information"/>
      • <Property Id="DefaultData.LogLevel.System" Value="Information"/>
  • Octopus Variable Changes:
    • None
  • Changes to Prerequisites:
    • .NET Framework is no longer required for EZ Gateway. (2021.3)
      Note: Other components may still require .NET Framework.
    • .NET Core is no longer required for EZ Gateway (2020.11)
      Note: Other components may still require .NET Core.
      Note: This update replaces an earlier change requiring .NET Core 3.1.8 (2020.9)
  • Miscellaneous Installation Changes:
    • Permissions to private keys for STS client certificate no longer manually required. (2020.10)
    • DGS Management Redirect. (2020.10)
Import and Export
Summary: This release includes the addition of Export and Import functionality. The Export and Import functionality were added to allow users the ability to transfer their packages from one environment to another, such as from a test environment to a production environment. Using the Export and Import feature eliminates the need to re-create these items on a new environment. This functionality is also useful in providing insight during troubleshooting and support issues.

Refer to the EZ Config Packages and Packets User Guide for instructions on using this new feature.
'Account' Updated to 'Accounts' in Web Services
Summary: This release includes updates to the integration APIs to update 'account' to 'accounts' within the routes to ensure consistency between Packages and Packets and Default Data APIs.
Note: Any existing integrations using the previous format of 'account' will not be affected by this change; both versions are still supported. However, integrations to the previous 'account' version should update their integrations to the 'accounts' format as the previous 'account' version will eventually be deprecated.
General Updates
  • Type: Enhancement
  • Reference: PBI 660584, 656227, 656529, 656225, 661436, 661910
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.
Removed .NET Framework as Install Prereq
Summary: This release includes updates to the installation documentation to remove .NET Framework as a prerequisite for installation. This is a documentation-only update; the prerequisite was eliminated in an earlier release, and it inadvertently remained documented as a prerequisite. Please note that other components may still require .NET Framework to be installed.

February

2021.2The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is February 2021.

Logging Levels Added; New Transform Variables Available
Summary: This release includes new transform variables. These new variables allow you to specify different levels of logging. Specifically, the variables allow you to designate an Information level of logging in addition to the already default Debug setting, which sometimes results in very large log files. The following variables were added. Note that you can specify different logging levels for Serilog, Microsoft, and system level. These variables are not required settings. No action is required if the "Information" level is sufficient for your organization.
  • <Property Id="PKGPKT.LogLevel.Serilog" Value="Debug"/>
  • <Property Id="PKGPKT.LogLevel.Microsoft" Value="Information"/>
  • <Property Id="PKGPKT.LogLevel.System" Value="Information"/>
Add Documents Functionality
  • Type: Enhancement
  • Reference: PBI 648473
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general behind the scenes enhancements to the Add Document functionality.
General Updates
  • Type: Enhancement
  • Reference: PBI 655672, 654473, 637978, 649683, 656529
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.

January

2021.01The effective date for Expere EZ Config Packages and Packets within the scope of this document for this release is January 2021.

Column Alignment Updates
  • Type: Enhancement
  • Reference: PBI 645912
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes updates to the alignment of columns on all list pages to make the appearance consistent across the program.
Updated API Parameters Documentation
Summary: This release includes updates to the web services documentation to list certain parameter items as integers instead of strings. We also updated the documentation to reflect that some values are optional and not required, as they previously were inadvertently documented incorrectly.
General Updates
  • Type: Enhancement
  • Reference: PBI 629576, 650906, 651909
  • Compliance Impacts: This item is not a compliance or regulatory issue.
  • Documentation Impacts: None
Summary: This release includes general updates not visible to the user.