Release Notes 2021-07-05

Version Information

OpenEdge Release

Version Information

11.7.7, 11.7.8, 11.7.9, 12.2, 12.3

Release 11.7 #66802@2021-07-05

OpenEdge 12.3 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.3. We hereby declare OpenEdge 12.3 fully supported for the SmartComponent Library as of the release of  November 24th 2020.

OpenEdge 12.2 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.2. We hereby declare OpenEdge 12.2 fully supported for the SmartComponent Library as of the release of April 09th 2020.

.NET Framework Version 4.7

.NET 4.7 is not supported with OpenEdge 11.x, see: Is .NET 4.7 certified and supported for OpenEdge? 

Progress has reported severy issues with OpenEdge GUI for .NET and .NET 4.7: GUI .Net Application crashes after .Net upgrade to 4.7

When using the .NET Framework 4.7, please make sure, you upgrade to OpenEdge 11.6.4 or OpenEdge 11.7.2 or later. Also, it may be required to recompile the application on a PC running .NET Framework 4.7 when applications are also executed on a PC with .NET Framework 4.7.

Introducing the SmartComponent Library developer forum

Got questions about using the SmartComponent Library? Wish to discuss feature requests with other users of the SmartComponent Library? To facilitate networking in the growing number of SmartComponent Library users and developers, we've added a developer forum on our new home-page. The developer forum can be found at: 

A login is required to participate in the forum. Don't be shy - create your account today!

Release Notes

Following the release of the OpenEdge 11.7 Release we have completed our testing of the SmartComponent Library on this release of Progress and are proud to announce formal support for the SmartComponent Library on OpenEdge 11.7 with the 2017-04-24 release of the SmartComponent Library. Generally we recommend customers on OpenEdge 11 to upgrade to OpenEdge 11.7 quickly. Starting the 2017-07-14 release we are supporting OpenEdge 11.7 Service Pack 1 (11.7.1).

Starting the 2015-10-09 release the Business Entity Designer will feature a start page with links to most recent release note articles on this site.

With SCL-751 we have adopted native Enums for OpenEdge 11.6. To activate this feature customers must add a definition to products.i. SCL-751 provides details for this.

With SCL-1113 we have modified the templates for SmartWindowForms and SmartTabFolderPages generated from the Business Entity Designer. We have removed the initialization of the viewer controls SmartTableIOState property (value was set to "NoDataSource" within the InitializeComponent method). Customers using their own set of templates should adopt the same fix to their templates.

OpenEdge 11.7.3 compatibility

During our tests on OpenEdge 11.7.3 we have experienced the following issues: 

  • [SCL-2216] - 11.7.3 Visual Designer disabling properties of ABL user controls

The issue has been resolved by Progress Software with hotfix 007 for OpenEdge 11.7.3.

OpenEdge 11.7.2 compatibility

During our tests on OpenEdge 11.7.2 we have experienced two issues: 

  • [SCL-2007] - Correct support for WebHandler in CcsServiceManager
  • [SCL-2008] - Closing SmartWindowForm causes crash on OpenEdge 11.7.2

We consider it mandatory for customers using OpenEdge 11.7.2 to use at least the release #44166@2017-11-27 of the SmartComponent Library. 

Due to an fix for

  • [SCL-1924] - SmartViewerControl: copy mechanism cannot cope with clob datatype

from Progress Software for in OpenEdge we further recommend all customers to apply this hotfix as well. 

New Versions of Proparse .NET Assemblies (30 December 2018)

We have updated proparse with further enhancements in this release (see Please download the .NET Assemblies ZIP file from our ESD and replace the in your environment with the latest one. The new assembly reference is:

<assembly name=", Version=, Culture=neutral, PublicKeyToken=cda1b098b1034b24"/>

As proparse is used by our Business Entity Generator, this new version of the Assembly is also relevant for customers not doing GUI for .NET development and require support for parsing new ABL language constructs.

This version of proparse provides additional debug information when errors are thrown from

New Version of the Consultingwerk.SmartComponents Assemly (09 January 2019)

To support the new SmartFilterControl and the "Filter" link between the SmartFilterControl/SmartDynamciFilterControl and a SmartBusinessEntityAdapter or SmartDatasetChildAdapter we have updated the Consultingwerk.SmartComponents.dll. The new Assembly reference is:

<assembly name="Consultingwerk.SmartComponents, Version=, Culture=neutral, PublicKeyToken=10603cb31df311b3"/>

Customers need to update this Assembly in order to compile the latest releases of the SmartComponent Library.

Hybrid Realm now using IAuthenticationService

We've updated the SmartHybridRealm class used for http authentication to leverage the IAuthenticationService. It is therefor required that for AppServers requiring http Authentication (e.g. REST or Web) the correct IAuthenticationService implementation is registered (using service.xml files).

Customers relying on the previous behavior should ensure that the Consultingwerk.SmartFramework.Authentication.AuthenticationService is regsitered as the IAuthenticationService. This implementation will auhtenticate users against the password stored in the SmartUser database table. 

When users with no Login Company set should be able to login using the SmartHybridRealm, it's required to set the Login Company Tennant Domain (similar to the field in the Login Company Maintenance) in the .restapplicationsettings / .applicationsettings, e.g.:

 "DefaultAuthenticationDomain": "consultingwerk" 

This is required as the Hydrid Realm Interface from Progress does not provide the domain name to the authentication method. 

Web Handler overview

This is an overview of the web handlers supported by this release

handler1=Consultingwerk.OERA.JsdoGenericService.WebHandler.CatalogWebHandler: /Catalog/{EntityName}
handler2=Consultingwerk.OERA.JsdoGenericService.WebHandler.CatalogsWebHandler: /Catalogs/{PackageName}
handler3=Consultingwerk.OERA.JsdoGenericService.WebHandler.CountWebHandler: /Resource/{EntityName}/count
handler4=Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceSubmitWebHandler: /Resource/{EntityName}/SubmitData
handler5=Consultingwerk.OERA.JsdoGenericService.WebHandler.InvokeMethodWebHandler: /Resource/{EntityName}/{MethodName}
handler6=Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceWebHandler: /Resource/{EntityName}
handler7=Consultingwerk.OERA.JsdoGenericService.WebHandler.BusinessServicesWebHandler: /BusinessServices/{OutputFormat}/{PackageName}
handler8=Consultingwerk.Web2.WebHandler.SmartMenuWebHandler: /SmartMenu/{MenuStructureId}
handler9=Consultingwerk.Web2.WebHandler.SmartMenuStructureWebHandler: /SmartMenuStructure
handler10=Consultingwerk.Web2.WebHandler.SmartRoutesWebHandler: /SmartRoutes
handler11=Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler: /SmartViews/Grid/{EntityName}/{ViewName}/{DetailTemplate}
handler12=Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler: /SmartViews/Grid/{EntityName}/{ViewName}
handler13=Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler: /SmartViews/Grid/{CustomViewName}
handler14=Consultingwerk.Web2.Services.SmartViewsHandler.SmartViewerWebHandler: /SmartViewer/Viewer/{EntityName}/{ViewName}
handler15=Consultingwerk.Web2.Services.SmartViewsHandler.SmartViewerWebHandler: /SmartViewer/Viewer/{ObjectName}
handler16=Consultingwerk.Web2.Services.SmartViewsHandler.SmartFormWebHandler: /SmartForm/{FormTemplate}/{EntityName}/{ViewName}
handler17=Consultingwerk.Web2.Services.SmartViewsHandler.SmartFormWebHandler: /SmartForm/{FormTemplate}/{ObjectName}
handler18=Consultingwerk.Web2.WebHandler.SmartMessageWebHandler: /SmartMessage/{MessageGroup}/{MessageNumber}
handler19=Consultingwerk.Web2.WebHandler.GetImageWebHandler: /Image/{FileName}
handler20=Consultingwerk.Web2.WebHandler.SmartValueListWebHandler: /ValueList/{ValueList}
handler21=Consultingwerk.Web2.WebHandler.SmartAttachmentsWebHandler: /Attachments/{Table}/{KeyValues}
handler22=Consultingwerk.Web2.WebHandler.SmartAttachmentWebHandler: /Attachment/{Guid}
handler23=Consultingwerk.Web2.WebHandler.SessionContextWebHandler: /SessionContext
handler24=Consultingwerk.Web2.WebHandler.ContextPropertiesWebHandler: /ContextProperties/{PropertyName}
handler25=Consultingwerk.Web2.WebHandler.ContextPropertiesWebHandler: /ContextProperties
handler26=Consultingwerk.Web2.WebHandler.SessionInfoWebHandler: /SessionInfo
handler27=Consultingwerk.Web2.WebHandler.FileSearchWebHandler: /FileSearch/{FileName}
handler28=Consultingwerk.Web2.WebHandler.ExecuteAblWebHandler: /ExecuteAbl
handler29=Consultingwerk.Web2.WebHandler.SmartLanguagesWebHandler: /Languages
handler30=Consultingwerk.OERA.RestResource.RestEntitiesWebHandler: /Entities
handler31=Consultingwerk.OERA.Swagger.SwaggerWebHandler: /Swagger/{EntityName}
handler32=Consultingwerk.OERA.Swagger.SwaggerRestEntitiesWebHandler: /SwaggerEntities/{OutputType}
handler33=Consultingwerk.Web2.WebHandler.SmartTokenSecurityCheckWebHandler: /TokenSecurityCheck/{ObjectName}
handler34=Consultingwerk.Web2.WebHandler.SmartTokenSecurityCheckWebHandler: /TokenSecurityCheck
handler35=Consultingwerk.Web2.WebHandler.SmartEntityTableMappingHandler: /EntityTableMapping/{EntityName}/{TableName}/{UiTypeCodes}
handler36=Consultingwerk.Web2.WebHandler.SmartTreeRootNodeWebHandler: /SmartViews/TreeRootNode/{rootnodeid}
handler37=Consultingwerk.Web2.WebHandler.SmartTreeChildNodesWebHandler: /SmartViews/TreeChildNodes/{parentnodeid}
handler38=Consultingwerk.Web2.WebHandler.SmartSecurityCheckWebHandler: /IsRestricted/{SecurityRealmCode}/{SecurityItemGuid}
handler39=Consultingwerk.Web2.WebHandler.SmartFieldSecurityCheckWebHandler: /RestrictedFields/{TableName}
handler40=Consultingwerk.Web2.WebHandler.GetImageNamesHandler: /ImageNames
handler41=Consultingwerk.Web2.WebHandler.ExecuteQueryWebHandler: /ExecuteQuery
handler42=Consultingwerk.Web2.WebHandler.TranslationProviderWebHandler: /GetTranslation

UTF-8 based deployments available

Starting August 14th 2016 we ship our source code also as UTF-8 encoded. The ZIP files ending with contain the source code encoded with that code page. The source code in the remaining archives is still encoded in ISO8859-1. Also on Github there is a new branch containing the OpenEdge 11 based source code in UTF-8.

Related article (Progress K-Base): How to get Progress Developer Studio to save in UTF-8 encoding

New Feature Documentation

Download Link

Overview of included tickets


SCL-3429 Resolved issue with ServiceManager:IsInCallStack when not using the ServiceNameMappingService


We have resolved an issue in the Service Manager that customers might have faced when not using a ServiceNameMappingService implementation. The issue might have through an invalid object reference error at runtime when using DatasetModels with the UseInterface value of "UnmanagedWhenInCallStack".


SCL-3426 Implemented meaningful error message when Proparse cannot write to prorefactor/temp


When Proparse was not able to write to files in the prorefactor or prorefactor/temp previously a Java null pointer exception has been raised.
We're now raising a more meaningful error message.

SCL-3427 Implemented support for new records in SmartBusinessEntityAdapter:HandleBufferQuestions


We have implemented support for deleted records when handling questions raised by the Backend Validation logic.

SCL-3428 Added support for BY-REFERENCE Datasets in BusinessEntity:FetchRelatedRecords


The BusinessEntity method FetchRelatedRecords can now also be used from an invokable method that has been called with a BY-REFERENCE dataset.

SCL-3430 Additional Deployment Datasets have been defined for the export utility


We have defined additional deployment datasets in the
file. These dataset definitions serve the user interface to import and export SmartFramework metadata and as a starting point for automation routines developed by customers using the Generic Data Importer and Exporter.

New Feature

SCL-3425 Implement new DatasetHelper:DeleteOrphanedRecords API


We have added a new API in the DatasetHelper:
DatasetHelper:DeleteOrphanedRecords (phDataset) deletes records in all child tables.
DatasetHelper:DeleteOrphanedRecords (phBuffer) deletes records in that child table (should be called on a child table, not the parent table).
Orphaned records are child records where the parent record does not exist in the Dataset.

SCL-3431 Support for single record/group by dump and load of SmartFramework data


When dumping and loading SmartFramework data using a JSON configuration file we do now support to dump from a single Business Entity to multiple files based on grouping by unique record values. Grouping is supported for up to nine fields of the first dumped table.
Dumping to multiple files is controlled by a JSON object FileNamePattern which is used as an alternative to the FileName character property. So an entry in the JSON file like this:

        "Description": "Messages",
        "BusinessEntity": "Consultingwerk.SmartFramework.System.MessageBusinessEntity",
        "SkipFields": "",
        "Tables": "*",
        "QueryString": "FOR EACH eSmartMessage WHERE eSmartMessage.LanguageGuid = '' AND eSmartMessage.MessageGroup <> 'TEST' BY eSmartMessage.MessageNumber",
        "FileName": "Test/data/smartmessages-full.xml"

dumps all Smart Messages into a single file. Two entries like this:

        "Description": "Messages",
        "BusinessEntity": "Consultingwerk.SmartFramework.System.MessageBusinessEntity",
        "SkipFields": "",
        "Tables": "*",
        "QueryString": "FOR EACH eSmartMessage WHERE eSmartMessage.LanguageGuid = '' AND eSmartMessage.MessageGroup <> 'TEST' BY eSmartMessage.MessageNumber",
        "FileNamePattern": {
            "ExportFileName": "Test/data/smartmessages/&1.xml",
            "GroupByFieldNames": [
            "ImportFileNamePattern": "Test/data/smartmessages/*.xml"
        "Description": "Messages",
        "BusinessEntity": "Consultingwerk.SmartFramework.System.MessageBusinessEntity",
        "SkipFields": "",
        "Tables": "*",
        "QueryString": "FOR EACH eSmartMessage WHERE eSmartMessage.LanguageGuid > '' AND eSmartMessage.MessageGroup <> 'TEST' BY eSmartMessage.MessageNumber",
        "FileNamePattern": {
            "ExportFileName": "Test/data/smartmessages/&1-&2.xml",
            "GroupByFieldNames": [
            "ImportFileNamePattern": "Test/data/smartmessages/*.xml"

Will dump all messages with no specific language (LanguageGuid = "") into files named by the MessageGroup (GroupByFIeldNames array and FileNamePattern with &1) and all messages with a specific language into files by langage and by group (GroupByFieldNames with two values and FileNamePattern with &1 and &2).
File Names will be
OpenEdge.xml, VALMSG.xml, SFR.xml and SFR-DE.xml, SFR-FR.xml, SFR-NL.xml.
Info: The LanguageGuid will automatically be replaced by the language ISO code.
This example here dumps the SmartBusinessEntity configuration into individual files, one per SmartBusinessEntity Name and Package, SmartBusinessEntityTable is contained in the SmartBusinessEntity XML files:

        "Description": "SmartBusinessEntity Definitions",
        "BusinessEntity": "Consultingwerk.SmartFramework.System.SmartBusinessEntityBusinessEntity",
        "Tables": "*",
        "QueryString": "FOR EACH eSmartBusinessEntity WHERE NOT eSmartBusinessEntity.BusinessEntityPackage BEGINS 'Consultingwerk.SmartComponentsDemo'",
        "FileNamePattern": {
            "ExportFileName": "Test/SCL3431/data/smartbusinessentity/&1.&2.xml",
            "GroupByFieldNames": [
            "ImportFileNamePattern": "Test/SCL3431/data/smartbusinessentity/*.xml"
        "SkipFields": "TrackDeletions"

When loading data via JSON, the FileNamePattern object contains the ImportFileNamePattern. This pattern controls which XML files are loaded.
The new structure in the JSON file is supported both by the
- Consultingwerk/SmartFramework/Tools/Export/release-data-from-json.p
- Consultingwerk/SmartFramework/Tools/Import/import-data-from-json.p
procedures and the class files
- Consultingwerk.SmartFramework.Tools.Export.GenericDataExporter
- Consultingwerk.SmartFramework.Tools.Import.GenericDataImporter