Release Notes 2024-03-27

Version Information

OpenEdge Release

Version Information

11.7.17, 12.2, 12.7, 12.8

Release 11.7 #79686@2024-03-27

Security Bulletin - log4j CVE-2021-44228

Further details: log4j CVE-2021-44228

OpenEdge 12.8 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.8. We hereby declare OpenEdge 12.8 fully supported for the SmartComponent Library as of the release of  January 15th 2024.

OpenEdge 12.7 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.7. We hereby declare OpenEdge 12.7 fully supported for the SmartComponent Library as of the release of  May 10th 2023.

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.

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.

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
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-4397 Resolve issue with accented characters in the DataTypeHelper's GetStringFromWideMemptr method


Resolve issue in the Consultingwerk.Util.DataTypeHelper’s GetStringFromWideMptr method where non-ASCII characters were incorrectly handled. UTF-8 characters are now returned correctly.

SCL-4423 SmartRepositoryService:StoreObjectMasterAttributes now supports AppServer


We have improved the SmartRepositoryService method StoreObjectMasterAttributes. The method can now be used from an AppServer client.


SCL-3714 Business Entities and Data Access classes support fast retrieval of single records using static queries in the Data Access layer


Business Entities and Data Access classes support fast retrieval of single records using static queries in the Data Access layer. Static queries are implemented for individual Data Access classes, and are intended to return a single record from a single temp-table in the Business Entity’s dataset (effectively operating like a FIND statement).

These static queries and their supporting classes are generated by the Business Entity Generator, based on indexes that have the Default Search Code Generation toggle selected. Each query is in a protected method named _Fetch<Table>By<Field>[<Field>]_ that contains statically-defined buffers and queries for just that method. These methods are called based on the OOABL type of the parameter object used; one parameter object is generated per index, and is named _Fetch<Table>By<Field>[<Field>]Request.cls_ . These parameter objects implement the new Consultingwerk.OERA.IFetchDataByStaticQueryRequest interface,

For example a request for a customer record based on the {{CustNum}} field would be called FetchByCustomerByCustNumRequest.cls . A request to retrieve a single orderline based on order number and line number would be FetchOrderlineByOrderNumLinenumRequest.cls. These request parameters would be used to call the FetchByCustomerByCustNum and FetchOrderlineByOrderNumLinenum methods in the Data Access classes (respectively).

By default, the methods do not run the dataset’s read events (if defined). This behaviour can be added using preprocessors in the implementing Data Access class. By default, no errors are thrown, for either no record being found, nor for mul,.tiple records being found; again, this behaviour is customisable via preprocessors.

The Data Access abstract base class does not implement any functionality: if a Data Access class does not override the {{FetchDataByStaticQuery}} method, a Consultingwerk.OERA.Exceptions.StaticQueryNotSupportedException exception is thrown.

Static queries may also be run from a Table Model, using a new {{FillByStaticQuery}} method. This method takes a request parameter object with a type of Consultingwerk.OERA.IFetchDataByStaticQueryRequest .

SCL-4290 New entitySchemaType attribute value for the ApiDoc annotation


To prevent the OOABL class names of Business Entities and Business Tasks from appearing in Swagger documentation for schemas (e.g. the record templates used for initial values requests, or in dataset schemas for invokable methods' parameters), a new entitySchemaType annotation argument has been added to the ApiDoc annotation. This attribute allows developers to provide an optional, alternative value to be used in the Swagger schemas instead of the Business Entity or Business Task class name.

For more detail, see

SCL-4347 Implemented support for adding custom descriptions for Swagger documentation for RestMethod and RestAddress annotations.


RESTful services using the RestAddress annotation allow the optional provision of descriptions for various HTTP methods (GET, PUT, POST, PATCH and DELETE) using a _methodDescription<Method>_ annotation attribute in the RestAddress annotation. This description is used for the operation in the generated Swagger documentation.

Invokable methods using the RestMethod annotation allow the optional provision of descriptions for the operation, as well as for any parameters to the method’s parameter class. The description is provided using a description attribute value, in the RestMethod annotation.

Descriptions for the parameters are provided using a new RestMethodParameter annotation, which has a name and a description attribute. The value of the name attribute should be the parameter name , which can be a path, header, cookie or query string. The descrption attribute contains a description for the parameter.

More information on the attribute values is avaliable at [ HTTP s://| HTTP s://|smart-link] and [ HTTP s://| HTTP s://|smart-link] .

SCL-4370 Silent mode for WebClientDeploymentHelper


The WebClientDeploymentHelper now supports reducing the output verbosity based on the JSON parameter object:

* silentCompile true/false: Suppress messages during compilation
* silentMode true/false: Suppress more status messages

SCL-4389 Implement generation of static data access queries with an explicit NO-LOCK


Static data access queries are generated with an explicit NO-LOCK in the OPEN QUERY statement, regardless of whether a lock mode was present anywhere in the query or not.

SCL-4392 Implement support for invokable methods with IWebRequest parameters with non-JSON message bodies


Support OpenEdge.Web.IWebRequest implementations as parameters to invokable methods, when the request has a message body (payload). When the RestMethod parameterClassName is “OpenEdge.Web.IWebRequest" or “IWebRequest", then a message body is allowed.

For all other cases, only a JSON message body is supported.

SCL-4402 Added new variant of method ClassHelper:IsInCallStack


Added a new variant to the ClassHelper:IsInCallStack method. This variant supports filtering by a method name in addition to the class name.

SCL-4409 Fixed exception raised in SmartRepositoryClientService:GetLookupDescriptor


We have fixed a potential exception raised by the GetLookupDescriptor method. This exception might have been raised based on the combination of attributes of the lookup master.

SCL-4419 Added max character length constant to Const.cls


We have added a new system constant to the Consultingwerk.Const class:

     * Purpose: The maximum length of an ABL character value
     * Notes:   31991

SCL-4420 ServiceInterface:InvokeMethod now also supports ServiceInterfaceSupportsSharedVariables with parameter object


The ServiceInterfaceSupportsSharedVariables switch in products.i is now also supported by ServiceInterface:InvokeMethod when a parameter object is passed. Previously, this was only supported when no parameter object was provided.

SCL-4421 ServiceInterfaceSupportsSharedVariables now also supports include files at the end of the si-... procedures


Based on a new setting in products.i

&IF 1=0 &THEN
/* Mike Fechner / Consultingwerk Ltd.
   SCL-4421 : Used together with ServiceInterfaceSupportsSharedVariables
              When defined, si-...p procedures will include a second include file at the end to support
              updating the session context from shared variables /
GLOBAL-DEFINE ServiceInterfaceSupportsSharedVariablesEnd ServiceInterfaceSupportsSharedVariablesEnd

we now support also adding a second include file at the end of the si-…. procedures. These include files support reading values of SHARE VARIABLES and storing them in the persisted session context.

SCL-4424 SmartDataBrowser now supports alternative default operator for SmartFilter


The SmartDataBrowser now supports to set an alternative default operator for a column in the the SmartFilter row. By default BEGINS is used as an operator on all CHARACTER fields/columns and GE is used on all other columns.

Developers can now set the SmartFilterOperators attribute of the grid instance to a comma delimited list of name=operator values, e.g. “Custnum=EQ,Region=eq”

This attribute can also be set in the SmartFramework Repository.

SCL-4426 Improved StringHelper:RemoveCharacters implementation


We have slightly improved the implementation of the StringHelper:RemoveCharacters method.