Release Notes 2019-10-20

Version Information

OpenEdge Release

Version Information

11.3.3, 11.3.4, 11.4, 11.6.2, 11.6.3, 11.7, 11.7.1, 11.7.2,, 11.7.4, 12.0, 12.1

Release 11.3 #54935@2019-10-20

OpenEdge 12.1 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.1. We hereby declare OpenEdge 12.1 fully supported for the SmartComponent Library as of the release of September 21st 2019.

OpenEdge 12.0 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.0. We hereby declare OpenEdge 12.0 fully supported for the SmartComponent Library as of the release of May 1st 2019.

OpenEdge 11.7.4 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 11.7.4. We hereby declare OpenEdge 11.7.4 fully supported for the SmartComponent Library as of the release of November 5th 2018.

OpenEdge 11.7.3 support!

The previously reported issues with the Progress Developer Studio Visual Designer (Visual Designer related OpenEdge 11.7.3 product alert!!!) has been resolved by Progress Software with Hotfix 007 of OpenEdge 11.7.3. We hereby announce full compatibility of the SmartComponent Library with OpenEdge 

Besides the issue with the Visual Designer however, we have not been aware of any incompatibilities with OpenEdge 11.7.3. 

.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!

Announcing the SmartFramework ERD Designer

We are announcing the availability of the SmartFramework ERD Designer

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

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-2804 DatasetModelGenerator now excludes Virtual Column's from cBufferFieldMapping


The DatasetModelGenerator now properly excludes virtual columns from the buffer-field mapping list.

SCL-2821 Improved handling of "{" character in dynamic query strings passed to DataAccess classes


Previously we've been masking the "{" character in dynamic queries strings received via the JSDO generic service with "~{". We're now providing the ability to replace this (and potentially other characters for every possible method of passing a query string to a Data Access class.
We have now implemented the interface Consultingwerk.OERA.IQueryStringFilter for services supporting manipulation of the query string for Data Access classes. Our default implementation the Consultingwerk.OERA.EscapeCurlyBracesFilter now generally escapes the "{" with "~{" in all query strings passed to the Data Access class.

SCL-2822 Displaying menu structure code in menu security assignment


To support the maintenance of the menu authorization in large menu structures, we're now also displaying the menu structure code in the menu authorization maintenance.


SCL-2774 Improved performance Viewer Master designer


We have significantly improved the performance of the Viewer Master Designer (SmartFramework repository) when opening and saving designs.

SCL-2791 List of Business Entity Web Handler now includes "copy to clipboard" functionality in html output


The /web/BusinessServices/... web handler now adds a copy to clipboard link to the name of a Business Entity or Task.

SCL-2794 RestServerSessionActivator won't store context for SESSION-ID "0" anymore


When the PASOE spring hybrid realm authentication is used with basic authentication, the client-principal SESSION-ID property returns "0". This is expected. As every request to the backend made using basic authentication, we're no longer storing and restoring the session context from the context store in the SmartDB for SESSION-ID = "0".

SCL-2807 Implemented endpoint for fetching Validation Instance Property Descriptors


To support the implementation of the browser based business entity designer, we've implemented an Endpoint in the BusinessEntityDesignerBusinessTask which returns the property descriptors for the validation objects supported by the tool.

SCL-2809 Added additional fields to the user grids in the group maintenance


To simplify the assignment of users to group in the group maintenance we have added additional fields to the grids there
- user full name
- user email

SCL-2810 Improved error message when seeking for a non existing object type in object type maintenance


We've improved the error message when seeking for a non existing object type in the object type maintenance. We're now showing a qualified error message instead of a generic "record not available".

SCL-2816 SmartBusinessEntityAdapter/SmartDataBrowser should scroll to top before/during RetrieveData


We've resolved a minor inconvenience. Previously when opening a SmartBusinessEntityAdapter query with batching and after scrolling down a few pages, calling RetrieveData again the Business Entity Adapter might have fetched the second batch just after requesting the initial batch.
Our investigation has shown that this was due to the Grid not repositioning to the to of the list in time and thus requesting the second batch (off end).
We've resolved this by scrolling to the top of the grid before/during RetrieveData.

SCL-2818 Implemented limit to the number of BY phrases used in PrepareQueryInReverseOrder


As the ABL does not support dynamic query strings with more than 16 BY phrases, we're not limiting the number of BY phrases added to the Query String in the QueryHelper:PrepareQueryInReverseOrder method.

SCL-2823 Implement ability to Skip rows sequentially in Data Access classes


The combination of row number based batching (Skip argument in FetchDataRequest) and BEFORE-ROW-FILL call backs may result in multiple batches containing the same database records.
When the first batch skipped 10 rows using BEFORE-ROW-FILL/RETURN NO-APPLY and the second batch is requested using Skip 50, result records 50 - 60 would overlap with the first batch as the Skip is just applied to the database query and is not taking the programmatically skipped rows into account.
We've implemented the ability to influence this behavior in a Data Access class. First the FetchDataAccessRequest class now provides a new attribute SkipRowsSequentually which changes the behavior of the Skip attribute of the FetchDataRequest. In Data Access classes using the BEFORE-ROW-FILL callback in combination with RETURN NO-APPLY to skip rows (row level security) developers can enable the extended batching behavior using this code:

    METHOD PUBLIC OVERRIDE VOID FetchData (poFetchDataRequest AS IFetchDataRequest):

        DEFINE VARIABLE oRequest AS FetchDataAccessRequest NO-UNDO.

        oRequest = NEW FetchDataAccessRequest (poFetchDataRequest) .
        oRequest:SkipRowsSequentually = TRUE .

        SUPER:FetchData (oRequest) .


Developers have to further separate the BEFORE-ROW-FILL callback method. We need to call into this method from within the Data Access class directly and be able to assert the result. As the ABL does not allow to assert if a method returned using


we have to split this method like this:
The actual BEFORE-ROW-FILL callback

    METHOD PUBLIC VOID eCustomerBeforeRowFill (DATASET dsCustomer):

        IF THIS-OBJECT:eCustomerBeforeRowFill () THEN
            RETURN NO-APPLY .


and the actual implementation of the decision which rows to skip (due to row-level security etc.):

    METHOD PROTECTED LOGICAL eCustomerBeforeRowFill ():

        IF Customer.CustNum MODULO 2 = 0 THEN
            RETURN TRUE .


It's important to provide those signatures exactly. The actual BEFORE-ROW-FILL callback is a PUBLIC method with the dataset as an INPUT PARAMETER. The method which decides which records should be skipped must be called <temp-table buffername>BeforeRowFill, may be PROTECTED or PUBLIC, returns LOGICAL (true: skip row, false or ?: accept row) and takes no parameter.

SCL-2824 Implemented logging about SmartFramework Rendering Performance


Based on the "Rendering" custom log entry type, we are now logging
- runtime for retrieving repository data
- runtime for rendering individual components
- runtime for retrieving data of various SmartBusinessEntityAdapter instances

New Feature

SCL-2541 Mass-Assignment utility for Security Assignment


We've implemented a new tool which allows Administrators to assign the authorization for a user or group for all security items of a given security realm to either restricted or unrestricted or to remove the existing security assignment records altogether.
This utility can be launched form the SmartFramework menu under "Authentication and Authorization".

SCL-2803 Equals() override for TableModel


When used as a Entites (DDD), TableModels should define Equality based on primary unique key values (the identity or records). To facilitate this we have implemented a default override of Equals(), implementing comparison of the primary unique key values (when present).

SCL-2805 Business Entity Designer now indicates private/protected columns


The Business Entity Designer now indicates PRIVATE and PROTECTED columns on the design canvas using the usual - and # characters after the field name.

SCL-2808 Ensuring PASOE Startup does not execute System.Environment:NewLine


A customer has reported issues with the use of .NET on PASOE in the form of crashes during the AppServer startup. Those issues are most likely OpenEdge core issues.
To support working around those issues we've however ensured that the Consultingwerk.Environment class invoked during the AppServer startup does not invoke the .NET System.Environment class anymore.