Release Notes 2018-09-10

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,

Release 11.3 #48227@2018-09-10

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 habe not been aware of any incompatibilities with OpenEdge 11.7.3. 

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 (08 April 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 methods for refactoring purposes. The most recent code in the Consultingwerk.Studio package relies on those methods. It's therefore mandatory to update proparse to this version.

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}

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-2357 Wrong variable used in TableModel class resulted in error "Unable to convert SET-PARAMETER value to datatype passed. (10059)"


We have resolved an issue where the invocation of the FetchDataByKeyTable method using a DatasetModel caused the error

Unable to convert SET-PARAMETER value to datatype passed. (10059)

CallStack from ABL error object:
--> FillByKeyTable Consultingwerk.OERA.TableModel at line 2412 


SCL-2353 Added ArrayHelper:Message variant for HANDLE[]


Aded the following new method to the ArrayHelper:

     * Purpose: Displays a message with the items of the given character array
     * Notes:
     * @param pcPrefix The prefix to add to each item (e.g. array name)
     * @param phArray The Handle Array
                                       phArray AS HANDLE EXTENT):

SCL-2354 WinKit IEmbeddedWindowForm now inherit from IFormWithUltraToolbarsManager


The Interface has already been a superset of the IFormWithUltraToolbarsManager. We've now finally added the inheritance between the two interfaces to reduce the number of CAST's which are required when working with the WinKit.

SCL-2355 Added UltraToolbarsHelper support for Office 2010 style Application Menu


Implemented method to render ABL MENU-BAR as Office 2010 style Application menu

     * Purpose: Builds a Ribbon ApplicationMenu structure with the structure
     *          of an ABL menu-bar
     * Notes:
     * @param poForm The Form owning the UltraToolbarsManager that contains the Ribbon
    METHOD PUBLIC STATIC VOID BuildRibbonApplicationMenu2010 (poForm AS IFormWithUltraToolbarsManager):

SCL-2356 RestAddressProvider now provides more details in error when .classpath file contains invalid folders


We have improved the error handling here, so that the error message now indicates the invalid entry in the .classpath file. This will simplify locating the configuration problem.

SCL-2361 BusinessEntityDesigner now allows case-sensitive modification of SERIALIZE-NAME during code generation


The Business Entity Designer does now support generating a SERIALIZE-NAME that only differs in the case form the field name. Previously a case-insensitive comparison was performed to decide of the SERIALIZE-NAME attribute of a temp-table field had to be written to the source code.

SCL-2364 Implemented a new BufferHelper API which determines the type of a buffer


Implemented the following new method in the BufferHelper which returns an Enum value representing the type of a given buffer: Database, Temp-Table or Before-Table

     * Purpose: Determines the type of a Buffer
     * Notes:   Database, Temp-Table or Before-Table
     * @param phBuffer The buffer to determine the type of
     * @return The type of the Buffer as a BufferTypeEnum value
    METHOD PUBLIC STATIC BufferTypeEnum BufferType (phBuffer AS HANDLE):

SCL-2365 Implemented JsonHelper method that build delimited lists of the given attributes of a JsonObject


Added the following new methods to the JsonHelper class

     * Purpose: Returns a delimited list with the values of the given
     *          attributes of the JsonObject
     * Notes:
     * @param poJsonObject The reference to the JsonObject
     * @param pcAttributeNames The comma delimited list with the names of the JSON attributes
     * @return The delimited list with the values
    METHOD PUBLIC STATIC CHARACTER ListFromAttributeValues (poJsonObject AS JsonObject,
                                                            pcAttributeNames AS CHARACTER):

     * Purpose: Returns a delimited list with the values of the given
     *          attributes of the JsonObject
     * Notes:
     * @param poJsonObject The reference to the JsonObject
     * @param pcAttributeNames The comma delimited list with the names of the JSON attributes
     * @param pcDelimiter The list delimited
     * @return The delimited list with the values
    METHOD PUBLIC STATIC CHARACTER ListFromAttributeValues (poJsonObject AS JsonObject,
                                                            pcAttributeNames AS CHARACTER,
                                                            pcDelimiter AS CHARACTER):

SCL-2366 Implemented scl-gen for Parameter objects with Interface (read-only or updatable)


We have implemented the following new scaffolding templates ( ):

scl-gen ParameterWithInterface SampleParameter Value1 Value2
scl-gen ParameterWithReadOnlyInterface SampleParameter Value1 Value2
scl-gen Interface SampleInterface Value1 Value2
scl-gen ReadOnlyInterface SampleInterface Value1 Value2

These templates can be used to generate Interface types and serializable parameter objects implementing those interfaces.

New Feature

SCL-1994 RESTful services now provide field security based on existing security realm


The RESTful services now utilize the SFV and SFS security realms. Fields which are not authorized using the SFV realm will be excluded from the responses of a RESTful entity. Fields which are not authorized using the SFS or SFV realms will cause an http 403 error when the user tries to update those fields using a POST, PUT or PATCH method.

SCL-2000 Implemented logging presets


The Consultingwerk.Util.LogManager class now supports setting the LOG-MANAGER:LOG-ENTRY-TYPES and the LogManager:CustomLogEntryTypes using presets provided by the IConfigurationProvider service (e.g. .applicationsettings file).

The .applicationsettings file can provide the logging presets using a nested JSON Structure:

    "loggingPresets": {
        "query": {
            "LogEntryTypes": "QryInfo:4,4GLTrace:2",
            "CustomLogEntryTypes": "DataAccess"
        "sample": {
            "LogEntryTypes": "4GLMessages:2,4GLTrans:2",
            "CustomLogEntryTypes": "ABC,DEF,GHI"

The logging presets can be activated using the LoggingPreset property:

Consultingwerk.Util.LogManager:LoggingPreset = "query".

The LogManagerSettings user control also supports selection of the active logging preset in a combo-box.

SCL-2359 Implement MetaGrid properties rowTemplate and rowDetailTemplate in the repository


To facilitate a common two label stack-layout in the NativeScript Grids, the JSON template for grids, both repository and annotations based, should have four new character properties:

* rowImageTemplate
* rowTemplate
* rowDetailTemplate
* rowBadgeTemplate

When the rowTemplate is not set by a developer, the NativeScript rending will derive a column layout based on the Grid columns.