Release Notes 2019-08-11

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 #53757@2019-08-11

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-2678 Resolved SmartLinkType GUID conflict with AKIOMA Repository


Our Partner AKIOMA is using the SmartFramework Repository for their Web based framework. They are using a similar object scheme and had created the "Navigation" SmartLink before us. When we have shipped our version of the Navigation SmartLinkType record this caused a conflict with data in AKIOMA's installations.
We have now adopted the same GUID for "our" Navigation link. The SmartDB upgrade and migration script will convert the GUID of the SmartLink and SmartLinkType records. The containers containing those modified SmartLink records will be flagged as modified.
The new GUID of the Navigation SmartLinkType is: f52235a4-c120-2490-3814-9e29182ad912

SCL-2719 Resolved conflicts between References to Flags enum and customer DB in ParameterObject and ValueObject


We've resolved compiler issues at one customer caused by conflict between a database field and abbreviated static references to the Progress.Reflect.Flags enum.

SCL-2720 Revolved DatasetModel Interface generator creating invalid source for extent properties.


We've fixed an issue in the generator for the TableModel Interfaces.

SCL-2729 Updated web page URL for scl-pasoe-.... documentation


Following the move of our Atlassian Confluence based documentation we have now updated the scl-pasoe-... sciprt's to open the new updated documentation web site location when launched with no arguments.

SCL-2730 Fixed issue in Consultingwerk.Framework.Server.AppServerStartupManager with parsing service definitions


We have resolved an issue in the AppServerStartupManager and derived implementation (e.g. GuiClientStartupManager) which might prevented the session from starting successfully.
The issue might have occurred when the JSON configuration file (or files the configuration is based on) were mixing references to service.xml files and direct references to services. The error seen would have been similiar to this here:
Array subscript 4 is out of range. The indeterminate extent is fixed to a dimension of 3. (11388)
The issue is now fixed.

SCL-2731 SmartRepositoryService would not be loaded on an AppServer client due to dependencies to the SmartDB


We've resolved direct dependencies from the SmartRepositoryService to the SmartDB.
Furthermore we've added the SmartRepositoryService to the Consultingwerk\SmartFramework\services_client.xml file. This is considered a temporary solution until the client rendering can fully depend on the SmartRepositoryClientService (SCL-2732).


SCL-2716 Now supports RESTful entities with ROWID KEYS


We have enhanced the RESTful Entities. Developers dealing with Business Entities without a unique field combination in the database can now use the ROWID Keys also as the id field value for RESTful URL's:

@RestAddress (type="record", address="/Scl2617Test/~{DbRowidField}", tables="eShipTo", id="DbRowidField",
              fields="eShipTo.*", canRead="true", canUpdate="true", canDelete="true").

@RestAddress (type="collection", address="/Scl2617Test", tables="eShipTo", id="DbRowidField",
              fields="CustNum,ShipToID", canCreate="true", canDelete="true").

The support for ROWID based RESTful URL's is now based on an enhancement of the Data Access query building routine (Consultingwerk.OERA.Query.QueryString). This now supports resolving a client query string like

FOR EACH eShipTo WHERE eShipTo.DbRowidField = "<rowid value>"


FOR EACH eShipTo WHERE eShipTo.DbRowidField = TO-ROWID("<rowid value>")

SCL-2725 GuiClientStartupManager now usable without startup Form


Previously, the GuiClientStartupManager has always attempted to launch the StartupForm - even when the configuration property was left empty.
We have made this optional when the StartupForm is not defined. This simplifies the integration of the GuiClientStartupManager into existing frameworks that take care of loading their own main menu etc.

SCL-2726 ModelClassGeneratorPlugin now supports abstraction from EntityName


There are situations where it's required to use a customized entity name in the EntityName property of the generated portion of the DatasetModel code (e.g. CustomerDatasetModel_Generated). This is typically the case, when customers implement a ServiceNameMappingService to abstract the true Business Entity implementations (customization scenario). Customers might demand to use Interface names as the client/consumer visible EntityName.
This is now supported by maintaining the ModelClassGenerator.EntityName custom property.

SCL-2728 scl-gen ant script now uses the PCT.jar file provided with the SmartComponent Library as part of the SmartDB upgrade and migration utility


We've made two changes to the scl-gen batch file to simplify the usage of the script for customers not using ANT and PCT for other tasks
a) when present (OpenEdge 11.7 onward) we're now using the ant installation provided with OpenEdge to execute the script. When the OpenEdge setup does not contain ant we're falling by on the previous behavior with was to expect ant to be available in the windows PATH
b) we're referencing the PCT.jar file from the SmartComponent Library Setup\Install\lib folder so that customers using the scl-gen script are not dependent on BYO PCT.jar

SCL-2733 Added ServiceLoader logging when ListService calls initialize() on new services


The ServiceLoader uses the ListService class to invoke the initialize() method no new Ccs.Common.IService implementations.
We've now added logging for this:

[19/08/10@08:43:01.658+0200] P-031664 T-008272 1 AS-7 ServiceLoa     ### Initializing Service: Consultingwerk.Framework.Factory
[19/08/10@08:43:01.658+0200] P-031664 T-008272 1 AS-7 ServiceLoa     ### Finished initializing Service: Consultingwerk.Framework.Factory 0 msec
[19/08/10@08:43:01.659+0200] P-031664 T-008272 1 AS-7 ServiceLoa     ### Initializing Service: Consultingwerk.OERA.RestResource.RestResourceService
[19/08/10@08:43:06.770+0200] P-031664 T-008272 1 AS-7 ServiceLoa     ### Finished initializing Service: Consultingwerk.OERA.RestResource.RestResourceService 5111 msec
[19/08/10@08:43:06.770+0200] P-031664 T-008272 1 AS-7 ServiceLoa     ### Initializing Service: Consultingwerk.SmartFramework.Authorization.SmartRequestAuthorizationProvider
[19/08/10@08:43:06.771+0200] P-031664 T-008272 1 AS-7 ServiceLoa     ### Finished initializing Service: Consultingwerk.SmartFramework.Authorization.SmartRequestAuthorizationProvider 1 msec

New Feature

SCL-2717 Support for FormAction


We've added a new FormAction property to the two menu function types
Consultingwerk.Web2.SmartFramework.Menu.LaunchWebViewCallParameter (Angular Web)
Consultingwerk.Windows.Framework.LaunchFormCallParameter (GUI for .NET)
Using that property, developers can specify an action which should be executed when the form is started (e.g. Add). For GUI for .NET, the property FormAction is set on the new Form instance, so that developers can add relevant code to handle the FormAction in the form's OnShown event.

SCL-2721 TableModel / BufferModel can now become the owner of the passed in Buffer handle and Temp-Table


When creating a BufferModel based on an existing Buffer, a new parameter passed to the constructor of the BufferModel (TableModel) of type Consultingwerk.OERA.BufferModelGcModeEnum allows to control if the BufferModel will delete the Buffer and the Temp-Table in it's destructor.

SCL-2722 BufferModel (TableModel) now supports creating the temp-table internally


Generated TableModel classes can now be instantiated without any parameter. In this more, a BufferModel based on a dynamically created temp-table will be created. This is useful when BufferModels should be used to pass around data without relying on an external owner of a temp-table.
This feature requires regeneration of the TabelModel classes based on the most recent templates; customers may need to update their own templates.
Existing TableModel classes need to be deleted first or a constructor with no arguments must be added manually.