Release Notes 2020-03-09

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, 11.7.5, 12.0, 12.1

Release 11.3 #57559@2020-03-09

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-2935 Resolved an issue with enabling read-only fields in MetaViewer instances


We have an issue with rendering of MetaViewer instances in GUI for .NET. When lazy loading was used, read-only fields have been enabled when they should have been disabled.
This issue is resolved now.

SCL-2958 Resolved an issue with @RestMethod discovery when .classpath file was used with prefix


We have resolved an issue that was preventing recovery of RESTful methods (Business Tasks or Business Entities) when a .classpath file was used with entries containing the class name prefix ( ?search_id=93fa789c-2f24-4c78-99d8-399c33537f7c).

SCL-2966 Fixed issue with Decimal values in the UltraGridFilterRowHelper


We have resolved an issue in the UltraGridFilterRowHelper class which has impacted the ability to filter in the UltraGrid on large decimal values.


SCL-2947 Implemented support for KEYS phrase with Buffer-Data-Source


We have implemented support for setting the DATA-SOURCE KEYS attribute when using the BufferDataSource. The Keys attribute can be passed through additional constructor arguments of the BufferSpec class. To allow type distinction, the Keys attribute is wrapped into a DataSourceKeys value object.

oBuferSpec = NEW Consultingwerk.OERA.BufferSpec ('Customer':U, 'Customer':U, NEW Consultingwerk.OERA.DataSourceKeys ('CustNum':U)) . 

The BusinessEntity Designer also supports generation for the KEYS option in the following way:

src_CustomerSalesrep = {Consultingwerk/create-instance.i Consultingwerk.OERA.IBufferDataSource
                        "NEW Consultingwerk.OERA.BufferSpec ('Customer':U, 'Customer':U, NEW Consultingwerk.OERA.DataSourceKeys ('CustNum':U))"
                        "NEW Consultingwerk.OERA.BufferSpec ('Salesrep':U, 'Salesrep':U, NEW Consultingwerk.OERA.DataSourceKeys ('ROWID':U))"}.

SCL-2949 Implement Clone() method for FetchDataRequests class


We have implemented the Clone() method for the FetchDataRequest class. The override returns a new instance of a FetchDataRequest instance.
The Clone() method does not implement a deep clone for the CustomParameter or NamedQuery attribute.

SCL-2950 Added support for Angular server side filtering Attribute


We have implemented support to control the ServerSideFiltering attribute for MetaDataSource instances when rendered to Angular Web Forms.

SCL-2955 GuiClientStartupManager now provides a progress bar during loading of services


We have added a Progress bar to the JSON Configuration based GUI Client Startup Manager. With new status bar indicates the progress while loading configured service instances during client startup.

New Feature

SCL-2933 Implemented additional DatasetModel constructors for fetch requests with custom context/parameter


We've added support to the DatasetModel for passing values for the CustomContext and CustomParameters when retrieving data through the DatasetModel constructors. The CustomContext (CHARACTER) and/or CustomParameter (Progress.Lang.Object) are passed to the DatasetModel contructors through a new holder value object of type Consultingwerk.OERA.FetchOptions.

oCustomer = NEW CustomerDatasetModel (42, NEW Consultingwerk.OERA.FetchOptions ("sample custom context")) .


oCustomer = NEW CustomerDatasetModel (42, NEW Consultingwerk.OERA.FetchOptions (oCustomParameter)) .

SCL-2943 Implemented GroupAssign-Link support for repository


We have added support for defining GroupAssign links between MetaViewer instances in the SmartFramework repository. GroupAssign links will be rendered to GUI for .NET and Angular Forms.

SCL-2957 Implement ability to inject query values from the DataAccess for referential integrity


A DataAccess implementing the Consultingwerk.Framework.IRelationServiceQueryCustomizer interface now supports the customization of the queries used during processing of referential integrity rules during add/update and delete operations.
The Data Access class needs to implement the following methods:

     * Purpose: Callback method to support customization of the child query string
     * Notes:   Used by the OnParentDelete.... methods
     * @param pcQueryString The default query string
     * @param phParentBuffer The handle of the database buffer with the parent record
     * @param phChildBuffer The handle of the CHild buffer which will be used in the returned query
     * @param poRelation The value object or buffer model describing the relation record
     * @return The customized query string
    METHOD PUBLIC CHARACTER CustomizeChildQuery (pcQueryString AS CHARACTER,
                                                 phParentBuffer AS HANDLE,
                                                 phChildBuffer AS HANDLE,
                                                 poRelation AS ISmartRelationTableModel).

     * Purpose: Callback method to support customization of the parent query string
     * Notes:   Used by the OnChildUpdateRestrict method
     * @param pcQueryString The default query string
     * @param phChildBuffer The handle of the database buffer with the child record
     * @param phParentBuffer The handle of the database buffer for the parent record, this buffer will be navigated by the returned query
     * @param poRelation The value object or buffer model describing the relation record
     * @return The customized query string
    METHOD PUBLIC CHARACTER CustomizeParentQuery (pcQueryString AS CHARACTER,
                                                  phChildBuffer AS HANDLE,
                                                  phParentBuffer AS HANDLE,
                                                  poRelation AS ISmartRelationTableModel).

The relation service will first generate the query based on the defined field-pairs for the relation and then pass the query string along with details of the relation currently processed to the Data Access class where it can be fully customized.

SCL-2962 Added repository support for DeselectRowsOnActivate


GUI for .NET Rendering of MetaGrid instances now supports the DeselectRowsOnActivate attribute which is key to support multi-selection in the SmartDataBrowser control.