Release Notes 2023-08-20

Version Information

OpenEdge Release

Version Information

11.7.9, 11.7.10, 11.7.11, 11.7.12, 12.2, 12.6, 12.7 CQC

Release 11.7 #77277@2023-08-20

Security Bulletin - log4j CVE-2021-44228

Further details: log4j CVE-2021-44228

OpenEdge 12.7 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.7. We hereby declare OpenEdge 12.7 fully supported for the SmartComponent Library as of the release of  May 10th 2023.

OpenEdge 12.6 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.6. We hereby declare OpenEdge 12.6 fully supported for the SmartComponent Library as of the release of  October 4th 2022.

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-4168 Fixed Swagger Interface for JSDO Endpoints


The generation of the Swagger page for JSDO endpoints was failing with a runtime error:

Call to Progress.Json.ObjectModel.JsonObject:Add( )

This issue is now resolved.

SCL-4180 Fixed support for enforce nested in Swagger for RESTful entities


We have restored the enforce nested feature in the Swagger generator for the RESTful entities.

SCL-4194 Fixed issue in Repository viewer designer when switching to design view and to the instances tab and back


We have resolved an issue in the repository viewer designer that was generating an error message when switching back and forth from the designer view to the instances tab.

SCL-4199 Fixed lookup query string in menu structure maintenance viewer


We have fixed the lookup definition in the Menu Structure maintenance viewer. The previous configuration disallowed selecting a menu function using the lookup.

SCL-4200 Fixed storing and restoring of vertical ultrasplitter positions


We have fixed the storing and restoring of vertical UltraSplitter positions in the .NET user interface.


SCL-4144 Business entities and business tasks that use business entities have their internal state reset at the end of a request


Business entities (inheriting from Consultingwerk.OERA.BusinessEntity) and business tasks that use business entities (inheriting from Consultingwerk.OERA.BusinessEntityBusinessTask) have their internal state reset at the end of a request. The Consultingwerk.OERA.ISupportsResetState interface provides a ResetState method with no parameters and a void return) value. In business entities or business entity business tasks, a state reset is the emptying of the service’s dataset’s temp-tables if there are no references held to them or the dataset. References may be held if the dataset or temp-tables are called using BY-REFERENCE in a method call.

A new static RequestEnded event is available in the Consultingwerk.OERA.ServiceInterface class. This differs from the BeforeDeactivated, Deactivated and AfterDeactived events in that the RequestEnded event is only publised from the AppServer’s deactivate procedure, once a request has completed. The other events are published earlier in the request (from within a ServiceInterface method).

The ServiceManager subscribes to the ServiceInterface’s Activated and RequestEnded events and will call the ResetState method for all business services that implement the Consultingwerk.OERA.ISupportsResetState interface, that were accessed during the course of the request,

Business services that either inherit from Consultingwerk.OERA.BusinessEntity or Consultingwerk.OERA.BusinessEntityBusinessTask may override the default behaviour by implementing an override to the ResetState method. Other business services (for example those that inherit from Consultingwerk.OERA.BusinessTask directly or which simply implement the Consultingwerk.OERA.IBusinessService interface) may opt in to having their state reset at the end of a request by implementing the ISupportsResetState interface.

The numbers of records deleted from these temp-tables is optionally logged, using a log entry named BusinessService at a log level of 4. has more information on using custom log entry types.

SCL-4179 Fixed typos in Exception Names


We have fixed typos in two exception names by renaming the class files and updating the references to those:

* Consultingwerk.OERA.RestResource.AmbigiousRecordFoundException → AmbiguousRecordFoundException
* Consultingwerk.OERA.RestResource.UnsupporteRequestEntityException → UnsupportedRequestEntityException

The class files are intended to be used inside our code based only and not by customers. Customers are recommended to delete the two class files from their code base:

* Consultingwerk/OERA/RestResource/AmbigiousRecordFoundException.cls
* Consultingwerk/OERA/RestResource/UnsupporteRequestEntityException.cls

SCL-4181 Improved Lookup's handling of CLOB bound fields with unknown value


When a SmartBusinessEntityLookup is using a CLOB field as a LookupFIeld/LookupControl entry and that LONGCHAR is empty, the SmartDataAdapter returns “?” (string value, not unknown value) which was displayed like that in the viewer - instead of the expected empty string.

This is resolved now.

SCL-4183 Implemented Angular rendering support for updates in DetailForms


We have implemented Angular JSON rendering for the DetailForm and DetailFormDataSources properties of MetaGrid instances in the repository.

SCL-4184 Fully-Qualifying "DataType" class in source-code due to incompatibility to DataTypeHdl field in Build.One SWAT


Due to the OpenEdge compilers preference to abbreviated fields names over class names qualified with a USING Statement, we’ve had to fully qualify the OpenEdge built in DataType class with the package name.

SCL-4186 Support for rendering hidden fields on Angular viewer


We’re now supporting to render fields and their labels as hidden in an Angular MetaViewer object master.

SCL-4188 Parent Instance field in Repository Instance Viewer now behaves like a lookup


The parent instance field in the repository instance viewer now behaves like a lookup - allowing the user to type a value directly in the object instance viewer.

Previously the field was read-only and values could only be changed using the dialog.

SCL-4189 Instance viewer now supports layout position in SplitContainer


The object instance viewer in the repository object master designer now provides support for selecting layout positions within a split container. The drop down to select a layout position now supports to set the “L” and “R” prefix to the layout position.

SCL-4190 Implementen auto-align features in the Viewer Designer of the repository


We have implemented auto-align features in the viewer designer of the object master designer form. Those auto-align features are applied when selecting multiple fields on the design canvas and include:

* same height (based on first selected control, allow user to set height in dialog)
* same width (based on first selected control, allow user to set width in dialog)
* same vertical distance (based on default margin of .NET Controls, allow user to set distance in dialog, allow user to store distance as new preference)
* left-align (based on first selected control)

SCL-4193 Introduced "quick" actions in the SmartComponents Desktop 2


Based on the LRU list for those features, the new SmartComponent Library desktop allows to launch those directly as a quick-action:

* trimming PASOE agents
* opening Business Entity Designs

SCL-4195 Implemented StringHelper method to return a string backwards


We have implemented a StringHelper method to return a CHARCTER Value backwards.

SCL-4202 MetaToolbar now has additional ToolbarButtons attribute


We have introduced a new attribute ToolbarButtonsBase to the MetaToolbar type that is only settable on a master.

During rendering the ToolbarButtonsBase and ToolbarButtons will be combined.

This allows to maintain buttons in a specific toolbar master and still allows adding extra buttons in an instance.

SCL-4203 SplitContainer now exposes UltraSplitter reference


The SplitContainer used in GUI for .NET Rendering now exposes the reference to the UltraSplitter control so that we can obtain the height etc.

SCL-4204 Add more details of the selected node to the Proparse TreeView Form


For record names and fieldref nodes we should be marking the root node of the scope and the define block.

For any symbol, we now display the name and the number of references in the status bar.

New Feature

SCL-4197 Implemented Business Entity Designer Plugin to ensure type of line ending


The Business Entity Designer and it’s plugins may produce source code using a mix of LF and CR/LF line endings. The


plugin can be used to ensure consistent use of CR/LF line endings.


SCL-4191 Implemented Angular rendering of LogicClasses attribute for MetaViewer and MetaGrid


We now support rendering of the logic classes attribute for Angular MetaGrid and MetaViewer object masters.


SCL-4159 Use custom initial values for creating new records via Dataset Model


The use of custom initial values for creating new records via Dataset Model are supported by means of the logical GetInitialValues property on a table’s Business Entity Table Descriptor . This value defaults to FALSE, and may be provided in a Business Entity’s @BusinessEntityTable annotation, using an optional GetInitialValues attribute. See for additional information.

SCL-4160 Default /InitialValues endpoint for GET requests to RestAddress collections


A default /InitialValues endpoint is available to retrieve initial values for a Business Entity’s table. This endpoint is expected to be used to provide default values to a UI. Only the GET method is supported, and only for a RestAddress that is a collection type. The table used is the first table defined in the RestAddress annotation’s tables attribute, and the initial values are determined by calling the Business Entity’s GetInitialValues method.

The default endpoint is also described in the Swagger documentation for such Business Entities.


SCL-4182 Business Task Dataset Schema was not exposed correctly in Swagger


We have resolved multiple issues with exposing Business Tasks in the Swagger page for RESTful services:

* EXTENT fields not exposed to Swagger as EXTENT:
* Nested Dataset relation not exposed to Swagger as nested
* IntegerHolder parameter in URL exposed as string

SCL-4196 Support for rendering the MaxLength attribute of the Infragistics UltraTextEditor


The SmartFramework repository now supports rendering the MaxLength attribute of the UltraTextEditor. This is also supported for the SmartLookups.