Release Notes 2021-08-30

Version Information

OpenEdge Release

Version Information

11.7.9, 11.7.10, 12.2, 12.3, 12.4

Release 11.7 #67671@2021-08-30

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-3469 Grid Repository Designer has been crashing (silently) when retrieve data from Business Entity times out


We have resolved an issue in the Grid Repository Designer that caused a crash of the OpenEdge session when the request to the design time Business Entity has timed out (stop-after). The issue was resolved by improving the handling of stop-conditions in the SmartBusinessEntityAdapter class.


SCL-3466 Added CompilingFile event to the CompilerHelper


The CompilerHelper now provides an event called CompilingFile which is raised before a file is compiled by the CompileFile and CompileFiles methods.

The event can be used for status displays. When raised from the CompileFiles method the event is cancelable.

SCL-3467 Added options to the FileHelper:CopyFiles method to exclude files


The FileHelper:CopyFiles method now supports excluding files from the copy operation. New overrides to the method provide an ExcludeFiles parameter which specifies a comma delimited list of file patterns (matches, with forward slash) of files names that will be excluded from the copy operation.

SCL-3468 Added new options to the WebClientPackageHelper


Added the following new options to the WebClientPackageHelper class:

* support for ExcludeFromCopy argument ([SCL-3467])
* support for ExcludeFromCompile argument (based on [SCL-3466])
* when the CompileFiles argument is passed empty, R-Code is copied from the source directory (working directory) that does not have any database-references
* support for updating the WCP File (WcpFile argument).

When the WcpFile argument is passed, the CreateDeployment routine will update the WCP file (WebClient project file) with the actual set of files for the base cabinet file. This will eliminate the need to update the contents of the base cab before generating a new version. The .ico file names referenced in the system task definition for the application and Web Client manager icons are excluded from the base cab file list.

A sample JSON config file:

    "TargetPath": "..\\WebClient\\R-Code",
    "CompileFiles": "*.cls,*.w,*.p",
    "ExcludeFromCompile": "_idestartup.p,OpenEdge/*,Setup/*,Test/*,Consultingwerk/BusinessEntityDesigner/*,Consultingwerk/iOSAdapter/*,Consultingwerk/SmartUnit/*,Consultingwerk/SmartComponentsDemo/ProgresticSearch/*",
    "CompileLogFile": "..\\WebClient\\compile.log",
    "CopyFiles": "*.config,*.xml,*.xsd,*.cfg,appsrvtt.d,*.resx,*.dll,*.png,*.gif,*.bmp,*.jpg,*.ico,*.isl,.applicationsettings,*.json",
    "ExcludeFromCopy": ".externalToolBuilders/*,.settings/*,.sonarlint/*,.vscode/*,Assemblies/EA/*,Assemblies/CefSharp/*,build/*,DesignTemplates/*,OpenEdge/*,Setup/*,Test/*,Consultingwerk/BusinessEntityDesigner/*,Consultingwerk/iOSAdapter/*,Consultingwerk/SmartUnit/*,Consultingwerk/SmartComponentsDemo/ProgresticSearch/*,.AblFrameMigrationSettings.xml,.BusinessEntityDesignerSettings.xml,.classpath,.dbconnection,.openedge.json,.project,.propath,.restapplicationsettings,.servicelifecycledefinition.xml,.servicenamemapping,ABL.xml,annotations.xml,BPMAdapterSettings.xml,BPMWorkStepDescriptionTemplates.xml,build-demo.xml,build-test.xml,build.xml,copy-appserver.xml,project.xml,scheduler.xml,sonarlint.json,sonarlint.xml,sonarsource.xml,toolbox.xml,viewer_9999bda5-b6f8-0e9e-df11-fef0a26c9a38.xml,.applicationsettings.xml,build.config",
    "InfragisticsAssembliesFrom": "",
    "InfragisticsAssembliesTo": "",
    "AlternativeConfigDirectory": "..\\WebClient\\Config",
    "WcpFile": "..\\WebClient\\WebClientApplicationAssembler\\SmartFramework Administration.wcp"

SCL-3470 Removed extra assignment of LookupQueryString in LookupRenderer


The repository LookupRenderer was assigning the LookupQueryString of the SmartBusinessEntityLookup component twice. This has been removed.

SCL-3471 Added dedicated property for LookupDialogFilterFIelds to repository


We have added a dedicated property to the MetaBusinessEntityLookup repository type to control the LookupDialogFilterFields property of the SmartBusinessEntityLookup component.


SCL-3201 Implemented web service for Proparse


We have implemented a new Tomcat web service which exposes the Proparse functionality as a RESTful web service.

Documentation for the Proparse web service will follow.

SCL-3463 Implemented Data Access support for directly processing QueryExpressions in the DataAccess class


We have implemented the ability to directly use an IQueryExpression intance (e.g. QueryExpression, ListQueryExpression) to manipulate the Data Access Query of a DataAccess class during FetchData.

The FetchDataRequest class now contains a new property QueryExpressionsWithSort of type QueryExpressionWithSort EXTENT. The QueryExpressionWithSort type references an IQueryExpression and a ListSortField. This array can contain an element per temp-table referenced in the Tables property of the FetchDataRequest instance.

When the QueryExpressionsWithSort property of the FetchDataRequest instance is set, the Queries property will be ignored.