Release Notes 2021-08-02

Version Information

OpenEdge Release

Version Information

OpenEdge Release

Version Information

11.7.9, 11.7.10, 12.2, 12.3, 12.4

Release 11.7 #67142@2021-08-02

OpenEdge 12.3 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.3. We hereby declare OpenEdge 12.3 fully supported for the SmartComponent Library as of the release of  November 24th 2020.

OpenEdge 12.2 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.2. We hereby declare OpenEdge 12.2 fully supported for the SmartComponent Library as of the release of April 09th 2020.

.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!

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:

1 <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.:

1 "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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 defaultHandler=OpenEdge.Web.CompatibilityHandler 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 handler41=Consultingwerk.Web2.WebHandler.ExecuteQueryWebHandler: /ExecuteQuery handler42=Consultingwerk.Web2.WebHandler.TranslationProviderWebHandler: /GetTranslation

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-3421 Resolved SFRBO reload issue - implemented URL Rewrite on PASOE


When the SmartFramework Angular client is deployed to PASOE as a web server, it's required to enable a URL rewrite rule on PASOE. Otherwise an HTTP 404 error is raised when the user reloads the page. Instructions for configuring this rewrite URL for PASOE are provided on
HTTP s://

SCL-3434 Fixed issue starting thin client GUI application with caching of user group assignments


We have resolved the issue
Unable to initialize static property Consultingwerk.SmartFramework.Authorization.SecurityService:CacheUserGroupAssignments.
Consultingwerk.SmartFramework.Authorization.SecurityService Database SmartDB not connected. (1006)
Static instance failed to load. Cannot reference class Consultingwerk.SmartFramework.Authorization.SecurityService. (14631)
Static member 'CacheUserGroupAssignments' must be accessed via a class name, not via an object instance. (14634)
when starting a thin-client application with the caching service for user group assignments enabled.

SCL-3435 Resolved -s stack exceeded in ErrorHelper


We have resolved an issue in the ErrorHelper class that was causing an -s exceeded error when dealing with a large stack trace.
This issue is resolved now.

SCL-3436 The DatasetModel destructor failed when created with no parameters


The DatasetModel destructor was raising an issue when the instance was created with no arguments.
This issue has been fixed now.

SCL-3437 DatasetHelper:AllChildBufferNames failed with recursive relations


The method DatasetHelper:AllChildBufferNames was failing when the ProDataset contained recursive relations.
This issue has been fixed now.

SCL-3439 RestResourceService failed to initialize with abstract Business Entity class


Customer has implemented an abstract base class for Business Entities. This abstract base class did cause issues initializing the RestResoruceService (used by the REST Entities web handler).
This issue is now fixed.

SCL-3440 URL's produced by the RESTful entities now include the Web App Name in the path


The HATEOAS style URL's produced by the RESTful Entities web handler now include the Web App name in the URL's contained in the responses.


SCL-2727 Added possibility to specify alternative storage areas for tables/indices and LOBs when starting setup.xml


Added the functionality to in addition of removing the areas, replacing the areas by command line paramater prescribed areas. When specifying -Dtablearea -Dindexarea -Dlobarea
See for more information

SCL-3417 Validate Design in the Business Entity Designer now checks for reserved ABL keywords in Temp-Table-, Field- and Index Names


The Validate Design feature of the Business Entity Designer has been extended to verify that identifiers used for tables, fields and indexes are actually valid in the ABL language.

SCL-3418 Setting DataAccess:InFetchDataByKeyTable to TRUE before CustomizeFetchDataRequest


We're now setting the DataAccess:InFetchDataByKeyTable flag to TRUE before invoking the CustomizeFetchDataRequest method.
This allows developers utilize this flag value already when in the CustomizeFetchDataRequest method.

SCL-3419 Implemented DatasetModel Class support for RefetchCurrentRow


We have implemented a RefetchCurrnetRow method on the TableModel class similar to the same named method on the SmartBusinessEntityAdapter.
The method can be used to refetch the current record from the backend.

SCL-3423 Added support for multiple PASOE web apps for a single PASOE ABL app to scl-pasoe scripts


The PASOE scripts will now use the OpenEdge application name instead of the webapp names.
Note, that a single ABL web application can be used/referenced by multiple Tomcat web applications. An ABL web application represents an agent pool, an Tomcat web application represents an URL entry point.
A possible use-case for two web applications for a single PASOE ABL web application might be different authentication configurations for the same application.

SCL-3438 Ensuring ProDataset buffers are repositioned after submit with error message in SmartBusinessEntityAdapter


We are now ensuring that the buffers of all ProDataset tables are positioned to the records they have been pointing to before attempting to submit updated data even after an update that caused a validation error message.
Previously we have only been positioning the buffers to the correct records after a successful update.

New Feature

SCL-3374 Implemented linking between Business Entities/Dataset Models


Using the Consultingwerk.BusinessEntityDesigner.Plugins.BusinessEntityRelationsPlugin plugin the Business Entity Designer now supports the maintenance of relations between tables in different Business Entities.
When the plugin is activated the "Table Relation" button on the "Temp Table" tab of the main ribbon can be used to maintain relations.
Currently, the Dataset Model generator plugin is using those relations to generate GetMethods (e.g. OderTableModel:GetCustomer() or CustomerTableModel:GetOrders()) on the Table Model instance. These methods will return a DatasetModel for the referenced Business Entity with the related data already fetched from the backend.

SCL-3386 The business entity designer now warns when deleting a field that is present in an index


The Business Entity Designer, the developer is now warned when attempting to delete a field from a temp-table that is still referenced in an index.

SCL-3420 Implemented support for strong typed action types


Action Types have been established by multiple customers now to distinguish updates in different application contexts. Previously we've been supporting Action Types in the Business Entity as Enum values provided by the SaveChangesParameter and the IProvidesActionType interface.
Strong typed Action types go a step beyond as the Action Type will actually take over the whole validation workflow in the Business Entity. An update performed with an Action Type will no longer invoke the ValidateData method in the Business Entity.
The implementation has multiple components:
The actual Action Type implementation. Action Types have to implement the Consultingwerk.OERA.IActionType interface, there's an abstract base class Consultingwerk.OERA.ActionType that can be used when implementing Action Types.
It is strongly suggested, that Action Types are placed in the same package as the Business Entity and have a PACKAGE-PROTECTED constructor (OpenEdge 12) as it's expected that the Business Entity is used to return an instance of an action type to a consumer (e.g. Business Task or Dataset Model).
A Business Entity providing updates with action types is expected to
return action type instances to consumers through STATIC properties, e.g.:

1 2 3 4 5 6 7 8 9 10 11 12 13 /** * Purpose: Returns the CancelOrderActionType instance * Notes: * */ DEFINE PUBLIC STATIC PROPERTY CancelOrderActionType AS CancelOrderActionType NO-UNDO GET(): IF NOT VALID-OBJECT (OrderBusinessEntity:CancelOrderActionType) THEN OrderBusinessEntity:CancelOrderActionType = NEW CancelOrderActionType (). RETURN OrderBusinessEntity:CancelOrderActionType . END GET. PRIVATE SET.

The Consultingwerk.BusinessEntityDesigner.Plugins.ActionTypePlugin plugin for the Business Entity Designer has been implemented to provide facades to these STATIC properties as part of the DatasetModel for the Business Entity as it's expected that in many cases a Business Task is primarily using the DatasetModel to interface with the Business Entity.
The Business Entity now has a new variant of the SaveChanges method accepting the ProDataset with changes and an Action Type instance.
When this variant of SaveChanges is used, the ValidateData Method of the Business Entity is not used. Instead all validation is delegated to the Execute method of the action type instance.
The Consultingwerk.OERA.ActionType implementation (abstract base class) implements the following validations:
- Validation of fields that are allowed to change within this Action Type
- Validation of temp-table that is allowed to be updated within this Action Type
- Execution of a ValidationMethod in a ValidationClass
- Passing of a TableModel (Buffer-Model) for the before and after representation of the record to the validation method
The instance of the Validation class is obtained using the following methods:
- when an Interface that inherits from Ccs.Common.IService is specified the ServiceContainer is used to obtain the validation service instance
- when an Interface that does not inherits from Ccs.Common.IService is specified the IFactory Service will be used to obtain a validation instance
- when a class type is provided, we'll dynamically create an instance of that class without further abstraction.
Below is a sample Action Type:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 CLASS Consultingwerk.OeraTests.SCL3420.CancelOrderActionType INHERITS ActionType: DEFINE PROTECTED OVERRIDE PROPERTY ActionFields AS CHARACTER NO-UNDO INITIAL "Instructions":U GET. DEFINE PROTECTED OVERRIDE PROPERTY ActionTable AS CHARACTER NO-UNDO INITIAL "eOrder":U GET. DEFINE PROTECTED OVERRIDE PROPERTY TableModelClass AS Progress.Lang.Class NO-UNDO GET. PRIVATE SET . DEFINE PROTECTED OVERRIDE PROPERTY ValidationClass AS Progress.Lang.Class NO-UNDO GET. PRIVATE SET . DEFINE PROTECTED OVERRIDE PROPERTY ValidationMethod AS CHARACTER NO-UNDO INITIAL "ValidateData":U GET. /** * Purpose: Package-protected constructor for the ShipOrderActionType class * Notes: */ CONSTRUCTOR {&PACKAGE-PROTECTED} CancelOrderActionType (): ASSIGN THIS-OBJECT:TableModelClass = GET-CLASS (OrderTableModel) THIS-OBJECT:ValidationClass = GET-CLASS (IValidateCancelOrder) . END CONSTRUCTOR. END CLASS.

And an example for the validation class:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 CLASS Consultingwerk.OeraTests.SCL3420.ValidateCancelOrder IMPLEMENTS IValidateCancelOrder: /** * Purpose: Validates a shipped order * Notes: * @param poBefore The reference to the before buffer * @param poAfter The reference to the current buffer */ METHOD PUBLIC VOID ValidateData (poBefore AS OrderTableModel, poAfter AS OrderTableModel): DatasetHelper:AddErrorString (poAfter:BufferHandle, "ValidateCancelOrder was here") . END METHOD. METHOD PUBLIC VOID dispose (): END METHOD. METHOD PUBLIC VOID initialize (): END METHOD. END CLASS.

The IValidateCancelOrder Interface inherits Ccs.Common.IService.


SCL-3422 Implemented Backend API's for SFRBO Menu Security Maintenance


We have implemented various backend API's to support the Angular version of the menu security maintenance screen.

SCL-3432 Resolved error when lookup query contains a question mark (unknown value)


We have resolved an issue in the Consultingwerk.OERA.Query.QueryString class with processing client query strings that contain the unknown value as the value for a field.
This issue has been fixed now.