Release Notes 2021-04-13

Version Information

OpenEdge Release

Version Information

11.7.7, 11.7.8, 12.2, 12.3

Release 11.7 #65551@2021-04-13

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-3341 Fixes issues with upgrading old SmartDB instances


We have fixed issues converting SmartDB instances created more than one year ago.
Customers have reported error messages such as the following when executing the SmartDB upgrade and migration utility. This issue is resolved now.

[SFR-import-smartrepo] [972/1006] Loading: Consultingwerk/SmartFramework/Repository/Dump/SmartModuleDataSource.smartrepo
[SFR-import-smartrepo] Unhandled error:
[SFR-import-smartrepo] An Consultingwerk.Exceptions.DatasetException has occurred:
[SFR-import-smartrepo] A conflicting Object Master record already exists with Object Name "SmartModuleDataSource" Customization Result ""!
[SFR-import-smartrepo]   Table: eSmartObjectMaster
[SFR-import-smartrepo] ThrowDatasetErrors Consultingwerk.Util.DatasetHelper at line 4144  (C:\oeproject\wms\SmartComponentLibrary\Consultingwerk\Util\DatasetHelper.cls)
[SFR-import-smartrepo] LoadRepositoryObject Consultingwerk.SmartFramework.Repository.Tools.RepositoryObjectImporter at line 547  (C:\oeproject\wms\SmartComponentLibrary\Consultingwerk\SmartFramework\Repository\Tools\RepositoryObjectImporter.r)
[SFR-import-smartrepo] Consultingwerk/SmartFramework/Repository/Tools/import-repository-data.p at line 565  (C:\oeproject\wms\SmartComponentLibrary\Consultingwerk\SmartFramework\Repository\Tools\import-repository-data.r)
[SFR-import-smartrepo] C:\Users\Lode\AppData\Local\Temp\pctinit259985090.p at line 40  (C:\Users\Lode\AppData\Local\Temp\pctinit259985090.p)

SCL-3344 Fixed issues saving a viewer layout in the Repository


We have resolved two issues that could have resulted in error reported when saving a viewer layout to the repository.


SCL-3262 Data Access: Support for passing arguments to FetchData sub-routines


We have added a new protected property to the DataAccess class:

     * Purpose: A property that allows to store a custom object with arguments that
     *          can be used to pass additional information (such as details on query
     *          execution strategy) from an override to FetchData or FetchDataByKeyTable
     * Notes:   The object reference is cleared (assigned to ?) at the end of the FetchData
     *          or FetchDataByKeyTable method
    DEFINE PROTECTED PROPERTY FetchDataArguments AS Progress.Lang.Object NO-UNDO

The purpose of this property is to allow passing arguments from a Data Access classes FetchData/FetchDataByKeyTable method override to sub-routines used by the FetchDataInternal method:
- Attach/DetachDataSource
- Setting/Unsetting callbacks
- SourceDefaultQuery
- SourceColumn
Instead of introducing an actual parameter passed to these methods, we have added this property. An (additional) parameter passed to those methods would have introduced a significant incompatibility with existing applications.
The object refence stored in this property will be voided (assigned to ?) at the end of FetchData and FetchDataByKeyTable.
The purpose of this property is to provide a central place for storing the execution strategy for the data access query, e.g. buffer order in the query. Previously this did require global variables in the data access implementation causing the risk that the a value of those properties might not be reset reliably after every request.

SCL-3317 Replaced trivial CATCH for Progress.Lang.Error with ui-catch.i Include


Following the release of SCL-2461 we have now replaced all trivial CATCH blocks (CHATCH blocks that only show the error message without further handling) with the reference to the Consultingwerk\Windows\ui-catch.i Include file.
Details can be found in the release notes of the SCL-2461 feature.

SCL-3327 Generic Data Exporter and Importer now supports the CustomContext argument


We have extended the Generic Data Exported and Importer to support the CustomContext argument of the FetchDataRequest class. This supports to pass arguments such as "NoCalculatedFields" to business entities which may improve the performance of the export and import significantly.

SCL-3332 Implemented ability to define shortcuts for repository toolbar buttons


The Windows toolbar definition used by the repository rendering now supports the definition of shortcut keys. Valid shortcut keys must be a member of the System.Windows.Forms.Shortcut Enum ( ?view=net-5.0). The shortcut keys can be specified as a JSON Array, e.g. ["Ctrl", "S"}. Sample Button definition in the default-buttons.json file:

"save": {
    "buttonType": "button",
    "buttonName": "TableIOSave",
    "buttonLabel": "Save",
    "buttonImageSmall": "Consultingwerk/SmartComponents/Images/saverec.png",
    "buttonImageLarge": "Consultingwerk/SmartComponents/Images/saverec_32.png",
    "group": "tableio",
    "shortcut": ["Ctrl", "S"]

SCL-3342 RESTful requests (ISupportsRestAddress and ISupportsRestMethod) now return SmartMessages expanded


Errors thrown from the RESTful calls into business services (CRUD and method calls) now return error messages reported as Smart Messages in plain text instead of tokenized.

SCL-3343 "Insert Data Field" in Viewer Designer now considers entity field mapping


The "Insert Data Field" tool in the repository viewer designer now respects the entity field mapping definition.

SCL-3345 Improved SwaggerRestEntitiesGenerator initialization


We have improved the initialization of the SwaggerRestEntitiesGenerator service. Those fixes will resolve issues reported by customers that have been using an invalid sete of templates for the Swagger files.

SCL-3347 Improved handling in DatasetHelper:ThrowDatasetErrors when there are many errors


We have improved the DatasetHelper:ThrowDatasetErrors API for cases when there are many records with errors. We have implemented a secondary set of the API's used by the ThrowDatasetErrors API returning the error messages as a LONGCHAR value instead of CHARACTER.

New Feature

SCL-2894 Implemented ability to "lock" PASOE web sessions


We have implemented the ability to "lock" a PASOE web session. A locked session will no longer allow requests from clients under that session. Requests made from a locked session will be causing an HTTP 401 error.
The Consultingwerk.SmartFramework.Context.ContextStoreBusinessEntity provides two new method to support locking of sessions:
- LockSession based on a CharacterHolder with the value of a Session ID will lock the given session
- LockUserSessions (with a CharacterHolder as an unused parameter) will lock all sessions of the current user except for the current session (from which the call is made)
We have implemented a new Security Token named "ListUserSessions". Users with authorization for this security token can list web sessions of all users. Users without authorization for this security token can only list web sessions for the current user.
Based on this security token, the ContextStoreBusinessEntity business entity can be used to list the sessions of the current user.

SCL-3311 Improved behavior of the reference main menu form on Windows shutdown


We have added a check to the OnFormCLosing event handler method of the MainMenuForm. This check now prevents to "Are you sure you want to close" prompts when the FormClosing event is raised by a pending Windows shutdown / user logoff.
When the user still has a pending update in a screen launched from the main menu form, that form will still prompt if the user wants to save the pending changes.
We're also passing the -wy startup parameter to the background jobs populating the dashboards in the Sports2000 demo application (customer explorer). This will prevent those background jobs from asking if the user is o.k to exit Windows.

SCL-3320 Implemented Wizard in Repository Designer to create Menu Function for GUI


We have implemented a new wizard in the Repository Designer that supports the creation of a menu item to launch a repository form in GUI.

SCL-3321 Implemented Wizard in Repository Designer to create Menu Function for Angular


We have implemented a new wizard in the Repository Designer that supports the creation of a menu item to launch a repository form in the Angular web application. This wizard also supports the execution of the SCLNG command line utility to create a the Form typescript class.