Release Notes 2019-11-14

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 #55210@2019-11-14

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-2839 Fixed error in RestEntitiesWebHandler when resource URI references field actually not returned by the request itself


In this request http://localhost:8820/web/Entities/Customers/1/Orders/36/OrderLines/1 the customer number is not returned by the OrderLine table.

@RestAddress (type="record", address="/Customers/~{CustNum}/Orders/~{OrderNum}/OrderLines/~{LineNum}", tables="eOrderLine,eItem", id="LineNum",
              fields="*", canRead="true", canUpdate="true", canDelete="true").

However it's provided by the request URL and can be used to build the record URL for the response.
However the following error is raised:

  "title": "A runtime error has occurred (Progress.Lang.SysError)",
  "error": "Progress.Lang.SysError",
  "messages": [
      "message": "BUFFER-FIELD CustNum was not found in buffer eOrderLine. (7351)",
      "messageNum": 7351
      "message": "Lead attributes in a chained-attribute expression (a:b:c) must be type HANDLE or a user-defined type and valid (not UNKNOWN). (10068)",
      "messageNum": 10068
      "message": "Error attempting to push run time parameters onto the stack. (984)",
      "messageNum": 984
      "message": "Error attempting to push run time parameters onto the stack. (984)",
      "messageNum": 984
  "callStack": "ResourceUri Consultingwerk.OERA.RestResource.RestEntitiesWebHandler at line 3669  (c:\\work_stream\\SmartComponentLibrary\\Develop121\\ABL\\Consultingwerk\\OERA\\RestResource\\RestEntitiesWebHandler.r)\nBuildRecordResponse Consultingwerk.OERA.RestResource.RestEntitiesWebHandler at line 1118  (c:\\work_stream\\SmartComponentLibrary\\Develop121\\ABL\\Consultingwerk\\OERA\\RestResource\\RestEntitiesWebHandler.r)\nHandleGet Consultingwerk.OERA.RestResource.RestEntitiesWebHandler at line 1913  (c:\\work_stream\\SmartComponentLibrary\\Develop121\\ABL\\Consultingwerk\\OERA\\RestResource\\RestEntitiesWebHandler.r)\nHandleRequest OpenEdge.Web.WebHandler at line 61  (OpenEdge/Web/WebHandler.r)\nHandleRequest OpenEdge.Web.InternalWebRouter at line 113  (OpenEdge/Web/InternalWebRouter.r)"

We have fixed this issue.

SCL-2840 Resolved issue caused by race condition when creating a new session.


Customer was reporting occasional errors like this when web clients were logging into the system:
Osiv reported that during performance testing they encountered the following error:

An Progress.Lang.SysError has occurred:
Error reading XML from a MEMPTR or LONGCHAR. (13036)
READ-XML encountered an error while parsing the XML Document: FATAL ERROR: file 'MEMPTR', line '1', column '1', message 'invalid document structure'. (13064)
RestoreSessionContext Akioma.Swat.OERA.Context.SwatContextDatasetStore at line 602 (Akioma/Swat/OERA/Context/SwatContextDatasetStore.r)
ActivateSmartServerSession Akioma.Swat.System.SwatServerSessionActivator at line 805 (Akioma/Swat/System/SwatServerSessionActivator.r)
ActivateServerSession Akioma.Swat.System.SwatServerSessionActivator at line 553 (Akioma/Swat/System/SwatServerSessionActivator.r)
OnActivated Consultingwerk.OERA.ServiceInterface at line 4447 (Consultingwerk/OERA/ServiceInterface.r)
Activate Consultingwerk.OERA.ServiceInterface at line 597 (Consultingwerk/OERA/ServiceInterface.r)
GetData Consultingwerk.OERA.JsdoGenericService.Service at line 1045 (Consultingwerk/OERA/JsdoGenericService/Service.r)
HandleGet Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceWebHandler at line 754 (Consultingwerk/OERA/JsdoGenericService/WebHandler/ResourceWebHandler.r)
HandleRequest OpenEdge.Web.WebHandler at line 61 (OpenEdge/Web/WebHandler.r)
HandleRequest OpenEdge.Web.InternalWebRouter at line 113 (OpenEdge/Web/InternalWebRouter.r)

Analysis has shown that this issue might have occurred when multiple requests from the same client session have been issued while the session context store was yet to be initialized and thus the LONGCHAR / CLOB with the serialized context dataset was empty.
We have added a new configuration setting (.restapplicationsettings) RereadSmartContextStoreOnInitialization which allows to control the number of attempts to read the SmartContextStore when the SessionID is already valid, but no data is stored for the Context Dataset yet. We'll use a 1/10 of a second break between re-read attempts. The ThrowWhenStoredContextIsNotAvailable setting (logical) allows to control if we're throwing an exception when the context record contains no valid context dataset of if we re-create the context dataset.

SCL-2843 Resolved an issue where the users password couldn't be changed for user with no company assigned


We have resolved an issue preventing users that were not defined against a specific login company from changing the user password stored in the SmartUser table.


SCL-2829 MetaViewer/MetaFrame Angular rendering now optionally supports absolute positioning


The MetaViewer and MetaFrame repository rendering to Angular (JSON) now supports both responsive (default) and absolute positioning of controls.
The behavior is based on the LayoutStyle property of the viewer and can be set to either Pixel or Responsive.

SCL-2830 MetaViewer/MetaFrame now supporting for rendering of images on Angular buttons


We've implemented rendering support for images on buttons in Angular Viewers.

SCL-2837 Added run button to Repository Object Master maintenance


We have added a Run button to the Repository Object Master maintenance Form. This buttons clears the repository cache and launches the currently opened form.

SCL-2841 Improved error message raised when creating a repository object under a duplicate name


We have implemented a more meaningful error message when creating an Object Master under a duplicate name.

SCL-2845 Improved fault tolerance of Repository Service on inconsistent repository data


We have improved the robustness of the Repository Service when retrieving repository data. First we no longer require the SmartModule of the SmartObjectMaster record to be available. The module is not needed for rendering purposes. Secondly when for whatever reasons the cache records for the Attribute Temp-Tables contains an invalid temp-table handle, we will re-create the temp-table instead of failing.

SCL-2849 SessionHelper:DLC now includes check for WINDOW-SYSTEM MS-WIN95


When determing the DLC or PROMSGS value we have been relying on the WINDOW-SYSTEM value of MS-WINXP. We've extended that to include MS-WIN95 as well.

SCL-2850 Implemented a way to disable NotifyIconWaitStateManager in GuiClientStartupManager


We have added a new static property to the Consultingwerk.Framework.GuiClientStartupManager class.

     * Purpose: Gets and sets if a Notify Icon WaitStateManager instance should be
     *          used and initialized
     * Notes:

This property can be set thorough the JSON configuration file and allows to control if an instance of the NotifyIconWaitStateManager will be instantiated or not.

SCL-2853 Added overload to BufferHelper:FindDatabaseBuffer which accepts additional key values


We've implemented a new overload to the FindDatabaseBuffer method which accepts a list of values which complete or override the key values form the provided temp-table buffer. This method is useful when the Business Entity temp-table's do not contain fields like the client key but those need to be provided when fetching the database buffer.

     * Purpose: Finds the database record for a linked (ProDataset data-source) record
     *          in a ProDataset.
     * Notes:   Uses the PUK or first UK of the database record with the field values
     *          of the ProDataset buffer, based on the provided field mapping. This variant of the
     *          method also allows to pass a ListNameValuePair with values which override or complete
     *          values (missing) from the temp-table, e.g. when the client-key of a database table is
     *          not part of the temp-tables
     * @param phBuffer The database buffer to locate
     * @param phDatasetBuffer The dataset (before or after) buffer
     * @param pcFieldMapping The field mapping between database and temp-table (ATTACH-DATA-SOURCE method)
     * @param poMissingValues List of Name value pairs with missing values
     * @param poLockMode The LockModeEnum value controlling the record lock-mode
    METHOD PUBLIC STATIC VOID FindDatabaseBuffer (phBuffer AS HANDLE,
                                                  phDatasetBuffer AS HANDLE,
                                                  pcFieldMapping AS CHARACTER,
                                                  poMissingValues AS ListNameValuePair,
                                                  poLockMode AS LockModeEnum):

New Feature

SCL-2826 Implemented on demand rendering of SmartViewerControl


SmartFramework Repository based SmartViewerControls (MetaViewer) now support lazy or on demand rendering. The controls on the viewer will now only be rendered when the user is switching to the tab folder page that contains the viewer. Lazy loading can be turned off using the LazyLoading repository attribute of the viewer instance or master.
Viewers on page 0 are by default not lazy loaded.
Lazy loading will significantly speed up the launch time of forms containing a larger number of viewers on various tab pages.