Release Notes 2020-03-18

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 #57762@2020-03-18

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-2956 RESTful "fields" option now based on serialize-name instead of field name


When clients were using the fields option (URI argument) when retrieving data from an RESTful business entity, we had been resolving the fields via the field name instead of the serialize name. That was confusing as the consumer did not have any insight into the field names, as all data was retrieved using the serialize name.

SCL-2963 Class Reference link provider now with Support for OpenEdge 12.x references to the OpenEdge documentation


When using our tool to generate a class library documentation, the documentation can provide hyperlinks to the documentation of classes provided by Progress Software as part of OpenEdge.
We are now providing the required mapping files to the OpenEdge class documentation for OpenEdge 12.0, OpenEdge 12.1 and OpenEdge 12.2

SCL-2976 Resolved issue when importing repository data for the SmartSupportedInstanceType table


The SmartFramework upgrade and migration utility might have failed complaining about duplicate unique key entries for the eSmartSupportedInstsanceObjType table:

   [PCTRun] Importing data: Consultingwerk.SmartFramework.Repository.Class.SupportedInstanceObjectTypeBusinessEntity
   [PCTRun] Importing from: D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Data\supportedinstanceobjecttype.xml
   [PCTRun] Verbose:  no
   [PCTRun] Unhandled error: 
   [PCTRun] An Progress.Lang.SysError has occurred:
   [PCTRun] ** eSmartSupportedInstanceObjType already exists with  "ad238208-b49f-68b9-1c14-14b29cda3189"  "a47c2093-c451-79af-1a14-87bc3446f6e5". (132)
   [PCTRun] ImportBusinessEntityData Consultingwerk.SmartFramework.Tools.Import.GenericDataImporter at line -1  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Tools\Import\GenericDataImporter.r)
   [PCTRun] ImportBusinessEntityData Consultingwerk.SmartFramework.Tools.Import.GenericDataImporter at line 508  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Tools\Import\GenericDataImporter.r)
   [PCTRun] Consultingwerk/SmartFramework/Tools/Import/import-data-from-json.p at line 519  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Tools\Import\import-data-from-json.r)
   [PCTRun] Akioma/Swat/Tools/Import/import-data-from-json.p at line 35  (D:\dev\devNSc\app\swat-backend\Akioma\Swat\Tools\Import\import-data-from-json.r)
   [PCTRun] C:\Users\APo_wf\AppData\Local\Temp\7\pctinit41992740.p at line 48  (C:\Users\APo_wf\AppData\Local\Temp\7\pctinit41992740.p)
   [PCTRun] Unhandled error: 
   [PCTRun] An Progress.Lang.SysError has occurred:
   [PCTRun] ** eSmartSupportedInstanceObjType already exists with  "ad238208-b49f-68b9-1c14-14b29cda3189"  "a47c2093-c451-79af-1a14-87bc3446f6e5". (132)
   [PCTRun] GetChangesDataset Consultingwerk.Util.DatasetHelper at line 2150  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\Util\DatasetHelper.r)
   [PCTRun] ImportBusinessEntityData Consultingwerk.SmartFramework.Tools.Import.GenericDataImporter at line 681  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Tools\Import\GenericDataImporter.r)
   [PCTRun] ImportBusinessEntityData Consultingwerk.SmartFramework.Tools.Import.GenericDataImporter at line 508  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Tools\Import\GenericDataImporter.r)
   [PCTRun] Consultingwerk/SmartFramework/Tools/Import/import-data-from-json.p at line 519  (D:\dev\devNSc\app\smartcomponentlibrary\Consultingwerk\SmartFramework\Tools\Import\import-data-from-json.r)
   [PCTRun] Akioma/Swat/Tools/Import/import-data-from-json.p at line 35  (D:\dev\devNSc\app\swat-backend\Akioma\Swat\Tools\Import\import-data-from-json.r)
   [PCTRun] C:\Users\APo_wf\AppData\Local\Temp\7\pctinit41992740.p at line 48  (C:\Users\APo_wf\AppData\Local\Temp\7\pctinit41992740.p)

The issue is resolved now.


SCL-2959 Integrated container security into menu (function) security


We have now implemented the ability to query the container security when retrieving the menu. This feature relies on two conditions:
a) .applicationsettings or .restapplicationsettings
The following two settings need to be enabled in the settings file:

    "performContainerSecurityCheck": "true",
    "performMenuStructureSecurityCheck": "true"

b) the specific menu functions need to be supported by your IMenuFunctionContainerSecurityService implementation
The Consultingwerk.SmartFramework.Menu.IMenuFunctionContainerSecurityService service is used to inquire the authorization for the specific function call type. Our implementation of the IMenuFunctionContainerSecurityService service supports the Consultingwerk.Windows.Framework.LaunchFormCallParameter type and determines the container represented by the menu function through the ClassName attribute.
Customers with custom types of menu functions need to implement and extended version of the IMenuFunctionContainerSecurityService service type.

SCL-2968 Zoom factor in Launch Shell Form now stored in the registry


The zoom factor that can be set in the Launch Shell command form is now stored in and restored from the Windows Registry. This increases the usability of tools like the PASOE Control Form on high resolution displays.

SCL-2970 Upgraded Proversion Enum for OpenEdge 12.2


In order to support the expected release of OpenEdge 12.2, we have added OpenEdge 12.2 to the ProversionEnum class.

SCL-2975 FileHelper:CombinePath now avoids double slashes when parts already beginning or trailing with slash or double-slash


The FileHelper:CombinePath API now resolves slashes and double-slashes that are provided based on the various arguments to the method. This prevents file names retrieved for instance based on SESSION:TEMP-DIRECTORY to end of as:

New Feature

SCL-2082 Implemented rename / move utility for classes based on Proparse


A new class Consultingwerk.Studio.Refactor.ClassRefactor has been implemented. This class provides methods to move an existing ABL class from one package to another or to rename the class within a package. When refactoring the class, the .cls file will be moved or renamed and all references in the source code to the class name itself will be updated.
Those features are based on the SmartRefactorSession class. The implementation here has been changed. It does no longer rely on an ABL Editor widget to locate text based on rows and columns. It's now using the new RefactorEditor class instead.

SCL-2796 GUI for .NET Text box rendering of logical fields


We have implemented a new Windows Control Consultingwerk.Windows.Controls.LogicalTextEditor that can be used to update logical values in a similar way as in an ABL FILL-IN Widget.
The control utilizes the FORMAT and MANDATORY attributes similar to the ABL widget (e.g. FORMAT "active/inactive".
In repository based viewers or grids, this component may be used by setting the ViewAs attribute to "FILL-IN" and setting the Format and Mandatory attributes.

SCL-2934 RESTful Methods new support to return OpenEdge.Core.String


When implementing RESTful methods, developers can now return text/plain responses by returning an OpenEdge.Core.String instance from the method.
In addition the RestMethodResponse based responses have been enhanced to support OpenEdge.Core.String reponses with the content type set to text/html.

SCL-2964 Support for registering static GUI for .NET Forms in the Repository


The SmartFramework Repository now supports registering static Forms. This allows them to be referenced by their short class name in the repository and to launch them that was from the SmartFormFactory and the dynamic launcher.
This also allows to utility the Container Security on those forms.
Static Forms are registered by creating an Object Master of the "StaticForm" type.
The ObjectName and the Package Name fields of the Object Master record must match the short class name and package name of the GUI for .NET Form class.