Release Notes 2019-07-30

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

Release 11.3 #53480@2019-07-30

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-2614 Business Task methods are now listed in the RESTful Swagger


The RESTful Swagger interface (e.g. http://localhost:8820/web/SwaggerEntities/html ) now includes the @RestMethod's contained in Business Tasks and Business Entities.
When Business Task methods are configured to return a dataset as the method response, it's required to provide an XSD file with the ProDataset schema to be included in the method documentation, e.g.:

    @RestMethod (address="/GetCustomerAndInvoices", requestMethod="get",
    @RestMethod (address="/GetCustomerAndInvoices/~{Value}", requestMethod="get",
    @RestMethod (address="/GetCustomerAndInvoices", requestMethod="post",
    @ParameterSchema (datasetname="dsCustomer", schemafile="Consultingwerk/SmartComponentsDemo/OERA/Sports2000/dsCustomer.xsd").
    @ParameterSchema (datasetname="dsInvoice", schemafile="Consultingwerk/SmartComponentsDemo/OERA/Sports2000/dsInvoice.xsd").
    METHOD PUBLIC VOID GetCustomerAndInvoices (INPUT-OUTPUT DATASET dsCustomer,
                                               INPUT-OUTPUT DATASET dsInvoice,
                                               poParameter AS IntegerHolder):

SCL-2699 Fixed HasEntryMatching method of the ProcedureHelper


We have fixed the method HasEntryMatching in the ProcedureHelper. This method was using a wrong procedure handle when evaluating the super procedure's entries.

SCL-2701 Method DelimitedListToDictionary of ListHelper is now a static method


We have now made the metod DelimitedListToDictionary of the ListHelper a static method.

SCL-2702 Fixed an issue in the ListHelper:EnsureUniqueEntries method


We have fixed an issue in the ListHelper:EnsureUniqueEntried method that caused incorrect interpretation of the list when using a non default list delimiter.

SCL-2703 ListHelper:LastEntry failed for empty list


We have resolved an issue in the ListHelper:LastEntry method caused by an empty argument passed to be method.

SCL-2706 Fixed ascending/descending sorting of the RESTful Business Entities


Previously the us of the plus sign (+) in the sort argument (as documented) passed to RESTful Business Entity web handler did resolve in an invalid query string getting passed to the Business Entity. This issue has been resolved now.

SCL-2710 Fixed issue with SecurityObjectDataAccess not setting AssignSkipList depending on GenericDataImporter:Importing


We have fixed an issue in the SecurityObjectDatAccess causing the SecurityObject Token assigment to be invalid after XML export/import.
Customers using our distribute, export and import routines to distribute Security Object Token assignment may have to delete those records in the receiving environments.

SCL-2711 Fixed an issue with eSmartSecurityRealm buffer may be invalid in SecurityService:IsRestricted ()


We have fixed an issue introduced in SCL-2485 which might have broken the IsRestricted check of the SecurityService class.


SCL-2695 Created missing indexes in the SmartGroup and SmartUserGroup database table


We have created missing indexes in the SmartGroup and SmartUserGroup database table.

SCL-2696 Migrated Consultingwerk .NET Assemblies to CLI 4.0


The Consultingwerk .NET Assemblies have been ported to .NET 4.0. The new assembly versions are:

  <assembly name="Consultingwerk.Design, Version=, Culture=neutral, PublicKeyToken=10603cb31df311b3"/>
  <assembly name="Consultingwerk.SmartComponents, Version=, Culture=neutral, PublicKeyToken=10603cb31df311b3"/>
  <assembly name="Consultingwerk.SmartComponents.Design, Version=, Culture=neutral, PublicKeyToken=null"/>
  <assembly name="Consultingwerk.Support, Version=, Culture=neutral, PublicKeyToken=10603cb31df311b3"/>

SCL-2697 Added repository support für SmartDataBrowser:EditInViewerOnDefaultAction property


We have added the property Repository support EditInViewerOnDefaultAction to the MetaGrid class in the repository and added rendering support for it.


The MetaForm repository type now supports the definition of pass-through data-links from a calling form to an instance within the called form.
It's now supported to define the "PrimaryDataTarget" link from a MetaDataSource, MetaViewer or MetaGrid to the Customer. When the form is rendered, the rendering service will set the PrimaryDataTarget property of the form to the reference to the linked component.
When starting the form, developers can set the ExternalDataTarget property before the Form is shown.
To support the use of this, we have also added for variants for the LaunchForm method to the SmartFormFactory ( _library/release/Consultingwerk.Windows.Framework.SmartFormFactory.html) class.

     * Purpose: Launches a Form
     * Notes:
     * @param pcClassName The name of the Form to launch (static class name or repository object name)
    METHOD PUBLIC STATIC Progress.Windows.Form LaunchForm (pcClassName AS CHARACTER):

     * Purpose: Launches a Form
     * Notes:
     * @param pcClassName The name of the Form to launch (static class name or repository object name)
     * @param poExternalDataSource The reference of the SmartDataSource to use of the ExternalDataSource of the SmartWindowForm
    METHOD PUBLIC STATIC Progress.Windows.Form LaunchForm (pcClassName AS CHARACTER,
                                                           poExternalDataSource AS ISmartDataSource):

     * Purpose: Launches a Form
     * Notes:
     * @param pcClassName The name of the Form to launch (static class name or repository object name)
     * @param plModal Logical value indicating if the Form should be started modally
    METHOD PUBLIC STATIC Progress.Windows.Form LaunchForm (pcClassName AS CHARACTER,
                                                           plModal AS LOGICAL):

     * Purpose: Launches a Form
     * Notes:
     * @param pcClassName The name of the Form to launch (static class name or repository object name)
     * @param poExternalDataSource The reference of the SmartDataSource to use of the ExternalDataSource of the SmartWindowForm
     * @param plModal Logical value indicating if the Form should be started modally
    METHOD PUBLIC STATIC Progress.Windows.Form LaunchForm (pcClassName AS CHARACTER,
                                                           poExternalDataSource AS ISmartDataSource,
                                                           plModal AS LOGICAL):

A sample event handler using these new API's in a calling form may look like this:

    METHOD PUBLIC VOID OrderOverviewHandler (sender AS System.Object,
                                             e AS ToolClickEventArgs):

        DEFINE VARIABLE oDataSource AS SmartBusinessEntityAdapter NO-UNDO .
        DEFINE VARIABLE oForm       AS Progress.Windows.Form      NO-UNDO .

        oDataSource = CAST (CAST (THIS-OBJECT:Owner, 
                                  DynamicForm):GetInstance ("CustomerDataSource":U), 
                            SmartBusinessEntityAdapter) .

        oForm = SmartFormFactory:LaunchForm ("OrderOverViewForm":U,
                                             TRUE) .

SCL-2700 Implemented minor performance improvement in WinKitForms:FromEmbeddedWindow


We have implemented a minor performance improvement in the FromEmbeddedWindow method of the WinKitForms class.

SCL-2708 Updated Release note RSS Feed to point to Atlassian Cloud Confluence


Following the move of our documentation website to we have updated the RSS feed used by the Business Entity Designer to display release notes.

New Feature

SCL-2378 Implemented ability to enable ProfilerService from the startup JSON file


The JSON configuration file can now be used to activate the Performance Profiler for a session. The following JSON entry can be used to enable and configure the profiler.

    "profiler": {
        "enabled": true,
        "outputFileName": "c:/Work_STREAM/SmartComponentLibrary/Develop/smartpas_stream/work/",
        "description": "AppServer Profiler Session",
        "debugListingDirectory": "c:/Work_STREAM/SmartComponentLibrary/Develop/smartpas_stream/work",
        "traceFilter": "*"

For AppServer session the startup manager will append a GUID for the provided file name to ensure a unique file name,
More details on the JSON Configuration File Format: