Release Notes 2019-10-06

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 #54703@2019-10-06

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-2802 Improved DatasetModel Interface generator handling of output path names


We have resolved differences in how the DatasetModel interface generator and the DatasetModel classes generator were determining the output directory name.


SCL-2783 Added valueListKey property to the rendering of Grid columns


The MetaGrid rendering now supports the ValueListKey/valueListKey attribute.

SCL-2784 Rendering support for Combo-Box LimitToList attribute


The MetaCombo and DataField objects now support rendering of the LimitToList Attribute for the underlying UltraComboEditor control.

SCL-2793 Implement JsonHelper methods to assign/set a Character property based on a path


Supports assigning the SerializedType property in a standard JsonObject, supports other use cases as well.
* JsonHelper:SetPropertyByPath (oJson, "Abc", "SerializedType", "Consultingwerk.CharacterHelper").
Will assign the SerializedType to the JsonObject referenced by the Abc property in the given JsonObject
* JsonHelper:SetPropertyByPath (oJson, "Abc[]", "SerializedType", "Consultingwerk.CharacterHelper").
Will assign the SerializedType to all JsonObjects contained in the JsonArray referenced by the Abc property in the given JsonObject
* JsonHelper:SetPropertyByPath (oJson, "Abc[].Def[]", "SerializedType", "Consultingwerk.CharacterHelper").
Will first iterate all JsonObjects in the Abc JsonArray, and for each JsonObject in that array, iterate all objects in the Def JsonArray.

New Feature

SCL-2798 Implemented Web Handler to support Web version of the Business Entity Designer


Implemented the following REST endpoints:

File Access

This returns a list of root folders. The open file dialog should be populating a combo-box with those folders names:
GET http://localhost:8820/web/Entities/BusinessEntityDesigner/Files/GetRootFolders
This returns the list of files based on a given root folder:
GET http://localhost:8820/web/Entities/BusinessEntityDesigner/Files/GetFileNames ?Value=../../ABL
Opens a file name and returns the Business Entity Design as a JSON document:
GET http://localhost:8820/web/Entities/BusinessEntityDesigner/Files/OpenFile ?Value=C%3A%5CWork_STREAM%5CSmartComponentLibrary%5CDevelop%5CABL%5CConsultingwerk%5CSmartComponentsDemo%5COERA%5CSports2000%5COrderBusinessEntity.bedgm
Saves a file (post XML document here):
POST http://localhost:8820/web/Entities/BusinessEntityDesigner/Files/SaveFile

  { "dsBusinessEntity": ...., 
  { "parameter": { "Value": "C:\\Work_STREAM\\SmartComponentLibrary\\Develop\\ABL\\Consultingwerk\\SmartComponentsDemo\\OERA\\Sports2000\\OrderBusinessEntity.bedgm" }

Database schema

GET http://localhost:8820/web/Entities/BusinessEntityDesigner/Databases/GetDatabaseSchema
This endpoint returns the schema of the connected databases.
It returns a list of databases, tables, fields and indexes. There's one special database, the DICT-DB. This is not contained in the eDatabases as it represents virtual tables.



SCL-2799 Implemented REST endpoint to create an object instance in the respository


Implementing this as a POST to http://localhost:8820/web/Entities/SmartFramework/Repository/CreateInstance with the following JSON payload (descriptions in the comment above):
- ContainerObject: string
- InstanceObject: string
- InstanceName: string
- InstanceDescription: string
- PageGuid: string
- ObjectSequence: integer
The implementation is based on the following ISmartRepositoryService API:

     * Purpose: Creates an Object Instance
     * Notes:
     * @param pcContainerObject The Container Object Master GUID or Container Object Name
     * @param pcInstanceObject The Object Master GUID or Object Name of the object to create an instance of
     * @param pcInstanceName The name of the object instance (or ? to use the object name)
     * @param pcInstanceDescription The description of the instance
     * @param pcPageGuid The GUID of the page to create the instance on
     * @param piObjectSequence The sequence of the object instance on the given page
     * @return The Object Instance Guid
    METHOD PUBLIC CHARACTER CreateInstance (pcContainerObject AS CHARACTER,
                                            pcInstanceObject AS CHARACTER,
                                            pcInstanceName AS CHARACTER,
                                            pcInstanceDescription AS CHARACTER,
                                            pcPageGuid AS CHARACTER,
                                            piObjectSequence AS INTEGER).

SCL-2800 Resolved an issue in the AblReflectionHelper GetInvokableMethod method


The have resolved an issue in the GetInvokableMethod method. In a certain cases when calling an invokable method that is overloaded though the Service Interface customers were getting an error on the extent of the oParameters variable. We've resolved this issue now.


SCL-2797 Additional ANT patternsets to extract AppServer code


We are now providing two additional ANT patternset definitions that can be used to copy the parts of the SmartComponent Library code base that are required on the AppServer into a build folder:
- smartcomponents.include.appserver.nodemo
- smartcomponents.include.appserver.nodemo.studiofiles
The patternsets are defined in the build/smartcomponents.xml file. The second file set is required as we exclude the Consultingwerk/Studio package but need to include a subset. Ant patternsets generally prefer exclude over include. The following ANT target demonstrates how the patternsets may be used to copy the relevant sourcecode to an "AppServer" folder:

    <target name="copy">
        <copy todir="../AppServer">
              <fileset dir="." casesensitive="false">
                 <patternset refid="smartcomponents.include.appserver.nodemo" /> 
              <fileset dir="." casesensitive="false">
                 <patternset refid="smartcomponents.include.appserver.nodemo.studiofiles" />