Release Notes 2019-05-01

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.3 #51726@2019-05-01

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-2588 Fixed ExcelWorksheetExporter raised Invalid Handle error when the file doesn't exist


The ExcelWorksheetExporter class raised an invalid handle error when the file name argument was incorrect (non existing file). This is fixed now.

SCL-2600 Fixed problem subscribing ParentFormClosed event with Form Inheritance


We have resolved an issue with Form inheritance when developers have placed an instance of the SmartToolbarController in the visual Form base class.
At runtime the following error message was raised: "System.ApplicationException: Subscribe ... failed. ParentFormDestroyedHandler already assigned to FormDestroyed-event (15329)"
This issue is now resolved.

SCL-2604 Fixed invalid parsing for "WHERE" in FindRecord2 of DataAccess


We have fixed a recently introduced issue in the parsing and reconstruction of query strings in the FindRecord2 method of the DataAccess class.

SCL-2605 Fixed JsonHelper EnsureCharacterProperty method for boolean datatype


The JsonHelper method EnsureCharacterProperty now properly works for boolean (LOGICAL) values.


SCL-2587 Added column label options to ExcelWorksheetExporter


We have implemented a new property to the Consultingwerk.Utilities.Excel.ExportWorksheetArgument class.

     * Purpose: Gets and sets the source of the column label
     * Notes:
    DEFINE PUBLIC PROPERTY ExportColumnLabel AS ExportColumnLabelEnum NO-UNDO

This property allows to control how the ExcelWorkSheetExporter creates the column labels:

|FieldName|The column label is built from the field name|
|FieldLabel|The column label is built from the field label|
|EventCallback|The ExcelWorkSheetExporter raises the RequestFieldLabel event to request the field label from the caller|

SCL-2599 Improved handling of "*" key in RenderedBrowseControlSearchProvider


We have improved the handling of the "*" key in the RenderedBrowseControlSearchProvider. Previously some keys caused to open the search dialog with all text selected - instead of moving the cursor behind the last character.

SCL-2603 Implemented default value for "RestfulEntitiesAddress" in .restapplicationsettings


When the RestfulEntitiesAddress setting in the .restapplicationsetting was not set, the RESTful Swagger page did not contain a valid server reference. We are now using the URI of the current request as a default value to resolve this issue.

SCL-2606 JSDO Generic Service: Implemented option to disable Count requests by returning a default value


A new optional setting in .restapplicationsettings has been implemented:

"CountFunctionDisabled": "true"

When this setting is set to True, any call into the JSDO generic serivce's Count method will immediately return the "magic number" - either 9999 or the value of the CountStopAfterNumResults setting.

New Feature

SCL-2583 JSDO Generic Service Count Request: Optional configuration for StopAfter and StopAfterNumRecords


The JSDO Generic service now supports configuration of the Count function. Through two entries in the .restapplicationsettings file, it's now possible to configure the STOP-AFTER setting for the Count request as well as the result to be returned to the caller in case the STOP-AFTER limit has been exceeded.

    "CountStopAfter": "1",
    "CountStopAfterNumResults": "999999",

SCL-2584 Fixed decoding of the plus sign in URI's received by the ResourceWebHandler


Some consumers encode the space character in an URL Query String with the plus sign. So far we had only decoded the %20 to the space character. We're now also decoding the + sign to the space character.

SCL-2585 Added new BufferHelper API to create a new Temp-Table with the current record of a buffer


We've added two new API's to the BufferHelper class. These API's create a new dynamic temp-table based on the current record of a buffer. The resulting temp-table will have zero or one records, regardless of the number of records in the source table.

     * Purpose: Creates a temp-table with the current record of the provided
     *          buffer
     * Notes:   When the buffer does not have a record available, an empty temp-table
     *          is created
     * @param phBuffer The handle of the source buffer
     * @param pcFieldNames The comma delimited list of field names to create (CAN-DO like, or ? for all fields)
     * @return The handle of the created temp-table
    METHOD PUBLIC STATIC HANDLE CreateTempTableFromRecord (phBuffer AS HANDLE,
                                                           pcFieldNames AS CHARACTER):

     * Purpose: Creates a temp-table with the current record of the provided
     *          buffer
     * Notes:   When the buffer does not have a record available, an empty temp-table
     *          is created
     * @param phBuffer The handle of the source buffer
     * @return The handle of the created temp-table
    METHOD PUBLIC STATIC HANDLE CreateTempTableFromRecord (phBuffer AS HANDLE):

SCL-2586 Implemented a new operating mode of the TableModel classes: BufferModel


The BufferModel is a new operating mode of the TableModel classes of the DatasetModel construct. This mode allows to create an instance of the TableModel based on an existing buffer by passing the buffer into the generated TableModel constructor. This new approach allows to pass around a buffer as an object instance - including the ability to implement Interfaces on a field by field basis.
Customers are required to update customized Templates used by the Business Entity Designer from the templates shipped by use in the Consultingwerk\BusinessEntityDesigner\Templates\Model folder:
- tablemodel.template
- tablemodel_generated.template

SCL-2589 Implemented a base class for Business Tasks


Previously the SmartComponent Library did not provide a base class for Business Tasks. However certain functionality of Business Tasks required repetitive code in Business Tasks. We have generalized this now in the new abstract base class Consultingwerk.OERA.BusinessTask. Especially for Business tasks implementing the ISupportsRestMethods interface this new base class provides a default implementation for the GetRestMethods methods.
It's however not required to use the base class for any business task.

SCL-2590 DatasetModel Filter on Character field mapped to Enum now based on Enum, not Character


We've improved the generator for the TableModelFilter classes so that character fields which are mapped to an Enum value are filtered based on the Enum value, not the character value.

SCL-2591 DatasetModel field mapped to Enum now supports customizable mapping


Mapping DatasetModel/TableModel fields to Enum values is a great method of improving strong typing. However the field values persisted in the database do not always resolve to a value Enum value name (e.g. the value "Partially Shipped" in the sports2000.Order table.
Developers can implement the custom mapping by overriding the GetCharacterEnumFieldValue and SetCharacterEnumFieldValue methods in the generated TableModel class This example implements a custom mapping for the "Partially Shipped" value and falls back to the default behavior for any other field.

    METHOD PUBLIC OVERRIDE Progress.Lang.Object GetCharacterEnumFieldValue (poEnumType AS Progress.Lang.Class, pcFieldValue AS CHARACTER):

        IF poEnumType = GET-CLASS (OrderStatusEnum) AND pcFieldValue = "Partially Shipped" THEN
            RETURN OrderStatusEnum:PartiallyShipped .
            RETURN SUPER:GetCharacterEnumFieldValue(poEnumType, pcFieldValue) .


    METHOD PUBLIC OVERRIDE CHARACTER SetCharacterEnumFieldValue (poFieldValue AS Progress.Lang.Object):

        IF TYPE-OF (poFieldValue, OrderStatusEnum) AND CAST (poFieldValue, OrderStatusEnum) = OrderStatusEnum:PartiallyShipped THEN
            RETURN "Partially Shipped" .
            RETURN SUPER:SetCharacterEnumFieldValue (poFieldValue) .


SCL-2593 New scl-gen templabe for immutable value objects


We've added an additional template for the scl-gen code generator for Value Objects.
See for more.

SCL-2597 Implemented a Base Class for ValueObjects


We've implemented Consultingwerk.ValueObject as an abstract base class for Value Objects. The base class provides a default implementation for the Equals() and ToString() overrides as well as a simple hashing algorithm.